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

12
commands.go
View File

@ -173,6 +173,7 @@ var Commands = []cli.Command{
{ {
Name: "config", Name: "config",
Usage: "Print the connection config for machine", Usage: "Print the connection config for machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdConfig, Action: cmdConfig,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
@ -184,16 +185,19 @@ var Commands = []cli.Command{
{ {
Name: "inspect", Name: "inspect",
Usage: "Inspect information about a machine", Usage: "Inspect information about a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdInspect, Action: cmdInspect,
}, },
{ {
Name: "ip", Name: "ip",
Usage: "Get the IP address of a machine", Usage: "Get the IP address of a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdIp, Action: cmdIp,
}, },
{ {
Name: "kill", Name: "kill",
Usage: "Kill a machine", Usage: "Kill a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdKill, Action: cmdKill,
}, },
{ {
@ -210,6 +214,7 @@ var Commands = []cli.Command{
{ {
Name: "restart", Name: "restart",
Usage: "Restart a machine", Usage: "Restart a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdRestart, Action: cmdRestart,
}, },
{ {
@ -221,11 +226,13 @@ var Commands = []cli.Command{
}, },
Name: "rm", Name: "rm",
Usage: "Remove a machine", Usage: "Remove a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdRm, 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",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdEnv, Action: cmdEnv,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
@ -241,26 +248,31 @@ 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",
Description: "Arguments are [machine-name] command - Will use the active machine if none is provided.",
Action: cmdSsh, Action: cmdSsh,
}, },
{ {
Name: "start", Name: "start",
Usage: "Start a machine", Usage: "Start a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdStart, Action: cmdStart,
}, },
{ {
Name: "stop", Name: "stop",
Usage: "Stop a machine", Usage: "Stop a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdStop, 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",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdUpgrade, Action: cmdUpgrade,
}, },
{ {
Name: "url", Name: "url",
Usage: "Get the URL of a machine", Usage: "Get the URL of a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdUrl, Action: cmdUrl,
}, },
} }