Enabled GitHub Flavored Markdown

GitHub flavored markdown is now supported for links and images. Also, ran LinkChecker and FileResolver. Yay!
Fixes from Spider check
Output for docker/docker now goes into engine directory

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 8fee1c2020186ac100b45e64864b94ae3a169ad5
Component: engine
This commit is contained in:
Mary Anthony
2015-10-09 16:50:41 -07:00
parent 9816980864
commit 6b6c7cc2b6
112 changed files with 502 additions and 630 deletions

View File

@ -37,7 +37,7 @@ parent = "smn_cli"
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
to any of the files in the context. For example, your build can use an
[*ADD*](/reference/builder/#add) instruction to reference a file in the
[*ADD*](../builder.md#add) instruction to reference a file in the
context.
The `URL` parameter can specify the location of a Git repository; the repository
@ -93,7 +93,7 @@ In most cases, it's best to put each Dockerfile in an empty directory. Then,
add to that directory only the files needed for building the Dockerfile. To
increase the build's performance, you can exclude files and directories by
adding a `.dockerignore` file to that directory as well. For information on
creating one, see the [.dockerignore file](/reference/builder#dockerignore-file).
creating one, see the [.dockerignore file](../builder.md#dockerignore-file).
If the Docker client loses connection to the daemon, the build is canceled.
This happens if you interrupt the Docker client with `ctrl-c` or if the Docker
@ -124,7 +124,7 @@ There should be informational output of the reason for failure output to
See also:
[*Dockerfile Reference*](/reference/builder).
[*Dockerfile Reference*](../builder.md).
## Examples
@ -160,7 +160,7 @@ where to find the files for the "context" of the build on the Docker daemon.
Remember that the daemon could be running on a remote machine and that no
parsing of the Dockerfile happens at the client side (where you're running
`docker build`). That means that *all* the files at `PATH` get sent, not just
the ones listed to [*ADD*](/reference/builder/#add) in the Dockerfile.
the ones listed to [*ADD*](../builder.md#add) in the Dockerfile.
The transfer of context from the local machine to the Docker daemon is what the
`docker` client means when you see the "Sending build context" message.
@ -191,7 +191,7 @@ you must use `--rm=false`. This does not affect the build cache.
This example shows the use of the `.dockerignore` file to exclude the `.git`
directory from the context. Its effect can be seen in the changed size of the
uploaded context. The builder reference contains detailed information on
[creating a .dockerignore file](../../builder/#dockerignore-file)
[creating a .dockerignore file](../builder.md#dockerignore-file)
$ docker build -t vieux/apache:2.0 .
@ -250,11 +250,11 @@ 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](../run.md#specifying-custom-cgroups).
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).
flag values](../run.md#setting-ulimits-in-a-container).
You can use `ENV` instructions in a Dockerfile to define variable
values. These values persist in the built image. However, often
@ -273,4 +273,4 @@ Dockerfile. Also, these values don't persist in the intermediate or final images
like `ENV` values do.
For detailed information on using `ARG` and `ENV` instructions, see the
[Dockerfile reference](/reference/builder).
[Dockerfile reference](../builder.md).

View File

@ -31,7 +31,7 @@ each `docker` command with `sudo`. To avoid having to use `sudo` with the
`docker` and add users to it.
For more information about installing Docker or `sudo` configuration, refer to
the [installation](/installation) instructions for your operating system.
the [installation](../../installation) instructions for your operating system.
## Environment variables
@ -98,7 +98,7 @@ The property `psFormat` specifies the default format for `docker ps` output.
When the `--format` flag is not provided with the `docker ps` command,
Docker's client uses this property. If this property is not set, the client
falls back to the default table format. For a list of supported formatting
directives, see the [**Formatting** section in the `docker ps` documentation](../ps)
directives, see the [**Formatting** section in the `docker ps` documentation](ps.md)
Following is a sample `config.json` file:

View File

@ -83,8 +83,7 @@ This is useful when you want to set up a container configuration ahead of time
so that it is ready to start when you need it. The initial status of the
new container is `created`.
Please see the [run command](/reference/commandline/run) section and the [Docker run reference](
/reference/run/) for more details.
Please see the [run command](run.md) section and the [Docker run reference](run.md) for more details.
## Examples

View File

@ -73,7 +73,7 @@ To run the daemon with debug output, use `docker daemon -D`.
## Daemon socket option
The Docker daemon can listen for [Docker Remote API](/reference/api/docker_remote_api/)
The Docker daemon can listen for [Docker Remote API](../api/docker_remote_api.md)
requests via three different types of Socket: `unix`, `tcp`, and `fd`.
By default, a `unix` domain socket (or IPC socket) is created at
@ -83,7 +83,7 @@ membership.
If you need to access the Docker daemon remotely, you need to enable the `tcp`
Socket. Beware that the default setup provides un-encrypted and
un-authenticated direct access to the Docker daemon - and should be secured
either using the [built in HTTPS encrypted socket](/articles/https/), or by
either using the [built in HTTPS encrypted socket](../../articles/https/), or by
putting a secure web proxy in front of it. You can listen on port `2375` on all
network interfaces with `-H tcp://0.0.0.0:2375`, or on a particular network
interface using its IP address: `-H tcp://192.168.59.103:2375`. It is

View File

@ -23,7 +23,7 @@ the container, `docker export` will export the contents of the *underlying*
directory, not the contents of the volume.
Refer to [Backup, restore, or migrate data
volumes](/userguide/dockervolumes/#backup-restore-or-migrate-data-volumes) in
volumes](../../userguide/dockervolumes.md#backup-restore-or-migrate-data-volumes) in
the user guide for examples on exporting data in a volume.
## Examples

View File

@ -12,74 +12,74 @@ parent = "mn_reference"
# 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).
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.md).
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.
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.md) reference page.
### Docker management commands
* [daemon](daemon)
* [info](info)
* [inspect](inspect)
* [version](version)
* [daemon](daemon.md)
* [info](info.md)
* [inspect](inspect.md)
* [version](version.md)
### Image commands
* [build](build)
* [commit](commit)
* [export](export)
* [history](history)
* [images](images)
* [import](import)
* [load](load)
* [rmi](rmi)
* [save](save)
* [tag](tag)
* [build](build.md)
* [commit](commit.md)
* [export](export.md)
* [history](history.md)
* [images](images.md)
* [import](import.md)
* [load](load.md)
* [rmi](rmi.md)
* [save](save.md)
* [tag](tag.md)
### 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)
* [attach](attach.md)
* [cp](cp.md)
* [create](create.md)
* [diff](diff.md)
* [events](events.md)
* [exec](exec.md)
* [kill](kill.md)
* [logs](logs.md)
* [pause](pause.md)
* [port](port.md)
* [ps](ps.md)
* [rename](rename.md)
* [restart](restart.md)
* [rm](rm.md)
* [run](run.md)
* [start](start.md)
* [stats](stats.md)
* [stop](stop.md)
* [top](top.md)
* [unpause](unpause.md)
* [wait](wait.md)
### Hub and registry commands
* [login](login)
* [logout](logout)
* [pull](pull)
* [push](push)
* [search](search)
* [login](login.md)
* [logout](logout.md)
* [pull](pull.md)
* [push](push.md)
* [search](search.md)
### 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)
* [network_connect](network_connect.md)
* [network_create](network_create.md)
* [network_disconnect](network_disconnect.md)
* [network_inspect](network_inspect.md)
* [network_ls](network_ls.md)
* [network_rm](network_rm.md)
### Shared data volume commands
* [volume_create](volume_create)
* [volume_inspect](volume_inspect)
* [volume_ls](volume_ls)
* [volume_rm](volume_rm)
* [volume_create](volume_create.md)
* [volume_inspect](volume_inspect.md)
* [volume_ls](volume_ls.md)
* [volume_rm](volume_rm.md)

View File

@ -81,13 +81,12 @@ specified image, and then `starts` it using the specified command. That is,
previous changes intact using `docker start`. See `docker ps -a` to view a list
of all containers.
There is detailed information about `docker run` in the [Docker run reference](
/reference/run/).
There is detailed information about `docker run` in the [Docker run reference](run.md).
The `docker run` command can be used in combination with `docker commit` to
[*change the command that a container runs*](/reference/commandline/commit).
[*change the command that a container runs*](commit.md).
See the [Docker User Guide](/userguide/dockerlinks/) for more detailed
See the [Docker User Guide](../../userguide/dockerlinks.md) for more detailed
information about the `--expose`, `-p`, `-P` and `--link` parameters,
and linking containers.
@ -170,14 +169,14 @@ manipulate the host's Docker daemon.
$ docker run -p 127.0.0.1:80:8080 ubuntu bash
This binds port `8080` of the container to port `80` on `127.0.0.1` of
the host machine. The [Docker User Guide](/userguide/dockerlinks/)
the host machine. The [Docker User Guide](../../userguide/dockerlinks.md)
explains in detail how to manipulate ports in Docker.
$ docker run --expose 80 ubuntu bash
This exposes port `80` of the container for use within a link without
publishing the port to the host system's interfaces. The [Docker User
Guide](/userguide/dockerlinks) explains in detail how to manipulate
Guide](../../userguide/dockerlinks.md) explains in detail how to manipulate
ports in Docker.
$ docker run -e MYVAR1 --env MYVAR2=foo --env-file ./env.list ubuntu bash
@ -279,7 +278,7 @@ format:
You can load multiple label-files by supplying multiple `--label-file` flags.
For additional information on working with labels, see [*Labels - custom
metadata in Docker*](/userguide/labels-custom-metadata/) in the Docker User
metadata in Docker*](../../userguide/labels-custom-metadata.md) in the Docker User
Guide.
$ docker run --link /redis:redis --name console ubuntu bash
@ -466,7 +465,7 @@ This will run the `redis` container with a restart policy of **always**
so that if the container exits, Docker will restart it.
More detailed information on restart policies can be found in the
[Restart Policies (--restart)](/reference/run/#restart-policies-restart)
[Restart Policies (--restart)](../run.md#restart-policies-restart)
section of the Docker run reference page.
## Adding entries to a container hosts file

View File

@ -21,7 +21,7 @@ parent = "smn_cli"
Search [Docker Hub](https://hub.docker.com) for images
See [*Find Public Images on Docker Hub*](/userguide/dockerrepos/#searching-for-images) for
See [*Find Public Images on Docker Hub*](../../userguide/dockerrepos.md#searching-for-images) for
more details on finding shared images from the command line.
> **Note:**

View File

@ -18,4 +18,4 @@ parent = "smn_cli"
--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).
to [*Share Images via Repositories*](../../userguide/dockerrepos.md#contributing-to-docker-hub).

View File

@ -1,6 +1,6 @@
<!--[metadata]>
+++
title = "ps"
title = "volume rm"
description = "the volume rm command description and usage"
keywords = ["volume, rm"]
[menu.main]