docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #585 from ehazlett/command-docs 

add better docs to command help
This commit is contained in:
Ben Firshman 2015-02-24 10:48:39 +00:00
parent 5a5e8692fe cf1328ffb1
commit d80a28c675
1 changed files with 48 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
commands.go
View File

@ -171,9 +171,10 @@ var Commands = []cli.Command{
Action: cmdCreate, Action: cmdCreate,
}, },
{ {
Name: "config", Name: "config",
Usage: "Print the connection config for machine", Usage: "Print the connection config for machine",
Action: cmdConfig, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdConfig,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
Name: "swarm", Name: "swarm",
@ -182,19 +183,22 @@ var Commands = []cli.Command{
}, },
}, },
{ {
Name: "inspect", Name: "inspect",
Usage: "Inspect information about a machine", Usage: "Inspect information about a machine",
Action: cmdInspect, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdInspect,
}, },
{ {
Name: "ip", Name: "ip",
Usage: "Get the IP address of a machine", Usage: "Get the IP address of a machine",
Action: cmdIp, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdIp,
}, },
{ {
Name: "kill", Name: "kill",
Usage: "Kill a machine", Usage: "Kill a machine",
Action: cmdKill, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdKill,
}, },
{ {
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -208,9 +212,10 @@ var Commands = []cli.Command{
Action: cmdLs, Action: cmdLs,
}, },
{ {
Name: "restart", Name: "restart",
Usage: "Restart a machine", Usage: "Restart a machine",
Action: cmdRestart, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdRestart,
}, },
{ {
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -219,14 +224,16 @@ var Commands = []cli.Command{
Usage: "Remove local configuration even if machine cannot be removed", Usage: "Remove local configuration even if machine cannot be removed",
}, },
}, },
Name: "rm", Name: "rm",
Usage: "Remove a machine", Usage: "Remove a machine",
Action: cmdRm, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdRm,
}, },
{ {
Name: "env", Name: "env",
Usage: "Display the commands to set up the environment for the Docker client", Usage: "Display the commands to set up the environment for the Docker client",
Action: cmdEnv, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdEnv,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
Name: "swarm", Name: "swarm",
@ -239,29 +246,34 @@ var Commands = []cli.Command{
}, },
}, },
{ {
Name: "ssh", Name: "ssh",
Usage: "Log into or run a command on a machine with SSH", Usage: "Log into or run a command on a machine with SSH",
Action: cmdSsh, Description: "Arguments are [machine-name] command - Will use the active machine if none is provided.",
Action: cmdSsh,
}, },
{ {
Name: "start", Name: "start",
Usage: "Start a machine", Usage: "Start a machine",
Action: cmdStart, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdStart,
}, },
{ {
Name: "stop", Name: "stop",
Usage: "Stop a machine", Usage: "Stop a machine",
Action: cmdStop, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdStop,
}, },
{ {
Name: "upgrade", Name: "upgrade",
Usage: "Upgrade a machine to the latest version of Docker", Usage: "Upgrade a machine to the latest version of Docker",
Action: cmdUpgrade, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdUpgrade,
}, },
{ {
Name: "url", Name: "url",
Usage: "Get the URL of a machine", Usage: "Get the URL of a machine",
Action: cmdUrl, Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdUrl,
}, },
} }