*: replace '-' with '--' in doc

Fix etcd-io#4595.

Documentation/admin_guide.md

@@ -201,10 +201,10 @@ $ tar -xzvf infra1.etcd.tar.gz -C %data_dir%
 ```
 
 ```
-etcd -name infra1 \
--listen-peer-urls http://10.0.1.13:2380 \
--listen-client-urls http://10.0.1.13:2379,http://127.0.0.1:2379 \
--advertise-client-urls http://10.0.1.13:2379,http://127.0.0.1:2379
+etcd --name infra1 \
+--listen-peer-urls http://10.0.1.13:2380 \
+--listen-client-urls http://10.0.1.13:2379,http://127.0.0.1:2379 \
+--advertise-client-urls http://10.0.1.13:2379,http://127.0.0.1:2379
 ```
 
 ### Disaster Recovery
@@ -220,9 +220,9 @@ To recover from such scenarios, etcd provides functionality to backup and restor
 The first step of the recovery is to backup the data directory on a functioning etcd node. To do this, use the `etcdctl backup` command, passing in the original data directory used by etcd. For example:
 
 ```sh
-    etcdctl backup \
-      --data-dir %data_dir% \
-      --backup-dir %backup_data_dir%
+etcdctl backup \
+  --data-dir %data_dir% \
+  --backup-dir %backup_data_dir%
 ```
 
 This command will rewrite some of the metadata contained in the backup (specifically, the node ID and cluster ID), which means that the node will lose its former identity. In order to recreate a cluster from the backup, you will need to start a new, single-node cluster. The metadata is rewritten to prevent the new node from inadvertently being joined onto an existing cluster.
@@ -232,23 +232,23 @@ This command will rewrite some of the metadata contained in the backup (specific
 To restore a backup using the procedure created above, start etcd with the `-force-new-cluster` option and pointing to the backup directory. This will initialize a new, single-member cluster with the default advertised peer URLs, but preserve the entire contents of the etcd data store. Continuing from the previous example:
 
 ```sh
-    etcd \
-      -data-dir=%backup_data_dir% \
-      -force-new-cluster \
-      ...
+etcd \
+  --data-dir=%backup_data_dir% \
+  --force-new-cluster \
+  ...
 ```
 
 Now etcd should be available on this node and serving the original datastore.
 
 Once you have verified that etcd has started successfully, shut it down and move the data back to the previous location (you may wish to make another copy as well to be safe):
 
 ```sh
-    pkill etcd
-    rm -fr %data_dir%
-    mv %backup_data_dir% %data_dir%
-    etcd \
-      -data-dir=%data_dir% \
-      ...
+pkill etcd
+rm -fr %data_dir%
+mv %backup_data_dir% %data_dir%
+etcd \
+  --data-dir=%data_dir% \
+  ...
 ```
 
 #### Restoring the cluster

Documentation/authentication.md

@@ -45,8 +45,8 @@ And there will be prompt for a new password.
 Roles can be granted and revoked for a user with
 
 ```
-$ etcdctl user grant myusername -roles foo,bar,baz
-$ etcdctl user revoke myusername -roles bar,baz
+$ etcdctl user grant myusername --roles foo,bar,baz
+$ etcdctl user revoke myusername --roles bar,baz
 ```
 
 We can look at this user with
@@ -95,20 +95,20 @@ Access can be granted as either read, write, or both, as in the following exampl
 
 ```
 # Give read access to keys under the /foo directory
-$ etcdctl role grant myrolename -path '/foo/*' -read
+$ etcdctl role grant myrolename --path '/foo/*' -read
 
 # Give write-only access to the key at /foo/bar
-$ etcdctl role grant myrolename -path '/foo/bar' -write
+$ etcdctl role grant myrolename --path '/foo/bar' -write
 
 # Give full access to keys under /pub
-$ etcdctl role grant myrolename -path '/pub/*' -readwrite
+$ etcdctl role grant myrolename --path '/pub/*' -readwrite
 ```
 
 Beware that 
 
 ```
 # Give full access to keys under /pub??
-$ etcdctl role grant myrolename -path '/pub*' -readwrite
+$ etcdctl role grant myrolename --path '/pub*' -readwrite
 ```
 
 Without the slash may include keys under `/publishing`, for example. To do both, grant `/pub` and `/pub/*`
@@ -122,7 +122,7 @@ $ etcdctl role get myrolename
 Revocation of permissions is done the same logical way:
 
 ```
-$ etcdctl role revoke myrolename -path '/foo/bar' -write
+$ etcdctl role revoke myrolename --path '/foo/bar' -write
 ```
 
 As is removing a role entirely

Documentation/backward_compatibility.md

@@ -8,14 +8,14 @@ The other main focus of this release was a more reliable Raft implementation, bu
 
 The major flag changes are to mostly related to bootstrapping. The `initial-*` flags provide an improved way to specify the required criteria to start the cluster. The advertised URLs now support a list of values instead of a single value, which allows etcd users to gracefully migrate to the new set of IANA-assigned ports (2379/client and 2380/peers) while maintaining backward compatibility with the old ports.
 
- - `-addr` is replaced by `-advertise-client-urls`.
- - `-bind-addr` is replaced by `-listen-client-urls`.
- - `-peer-addr` is replaced by `-initial-advertise-peer-urls`.
- - `-peer-bind-addr` is replaced by `-listen-peer-urls`.
- - `-peers` is replaced by `-initial-cluster`.
- - `-peers-file` is replaced by `-initial-cluster`.
- - `-peer-heartbeat-interval` is replaced by `-heartbeat-interval`.
- - `-peer-election-timeout` is replaced by `-election-timeout`.
+ - `addr` is replaced by `advertise-client-urls`.
+ - `bind-addr` is replaced by `listen-client-urls`.
+ - `peer-addr` is replaced by `initial-advertise-peer-urls`.
+ - `peer-bind-addr` is replaced by `listen-peer-urls`.
+ - `peers` is replaced by `initial-cluster`.
+ - `peers-file` is replaced by `initial-cluster`.
+ - `peer-heartbeat-interval` is replaced by `heartbeat-interval`.
+ - `peer-election-timeout` is replaced by `election-timeout`.
 
 The documentation of new command line flags can be found at
 https://github.com/coreos/etcd/blob/master/Documentation/configuration.md.

Documentation/clustering.md

@@ -192,7 +192,7 @@ ETCD_DISCOVERY=https://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573d
 ```
 
 ```
--discovery https://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573de
+--discovery https://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573de
 ```
 
 **Each member must have a different name flag specified. `Hostname` or `machine-id` can be a good choice. Or discovery will fail due to duplicated name.**

Documentation/docker_guide.md

@@ -17,14 +17,14 @@ This will run the latest release version of etcd. You can specify version if nee
 ```
 docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  --name etcd quay.io/coreos/etcd \
- -name etcd0 \
- -advertise-client-urls http://${HostIP}:2379,http://${HostIP}:4001 \
- -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
- -initial-advertise-peer-urls http://${HostIP}:2380 \
- -listen-peer-urls http://0.0.0.0:2380 \
- -initial-cluster-token etcd-cluster-1 \
- -initial-cluster etcd0=http://${HostIP}:2380 \
- -initial-cluster-state new
+ --name etcd0 \
+ --advertise-client-urls http://${HostIP}:2379,http://${HostIP}:4001 \
+ --listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
+ --initial-advertise-peer-urls http://${HostIP}:2380 \
+ --listen-peer-urls http://0.0.0.0:2380 \
+ --initial-cluster-token etcd-cluster-1 \
+ --initial-cluster etcd0=http://${HostIP}:2380 \
+ --initial-cluster-state new
 ```
 
 Configure etcd clients to use the Docker host IP and one of the listening ports from above.
@@ -47,44 +47,44 @@ The main difference being the value used for the `-initial-cluster` flag, which
 ```
 docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  --name etcd quay.io/coreos/etcd \
- -name etcd0 \
- -advertise-client-urls http://192.168.12.50:2379,http://192.168.12.50:4001 \
- -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
- -initial-advertise-peer-urls http://192.168.12.50:2380 \
- -listen-peer-urls http://0.0.0.0:2380 \
- -initial-cluster-token etcd-cluster-1 \
- -initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
- -initial-cluster-state new
+ --name etcd0 \
+ --advertise-client-urls http://192.168.12.50:2379,http://192.168.12.50:4001 \
+ --listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
+ --initial-advertise-peer-urls http://192.168.12.50:2380 \
+ --listen-peer-urls http://0.0.0.0:2380 \
+ --initial-cluster-token etcd-cluster-1 \
+ --initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
+ --initial-cluster-state new
 ```
 
 ### etcd1
 
 ```
 docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  --name etcd quay.io/coreos/etcd \
- -name etcd1 \
- -advertise-client-urls http://192.168.12.51:2379,http://192.168.12.51:4001 \
- -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
- -initial-advertise-peer-urls http://192.168.12.51:2380 \
- -listen-peer-urls http://0.0.0.0:2380 \
- -initial-cluster-token etcd-cluster-1 \
- -initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
- -initial-cluster-state new
+ --name etcd1 \
+ --advertise-client-urls http://192.168.12.51:2379,http://192.168.12.51:4001 \
+ --listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
+ --initial-advertise-peer-urls http://192.168.12.51:2380 \
+ --listen-peer-urls http://0.0.0.0:2380 \
+ --initial-cluster-token etcd-cluster-1 \
+ --initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
+ --initial-cluster-state new
 ```
 
 ### etcd2
 
 ```
 docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  --name etcd quay.io/coreos/etcd \
- -name etcd2 \
- -advertise-client-urls http://192.168.12.52:2379,http://192.168.12.52:4001 \
- -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
- -initial-advertise-peer-urls http://192.168.12.52:2380 \
- -listen-peer-urls http://0.0.0.0:2380 \
- -initial-cluster-token etcd-cluster-1 \
- -initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
- -initial-cluster-state new
+ --name etcd2 \
+ --advertise-client-urls http://192.168.12.52:2379,http://192.168.12.52:4001 \
+ --listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
+ --initial-advertise-peer-urls http://192.168.12.52:2380 \
+ --listen-peer-urls http://0.0.0.0:2380 \
+ --initial-cluster-token etcd-cluster-1 \
+ --initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
+ --initial-cluster-state new
 ```
 
 Once the cluster has been bootstrapped etcd clients can be configured with a list of etcd members:

Documentation/runtime-configuration.md

@@ -124,7 +124,7 @@ Now start the new etcd process with the relevant flags for the new member:
 $ export ETCD_NAME="infra3"
 $ export ETCD_INITIAL_CLUSTER="infra0=http://10.0.1.10:2380,infra1=http://10.0.1.11:2380,infra2=http://10.0.1.12:2380,infra3=http://10.0.1.13:2380"
 $ export ETCD_INITIAL_CLUSTER_STATE=existing
-$ etcd -listen-client-urls http://10.0.1.13:2379 -advertise-client-urls http://10.0.1.13:2379  -listen-peer-urls http://10.0.1.13:2380 -initial-advertise-peer-urls http://10.0.1.13:2380 -data-dir %data_dir%
+$ etcd --listen-client-urls http://10.0.1.13:2379 --advertise-client-urls http://10.0.1.13:2379 --listen-peer-urls http://10.0.1.13:2380 --initial-advertise-peer-urls http://10.0.1.13:2380 --data-dir %data_dir%
 ```
 
 The new member will run as a part of the cluster and immediately begin catching up with the rest of the cluster.
@@ -138,19 +138,19 @@ In the following case we have not included our new host in the list of enumerate
 If this is a new cluster, the node must be added to the list of initial cluster members.
 
 ```sh
-$ etcd -name infra3 \
-  -initial-cluster infra0=http://10.0.1.10:2380,infra1=http://10.0.1.11:2380,infra2=http://10.0.1.12:2380 \
-  -initial-cluster-state existing
+$ etcd --name infra3 \
+  --initial-cluster infra0=http://10.0.1.10:2380,infra1=http://10.0.1.11:2380,infra2=http://10.0.1.12:2380 \
+  --initial-cluster-state existing
 etcdserver: assign ids error: the member count is unequal
 exit 1
 ```
 
 In this case we give a different address (10.0.1.14:2380) to the one that we used to join the cluster (10.0.1.13:2380).
 
 ```sh
-$ etcd -name infra4 \
-  -initial-cluster infra0=http://10.0.1.10:2380,infra1=http://10.0.1.11:2380,infra2=http://10.0.1.12:2380,infra4=http://10.0.1.14:2380 \
-  -initial-cluster-state existing
+$ etcd --name infra4 \
+  --initial-cluster infra0=http://10.0.1.10:2380,infra1=http://10.0.1.11:2380,infra2=http://10.0.1.12:2380,infra4=http://10.0.1.14:2380 \
+  --initial-cluster-state existing
 etcdserver: assign ids error: unmatched member while checking PeerURLs
 exit 1
 ```

Documentation/security.md

@@ -41,9 +41,9 @@ For this you need your CA certificate (`ca.crt`) and signed key pair (`server.cr
 Let us configure etcd to provide simple HTTPS transport security step by step:
 
 ```sh
-$ etcd -name infra0 -data-dir infra0 \
-  -cert-file=/path/to/server.crt -key-file=/path/to/server.key \
-  -advertise-client-urls=https://127.0.0.1:2379 -listen-client-urls=https://127.0.0.1:2379
+$ etcd --name infra0 --data-dir infra0 \
+  --cert-file=/path/to/server.crt --key-file=/path/to/server.key \
+  --advertise-client-urls=https://127.0.0.1:2379 --listen-client-urls=https://127.0.0.1:2379
 ```
 
 This should start up fine and you can now test the configuration by speaking HTTPS to etcd:
@@ -69,9 +69,9 @@ The clients will provide their certificates to the server and the server will ch
 You need the same files mentioned in the first example for this, as well as a key pair for the client (`client.crt`, `client.key`) signed by the same certificate authority.
 
 ```sh
-$ etcd -name infra0 -data-dir infra0 \
-  -client-cert-auth -trusted-ca-file=/path/to/ca.crt -cert-file=/path/to/server.crt -key-file=/path/to/server.key \
-  -advertise-client-urls https://127.0.0.1:2379 -listen-client-urls https://127.0.0.1:2379
+$ etcd --name infra0 --data-dir infra0 \
+  --client-cert-auth --trusted-ca-file=/path/to/ca.crt --cert-file=/path/to/server.crt --key-file=/path/to/server.key \
+  --advertise-client-urls https://127.0.0.1:2379 --listen-client-urls https://127.0.0.1:2379
 ```
 
 Now try the same request as above to this server:
@@ -129,16 +129,16 @@ Assuming we have our `ca.crt` and two members with their own keypairs (`member1.
 DISCOVERY_URL=... # from https://discovery.etcd.io/new
 
 # member1
-$ etcd -name infra1 -data-dir infra1 \
-  -peer-client-cert-auth -peer-trusted-ca-file=/path/to/ca.crt -peer-cert-file=/path/to/member1.crt -peer-key-file=/path/to/member1.key \
-  -initial-advertise-peer-urls=https://10.0.1.10:2380 -listen-peer-urls=https://10.0.1.10:2380 \
-  -discovery ${DISCOVERY_URL}
+$ etcd --name infra1 --data-dir infra1 \
+  --peer-client-cert-auth --peer-trusted-ca-file=/path/to/ca.crt --peer-cert-file=/path/to/member1.crt --peer-key-file=/path/to/member1.key \
+  --initial-advertise-peer-urls=https://10.0.1.10:2380 --listen-peer-urls=https://10.0.1.10:2380 \
+  --discovery ${DISCOVERY_URL}
 
 # member2
-$ etcd -name infra2 -data-dir infra2 \
-  -peer-client-cert-auth -peer-trusted-ca-file=/path/to/ca.crt -peer-cert-file=/path/to/member2.crt -peer-key-file=/path/to/member2.key \
-  -initial-advertise-peer-urls=https://10.0.1.11:2380 -listen-peer-urls=https://10.0.1.11:2380 \
-  -discovery ${DISCOVERY_URL}
+$ etcd --name infra2 --data-dir infra2 \
+  --peer-client-cert-auth --peer-trusted-ca-file=/path/to/ca.crt --peer-cert-file=/path/to/member2.crt --peer-key-file=/path/to/member2.key \
+  --initial-advertise-peer-urls=https://10.0.1.11:2380 --listen-peer-urls=https://10.0.1.11:2380 \
+  --discovery ${DISCOVERY_URL}
 ```
 
 The etcd members will form a cluster and all communication between members in the cluster will be encrypted and authenticated using the client certificates. You will see in the output of etcd that the addresses it connects to use HTTPS.

Documentation/tuning.md

@@ -41,7 +41,7 @@ You can override the default values on the command line:
 
 ```sh
 # Command line arguments:
-$ etcd -heartbeat-interval=100 -election-timeout=500
+$ etcd --heartbeat-interval=100 --election-timeout=500
 
 # Environment variables:
 $ ETCD_HEARTBEAT_INTERVAL=100 ETCD_ELECTION_TIMEOUT=500 etcd
@@ -66,7 +66,7 @@ If etcd's memory usage and disk usage are too high, you can lower the snapshot t
 
 ```sh
 # Command line arguments:
-$ etcd -snapshot-count=5000
+$ etcd --snapshot-count=5000
 
 # Environment variables:
 $ ETCD_SNAPSHOT_COUNT=5000 etcd

etcdctl/command/user_commands.go

@@ -181,7 +181,7 @@ func actionUserRevoke(c *cli.Context) {
 func userGrantRevoke(c *cli.Context, grant bool) {
 	roles := c.StringSlice("roles")
 	if len(roles) == 0 {
-		fmt.Fprintln(os.Stderr, "No roles specified; please use `-roles`")
+		fmt.Fprintln(os.Stderr, "No roles specified; please use `--roles`")
 		os.Exit(1)
 	}
 

etcdmain/config.go

@@ -69,7 +69,7 @@ var (
 
 	ErrConflictBootstrapFlags = fmt.Errorf("multiple discovery or bootstrap flags are set. " +
 		"Choose one of \"initial-cluster\", \"discovery\" or \"discovery-srv\"")
-	errUnsetAdvertiseClientURLsFlag = fmt.Errorf("-advertise-client-urls is required when -listen-client-urls is set explicitly")
+	errUnsetAdvertiseClientURLsFlag = fmt.Errorf("-advertise-client-urls is required when --listen-client-urls is set explicitly")
 )
 
 type config struct {
@@ -228,12 +228,12 @@ func NewConfig() *config {
 	fs.IntVar(&cfg.autoCompactionRetention, "experimental-auto-compaction-retention", 0, "Auto compaction retention in hour. 0 means disable auto compaction.")
 
 	// backwards-compatibility with v0.4.6
-	fs.Var(&flags.IPAddressPort{}, "addr", "DEPRECATED: Use -advertise-client-urls instead.")
-	fs.Var(&flags.IPAddressPort{}, "bind-addr", "DEPRECATED: Use -listen-client-urls instead.")
-	fs.Var(&flags.IPAddressPort{}, "peer-addr", "DEPRECATED: Use -initial-advertise-peer-urls instead.")
-	fs.Var(&flags.IPAddressPort{}, "peer-bind-addr", "DEPRECATED: Use -listen-peer-urls instead.")
-	fs.Var(&flags.DeprecatedFlag{Name: "peers"}, "peers", "DEPRECATED: Use -initial-cluster instead.")
-	fs.Var(&flags.DeprecatedFlag{Name: "peers-file"}, "peers-file", "DEPRECATED: Use -initial-cluster instead.")
+	fs.Var(&flags.IPAddressPort{}, "addr", "DEPRECATED: Use --advertise-client-urls instead.")
+	fs.Var(&flags.IPAddressPort{}, "bind-addr", "DEPRECATED: Use --listen-client-urls instead.")
+	fs.Var(&flags.IPAddressPort{}, "peer-addr", "DEPRECATED: Use --initial-advertise-peer-urls instead.")
+	fs.Var(&flags.IPAddressPort{}, "peer-bind-addr", "DEPRECATED: Use --listen-peer-urls instead.")
+	fs.Var(&flags.DeprecatedFlag{Name: "peers"}, "peers", "DEPRECATED: Use --initial-cluster instead.")
+	fs.Var(&flags.DeprecatedFlag{Name: "peers-file"}, "peers-file", "DEPRECATED: Use --initial-cluster instead.")
 
 	// pprof profiler via HTTP
 	fs.BoolVar(&cfg.enablePprof, "enable-pprof", false, "Enable runtime profiling data via HTTP server. Address is at client URL + \"/debug/pprof\"")
@@ -306,7 +306,7 @@ func (cfg *config) Parse(arguments []string) error {
 		return err
 	}
 
-	// when etcd runs in member mode user needs to set -advertise-client-urls if -listen-client-urls is set.
+	// when etcd runs in member mode user needs to set --advertise-client-urls if --listen-client-urls is set.
 	// TODO(yichengq): check this for joining through discovery service case
 	mayFallbackToProxy := flags.IsSet(cfg.FlagSet, "discovery") && cfg.fallback.String() == fallbackFlagProxy
 	mayBeProxy := cfg.proxy.String() != proxyFlagOff || mayFallbackToProxy
@@ -317,10 +317,10 @@ func (cfg *config) Parse(arguments []string) error {
 	}
 
 	if 5*cfg.TickMs > cfg.ElectionMs {
-		return fmt.Errorf("-election-timeout[%vms] should be at least as 5 times as -heartbeat-interval[%vms]", cfg.ElectionMs, cfg.TickMs)
+		return fmt.Errorf("--election-timeout[%vms] should be at least as 5 times as --heartbeat-interval[%vms]", cfg.ElectionMs, cfg.TickMs)
 	}
 	if cfg.ElectionMs > maxElectionMs {
-		return fmt.Errorf("-election-timeout[%vms] is too long, and should be set less than %vms", cfg.ElectionMs, maxElectionMs)
+		return fmt.Errorf("--election-timeout[%vms] is too long, and should be set less than %vms", cfg.ElectionMs, maxElectionMs)
 	}
 
 	return nil