X Tutup
Skip to content

Commit d7e97d0

Browse files
author
Hakan Ozler
committed
update command line references
Signed-off-by: Hakan Ozler <hakan.ozler@kodcu.com>
1 parent 7cc7fba commit d7e97d0

File tree

9 files changed

+82
-8
lines changed

9 files changed

+82
-8
lines changed

docs/reference/config.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,19 @@ parent="smn_machine_subcmds"
1010

1111
# config
1212

13-
Show the Docker client configuration for a machine.
13+
Usage: docker-machine config [OPTIONS] [arg...]
14+
15+
Print the connection config for machine
16+
17+
Description:
18+
Argument is a machine name.
19+
20+
Options:
21+
22+
--swarm Display the Swarm config instead of the Docker daemon
23+
24+
25+
For example:
1426

1527
$ docker-machine config dev
1628
--tlsverify

docs/reference/help.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,22 @@ parent="smn_machine_subcmds"
1010

1111
# help
1212

13+
Usage: docker-machine help [arg...]
14+
15+
Shows a list of commands or help for one command
16+
1317
Usage: docker-machine help _subcommand_
1418

15-
Show help text, for example:
19+
For example:
1620

1721
$ docker-machine help config
22+
Usage: docker-machine config [OPTIONS] [arg...]
23+
24+
Print the connection config for machine
25+
26+
Description:
27+
Argument is a machine name.
28+
29+
Options:
30+
31+
--swarm Display the Swarm config instead of the Docker daemon

docs/reference/kill.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@ parent="smn_machine_subcmds"
1111

1212
# kill
1313

14-
Kill (abruptly force stop) a machine.
14+
Usage: docker-machine kill [arg...]
15+
16+
Kill (abruptly force stop) a machine
17+
18+
Description:
19+
Argument(s) are one or more machine names.
20+
21+
For example:
1522

1623
$ docker-machine ls
1724
NAME ACTIVE DRIVER STATE URL

docs/reference/ls.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ parent="smn_machine_subcmds"
1818

1919
--quiet, -q Enable quiet mode
2020
--filter [--filter option --filter option] Filter output based on conditions provided
21-
--timeout, -t Timeout in seconds, default to 10s
21+
--timeout, -t "10" Timeout in seconds, default to 10s
2222
--format, -f Pretty-print machines using a Go template
2323

2424
## Timeout
@@ -102,7 +102,7 @@ for all running machines:
102102

103103
To list all machine names with their driver in a table format you can use:
104104

105-
$ docker-machine ls --format "table {{.Name}}: {{.DriverName}}"
105+
$ docker-machine ls --format "table {{.Name}} {{.DriverName}}"
106106
NAME DRIVER
107107
default virtualbox
108108
ec2 amazonec2

docs/reference/regenerate-certs.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,21 @@ parent="smn_machine_subcmds"
1010

1111
# regenerate-certs
1212

13+
Usage: docker-machine regenerate-certs [OPTIONS] [arg...]
14+
15+
Regenerate TLS Certificates for a machine
16+
17+
Description:
18+
Argument(s) are one or more machine names.
19+
20+
Options:
21+
22+
--force, -f Force rebuild and do not prompt
23+
1324
Regenerate TLS certificates and update the machine with new certs.
1425

26+
For example:
27+
1528
$ docker-machine regenerate-certs dev
1629
Regenerate TLS machine certs? Warning: this is irreversible. (y/n): y
1730
Regenerating TLS certificates

docs/reference/restart.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ parent="smn_machine_subcmds"
1111

1212
# restart
1313

14+
Usage: docker-machine restart [arg...]
15+
16+
Restart a machine
17+
18+
Description:
19+
Argument(s) are one or more machine names.
20+
1421
Restart a machine. Oftentimes this is equivalent to
1522
`docker-machine stop; docker-machine start`. But some cloud driver try to implement a clever restart which keeps the same
1623
ip address.

docs/reference/start.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@ parent="smn_machine_subcmds"
1111

1212
# start
1313

14-
Start a machine.
14+
Usage: docker-machine start [arg...]
15+
16+
Start a machine
17+
18+
Description:
19+
Argument(s) are one or more machine names.
20+
21+
For example:
1522

1623
$ docker-machine start dev
1724
Starting VM...

docs/reference/status.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@ parent="smn_machine_subcmds"
1010

1111
# status
1212

13-
Get the status of a machine.
13+
Usage: docker-machine status [arg...]
14+
15+
Get the status of a machine
16+
17+
Description:
18+
Argument is a machine name.
19+
20+
For example:
1421

1522
$ docker-machine status dev
1623
Running

docs/reference/stop.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@ parent="smn_machine_subcmds"
1111

1212
# stop
1313

14-
Gracefully stop a machine.
14+
Usage: docker-machine stop [arg...]
15+
16+
Gracefully Stop a machine
17+
18+
Description:
19+
Argument(s) are one or more machine names.
20+
21+
For example:
1522

1623
$ docker-machine ls
1724
NAME ACTIVE DRIVER STATE URL

0 commit comments

Comments
 (0)
X Tutup