docker/cli
1
0
Fork 0
mirror of https://github.com/docker/cli.git synced 2025-07-30 17:03:07 +03:00
Code Activity

Fix man and commandline docs

Browse Source 
- 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 <amurdaca@redhat.com>
This commit is contained in:
Antonio Murdaca
2015-10-03 17:56:41 +02:00
committed by Tibor Vass
parent 1b1a0a0835
commit cbd33a2b27
50 changed files with 148 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/commandline/attach.md
View File

@ -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

34
docs/reference/commandline/build.md
View File

@ -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

1
docs/reference/commandline/commit.md
View File

@ -17,6 +17,7 @@ weight=1
-a, --author="" Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
-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

8
docs/reference/commandline/cp.md
View File

@ -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

5
docs/reference/commandline/create.md
View File

@ -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

4
docs/reference/commandline/diff.md
View File

@ -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`:

1
docs/reference/commandline/events.md
View File

@ -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

1
docs/reference/commandline/exec.md
View File

@ -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

24
docs/reference/commandline/export.md
View File

@ -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

1
docs/reference/commandline/history.md
View File

@ -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

1
docs/reference/commandline/import.md
View File

@ -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

4
docs/reference/commandline/info.md
View File

@ -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

8
docs/reference/commandline/inspect.md
View File

@ -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.

1
docs/reference/commandline/kill.md
View File

@ -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

1
docs/reference/commandline/load.md
View File

@ -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.

1
docs/reference/commandline/login.md
View File

@ -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

2
docs/reference/commandline/logout.md
View File

@ -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

1
docs/reference/commandline/logs.md
View File

@ -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

4
docs/reference/commandline/pause.md
View File

@ -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

4
docs/reference/commandline/port.md
View File

@ -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:

3
docs/reference/commandline/ps.md
View File

@ -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.

1
docs/reference/commandline/pull.md
View File

@ -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.

5
docs/reference/commandline/push.md
View File

@ -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.

6
docs/reference/commandline/rename.md
View File

@ -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.

1
docs/reference/commandline/restart.md
View File

@ -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

1
docs/reference/commandline/rm.md
View File

@ -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

2
docs/reference/commandline/rmi.md
View File

@ -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.

6
docs/reference/commandline/run.md
View File

@ -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: <name|uid>[:<group|gid>])
--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)

1
docs/reference/commandline/save.md
View File

@ -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.

1
docs/reference/commandline/search.md
View File

@ -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

3
docs/reference/commandline/start.md
View File

@ -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

2
docs/reference/commandline/stats.md
View File

@ -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

5
docs/reference/commandline/stop.md
View File

@ -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`.
period, `SIGKILL`.

1
docs/reference/commandline/tag.md
View File

@ -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).

6
docs/reference/commandline/top.md
View File

@ -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
Display the running processes of a container
--help=false Print usage

4
docs/reference/commandline/unpause.md
View File

@ -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.

1
docs/reference/commandline/version.md
View File

@ -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.

10
docs/reference/commandline/volume_create.md
View File

@ -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.

4
docs/reference/commandline/volume_inspect.md
View File

@ -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

6
docs/reference/commandline/volume_ls.md
View File

@ -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"`)

2
docs/reference/commandline/volume_rm.md
View File

@ -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.

6
docs/reference/commandline/wait.md
View File

@ -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.
Block until a container stops, then print its exit code.
--help=false Print usage