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

move extended help to command descriptions 

Signed-off-by: Evan Hazlett <ejhazlett@gmail.com>
This commit is contained in:
Evan Hazlett 2015-02-23 11:45:14 -05:00
parent b71aad0501
commit cf1328ffb1
No known key found for this signature in database
GPG Key ID: A519480096146526
1 changed files with 48 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
commands.go
View File

@ -172,7 +172,8 @@ var Commands = []cli.Command{
},
{
Name: "config",
Usage: "Print the connection config for machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Print the connection config for machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdConfig,
Flags: []cli.Flag{
cli.BoolFlag{
@ -183,17 +184,20 @@ var Commands = []cli.Command{
},
{
Name: "inspect",
Usage: "Inspect information about a machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Inspect information about a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdInspect,
},
{
Name: "ip",
Usage: "Get the IP address of a machine. Argument is a machine name. Will use the active machine if none is provided.",
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,
},
{
Name: "kill",
Usage: "Kill a machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Kill a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdKill,
},
{
@ -209,7 +213,8 @@ var Commands = []cli.Command{
},
{
Name: "restart",
Usage: "Restart a machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Restart a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdRestart,
},
{
@ -220,12 +225,14 @@ var Commands = []cli.Command{
},
},
Name: "rm",
Usage: "Remove a machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Remove a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdRm,
},
{
Name: "env",
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,
Flags: []cli.Flag{
cli.BoolFlag{
@ -236,27 +243,32 @@ var Commands = []cli.Command{
},
{
Name: "ssh",
Usage: "Log into or run a command on a machine with SSH. Arguments are [machine-name] command. Will use the active machine if none is provided.",
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,
},
{
Name: "start",
Usage: "Start a machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Start a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdStart,
},
{
Name: "stop",
Usage: "Stop a machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Stop a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdStop,
},
{
Name: "upgrade",
Usage: "Upgrade a machine to the latest version of Docker. Argument is a machine name. Will use the active machine if none is provided.",
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,
},
{
Name: "url",
Usage: "Get the URL of a machine. Argument is a machine name. Will use the active machine if none is provided.",
Usage: "Get the URL of a machine",
Description: "Argument is a machine name. Will use the active machine if none is provided.",
Action: cmdUrl,
},
}