mirror of https://github.com/docker/cli.git
Fixing issues in command ordering. Adding index.md
Adjust bullets Entering Seb's comments Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
parent
42fe72228d
commit
d45666f869
|
@ -5,7 +5,6 @@ description = "The attach command description and usage"
|
|||
keywords = ["attach, running, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -89,4 +88,3 @@ process is returned by the `docker attach` command to its caller too:
|
|||
13
|
||||
$ docker ps -a | grep test
|
||||
275c44472aeb debian:7 "/bin/bash" 26 seconds ago Exited (13) 17 seconds ago test
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The build command description and usage"
|
|||
keywords = ["build, docker, image"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -1,14 +1,15 @@
|
|||
<!--[metadata]>
|
||||
+++
|
||||
title = "Using the command line"
|
||||
title = "Use the Docker command line"
|
||||
description = "Docker's CLI command description and usage"
|
||||
keywords = ["Docker, Docker documentation, CLI, command line"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight = -2
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
# Using the command line
|
||||
# Use the Docker command line
|
||||
|
||||
To list available commands, either run `docker` with no parameters
|
||||
or execute `docker help`:
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The commit command description and usage"
|
|||
keywords = ["commit, file, changes"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -62,4 +61,3 @@ created. Supported `Dockerfile` instructions:
|
|||
f5283438590d
|
||||
$ docker inspect -f "{{ .Config.Env }}" f5283438590d
|
||||
[HOME=/ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin DEBUG=true]
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The cp command description and usage"
|
|||
keywords = ["copy, container, files, folders"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The create command description and usage"
|
|||
keywords = ["docker, create, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -121,5 +120,3 @@ then be used from the subsequent container:
|
|||
-rw-r--r-- 1 1000 staff 920 Nov 28 11:51 .profile
|
||||
drwx--S--- 2 1000 staff 460 Dec 5 00:51 .ssh
|
||||
drwxr-xr-x 32 1000 staff 1140 Dec 5 04:01 docker
|
||||
|
||||
|
||||
|
|
|
@ -5,7 +5,7 @@ description = "The daemon command description and usage"
|
|||
keywords = ["container, daemon, runtime"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
weight = -1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -551,5 +551,3 @@ set like this:
|
|||
# or
|
||||
export DOCKER_TMPDIR=/mnt/disk2/tmp
|
||||
/usr/local/bin/docker daemon -D -g /var/lib/docker -H unix:// > /var/lib/docker-machine/docker.log 2>&1
|
||||
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The diff command description and usage"
|
|||
keywords = ["list, changed, files, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The events command description and usage"
|
|||
keywords = ["events, container, report"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The exec command description and usage"
|
|||
keywords = ["command, container, run, execute"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The export command description and usage"
|
|||
keywords = ["export, file, system, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The history command description and usage"
|
|||
keywords = ["docker, image, history"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -39,5 +38,3 @@ To see how the `docker:apache` image was added to a container's base image:
|
|||
88b42ffd1f7c 5 months ago /bin/sh -c #(nop) ADD file:1fd8d7f9f6557cafc7 373.7 MB
|
||||
c69cab00d6ef 5 months ago /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar 0 B
|
||||
511136ea3c5a 19 months ago 0 B Imported from -
|
||||
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The images command description and usage"
|
|||
keywords = ["list, docker, images"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -178,4 +177,3 @@ In this example, with the `0.1` value, it returns an empty set because no matche
|
|||
|
||||
$ docker images --filter "label=com.example.version=0.1"
|
||||
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The import command description and usage"
|
|||
keywords = ["import, file, system, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -68,4 +67,3 @@ Note the `sudo` in this example – you must preserve
|
|||
the ownership of the files (especially root ownership) during the
|
||||
archiving with tar. If you are not root (or the sudo command) when you
|
||||
tar, then the ownerships might not get preserved.
|
||||
|
||||
|
|
|
@ -0,0 +1,85 @@
|
|||
<!-- [metadata]>
|
||||
+++
|
||||
title = "Using the command line"
|
||||
description = "Docker's CLI command description and usage"
|
||||
keywords = ["Docker, Docker documentation, CLI, command line"]
|
||||
[menu.main]
|
||||
identifier= "smn_cli"
|
||||
parent = "mn_reference"
|
||||
+++
|
||||
<!-- [end-metadata]-->
|
||||
|
||||
|
||||
# The Docker commands
|
||||
|
||||
This section contains reference information on using Docker's command line client. Each command has a reference page along with samples. If you are unfamiliar with the command line, you should start by reading about how to ["Use the Docker command line"](cli).
|
||||
|
||||
You start the Docker daemon with the command line. How you start the daemon affects your Docker containers. For that reason you should also make sure to read the [`daemon`](daemon) reference page.
|
||||
|
||||
### Docker management commands
|
||||
|
||||
* [daemon](daemon)
|
||||
* [info](info)
|
||||
* [inspect](inspect)
|
||||
* [version](version)
|
||||
|
||||
### Image commands
|
||||
|
||||
* [build](build)
|
||||
* [commit](commit)
|
||||
* [export](export)
|
||||
* [history](history)
|
||||
* [images](images)
|
||||
* [import](import)
|
||||
* [load](load)
|
||||
* [rmi](rmi)
|
||||
* [save](save)
|
||||
* [tag](tag)
|
||||
|
||||
### Container commands
|
||||
|
||||
* [attach](attach)
|
||||
* [cp](cp)
|
||||
* [create](create)
|
||||
* [diff](diff)
|
||||
* [events](events)
|
||||
* [exec](exec)
|
||||
* [kill](kill)
|
||||
* [logs](logs)
|
||||
* [pause](pause)
|
||||
* [port](port)
|
||||
* [ps](ps)
|
||||
* [rename](rename)
|
||||
* [restart](restart)
|
||||
* [rm](rm)
|
||||
* [run](run)
|
||||
* [start](start)
|
||||
* [stats](stats)
|
||||
* [stop](stop)
|
||||
* [top](top)
|
||||
* [unpause](unpause)
|
||||
* [wait](wait)
|
||||
|
||||
### Hub and registry commands
|
||||
|
||||
* [login](login)
|
||||
* [logout](logout)
|
||||
* [pull](pull)
|
||||
* [push](push)
|
||||
* [search](search)
|
||||
|
||||
### Network and connectivity commands
|
||||
|
||||
* [network_connect](network_connect)
|
||||
* [network_create](network_create)
|
||||
* [network_disconnect](network_disconnect)
|
||||
* [network_inspect](network_inspect)
|
||||
* [network_ls](network_ls)
|
||||
* [network_rm](network_rm)
|
||||
|
||||
### Shared data volume commands
|
||||
|
||||
* [volume_create](volume_create)
|
||||
* [volume_inspect](volume_inspect)
|
||||
* [volume_ls](volume_ls)
|
||||
* [volume_rm](volume_rm)
|
|
@ -5,7 +5,6 @@ description = "The info command description and usage"
|
|||
keywords = ["display, docker, information"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -57,5 +56,3 @@ The global `-D` option tells all `docker` commands to output debug information.
|
|||
|
||||
When sending issue reports, please use `docker version` and `docker -D info` to
|
||||
ensure we know how your setup is configured.
|
||||
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The inspect command description and usage"
|
|||
keywords = ["inspect, container, json"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -73,4 +72,3 @@ section contains complex JSON object, so to grab it as JSON, you use
|
|||
`json` to convert the configuration object into JSON.
|
||||
|
||||
$ docker inspect --format='{{json .config}}' $INSTANCE_ID
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The kill command description and usage"
|
|||
keywords = ["container, kill, signal"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The load command description and usage"
|
|||
keywords = ["stdin, tarred, repository"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -35,4 +34,3 @@ Restores both images and tags.
|
|||
fedora 20 58394af37342 7 weeks ago 385.5 MB
|
||||
fedora heisenbug 58394af37342 7 weeks ago 385.5 MB
|
||||
fedora latest 58394af37342 7 weeks ago 385.5 MB
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The login command description and usage"
|
|||
keywords = ["registry, login, image"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -26,5 +25,3 @@ adding the server name.
|
|||
|
||||
example:
|
||||
$ docker login localhost:8080
|
||||
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The logout command description and usage"
|
|||
keywords = ["logout, docker, registry"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -21,6 +20,3 @@ weight=1
|
|||
For example:
|
||||
|
||||
$ docker logout localhost:8080
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The logs command description and usage"
|
|||
keywords = ["logs, retrieve, docker"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -27,4 +27,3 @@ Connects a running container to a network. This enables instant communication wi
|
|||
the container will be connected to the network that is created and managed by the driver (multi-host overlay driver in the above example) or external network plugins.
|
||||
|
||||
Multiple containers can be connected to the same network and the containers in the same network will start to communicate with each other. If the driver/plugin supports multi-host connectivity, then the containers connected to the same multi-host network will be able to communicate seamlessly.
|
||||
|
||||
|
|
|
@ -29,4 +29,3 @@ the container will be connected to the network that is created and managed by th
|
|||
Multiple containers can be connected to the same network and the containers in the same network will start to communicate with each other. If the driver/plugin supports multi-host connectivity, then the containers connected to the same multi-host network will be able to communicate seamlessly.
|
||||
|
||||
*Note*: UX needs enhancement to accept network options to be passed to the drivers
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The pause command description and usage"
|
|||
keywords = ["cgroups, container, suspend, SIGSTOP"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -26,4 +25,3 @@ and subsequently resumed.
|
|||
See the
|
||||
[cgroups freezer documentation](https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt)
|
||||
for further details.
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The port command description and usage"
|
|||
keywords = ["port, mapping, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The ps command description and usage"
|
|||
keywords = ["container, running, list"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The pull command description and usage"
|
|||
keywords = ["pull, image, hub, docker"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -50,4 +49,3 @@ use `docker pull`:
|
|||
# manually specifies the path to the default Docker registry. This could
|
||||
# be replaced with the path to a local registry to pull from another source.
|
||||
# sudo docker pull myhub.com:8080/test-image
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The push command description and usage"
|
|||
keywords = ["share, push, image"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The rename command description and usage"
|
|||
keywords = ["rename, docker, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The restart command description and usage"
|
|||
keywords = ["restart, container, Docker"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -17,4 +16,3 @@ weight=1
|
|||
|
||||
--help=false Print usage
|
||||
-t, --time=10 Seconds to wait for stop before killing the container
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The rm command description and usage"
|
|||
keywords = ["remove, Docker, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -46,4 +45,3 @@ This command will delete all stopped containers. The command
|
|||
`docker ps -a -q` will return all existing container IDs and pass them to
|
||||
the `rm` command which will delete them. Any running containers will not be
|
||||
deleted.
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The rmi command description and usage"
|
|||
keywords = ["remove, image, Docker"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -73,4 +72,3 @@ To remove an image using its digest:
|
|||
Deleted: 4986bf8c15363d1c5d15512d5266f8777bfba4974ac56e3270e7760f6f0a8125
|
||||
Deleted: ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2
|
||||
Deleted: df7546f9f060a2268024c8a230d8639878585defcc1bc6f79d2728a13957871b
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The run command description and usage"
|
|||
keywords = ["run, command, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The save command description and usage"
|
|||
keywords = ["tarred, repository, backup"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The search command description and usage"
|
|||
keywords = ["search, hub, images"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -27,4 +26,3 @@ more details on finding shared images from the command line.
|
|||
|
||||
> **Note:**
|
||||
> Search queries will only return up to 25 results
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The start command description and usage"
|
|||
keywords = ["Start, container, stopped"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -18,4 +17,3 @@ weight=1
|
|||
-a, --attach=false Attach STDOUT/STDERR and forward signals
|
||||
--help=false Print usage
|
||||
-i, --interactive=false Attach container's STDIN
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The stats command description and usage"
|
|||
keywords = ["container, resource, statistics"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The stop command description and usage"
|
|||
keywords = ["stop, SIGKILL, SIGTERM"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The tag command description and usage"
|
|||
keywords = ["tag, name, image"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The top command description and usage"
|
|||
keywords = ["container, running, processes"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The unpause command description and usage"
|
|||
keywords = ["cgroups, suspend, container"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The version command description and usage"
|
|||
keywords = ["version, architecture, api"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
@ -54,4 +53,3 @@ describes all the details of the format.
|
|||
|
||||
$ docker version --format '{{json .}}'
|
||||
{"Client":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"},"ServerOK":true,"Server":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","KernelVersion":"3.13.2-gentoo","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"}}
|
||||
|
||||
|
|
|
@ -39,4 +39,3 @@ These options are passed directly to the volume driver. Options for
|
|||
different volume drivers may do different things (or nothing at all).
|
||||
|
||||
*Note*: The built-in `local` volume driver does not currently accept any options.
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@ description = "The wait command description and usage"
|
|||
keywords = ["container, stop, wait"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
weight=1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
Loading…
Reference in New Issue