update command line references

Signed-off-by: Hakan Ozler <hakan.ozler@kodcu.com>
This commit is contained in:
Hakan Ozler 2016-02-20 18:53:33 +02:00
parent 7cc7fbadcc
commit d7e97d0443
9 changed files with 82 additions and 8 deletions

View File

@ -10,7 +10,19 @@ parent="smn_machine_subcmds"
# config
Show the Docker client configuration for a machine.
Usage: docker-machine config [OPTIONS] [arg...]
Print the connection config for machine
Description:
Argument is a machine name.
Options:
--swarm Display the Swarm config instead of the Docker daemon
For example:
$ docker-machine config dev
--tlsverify

View File

@ -10,8 +10,22 @@ parent="smn_machine_subcmds"
# help
Usage: docker-machine help [arg...]
Shows a list of commands or help for one command
Usage: docker-machine help _subcommand_
Show help text, for example:
For example:
$ docker-machine help config
Usage: docker-machine config [OPTIONS] [arg...]
Print the connection config for machine
Description:
Argument is a machine name.
Options:
--swarm Display the Swarm config instead of the Docker daemon

View File

@ -11,7 +11,14 @@ parent="smn_machine_subcmds"
# kill
Kill (abruptly force stop) a machine.
Usage: docker-machine kill [arg...]
Kill (abruptly force stop) a machine
Description:
Argument(s) are one or more machine names.
For example:
$ docker-machine ls
NAME ACTIVE DRIVER STATE URL

View File

@ -18,7 +18,7 @@ parent="smn_machine_subcmds"
--quiet, -q Enable quiet mode
--filter [--filter option --filter option] Filter output based on conditions provided
--timeout, -t Timeout in seconds, default to 10s
--timeout, -t "10" Timeout in seconds, default to 10s
--format, -f Pretty-print machines using a Go template
## Timeout
@ -102,7 +102,7 @@ for all running machines:
To list all machine names with their driver in a table format you can use:
$ docker-machine ls --format "table {{.Name}}: {{.DriverName}}"
$ docker-machine ls --format "table {{.Name}} {{.DriverName}}"
NAME DRIVER
default virtualbox
ec2 amazonec2

View File

@ -10,8 +10,21 @@ parent="smn_machine_subcmds"
# regenerate-certs
Usage: docker-machine regenerate-certs [OPTIONS] [arg...]
Regenerate TLS Certificates for a machine
Description:
Argument(s) are one or more machine names.
Options:
--force, -f Force rebuild and do not prompt
Regenerate TLS certificates and update the machine with new certs.
For example:
$ docker-machine regenerate-certs dev
Regenerate TLS machine certs? Warning: this is irreversible. (y/n): y
Regenerating TLS certificates

View File

@ -11,6 +11,13 @@ parent="smn_machine_subcmds"
# restart
Usage: docker-machine restart [arg...]
Restart a machine
Description:
Argument(s) are one or more machine names.
Restart a machine. Oftentimes this is equivalent to
`docker-machine stop; docker-machine start`. But some cloud driver try to implement a clever restart which keeps the same
ip address.

View File

@ -11,7 +11,14 @@ parent="smn_machine_subcmds"
# start
Start a machine.
Usage: docker-machine start [arg...]
Start a machine
Description:
Argument(s) are one or more machine names.
For example:
$ docker-machine start dev
Starting VM...

View File

@ -10,7 +10,14 @@ parent="smn_machine_subcmds"
# status
Get the status of a machine.
Usage: docker-machine status [arg...]
Get the status of a machine
Description:
Argument is a machine name.
For example:
$ docker-machine status dev
Running

View File

@ -11,7 +11,14 @@ parent="smn_machine_subcmds"
# stop
Gracefully stop a machine.
Usage: docker-machine stop [arg...]
Gracefully Stop a machine
Description:
Argument(s) are one or more machine names.
For example:
$ docker-machine ls
NAME ACTIVE DRIVER STATE URL