github.com/jpetazzo/etcd@v0.2.1-0.20140113055439-97f1363afac5/server/usage.go (about)

     1  package server
     2  
     3  import (
     4  	"strings"
     5  )
     6  
     7  // usage defines the message shown when a help flag is passed to etcd.
     8  var usage = `
     9  etcd
    10  
    11  Usage:
    12    etcd -name <name>
    13    etcd -name <name> [-data-dir=<path>]
    14    etcd -h | -help
    15    etcd -version
    16  
    17  Options:
    18    -h -help          Show this screen.
    19    --version         Show version.
    20    -f -force         Force a new configuration to be used.
    21    -config=<path>    Path to configuration file.
    22    -name=<name>      Name of this node in the etcd cluster.
    23    -data-dir=<path>  Path to the data directory.
    24    -cors=<origins>   Comma-separated list of CORS origins.
    25    -v                Enabled verbose logging.
    26    -vv               Enabled very verbose logging.
    27  
    28  Cluster Configuration Options:
    29    -peers-file=<path>              Path to a file containing the peer list.
    30    -peers=<host:port>,<host:port>  Comma-separated list of peers. The members
    31                                    should match the peer's '-peer-addr' flag.
    32  
    33  Client Communication Options:
    34    -addr=<host:port>         The public host:port used for client communication.
    35    -bind-addr=<host[:port]>  The listening host:port used for client communication.
    36    -ca-file=<path>           Path to the client CA file.
    37    -cert-file=<path>         Path to the client cert file.
    38    -key-file=<path>          Path to the client key file.
    39  
    40  Peer Communication Options:
    41    -peer-addr=<host:port>  The public host:port used for peer communication.
    42    -peer-bind-addr=<host[:port]>  The listening host:port used for peer communication.
    43    -peer-ca-file=<path>    Path to the peer CA file.
    44    -peer-cert-file=<path>  Path to the peer cert file.
    45    -peer-key-file=<path>   Path to the peer key file.
    46    -peer-heartbeat-timeout=<time>
    47                            Time (in milliseconds) for a heartbeat to timeout.
    48    -peer-election-timeout=<time>
    49                            Time (in milliseconds) for an election to timeout.
    50  
    51  Other Options:
    52    -max-result-buffer   Max size of the result buffer.
    53    -max-retry-attempts  Number of times a node will try to join a cluster.
    54    -max-cluster-size    Maximum number of nodes in the cluster.
    55    -snapshot            Open or close the snapshot.
    56    -snapshot-count      Number of transactions before issuing a snapshot.
    57  `
    58  
    59  // Usage returns the usage message for etcd.
    60  func Usage() string {
    61  	return strings.TrimSpace(usage)
    62  }