From 14e8898648909379f37049828e103ba1c97f253b Mon Sep 17 00:00:00 2001 From: Antonio Murdaca Date: Sat, 3 Oct 2015 17:56:41 +0200 Subject: [PATCH] Fix man and commandline docs - missing help option in `docs/reference/commandline/*.md` (some files have it, the other I fixed didn't) - missing `[OPTIONS]` in Usage description - missing options - formatting - start/stop idempotence Signed-off-by: Antonio Murdaca --- api/client/start.go | 4 +- api/client/stop.go | 4 +- contrib/completion/fish/docker.fish | 4 +- docker/flags.go | 4 +- docs/reference/commandline/attach.md | 1 + docs/reference/commandline/build.md | 34 +++++++++-------- docs/reference/commandline/commit.md | 1 + docs/reference/commandline/cp.md | 8 ++-- docs/reference/commandline/create.md | 5 ++- docs/reference/commandline/diff.md | 4 +- docs/reference/commandline/events.md | 1 + docs/reference/commandline/exec.md | 1 + docs/reference/commandline/export.md | 24 ++++++------ docs/reference/commandline/history.md | 1 + docs/reference/commandline/import.md | 1 + docs/reference/commandline/info.md | 4 +- docs/reference/commandline/inspect.md | 8 ++-- docs/reference/commandline/kill.md | 1 + docs/reference/commandline/load.md | 1 + docs/reference/commandline/login.md | 1 + docs/reference/commandline/logout.md | 2 + docs/reference/commandline/logs.md | 1 + docs/reference/commandline/pause.md | 4 +- docs/reference/commandline/port.md | 4 +- docs/reference/commandline/ps.md | 3 +- docs/reference/commandline/pull.md | 1 + docs/reference/commandline/push.md | 5 ++- docs/reference/commandline/rename.md | 6 ++- docs/reference/commandline/restart.md | 1 + docs/reference/commandline/rm.md | 1 + docs/reference/commandline/rmi.md | 2 +- docs/reference/commandline/run.md | 6 +-- docs/reference/commandline/save.md | 1 + docs/reference/commandline/search.md | 1 + docs/reference/commandline/start.md | 3 +- docs/reference/commandline/stats.md | 2 +- docs/reference/commandline/stop.md | 5 ++- docs/reference/commandline/tag.md | 1 + docs/reference/commandline/top.md | 6 ++- docs/reference/commandline/unpause.md | 4 +- docs/reference/commandline/version.md | 1 + docs/reference/commandline/volume_create.md | 10 ++--- docs/reference/commandline/volume_inspect.md | 4 +- docs/reference/commandline/volume_ls.md | 6 +-- docs/reference/commandline/volume_rm.md | 2 +- docs/reference/commandline/wait.md | 6 ++- man/docker-build.1.md | 11 +++--- man/docker-commit.1.md | 2 +- man/docker-daemon.8.md | 5 +-- man/docker-ps.1.md | 39 ++++++++++---------- man/docker-start.1.md | 6 +-- man/docker-stop.1.md | 4 +- man/docker.1.md | 4 +- 53 files changed, 154 insertions(+), 117 deletions(-) diff --git a/api/client/start.go b/api/client/start.go index e039df022..a7e624c4c 100644 --- a/api/client/start.go +++ b/api/client/start.go @@ -41,11 +41,11 @@ func (cli *DockerCli) forwardAllSignals(cid string) chan os.Signal { return sigc } -// CmdStart starts one or more stopped containers. +// CmdStart starts one or more containers. // // Usage: docker start [OPTIONS] CONTAINER [CONTAINER...] func (cli *DockerCli) CmdStart(args ...string) error { - cmd := Cli.Subcmd("start", []string{"CONTAINER [CONTAINER...]"}, "Start one or more stopped containers", true) + cmd := Cli.Subcmd("start", []string{"CONTAINER [CONTAINER...]"}, "Start one or more containers", true) attach := cmd.Bool([]string{"a", "-attach"}, false, "Attach STDOUT/STDERR and forward signals") openStdin := cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's STDIN") cmd.Require(flag.Min, 1) diff --git a/api/client/stop.go b/api/client/stop.go index b7348a7bb..e195d4a15 100644 --- a/api/client/stop.go +++ b/api/client/stop.go @@ -9,13 +9,13 @@ import ( flag "github.com/docker/docker/pkg/mflag" ) -// CmdStop stops one or more running containers. +// CmdStop stops one or more containers. // // A running container is stopped by first sending SIGTERM and then SIGKILL if the container fails to stop within a grace period (the default is 10 seconds). // // Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...] func (cli *DockerCli) CmdStop(args ...string) error { - cmd := Cli.Subcmd("stop", []string{"CONTAINER [CONTAINER...]"}, "Stop a running container by sending SIGTERM and then SIGKILL after a\ngrace period", true) + cmd := Cli.Subcmd("stop", []string{"CONTAINER [CONTAINER...]"}, "Stop a container by sending SIGTERM and then SIGKILL after a\ngrace period", true) nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Seconds to wait for stop before killing it") cmd.Require(flag.Min, 1) diff --git a/contrib/completion/fish/docker.fish b/contrib/completion/fish/docker.fish index cedd51a21..17d2a06d7 100644 --- a/contrib/completion/fish/docker.fish +++ b/contrib/completion/fish/docker.fish @@ -360,7 +360,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from search' -l no-trunc -d complete -c docker -A -f -n '__fish_seen_subcommand_from search' -s s -l stars -d 'Only displays with at least x stars' # start -complete -c docker -f -n '__fish_docker_no_subcommand' -a start -d 'Start a stopped container' +complete -c docker -f -n '__fish_docker_no_subcommand' -a start -d 'Start a container' complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s a -l attach -d "Attach container's STDOUT and STDERR and forward all signals to the process" complete -c docker -A -f -n '__fish_seen_subcommand_from start' -l help -d 'Print usage' complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s i -l interactive -d "Attach container's STDIN" @@ -373,7 +373,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from stats' -l no-stream -d complete -c docker -A -f -n '__fish_seen_subcommand_from stats' -a '(__fish_print_docker_containers running)' -d "Container" # stop -complete -c docker -f -n '__fish_docker_no_subcommand' -a stop -d 'Stop a running container' +complete -c docker -f -n '__fish_docker_no_subcommand' -a stop -d 'Stop a container' complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -l help -d 'Print usage' complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -s t -l time -d 'Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.' complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -a '(__fish_print_docker_containers running)' -d "Container" diff --git a/docker/flags.go b/docker/flags.go index edd362354..de517ddc7 100644 --- a/docker/flags.go +++ b/docker/flags.go @@ -52,9 +52,9 @@ var dockerCommands = []command{ {"run", "Run a command in a new container"}, {"save", "Save an image(s) to a tar archive"}, {"search", "Search the Docker Hub for images"}, - {"start", "Start one or more stopped containers"}, + {"start", "Start one or more containers"}, {"stats", "Display a live stream of container(s) resource usage statistics"}, - {"stop", "Stop a running container"}, + {"stop", "Stop a container"}, {"tag", "Tag an image into a repository"}, {"top", "Display the running processes of a container"}, {"unpause", "Unpause all processes within a container"}, diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/attach.md index 89cc3f25d..1afce11a2 100644 --- a/docs/reference/commandline/attach.md +++ b/docs/reference/commandline/attach.md @@ -15,6 +15,7 @@ weight=1 Attach to a running container + --help=false Print usage --no-stdin=false Do not attach STDIN --sig-proxy=true Proxy all received signals to the process diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index 8cb6b1310..c608c97c5 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -15,21 +15,25 @@ weight=1 Build a new image from the source code at PATH - -f, --file="" Name of the Dockerfile (Default is 'PATH/Dockerfile') - --force-rm=false Always remove intermediate containers - --build-arg=[] Set build-time variables - --no-cache=false Do not use cache when building the image - --pull=false Always attempt to pull a newer version of the image - -q, --quiet=false Suppress the verbose output generated by the containers - --rm=true Remove intermediate containers after a successful build - -t, --tag="" Repository name (and optionally a tag) for the image - -m, --memory="" Memory limit for all build containers - --memory-swap="" Total memory (memory + swap), `-1` to disable swap - -c, --cpu-shares CPU Shares (relative weight) - --cpuset-mems="" MEMs in which to allow execution, e.g. `0-3`, `0,1` - --cpuset-cpus="" CPUs in which to allow execution, e.g. `0-3`, `0,1` - --cgroup-parent="" Optional parent cgroup for the container - --ulimit=[] Ulimit options + --build-arg=[] Set build-time variables + -c, --cpu-shares CPU Shares (relative weight) + --cgroup-parent="" Optional parent cgroup for the container + --cpu-period=0 Limit the CPU CFS (Completely Fair Scheduler) period + --cpu-quota=0 Limit the CPU CFS (Completely Fair Scheduler) quota + --cpuset-cpus="" CPUs in which to allow execution, e.g. `0-3`, `0,1` + --cpuset-mems="" MEMs in which to allow execution, e.g. `0-3`, `0,1` + --disable-content-trust=true Skip image verification + -f, --file="" Name of the Dockerfile (Default is 'PATH/Dockerfile') + --force-rm=false Always remove intermediate containers + --help=false Print usage + -m, --memory="" Memory limit for all build containers + --memory-swap="" Total memory (memory + swap), `-1` to disable swap + --no-cache=false Do not use cache when building the image + --pull=false Always attempt to pull a newer version of the image + -q, --quiet=false Suppress the verbose output generated by the containers + --rm=true Remove intermediate containers after a successful build + -t, --tag="" Repository name (and optionally a tag) for the image + --ulimit=[] Ulimit options Builds Docker images from a Dockerfile and a "context". A build's context is the files located in the specified `PATH` or `URL`. The build process can refer diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/commit.md index cec7de672..dafdb396b 100644 --- a/docs/reference/commandline/commit.md +++ b/docs/reference/commandline/commit.md @@ -17,6 +17,7 @@ weight=1 -a, --author="" Author (e.g., "John Hannibal Smith ") -c, --change=[] Apply specified Dockerfile instructions while committing the image + --help=false Print usage -m, --message="" Commit message -p, --pause=true Pause container during commit diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/cp.md index c9c87a30e..1fd43dfa0 100644 --- a/docs/reference/commandline/cp.md +++ b/docs/reference/commandline/cp.md @@ -11,12 +11,12 @@ weight=1 # cp -Copy files/folders between a container and the local filesystem. + Usage: docker cp [OPTIONS] CONTAINER:PATH LOCALPATH|- + docker cp [OPTIONS] LOCALPATH|- CONTAINER:PATH - Usage: docker cp [options] CONTAINER:PATH LOCALPATH|- - docker cp [options] LOCALPATH|- CONTAINER:PATH + Copy files/folders between a container and the local filesystem - --help Print usage statement + --help=false Print usage In the first synopsis form, the `docker cp` utility copies the contents of `PATH` from the filesystem of `CONTAINER` to the `LOCALPATH` (or stream as diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index 34ae6dfef..1af6bc9d6 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -30,6 +30,7 @@ Creates a new container. --cpuset-cpus="" CPUs in which to allow execution (0-3, 0,1) --cpuset-mems="" Memory nodes (MEMs) in which to allow execution (0-3, 0,1) --device=[] Add a host device to the container + --disable-content-trust=true Skip image verification --dns=[] Set custom DNS servers --dns-opt=[] Set custom DNS options --dns-search=[] Set custom DNS search domains @@ -37,6 +38,7 @@ Creates a new container. --entrypoint="" Overwrite the default ENTRYPOINT of the image --env-file=[] Read in a file of environment variables --expose=[] Expose a port or a range of ports + --group-add=[] Add additional groups to join -h, --hostname="" Container host name --help=false Print usage -i, --interactive=false Keep STDIN open even if not attached @@ -54,7 +56,7 @@ Creates a new container. --memory-swap="" Total memory (memory + swap), '-1' to disable swap --memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. --name="" Assign a name to the container - --net="bridge" Set the Network mode for the container + --net="default" Set the Network mode for the container --oom-kill-disable=false Whether to disable OOM Killer for the container or not -P, --publish-all=false Publish all exposed ports to random ports -p, --publish=[] Publish a container's port(s) to the host @@ -65,7 +67,6 @@ Creates a new container. --security-opt=[] Security options --stop-signal="SIGTERM" Signal to stop a container -t, --tty=false Allocate a pseudo-TTY - --disable-content-trust=true Skip image verification -u, --user="" Username or UID --ulimit=[] Ulimit options --uts="" UTS namespace to use diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/diff.md index ae5da0587..64140ccbb 100644 --- a/docs/reference/commandline/diff.md +++ b/docs/reference/commandline/diff.md @@ -11,10 +11,12 @@ weight=1 # diff - Usage: docker diff CONTAINER + Usage: docker diff [OPTIONS] CONTAINER Inspect changes on a container's filesystem + --help=false Print usage + List the changed files and directories in a container᾿s filesystem There are 3 events that are listed in the `diff`: diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index f71462130..8dea27018 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -16,6 +16,7 @@ weight=1 Get real time events from the server -f, --filter=[] Filter output based on conditions provided + --help=false Print usage --since="" Show all events created since timestamp --until="" Stream events until this timestamp diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md index 2ff120560..76a491d79 100644 --- a/docs/reference/commandline/exec.md +++ b/docs/reference/commandline/exec.md @@ -16,6 +16,7 @@ weight=1 Run a command in a running container -d, --detach=false Detached mode: run command in the background + --help=false Print usage -i, --interactive=false Keep STDIN open even if not attached --privileged=false Give extended Linux capabilities to the command -t, --tty=false Allocate a pseudo-TTY diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/export.md index 5b1812cb7..ab7855b95 100644 --- a/docs/reference/commandline/export.md +++ b/docs/reference/commandline/export.md @@ -12,22 +12,12 @@ weight=1 # export Usage: docker export [OPTIONS] CONTAINER - - Export the contents of a filesystem to a tar archive (streamed to STDOUT by default). + Export the contents of a container's filesystem as a tar archive + + --help=false Print usage -o, --output="" Write to a file, instead of STDOUT - Produces a tarred repository to the standard output stream. - - - For example: - - $ docker export red_panda > latest.tar - - Or - - $ docker export --output="latest.tar" red_panda - The `docker export` command does not export the contents of volumes associated with the container. If a volume is mounted on top of an existing directory in the container, `docker export` will export the contents of the *underlying* @@ -36,3 +26,11 @@ directory, not the contents of the volume. Refer to [Backup, restore, or migrate data volumes](/userguide/dockervolumes/#backup-restore-or-migrate-data-volumes) in the user guide for examples on exporting data in a volume. + +## Examples + + $ docker export red_panda > latest.tar + +Or + + $ docker export --output="latest.tar" red_panda diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md index a67587ec7..2d8aa5ac9 100644 --- a/docs/reference/commandline/history.md +++ b/docs/reference/commandline/history.md @@ -16,6 +16,7 @@ weight=1 Show the history of an image -H, --human=true Print sizes and dates in human readable format + --help=false Print usage --no-trunc=false Don't truncate output -q, --quiet=false Only show numeric IDs diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/import.md index 92bf878a1..b673aaf64 100644 --- a/docs/reference/commandline/import.md +++ b/docs/reference/commandline/import.md @@ -18,6 +18,7 @@ weight=1 optionally tag it. -c, --change=[] Apply specified Dockerfile instructions while importing the image + --help=false Print usage -m, --message= Set commit message for imported image You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/info.md index 129c2ee6d..0ff60771e 100644 --- a/docs/reference/commandline/info.md +++ b/docs/reference/commandline/info.md @@ -12,10 +12,12 @@ weight=1 # info - Usage: docker info + Usage: docker info [OPTIONS] Display system-wide information + --help=false Print usage + For example: $ docker -D info diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index c6c4721c6..e82f969ad 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -15,10 +15,10 @@ weight=1 Return low-level information on a container or image - -f, --format="" Format the output using the given go template - - --type=container|image Return JSON for specified type, permissible - values are "image" or "container" + -f, --format="" Format the output using the given go template + --help=false Print usage + --type=container|image Return JSON for specified type, permissible + values are "image" or "container" By default, this will render all results in a JSON array. If a format is specified, the given template will be executed for each result. diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/kill.md index 798b9cc9e..d54b9d820 100644 --- a/docs/reference/commandline/kill.md +++ b/docs/reference/commandline/kill.md @@ -15,6 +15,7 @@ weight=1 Kill a running container using SIGKILL or a specified signal + --help=false Print usage -s, --signal="KILL" Signal to send to the container The main process inside the container will be sent `SIGKILL`, or any diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md index d4154cd5f..858257977 100644 --- a/docs/reference/commandline/load.md +++ b/docs/reference/commandline/load.md @@ -15,6 +15,7 @@ weight=1 Load an image from a tar archive or STDIN + --help=false Print usage -i, --input="" Read from a tar archive file, instead of STDIN. The tarball may be compressed with gzip, bzip, or xz Loads a tarred repository from a file or the standard input stream. diff --git a/docs/reference/commandline/login.md b/docs/reference/commandline/login.md index 5c2934a92..ff82affa4 100644 --- a/docs/reference/commandline/login.md +++ b/docs/reference/commandline/login.md @@ -17,6 +17,7 @@ weight=1 specified "https://index.docker.io/v1/" is the default. -e, --email="" Email + --help=false Print usage -p, --password="" Password -u, --username="" Username diff --git a/docs/reference/commandline/logout.md b/docs/reference/commandline/logout.md index 3dc902786..e936f05fd 100644 --- a/docs/reference/commandline/logout.md +++ b/docs/reference/commandline/logout.md @@ -16,6 +16,8 @@ weight=1 Log out from a Docker registry, if no server is specified "https://index.docker.io/v1/" is the default. + --help=false Print usage + For example: $ docker logout localhost:8080 diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md index 3b7a96c43..678108c02 100644 --- a/docs/reference/commandline/logs.md +++ b/docs/reference/commandline/logs.md @@ -16,6 +16,7 @@ weight=1 Fetch the logs of a container -f, --follow=false Follow log output + --help=false Print usage --since="" Show logs since timestamp -t, --timestamps=false Show timestamps --tail="all" Number of lines to show from the end of the logs diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/pause.md index 20ee02904..72174e07d 100644 --- a/docs/reference/commandline/pause.md +++ b/docs/reference/commandline/pause.md @@ -11,10 +11,12 @@ weight=1 # pause - Usage: docker pause CONTAINER [CONTAINER...] + Usage: docker pause [OPTIONS] CONTAINER [CONTAINER...] Pause all processes within a container + --help=false Print usage + The `docker pause` command uses the cgroups freezer to suspend all processes in a container. Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/port.md index 0a9a3fe95..a5e850dee 100644 --- a/docs/reference/commandline/port.md +++ b/docs/reference/commandline/port.md @@ -11,11 +11,13 @@ weight=1 # port - Usage: docker port CONTAINER [PRIVATE_PORT[/PROTO]] + Usage: docker port [OPTIONS] CONTAINER [PRIVATE_PORT[/PROTO]] List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT + --help=false Print usage + You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or just a specific mapping: diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md index ddf87411d..4b83268b2 100644 --- a/docs/reference/commandline/ps.md +++ b/docs/reference/commandline/ps.md @@ -18,13 +18,14 @@ weight=1 -a, --all=false Show all containers (default shows just running) --before="" Show only container created before Id or Name -f, --filter=[] Filter output based on conditions provided + --format=[] Pretty-print containers using a Go template + --help=false Print usage -l, --latest=false Show the latest created container, include non-running -n=-1 Show n last created containers, include non-running --no-trunc=false Don't truncate output -q, --quiet=false Only display numeric IDs -s, --size=false Display total file sizes --since="" Show created since Id or Name, include non-running - --format=[] Pretty-print containers using a Go template Running `docker ps --no-trunc` showing 2 linked containers. diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md index 53b0d4cb5..3e1ae495f 100644 --- a/docs/reference/commandline/pull.md +++ b/docs/reference/commandline/pull.md @@ -17,6 +17,7 @@ weight=1 -a, --all-tags=false Download all tagged images in the repository --disable-content-trust=true Skip image verification + --help=false Print usage Most of your images will be created on top of a base image from the [Docker Hub](https://hub.docker.com) registry. diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md index 7f88887dc..0ac05f851 100644 --- a/docs/reference/commandline/push.md +++ b/docs/reference/commandline/push.md @@ -11,11 +11,12 @@ weight=1 # push - Usage: docker push NAME[:TAG] + Usage: docker push [OPTIONS] NAME[:TAG] Push an image or a repository to the registry - --disable-content-trust=true Skip image signing + --disable-content-trust=true Skip image signing + --help=false Print usage Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com) registry or to a self-hosted one. diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/rename.md index 43115ff26..b252739b1 100644 --- a/docs/reference/commandline/rename.md +++ b/docs/reference/commandline/rename.md @@ -11,8 +11,10 @@ weight=1 # rename - Usage: docker rename OLD_NAME NEW_NAME + Usage: docker rename [OPTIONS] OLD_NAME NEW_NAME - rename a existing container to a NEW_NAME + Rename a container + + --help=false Print usage The `docker rename` command allows the container to be renamed to a different name. diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/restart.md index 339f79604..cfce95486 100644 --- a/docs/reference/commandline/restart.md +++ b/docs/reference/commandline/restart.md @@ -15,5 +15,6 @@ weight=1 Restart a container + --help=false Print usage -t, --time=10 Seconds to wait for stop before killing the container diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/rm.md index 3e4f0716e..dc8210728 100644 --- a/docs/reference/commandline/rm.md +++ b/docs/reference/commandline/rm.md @@ -16,6 +16,7 @@ weight=1 Remove one or more containers -f, --force=false Force the removal of a running container (uses SIGKILL) + --help=false Print usage -l, --link=false Remove the specified link -v, --volumes=false Remove the volumes associated with the container diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md index e699be12f..d0475c738 100644 --- a/docs/reference/commandline/rmi.md +++ b/docs/reference/commandline/rmi.md @@ -16,9 +16,9 @@ weight=1 Remove one or more images -f, --force=false Force removal of the image + --help=false Print usage --no-prune=false Do not delete untagged parents - You can remove an image using its short or long ID, its tag, or its digest. If an image has one or more tag or digest reference, you must remove all of them before the image is removed. diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 766ca205d..afb704872 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -29,6 +29,7 @@ weight=1 --cpuset-mems="" Memory nodes (MEMs) in which to allow execution (0-3, 0,1) -d, --detach=false Run container in background and print container ID --device=[] Add a host device to the container + --disable-content-trust=true Skip image verification --dns=[] Set custom DNS servers --dns-opt=[] Set custom DNS options --dns-search=[] Set custom DNS search domains @@ -54,7 +55,7 @@ weight=1 --memory-swap="" Total memory (memory + swap), '-1' to disable swap --memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. --name="" Assign a name to the container - --net="bridge" Set the Network mode for the container + --net="default" Set the Network mode for the container --oom-kill-disable=false Whether to disable OOM Killer for the container or not -P, --publish-all=false Publish all exposed ports to random ports -p, --publish=[] Publish a container's port(s) to the host @@ -64,12 +65,11 @@ weight=1 --restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped) --rm=false Automatically remove the container when it exits --security-opt=[] Security Options - --stop-signal="SIGTERM" Signal to stop a container --sig-proxy=true Proxy received signals to the process + --stop-signal="SIGTERM" Signal to stop a container -t, --tty=false Allocate a pseudo-TTY -u, --user="" Username or UID (format: [:]) --ulimit=[] Ulimit options - --disable-content-trust=true Skip image verification --uts="" UTS namespace to use -v, --volume=[] Bind mount a volume --volumes-from=[] Mount volumes from the specified container(s) diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/save.md index 83913c093..06ad5dfa6 100644 --- a/docs/reference/commandline/save.md +++ b/docs/reference/commandline/save.md @@ -15,6 +15,7 @@ weight=1 Save an image(s) to a tar archive (streamed to STDOUT by default) + --help=false Print usage -o, --output="" Write to a file, instead of STDOUT Produces a tarred repository to the standard output stream. diff --git a/docs/reference/commandline/search.md b/docs/reference/commandline/search.md index 35b4ed4da..ce6f0f33f 100644 --- a/docs/reference/commandline/search.md +++ b/docs/reference/commandline/search.md @@ -16,6 +16,7 @@ weight=1 Search the Docker Hub for images --automated=false Only show automated builds + --help=false Print usage --no-trunc=false Don't truncate output -s, --stars=0 Only displays with at least x stars diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/start.md index c23f5b5f6..cdbff0842 100644 --- a/docs/reference/commandline/start.md +++ b/docs/reference/commandline/start.md @@ -13,8 +13,9 @@ weight=1 Usage: docker start [OPTIONS] CONTAINER [CONTAINER...] - Start one or more stopped containers + Start one or more containers -a, --attach=false Attach STDOUT/STDERR and forward signals + --help=false Print usage -i, --interactive=false Attach container's STDIN diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md index d3e667bac..3ae7087ff 100644 --- a/docs/reference/commandline/stats.md +++ b/docs/reference/commandline/stats.md @@ -11,7 +11,7 @@ weight=1 # stats - Usage: docker stats CONTAINER [CONTAINER...] + Usage: docker stats [OPTIONS] CONTAINER [CONTAINER...] Display a live stream of one or more containers' resource usage statistics diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/stop.md index d2ef8f852..b5a22d6a1 100644 --- a/docs/reference/commandline/stop.md +++ b/docs/reference/commandline/stop.md @@ -13,10 +13,11 @@ weight=1 Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...] - Stop a running container by sending SIGTERM and then SIGKILL after a + Stop a container by sending SIGTERM and then SIGKILL after a grace period + --help=false Print usage -t, --time=10 Seconds to wait for stop before killing it The main process inside the container will receive `SIGTERM`, and after a grace -period, `SIGKILL`. \ No newline at end of file +period, `SIGKILL`. diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md index 57b2aa019..ab8aacda3 100644 --- a/docs/reference/commandline/tag.md +++ b/docs/reference/commandline/tag.md @@ -16,6 +16,7 @@ weight=1 Tag an image into a repository -f, --force=false Force + --help=false Print usage You can group your images together using names and tags, and then upload them to [*Share Images via Repositories*](/userguide/dockerrepos/#contributing-to-docker-hub). diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/top.md index c56beb314..eb0e39c1f 100644 --- a/docs/reference/commandline/top.md +++ b/docs/reference/commandline/top.md @@ -11,6 +11,8 @@ weight=1 # top - Usage: docker top CONTAINER [ps OPTIONS] + Usage: docker top [OPTIONS] CONTAINER [ps OPTIONS] - Display the running processes of a container \ No newline at end of file + Display the running processes of a container + + --help=false Print usage diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/unpause.md index aab7d0085..8a9d41a63 100644 --- a/docs/reference/commandline/unpause.md +++ b/docs/reference/commandline/unpause.md @@ -11,10 +11,12 @@ weight=1 # unpause - Usage: docker unpause CONTAINER [CONTAINER...] + Usage: docker unpause [OPTIONS] CONTAINER [CONTAINER...] Unpause all processes within a container + --help=false Print usage + The `docker unpause` command uses the cgroups freezer to un-suspend all processes in a container. diff --git a/docs/reference/commandline/version.md b/docs/reference/commandline/version.md index 4570ed542..a173c8dd1 100644 --- a/docs/reference/commandline/version.md +++ b/docs/reference/commandline/version.md @@ -16,6 +16,7 @@ weight=1 Show the Docker version information. -f, --format="" Format the output using the given go template + --help=false Print usage By default, this will render all version information in an easy to read layout. If a format is specified, the given template will be executed instead. diff --git a/docs/reference/commandline/volume_create.md b/docs/reference/commandline/volume_create.md index 12b381eab..be9d4198f 100644 --- a/docs/reference/commandline/volume_create.md +++ b/docs/reference/commandline/volume_create.md @@ -14,10 +14,10 @@ parent = "smn_cli" Create a volume - -d, --driver=local Specify volume driver name - --help=false Print usage - --name= Specify volume name - -o, --opt=map[] Set driver specific options + -d, --driver=local Specify volume driver name + --help=false Print usage + --name= Specify volume name + -o, --opt=map[] Set driver specific options Creates a new volume that containers can consume and store data in. If a name is not specified, Docker generates a random name. You create a volume and then configure the container to use it, for example: @@ -25,7 +25,7 @@ Creates a new volume that containers can consume and store data in. If a name is hello $ docker run -d -v hello:/world busybox ls /world -The mount is created inside the container's `/src` directory. Docker does not support relative paths for mount points inside the container. +The mount is created inside the container's `/src` directory. Docker does not support relative paths for mount points inside the container. Multiple containers can use the same volume in the same time period. This is useful if two containers need access to shared data. For example, if one container writes and the other reads the data. diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index 28f5d1fb3..0ca3bbf95 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -14,8 +14,8 @@ parent = "smn_cli" Inspect one or more volumes - -f, --format= Format the output using the given go template. - --help=false Print usage + -f, --format= Format the output using the given go template. + --help=false Print usage Returns information about a volume. By default, this command renders all results in a JSON array. You can specify an alternate format to execute a given template diff --git a/docs/reference/commandline/volume_ls.md b/docs/reference/commandline/volume_ls.md index 63e98a47d..3368866e1 100644 --- a/docs/reference/commandline/volume_ls.md +++ b/docs/reference/commandline/volume_ls.md @@ -14,9 +14,9 @@ parent = "smn_cli" List volumes - -f, --filter=[] Provide filter values (i.e. 'dangling=true') - --help=false Print usage - -q, --quiet=false Only display volume names + -f, --filter=[] Provide filter values (i.e. 'dangling=true') + --help=false Print usage + -q, --quiet=false Only display volume names Lists all the volumes Docker knows about. You can filter using the `-f` or `--filter` flag. The filtering format is a `key=value` pair. To specify more than one filter, pass multiple flags (for example, `--filter "foo=bar" --filter "bif=baz"`) diff --git a/docs/reference/commandline/volume_rm.md b/docs/reference/commandline/volume_rm.md index e2f31b3cc..6d09723ca 100644 --- a/docs/reference/commandline/volume_rm.md +++ b/docs/reference/commandline/volume_rm.md @@ -14,7 +14,7 @@ parent = "smn_cli" Remove a volume - --help=false Print usage + --help=false Print usage Removes one or more volumes. You cannot remove a volume that is in use by a container. diff --git a/docs/reference/commandline/wait.md b/docs/reference/commandline/wait.md index 847f3007b..ed1c2a874 100644 --- a/docs/reference/commandline/wait.md +++ b/docs/reference/commandline/wait.md @@ -11,6 +11,8 @@ weight=1 # wait - Usage: docker wait CONTAINER [CONTAINER...] + Usage: docker wait [OPTIONS] CONTAINER [CONTAINER...] - Block until a container stops, then print its exit code. \ No newline at end of file + Block until a container stops, then print its exit code. + + --help=false Print usage diff --git a/man/docker-build.1.md b/man/docker-build.1.md index fcf2c633c..bcf8ed2f2 100644 --- a/man/docker-build.1.md +++ b/man/docker-build.1.md @@ -6,9 +6,11 @@ docker-build - Build a new image from the source code at PATH # SYNOPSIS **docker build** +[**--build-arg**[=*[]*]] +[**-c**|**--cpu-shares**[=*0*]] +[**--cgroup-parent**[=*CGROUP-PARENT*]] [**--help**] [**-f**|**--file**[=*PATH/Dockerfile*]] -[**--build-arg**[=*[]*]] [**--force-rm**[=*false*]] [**--no-cache**[=*false*]] [**--pull**[=*false*]] @@ -17,14 +19,11 @@ docker-build - Build a new image from the source code at PATH [**-t**|**--tag**[=*TAG*]] [**-m**|**--memory**[=*MEMORY*]] [**--memory-swap**[=*MEMORY-SWAP*]] -[**-c**|**--cpu-shares**[=*0*]] [**--cpu-period**[=*0*]] [**--cpu-quota**[=*0*]] [**--cpuset-cpus**[=*CPUSET-CPUS*]] [**--cpuset-mems**[=*CPUSET-MEMS*]] -[**--cgroup-parent**[=*CGROUP-PARENT*]] [**--ulimit**[=*[]*]] - PATH | URL | - # DESCRIPTION @@ -34,9 +33,9 @@ directory to the Docker daemon. The contents of this directory would be used by **ADD** commands found within the Dockerfile. Warning, this will send a lot of data to the Docker daemon depending -on the contents of the current directory. The build is run by the Docker +on the contents of the current directory. The build is run by the Docker daemon, not by the CLI, so the whole context must be transferred to the daemon. -The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to +The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to the daemon. When the URL to a tarball archive or to a single Dockerfile is given, no context is sent from diff --git a/man/docker-commit.1.md b/man/docker-commit.1.md index b17b37c6b..5912d3636 100644 --- a/man/docker-commit.1.md +++ b/man/docker-commit.1.md @@ -7,8 +7,8 @@ docker-commit - Create a new image from a container's changes # SYNOPSIS **docker commit** [**-a**|**--author**[=*AUTHOR*]] -[**--help**] [**-c**|**--change**[=\[*DOCKERFILE INSTRUCTIONS*\]]] +[**--help**] [**-m**|**--message**[=*MESSAGE*]] [**-p**|**--pause**[=*true*]] CONTAINER [REPOSITORY[:TAG]] diff --git a/man/docker-daemon.8.md b/man/docker-daemon.8.md index 20e5e5b37..b37bd25e0 100644 --- a/man/docker-daemon.8.md +++ b/man/docker-daemon.8.md @@ -1,9 +1,6 @@ % DOCKER(1) Docker User Manuals - -% Shishir Mahajan - +% Shishir Mahajan % SEPTEMBER 2015 - # NAME docker-daemon - Enable daemon mode diff --git a/man/docker-ps.1.md b/man/docker-ps.1.md index 5e21926d7..3f3e0a390 100644 --- a/man/docker-ps.1.md +++ b/man/docker-ps.1.md @@ -8,16 +8,15 @@ docker-ps - List containers **docker ps** [**-a**|**--all**[=*false*]] [**--before**[=*BEFORE*]] -[**--help**] [**-f**|**--filter**[=*[]*]] +[**--format**=*"TEMPLATE"*] +[**--help**] [**-l**|**--latest**[=*false*]] [**-n**[=*-1*]] [**--no-trunc**[=*false*]] [**-q**|**--quiet**[=*false*]] [**-s**|**--size**[=*false*]] [**--since**[=*SINCE*]] -[**--format**=*"TEMPLATE"*] - # DESCRIPTION @@ -31,9 +30,6 @@ the running containers. **--before**="" Show only containers created before Id or Name, including non-running containers. -**--help** - Print usage statement - **-f**, **--filter**=[] Provide filter values. Valid filters: exited= - containers with exit code of @@ -44,6 +40,23 @@ the running containers. ancestor=([:tag]||) - filters containers that were created from the given image or a descendant. +**--format**=*"TEMPLATE"* + Pretty-print containers using a Go template. + Valid placeholders: + .ID - Container ID + .Image - Image ID + .Command - Quoted command + .CreatedAt - Time when the container was created. + .RunningFor - Elapsed time since the container was started. + .Ports - Exposed ports. + .Status - Container status. + .Size - Container disk size. + .Labels - All labels asigned to the container. + .Label - Value of a specific label for this container. For example `{{.Label "com.docker.swarm.cpu"}}` + +**--help** + Print usage statement + **-l**, **--latest**=*true*|*false* Show only the latest created container, include non-running ones. The default is *false*. @@ -62,20 +75,6 @@ the running containers. **--since**="" Show only containers created since Id or Name, include non-running ones. -**--format**=*"TEMPLATE"* - Pretty-print containers using a Go template. - Valid placeholders: - .ID - Container ID - .Image - Image ID - .Command - Quoted command - .CreatedAt - Time when the container was created. - .RunningFor - Elapsed time since the container was started. - .Ports - Exposed ports. - .Status - Container status. - .Size - Container disk size. - .Labels - All labels asigned to the container. - .Label - Value of a specific label for this container. For example `{{.Label "com.docker.swarm.cpu"}}` - # EXAMPLES # Display all containers, including non-running diff --git a/man/docker-start.1.md b/man/docker-start.1.md index 523b31559..2e1191b09 100644 --- a/man/docker-start.1.md +++ b/man/docker-start.1.md @@ -2,7 +2,7 @@ % Docker Community % JUNE 2014 # NAME -docker-start - Start one or more stopped containers +docker-start - Start one or more containers # SYNOPSIS **docker start** @@ -13,7 +13,7 @@ CONTAINER [CONTAINER...] # DESCRIPTION -Start one or more stopped containers. +Start one or more containers. # OPTIONS **-a**, **--attach**=*true*|*false* @@ -26,7 +26,7 @@ Start one or more stopped containers. Attach container's STDIN. The default is *false*. # See also -**docker-stop(1)** to stop a running container. +**docker-stop(1)** to stop a container. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) diff --git a/man/docker-stop.1.md b/man/docker-stop.1.md index 4939070d9..c4daffa3b 100644 --- a/man/docker-stop.1.md +++ b/man/docker-stop.1.md @@ -2,7 +2,7 @@ % Docker Community % JUNE 2014 # NAME -docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period +docker-stop - Stop a container by sending SIGTERM and then SIGKILL after a grace period # SYNOPSIS **docker stop** @@ -11,7 +11,7 @@ docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after CONTAINER [CONTAINER...] # DESCRIPTION -Stop a running container (Send SIGTERM, and then SIGKILL after +Stop a container (Send SIGTERM, and then SIGKILL after grace period) # OPTIONS diff --git a/man/docker.1.md b/man/docker.1.md index 88c62e7ee..41329deb3 100644 --- a/man/docker.1.md +++ b/man/docker.1.md @@ -190,7 +190,7 @@ inside it) See **docker-search(1)** for full documentation on the **search** command. **start** - Start a stopped container + Start a container See **docker-start(1)** for full documentation on the **start** command. **stats** @@ -198,7 +198,7 @@ inside it) See **docker-stats(1)** for full documentation on the **stats** command. **stop** - Stop a running container + Stop a container See **docker-stop(1)** for full documentation on the **stop** command. **tag**