Skip to content

Commit

Permalink
Merge pull request moby#16850 from moxiegirl/fix-command-meta
Browse files Browse the repository at this point in the history
Fixing issues introduced with new commands adding index
  • Loading branch information
thaJeztah committed Oct 8, 2015
2 parents 73e3d85 + b44ef2b commit 80469f8
Show file tree
Hide file tree
Showing 46 changed files with 101 additions and 84 deletions.
2 changes: 0 additions & 2 deletions docs/reference/commandline/attach.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The attach command description and usage"
keywords = ["attach, running, container"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -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 changes: 2 additions & 3 deletions docs/reference/commandline/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The build command description and usage"
keywords = ["build, docker, image"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -251,9 +250,9 @@ the command line.
When `docker build` is run with the `--cgroup-parent` option the containers
used in the build will be run with the [corresponding `docker run`
flag](/reference/run/#specifying-custom-cgroups).
flag](/reference/run/#specifying-custom-cgroups).

Using the `--ulimit` option with `docker build` will cause each build step's
Using the `--ulimit` option with `docker build` will cause each build step's
container to be started using those [`--ulimit`
flag values](/reference/run/#setting-ulimits-in-a-container).

Expand Down
5 changes: 3 additions & 2 deletions docs/reference/commandline/cli.md
Original file line number Diff line number Diff line change
@@ -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`:
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/commandline/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The commit command description and usage"
keywords = ["commit, file, changes"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -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]

1 change: 0 additions & 1 deletion docs/reference/commandline/cp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]-->

Expand Down
5 changes: 1 addition & 4 deletions docs/reference/commandline/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The create command description and usage"
keywords = ["docker, create, container"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -77,7 +76,7 @@ Creates a new container.
The `docker create` command creates a writeable container layer over the
specified image and prepares it for running the specified command. The
container ID is then printed to `STDOUT`. This is similar to `docker run -d`
except the container is never started. You can then use the
except the container is never started. You can then use the
`docker start <container_id>` command to start the container at any point.

This is useful when you want to set up a container configuration ahead of time
Expand Down Expand Up @@ -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


4 changes: 1 addition & 3 deletions docs/reference/commandline/daemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]-->

Expand Down Expand Up @@ -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


1 change: 0 additions & 1 deletion docs/reference/commandline/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]-->

Expand Down
3 changes: 1 addition & 2 deletions docs/reference/commandline/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The events command description and usage"
keywords = ["events, container, report"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -36,7 +35,7 @@ returns only new and/or live events.
## Filtering

The filtering flag (`-f` or `--filter`) format is of "key=value". If you would
like to use multiple filters, pass multiple flags (e.g.,
like to use multiple filters, pass multiple flags (e.g.,
`--filter "foo=bar" --filter "bif=baz"`)

Using the same filter multiple times will be handled as a *OR*; for example
Expand Down
1 change: 0 additions & 1 deletion docs/reference/commandline/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]-->

Expand Down
1 change: 0 additions & 1 deletion docs/reference/commandline/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]-->

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/commandline/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The history command description and usage"
keywords = ["docker, image, history"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -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 -


2 changes: 0 additions & 2 deletions docs/reference/commandline/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The images command description and usage"
keywords = ["list, docker, images"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -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

4 changes: 1 addition & 3 deletions docs/reference/commandline/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]-->

Expand Down Expand Up @@ -48,7 +47,7 @@ Import to docker via pipe and `STDIN`.

$ cat exampleimage.tgz | docker import - exampleimagelocal:new

Import with a commit message
Import with a commit message

$ cat exampleimage.tgz | docker import --message "New image imported from tarball" - exampleimagelocal:new

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

85 changes: 85 additions & 0 deletions docs/reference/commandline/index.md
Original file line number Diff line number Diff line change
@@ -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)
3 changes: 0 additions & 3 deletions docs/reference/commandline/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The info command description and usage"
keywords = ["display, docker, information"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -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.


2 changes: 0 additions & 2 deletions docs/reference/commandline/inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The inspect command description and usage"
keywords = ["inspect, container, json"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -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

1 change: 0 additions & 1 deletion docs/reference/commandline/kill.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The kill command description and usage"
keywords = ["container, kill, signal"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/commandline/load.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The load command description and usage"
keywords = ["stdin, tarred, repository"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down Expand Up @@ -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

3 changes: 0 additions & 3 deletions docs/reference/commandline/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The login command description and usage"
keywords = ["registry, login, image"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand All @@ -26,5 +25,3 @@ adding the server name.

example:
$ docker login localhost:8080


4 changes: 0 additions & 4 deletions docs/reference/commandline/logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The logout command description and usage"
keywords = ["logout, docker, registry"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand All @@ -21,6 +20,3 @@ weight=1
For example:

$ docker logout localhost:8080



1 change: 0 additions & 1 deletion docs/reference/commandline/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description = "The logs command description and usage"
keywords = ["logs, retrieve, docker"]
[menu.main]
parent = "smn_cli"
weight=1
+++
<![end-metadata]-->

Expand Down
3 changes: 1 addition & 2 deletions docs/reference/commandline/network_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ parent = "smn_cli"

--help=false Print usage

Connects a running container to a network. This enables instant communication with other containers belonging to the same network.
Connects a running container to a network. This enables instant communication with other containers belonging to the same network.

```
$ docker network create -d overlay multi-host-network
Expand All @@ -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.

1 change: 0 additions & 1 deletion docs/reference/commandline/network_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

2 changes: 1 addition & 1 deletion docs/reference/commandline/network_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ parent = "smn_cli"
--help=false Print usage

Returns information about a network. By default, this command renders all results
in a JSON object.
in a JSON object.

Example output:

Expand Down
Loading

0 comments on commit 80469f8

Please sign in to comment.