Merge pull request #394 from HeavyHorst/master

update some docs
kelseyhightower · Feb 21, 2016 · cf62311 · cf62311
2 parents eef0d05 + 52b3371
commit cf62311
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 29 deletions.
diff --git a/config.go b/config.go
@@ -95,7 +95,7 @@ func init() {
 	flag.BoolVar(&onetime, "onetime", false, "run once and exit")
 	flag.StringVar(&prefix, "prefix", "/", "key path prefix")
 	flag.BoolVar(&printVersion, "version", false, "print version and exit")
-	flag.StringVar(&scheme, "scheme", "http", "the backend URI scheme (http or https)")
+	flag.StringVar(&scheme, "scheme", "http", "the backend URI scheme for nodes retrieved from DNS SRV records (http or https)")
 	flag.StringVar(&srvDomain, "srv-domain", "", "the name of the resource record")
 	flag.StringVar(&srvRecord, "srv-record", "", "the SRV record to search for backends nodes. Example: _etcd-client._tcp.example.com")
 	flag.BoolVar(&syncOnly, "sync-only", false, "sync without check_cmd and reload_cmd")

diff --git a/docs/command-line-flags.md b/docs/command-line-flags.md
@@ -9,59 +9,60 @@ confd -h
 ```Text
 Usage of confd:
   -app-id string
-    	Vault app-id to use with the app-id backend (only used with -backend=vault and auth-type=app-id)
+      Vault app-id to use with the app-id backend (only used with -backend=vault and auth-type=app-id)
   -auth-token string
-    	Auth bearer token to use
+      Auth bearer token to use
   -auth-type string
-    	Vault auth backend type to use (only used with -backend=vault)
+      Vault auth backend type to use (only used with -backend=vault)
   -backend string
-    	backend to use (default "etcd")
+      backend to use (default "etcd")
   -basic-auth
-    	Use Basic Auth to authenticate (only used with -backend=etcd)
+      Use Basic Auth to authenticate (only used with -backend=etcd)
   -client-ca-keys string
-    	client ca keys
+      client ca keys
   -client-cert string
-    	the client cert
+      the client cert
   -client-key string
-    	the client key
+      the client key
   -confdir string
-    	confd conf directory (default "/etc/confd")
+      confd conf directory (default "/etc/confd")
   -config-file string
-    	the confd config file
+      the confd config file
   -interval int
-    	backend polling interval (default 600)
+      backend polling interval (default 600)
   -keep-stage-file
-    	keep staged files
+      keep staged files
   -log-level string
-    	level which confd should log messages
+      level which confd should log messages
   -node value
-    	list of backend nodes (default [])
+      list of backend nodes (default [])
   -noop
-    	only show pending changes
+      only show pending changes
   -onetime
-    	run once and exit
+      run once and exit
   -password string
-    	the password to authenticate with (only used with vault and etcd backends)
+      the password to authenticate with (only used with vault and etcd backends)
   -prefix string
-    	key path prefix (default "/")
+      key path prefix (default "/")
   -scheme string
-    	the backend URI scheme (http or https) (default "http")
+      the backend URI scheme for nodes retrieved from DNS SRV records (http or https) (default "http")
   -srv-domain string
-    	the name of the resource record
+      the name of the resource record
   -srv-record string
-    	the SRV record to search for backends nodes. Example: _etcd-client._tcp.example.com
+      the SRV record to search for backends nodes. Example: _etcd-client._tcp.example.com
   -sync-only
-    	sync without check_cmd and reload_cmd
+      sync without check_cmd and reload_cmd
   -table string
-    	the name of the DynamoDB table (only used with -backend=dynamodb)
+      the name of the DynamoDB table (only used with -backend=dynamodb)
   -user-id string
-    	Vault user-id to use with the app-id backend (only used with -backend=value and auth-type=app-id)
+      Vault user-id to use with the app-id backend (only used with -backend=value and auth-type=app-id)
   -username string
-    	the username to authenticate as (only used with vault and etcd backends)
+      the username to authenticate as (only used with vault and etcd backends)
   -version
-    	print version and exit
+      print version and exit
   -watch
-    	enable watch support
+      enable watch support
+
 ```
 
 > The -scheme flag is only used to set the URL scheme for nodes retrieved from DNS SRV records.
diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md
@@ -126,7 +126,7 @@ confd supports two modes of operation daemon and onetime. In daemon mode confd p
 #### etcd
 
 ```
-confd -onetime -backend etcd -node 127.0.0.1:4001
+confd -onetime -backend etcd -node http://127.0.0.1:4001
 ```
 
 #### consul