Browse code

Moving man pages out of docs Adding in other areas per comments Updating with comments; equalizing generating man page info Updating with duglin's comments Doug is right here again;fixing.

Signed-off-by: Mary Anthony <mary@docker.com>
(cherry picked from commit eacae64bd89ccc95a6db7bda76d36014e71e70ac)

Mary Anthony authored on 2015/06/09 02:48:20
Showing 98 changed files
... ...
@@ -80,7 +80,7 @@ sudo mkdir -m 755 dev
80 80
 # effectively: febootstrap-minimize --keep-zoneinfo --keep-rpmdb --keep-services "$target"
81 81
 #  locales
82 82
 sudo rm -rf usr/{{lib,share}/locale,{lib,lib64}/gconv,bin/localedef,sbin/build-locale-archive}
83
-#  docs
83
+#  docs and man pages
84 84
 sudo rm -rf usr/share/{man,doc,info,gnome/help}
85 85
 #  cracklib
86 86
 sudo rm -rf usr/share/cracklib
... ...
@@ -10,7 +10,7 @@ shift
10 10
 	# effectively: febootstrap-minimize --keep-zoneinfo --keep-rpmdb --keep-services "$target"
11 11
 	#  locales
12 12
 	rm -rf usr/{{lib,share}/locale,{lib,lib64}/gconv,bin/localedef,sbin/build-locale-archive}
13
-	#  docs
13
+	#  docs and man pages
14 14
 	rm -rf usr/share/{man,doc,info,gnome/help}
15 15
 	#  cracklib
16 16
 	rm -rf usr/share/cracklib
... ...
@@ -280,24 +280,11 @@ aws cloudfront  create-invalidation --profile docs.docker.com --distribution-id
280 280
 aws cloudfront  create-invalidation --profile docs.docker.com --distribution-id $DISTRIBUTION_ID --invalidation-batch '{"Paths":{"Quantity":1, "Items":["/v1.1/reference/api/docker_io_oauth_api/"]},"CallerReference":"6Mar2015sventest1"}'
281 281
 ```
282 282
 
283
-### Generate the man pages for Mac OSX
283
+### Generate the man pages 
284 284
 
285
-When using Docker on Mac OSX the man pages will be missing by default. You can manually generate them by following these steps:
285
+For information on generating man pages (short for manual page), see [the man
286
+page directory](https://github.com/docker/docker/tree/master/docker) in this
287
+project.
286 288
 
287
-1. Checkout the docker source. You must clone into your `/Users` directory because Boot2Docker can only share this path
288
-   with the docker containers.
289 289
 
290
-        $ git clone https://github.com/docker/docker.git
291
-		
292
-2. Build the docker image.
293
-   
294
-        $ cd docker/docs/man
295
-        $ docker build -t docker/md2man .
296 290
 
297
-3. Build the man pages.
298
-
299
-        $ docker run -v /Users/<path-to-git-dir>/docker/docs/man:/docs:rw -w /docs -i docker/md2man /docs/md2man-all.sh
300
-
301
-4. Copy the generated man pages to `/usr/share/man`
302
-
303
-        $ cp -R man* /usr/share/man/
304 291
deleted file mode 100644
... ...
@@ -1,7 +0,0 @@
1
-FROM golang:1.3
2
-RUN mkdir -p /go/src/github.com/cpuguy83
3
-RUN mkdir -p /go/src/github.com/cpuguy83 \
4
-    && git clone -b v1 https://github.com/cpuguy83/go-md2man.git /go/src/github.com/cpuguy83/go-md2man \
5
-    && cd /go/src/github.com/cpuguy83/go-md2man \
6
-    && go get -v ./...
7
-CMD ["/go/bin/go-md2man", "--help"]
8 1
deleted file mode 100644
... ...
@@ -1,329 +0,0 @@
1
-% DOCKERFILE(5) Docker User Manuals
2
-% Zac Dover
3
-% May 2014
4
-# NAME
5
-
6
-Dockerfile - automate the steps of creating a Docker image
7
-
8
-# INTRODUCTION
9
-
10
-The **Dockerfile** is a configuration file that automates the steps of creating
11
-a Docker image. It is similar to a Makefile. Docker reads instructions from the
12
-**Dockerfile** to automate the steps otherwise performed manually to create an
13
-image. To build an image, create a file called **Dockerfile**.
14
-
15
-The **Dockerfile** describes the steps taken to assemble the image. When the
16
-**Dockerfile** has been created, call the `docker build` command, using the
17
-path of directory that contains **Dockerfile** as the argument.
18
-
19
-# SYNOPSIS
20
-
21
-INSTRUCTION arguments
22
-
23
-For example:
24
-
25
-  FROM image
26
-
27
-# DESCRIPTION
28
-
29
-A Dockerfile is a file that automates the steps of creating a Docker image. 
30
-A Dockerfile is similar to a Makefile.
31
-
32
-# USAGE
33
-
34
-  docker build .
35
-
36
-  -- Runs the steps and commits them, building a final image.
37
-  The path to the source repository defines where to find the context of the
38
-  build. The build is run by the Docker daemon, not the CLI. The whole
39
-  context must be transferred to the daemon. The Docker CLI reports
40
-  `"Sending build context to Docker daemon"` when the context is sent to the
41
-  daemon.
42
-
43
-  ```
44
-  docker build -t repository/tag .
45
-  ```
46
-
47
-  -- specifies a repository and tag at which to save the new image if the build
48
-  succeeds. The Docker daemon runs the steps one-by-one, committing the result
49
-  to a new image if necessary, before finally outputting the ID of the new
50
-  image. The Docker daemon automatically cleans up the context it is given.
51
-
52
-  Docker re-uses intermediate images whenever possible. This significantly
53
-  accelerates the *docker build* process.
54
-
55
-# FORMAT
56
-
57
-  `FROM image`
58
-
59
-  `FROM image:tag`
60
-
61
-  -- The **FROM** instruction sets the base image for subsequent instructions. A
62
-  valid Dockerfile must have **FROM** as its first instruction. The image can be any
63
-  valid image. It is easy to start by pulling an image from the public
64
-  repositories.
65
-
66
-  -- **FROM** must be the first non-comment instruction in Dockerfile.
67
-
68
-  -- **FROM** may appear multiple times within a single Dockerfile in order to create
69
-  multiple images. Make a note of the last image ID output by the commit before
70
-  each new **FROM** command.
71
-
72
-  -- If no tag is given to the **FROM** instruction, Docker applies the 
73
-  `latest` tag. If the used tag does not exist, an error is returned.
74
-
75
-**MAINTAINER**
76
-  -- **MAINTAINER** sets the Author field for the generated images.
77
-
78
-**RUN**
79
-  -- **RUN** has two forms:
80
-
81
-  ```
82
-  # the command is run in a shell - /bin/sh -c
83
-  RUN <command>
84
-
85
-  # Executable form
86
-  RUN ["executable", "param1", "param2"]
87
-  ```
88
-
89
-
90
-  -- The **RUN** instruction executes any commands in a new layer on top of the current
91
-  image and commits the results. The committed image is used for the next step in
92
-  Dockerfile.
93
-
94
-  -- Layering **RUN** instructions and generating commits conforms to the core
95
-  concepts of Docker where commits are cheap and containers can be created from
96
-  any point in the history of an image. This is similar to source control.  The
97
-  exec form makes it possible to avoid shell string munging. The exec form makes
98
-  it possible to **RUN** commands using a base image that does not contain `/bin/sh`.
99
-
100
-  Note that the exec form is parsed as a JSON array, which means that you must
101
-  use double-quotes (") around words not single-quotes (').
102
-
103
-**CMD**
104
-  -- **CMD** has three forms:
105
-
106
-  ```
107
-  # Executable form
108
-  CMD ["executable", "param1", "param2"]`
109
-
110
-  # Provide default arguments to ENTRYPOINT
111
-  CMD ["param1", "param2"]`
112
-
113
-  # the command is run in a shell - /bin/sh -c
114
-  CMD command param1 param2
115
-  ```
116
-
117
-  -- There can be only one **CMD** in a Dockerfile. If more than one **CMD** is listed, only
118
-  the last **CMD** takes effect.
119
-  The main purpose of a **CMD** is to provide defaults for an executing container.
120
-  These defaults may include an executable, or they can omit the executable. If
121
-  they omit the executable, an **ENTRYPOINT** must be specified.
122
-  When used in the shell or exec formats, the **CMD** instruction sets the command to
123
-  be executed when running the image.
124
-  If you use the shell form of the **CMD**, the `<command>` executes in `/bin/sh -c`:
125
-
126
-  Note that the exec form is parsed as a JSON array, which means that you must
127
-  use double-quotes (") around words not single-quotes (').
128
-
129
-  ```
130
-  FROM ubuntu
131
-  CMD echo "This is a test." | wc -
132
-  ```
133
-
134
-  -- If you run **command** without a shell, then you must express the command as a
135
-  JSON array and give the full path to the executable. This array form is the
136
-  preferred form of **CMD**. All additional parameters must be individually expressed
137
-  as strings in the array:
138
-
139
-  ```
140
-  FROM ubuntu
141
-  CMD ["/usr/bin/wc","--help"]
142
-  ```
143
-
144
-  -- To make the container run the same executable every time, use **ENTRYPOINT** in
145
-  combination with **CMD**. 
146
-  If the user specifies arguments to `docker run`, the specified commands
147
-  override the default in **CMD**.
148
-  Do not confuse **RUN** with **CMD**. **RUN** runs a command and commits the result.
149
-  **CMD** executes nothing at build time, but specifies the intended command for
150
-  the image.
151
-
152
-**LABEL**
153
-  -- `LABEL <key>[=<value>] [<key>[=<value>] ...]`
154
-  The **LABEL** instruction adds metadata to an image. A **LABEL** is a
155
-  key-value pair. To include spaces within a **LABEL** value, use quotes and
156
-  backslashes as you would in command-line parsing.
157
-
158
-  ```
159
-  LABEL "com.example.vendor"="ACME Incorporated"
160
-  ```
161
-
162
-  An image can have more than one label. To specify multiple labels, separate
163
-  each key-value pair by a space. 
164
-  
165
-  Labels are additive including `LABEL`s in `FROM` images. As the system
166
-  encounters and then applies a new label, new `key`s override any previous
167
-  labels with identical keys.
168
-
169
-  To display an image's labels, use the `docker inspect` command.
170
-
171
-**EXPOSE**
172
-  -- `EXPOSE <port> [<port>...]`
173
-  The **EXPOSE** instruction informs Docker that the container listens on the
174
-  specified network ports at runtime. Docker uses this information to
175
-  interconnect containers using links, and to set up port redirection on the host
176
-  system.
177
-
178
-**ENV**
179
-  -- `ENV <key> <value>`
180
-  The **ENV** instruction sets the environment variable <key> to
181
-  the value `<value>`. This value is passed to all future 
182
-  RUN, **ENTRYPOINT**, and **CMD** instructions. This is
183
-  functionally equivalent to prefixing the command with `<key>=<value>`.  The
184
-  environment variables that are set with **ENV** persist when a container is run
185
-  from the resulting image. Use `docker inspect` to inspect these values, and
186
-  change them using `docker run --env <key>=<value>`.
187
-
188
-  Note that setting "`ENV DEBIAN_FRONTEND noninteractive`" may cause
189
-  unintended consequences, because it will persist when the container is run
190
-  interactively, as with the following command: `docker run -t -i image bash`
191
-
192
-**ADD**
193
-  -- **ADD** has two forms:
194
-
195
-  ```
196
-  ADD <src> <dest>
197
-
198
-  # Required for paths with whitespace
199
-  ADD ["<src>",... "<dest>"]
200
-  ```
201
-
202
-  The **ADD** instruction copies new files, directories
203
-  or remote file URLs to the filesystem of the container at path `<dest>`.
204
-  Multiple `<src>` resources may be specified but if they are files or directories
205
-  then they must be relative to the source directory that is being built
206
-  (the context of the build). The `<dest>` is the absolute path, or path relative
207
-  to **WORKDIR**, into which the source is copied inside the target container.
208
-  All new files and directories are created with mode 0755 and with the uid 
209
-  and gid of **0**.
210
-
211
-**COPY**
212
-  -- **COPY** has two forms:
213
-
214
-  ```
215
-  COPY <src> <dest>
216
-
217
-  # Required for paths with whitespace
218
-  COPY ["<src>",... "<dest>"]
219
-  ```
220
-
221
-  The **COPY** instruction copies new files from `<src>` and
222
-  adds them to the filesystem of the container at path <dest>. The `<src>` must be
223
-  the path to a file or directory relative to the source directory that is
224
-  being built (the context of the build) or a remote file URL. The `<dest>` is an
225
-  absolute path, or a path relative to **WORKDIR**, into which the source will
226
-  be copied inside the target container. All new files and directories are
227
-  created with mode **0755** and with the uid and gid of **0**.
228
-
229
-**ENTRYPOINT**
230
-  -- **ENTRYPOINT** has two forms:
231
-
232
-  ```
233
-  # executable form
234
-  ENTRYPOINT ["executable", "param1", "param2"]`
235
-
236
-  # run command in a shell - /bin/sh -c
237
-  ENTRYPOINT command param1 param2
238
-  ```
239
-
240
-  -- An **ENTRYPOINT** helps you configure a
241
-  container that can be run as an executable. When you specify an **ENTRYPOINT**,
242
-  the whole container runs as if it was only that executable.  The **ENTRYPOINT**
243
-  instruction adds an entry command that is not overwritten when arguments are
244
-  passed to docker run. This is different from the behavior of CMD. This allows
245
-  arguments to be passed to the entrypoint, for instance `docker run <image> -d`
246
-  passes the -d argument to the **ENTRYPOINT**.  Specify parameters either in the
247
-  **ENTRYPOINT** JSON array (as in the preferred exec form above), or by using a **CMD**
248
-  statement.  Parameters in the **ENTRYPOINT** are not overwritten by the docker run
249
-  arguments.  Parameters specifies via **CMD** are overwritten by docker run
250
-  arguments.  Specify a plain string for the **ENTRYPOINT**, and it will execute in
251
-  `/bin/sh -c`, like a **CMD** instruction:
252
-
253
-  ```
254
-  FROM ubuntu
255
-  ENTRYPOINT wc -l -
256
-  ```
257
-
258
-  This means that the Dockerfile's image always takes stdin as input (that's
259
-  what "-" means), and prints the number of lines (that's what "-l" means). To
260
-  make this optional but default, use a **CMD**:
261
-
262
-  ```
263
-  FROM ubuntu
264
-  CMD ["-l", "-"]
265
-  ENTRYPOINT ["/usr/bin/wc"]
266
-  ```
267
-
268
-**VOLUME**
269
-  -- `VOLUME ["/data"]`
270
-  The **VOLUME** instruction creates a mount point with the specified name and marks
271
-  it as holding externally-mounted volumes from the native host or from other
272
-  containers.
273
-
274
-**USER**
275
-  -- `USER daemon`
276
-  Sets the username or UID used for running subsequent commands.
277
-
278
-  The **USER** instruction can optionally be used to set the group or GID. The
279
-  followings examples are all valid:
280
-  USER [user | user:group | uid | uid:gid | user:gid | uid:group ]
281
-
282
-  Until the **USER** instruction is set, instructions will be run as root. The USER
283
-  instruction can be used any number of times in a Dockerfile, and will only affect
284
-  subsequent commands.
285
-
286
-**WORKDIR**
287
-  -- `WORKDIR /path/to/workdir`
288
-  The **WORKDIR** instruction sets the working directory for the **RUN**, **CMD**,
289
-  **ENTRYPOINT**, **COPY** and **ADD** Dockerfile commands that follow it. It can
290
-  be used multiple times in a single Dockerfile. Relative paths are defined
291
-  relative to the path of the previous **WORKDIR** instruction. For example:
292
-
293
-  ```
294
-  WORKDIR /a
295
-  WORKDIR b
296
-  WORKDIR c
297
-  RUN pwd
298
-  ```
299
-
300
-  In the above example, the output of the **pwd** command is **a/b/c**.
301
-
302
-**ONBUILD**
303
-  -- `ONBUILD [INSTRUCTION]`
304
-  The **ONBUILD** instruction adds a trigger instruction to an image. The
305
-  trigger is executed at a later time, when the image is used as the base for
306
-  another build. Docker executes the trigger in the context of the downstream
307
-  build, as if the trigger existed immediately after the **FROM** instruction in
308
-  the downstream Dockerfile.
309
-
310
-  You can register any build instruction as a trigger. A trigger is useful if
311
-  you are defining an image to use as a base for building other images. For
312
-  example, if you are defining an application build environment or a daemon that
313
-  is customized with a user-specific configuration.  
314
-  
315
-  Consider an image intended as a reusable python application builder. It must
316
-  add application source code to a particular directory, and might need a build
317
-  script called after that. You can't just call **ADD** and **RUN** now, because
318
-  you don't yet have access to the application source code, and it is different
319
-  for each application build.
320
-
321
-  -- Providing application developers with a boilerplate Dockerfile to copy-paste
322
-  into their application is inefficient, error-prone, and
323
-  difficult to update because it mixes with application-specific code.
324
-  The solution is to use **ONBUILD** to register instructions in advance, to
325
-  run later, during the next build stage.
326
-
327
-# HISTORY
328
-*May 2014, Compiled by Zac Dover (zdover at redhat dot com) based on docker.com Dockerfile documentation.
329
-*Feb 2015, updated by Brian Goff (cpuguy83@gmail.com) for readability
330 1
deleted file mode 100644
... ...
@@ -1,33 +0,0 @@
1
-Docker Documentation
2
-====================
3
-
4
-This directory contains the Docker user manual in the Markdown format.
5
-Do *not* edit the man pages in the man1 directory. Instead, amend the
6
-Markdown (*.md) files.
7
-
8
-# Generating man pages from the Markdown files
9
-
10
-The recommended approach for generating the man pages is via a Docker
11
-container using the supplied `Dockerfile` to create an image with the correct
12
-environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
13
-
14
-## Building the md2man image
15
-
16
-There is a `Dockerfile` provided in the `docker/docs/man` directory.
17
-
18
-Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
19
-
20
-    docker build -t docker/md2man .
21
-
22
-## Utilizing the image
23
-
24
-Once the image is built, run a container using the image with *volumes*:
25
-
26
-    docker run -v /<path-to-git-dir>/docker/docs/man:/docs:rw \
27
-    -w /docs -i docker/md2man /docs/md2man-all.sh
28
-
29
-The `md2man` Docker container will process the Markdown files and generate
30
-the man pages inside the `docker/docs/man/man1` directory using
31
-Docker volumes. For more information on Docker volumes see the man page for
32
-`docker run` and also look at the article [Sharing Directories via Volumes]
33
-(https://docs.docker.com/use/working_with_volumes/).
34 1
deleted file mode 100644
... ...
@@ -1,70 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-attach - Attach to a running container
6
-
7
-# SYNOPSIS
8
-**docker attach**
9
-[**--help**]/
10
-[**--no-stdin**[=*false*]]
11
-[**--sig-proxy**[=*true*]]
12
-CONTAINER
13
-
14
-# DESCRIPTION
15
-The **docker attach** command allows you to attach to a running container using
16
-the container's ID or name, either to view its ongoing output or to control it
17
-interactively.  You can attach to the same contained process multiple times
18
-simultaneously, screen sharing style, or quickly view the progress of your
19
-daemonized process.
20
-
21
-You can detach from the container (and leave it running) with `CTRL-p CTRL-q`
22
-(for a quiet exit) or `CTRL-c` which will send a `SIGKILL` to the container.
23
-When you are attached to a container, and exit its main process, the process's
24
-exit code will be returned to the client.
25
-
26
-It is forbidden to redirect the standard input of a `docker attach` command while
27
-attaching to a tty-enabled container (i.e.: launched with `-t`).
28
-
29
-# OPTIONS
30
-**--help**
31
-  Print usage statement
32
-
33
-**--no-stdin**=*true*|*false*
34
-   Do not attach STDIN. The default is *false*.
35
-
36
-**--sig-proxy**=*true*|*false*
37
-   Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
38
-
39
-# EXAMPLES
40
-
41
-## Attaching to a container
42
-
43
-In this example the top command is run inside a container, from an image called
44
-fedora, in detached mode. The ID from the container is passed into the **docker
45
-attach** command:
46
-
47
-    # ID=$(sudo docker run -d fedora /usr/bin/top -b)
48
-    # sudo docker attach $ID
49
-    top - 02:05:52 up  3:05,  0 users,  load average: 0.01, 0.02, 0.05
50
-    Tasks:   1 total,   1 running,   0 sleeping,   0 stopped,   0 zombie
51
-    Cpu(s):  0.1%us,  0.2%sy,  0.0%ni, 99.7%id,  0.0%wa,  0.0%hi,  0.0%si,  0.0%st
52
-    Mem:    373572k total,   355560k used,    18012k free,    27872k buffers
53
-    Swap:   786428k total,        0k used,   786428k free,   221740k cached
54
-
55
-    PID USER      PR  NI  VIRT  RES  SHR S %CPU %MEM    TIME+  COMMAND
56
-    1 root      20   0 17200 1116  912 R    0  0.3   0:00.03 top
57
-
58
-    top - 02:05:55 up  3:05,  0 users,  load average: 0.01, 0.02, 0.05
59
-    Tasks:   1 total,   1 running,   0 sleeping,   0 stopped,   0 zombie
60
-    Cpu(s):  0.0%us,  0.2%sy,  0.0%ni, 99.8%id,  0.0%wa,  0.0%hi,  0.0%si,  0.0%st
61
-    Mem:    373572k total,   355244k used,    18328k free,    27872k buffers
62
-    Swap:   786428k total,        0k used,   786428k free,   221776k cached
63
-
64
-    PID USER      PR  NI  VIRT  RES  SHR S %CPU %MEM    TIME+  COMMAND
65
-    1 root      20   0 17208 1144  932 R    0  0.3   0:00.03 top
66
-
67
-# HISTORY
68
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
69
-based on docker.com source material and internal work.
70
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
71 1
deleted file mode 100644
... ...
@@ -1,215 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-build - Build a new image from the source code at PATH
6
-
7
-# SYNOPSIS
8
-**docker build**
9
-[**--help**]
10
-[**-f**|**--file**[=*PATH/Dockerfile*]]
11
-[**--force-rm**[=*false*]]
12
-[**--no-cache**[=*false*]]
13
-[**--pull**[=*false*]]
14
-[**-q**|**--quiet**[=*false*]]
15
-[**--rm**[=*true*]]
16
-[**-t**|**--tag**[=*TAG*]]
17
-[**-m**|**--memory**[=*MEMORY*]]
18
-[**--memory-swap**[=*MEMORY-SWAP*]]
19
-[**-c**|**--cpu-shares**[=*0*]]
20
-[**--cpu-period**[=*0*]]
21
-[**--cpu-quota**[=*0*]]
22
-[**--cpuset-cpus**[=*CPUSET-CPUS*]]
23
-[**--cpuset-mems**[=*CPUSET-MEMS*]]
24
-[**--cgroup-parent**[=*CGROUP-PARENT*]]
25
-
26
-PATH | URL | -
27
-
28
-# DESCRIPTION
29
-This will read the Dockerfile from the directory specified in **PATH**.
30
-It also sends any other files and directories found in the current
31
-directory to the Docker daemon. The contents of this directory would
32
-be used by **ADD** commands found within the Dockerfile.
33
-
34
-Warning, this will send a lot of data to the Docker daemon depending
35
-on the contents of the current directory. The build is run by the Docker 
36
-daemon, not by the CLI, so the whole context must be transferred to the daemon. 
37
-The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to 
38
-the daemon.
39
-
40
-When a single Dockerfile is given as the URL, then no context is set.
41
-When a Git repository is set as the **URL**, the repository is used
42
-as context.
43
-
44
-# OPTIONS
45
-**-f**, **--file**=*PATH/Dockerfile*
46
-   Path to the Dockerfile to use. If the path is a relative path then it must be relative to the current directory. The file must be within the build context. The default is *Dockerfile*.
47
-
48
-**--force-rm**=*true*|*false*
49
-   Always remove intermediate containers, even after unsuccessful builds. The default is *false*.
50
-
51
-**--no-cache**=*true*|*false*
52
-   Do not use cache when building the image. The default is *false*.
53
-
54
-**--help**
55
-  Print usage statement
56
-
57
-**--pull**=*true*|*false*
58
-   Always attempt to pull a newer version of the image. The default is *false*.
59
-
60
-**-q**, **--quiet**=*true*|*false*
61
-   Suppress the verbose output generated by the containers. The default is *false*.
62
-
63
-**--rm**=*true*|*false*
64
-   Remove intermediate containers after a successful build. The default is *true*.
65
-
66
-**-t**, **--tag**=""
67
-   Repository name (and optionally a tag) to be applied to the resulting image in case of success
68
-
69
-**-m**, **--memory**=*MEMORY*
70
-  Memory limit
71
-
72
-**--memory-swap**=*MEMORY-SWAP*
73
-  Total memory (memory + swap), '-1' to disable swap.
74
-
75
-**-c**, **--cpu-shares**=*0*
76
-  CPU shares (relative weight).
77
-
78
-  By default, all containers get the same proportion of CPU cycles. You can
79
-  change this proportion by adjusting the container's CPU share weighting
80
-  relative to the weighting of all other running containers.
81
-
82
-  To modify the proportion from the default of 1024, use the **-c** or
83
-  **--cpu-shares** flag to set the weighting to 2 or higher.
84
-
85
-  The proportion is only applied when CPU-intensive processes are running.
86
-  When tasks in one container are idle, the other containers can use the
87
-  left-over CPU time. The actual amount of CPU time used varies depending on
88
-  the number of containers running on the system.
89
-
90
-  For example, consider three containers, one has a cpu-share of 1024 and
91
-  two others have a cpu-share setting of 512. When processes in all three
92
-  containers attempt to use 100% of CPU, the first container would receive
93
-  50% of the total CPU time. If you add a fourth container with a cpu-share
94
-  of 1024, the first container only gets 33% of the CPU. The remaining containers
95
-  receive 16.5%, 16.5% and 33% of the CPU.
96
-
97
-  On a multi-core system, the shares of CPU time are distributed across the CPU
98
-  cores. Even if a container is limited to less than 100% of CPU time, it can
99
-  use 100% of each individual CPU core.
100
-
101
-  For example, consider a system with more than three cores. If you start one
102
-  container **{C0}** with **-c=512** running one process, and another container
103
-  **{C1}** with **-c=1024** running two processes, this can result in the following
104
-  division of CPU shares:
105
-
106
-      PID    container    CPU    CPU share
107
-      100    {C0}         0      100% of CPU0
108
-      101    {C1}         1      100% of CPU1
109
-      102    {C1}         2      100% of CPU2
110
-
111
-**--cpu-period**=*0*
112
-  Limit the CPU CFS (Completely Fair Scheduler) period.
113
-
114
-  Limit the container's CPU usage. This flag causes the kernel to restrict the
115
-  container's CPU usage to the period you specify.
116
-
117
-**--cpu-quota**=*0*
118
-  Limit the CPU CFS (Completely Fair Scheduler) quota. 
119
-
120
-  By default, containers run with the full CPU resource. This flag causes the
121
-kernel to restrict the container's CPU usage to the quota you specify.
122
-
123
-**--cpuset-cpus**=*CPUSET-CPUS*
124
-  CPUs in which to allow execution (0-3, 0,1).
125
-
126
-**--cpuset-mems**=*CPUSET-MEMS*
127
-  Memory nodes (MEMs) in which to allow execution (-1-3, 0,1). Only effective on
128
-  NUMA systems.
129
-
130
-  For example, if you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
131
-to ensure the processes in your Docker container only use memory from the first
132
-two memory nodes.
133
-
134
-**--cgroup-parent**=*CGROUP-PARENT*
135
-  Path to `cgroups` under which the container's `cgroup` are created.
136
-
137
-  If the path is not absolute, the path is considered relative to the `cgroups` path of the init process.
138
-Cgroups are created if they do not already exist.
139
-
140
-# EXAMPLES
141
-
142
-## Building an image using a Dockerfile located inside the current directory
143
-
144
-Docker images can be built using the build command and a Dockerfile:
145
-
146
-    docker build .
147
-
148
-During the build process Docker creates intermediate images. In order to
149
-keep them, you must explicitly set `--rm=false`.
150
-
151
-    docker build --rm=false .
152
-
153
-A good practice is to make a sub-directory with a related name and create
154
-the Dockerfile in that directory. For example, a directory called mongo may
155
-contain a Dockerfile to create a Docker MongoDB image. Likewise, another
156
-directory called httpd may be used to store Dockerfiles for Apache web
157
-server images.
158
-
159
-It is also a good practice to add the files required for the image to the
160
-sub-directory. These files will then be specified with the `COPY` or `ADD`
161
-instructions in the `Dockerfile`.
162
-
163
-Note: If you include a tar file (a good practice), then Docker will
164
-automatically extract the contents of the tar file specified within the `ADD`
165
-instruction into the specified target.
166
-
167
-## Building an image and naming that image
168
-
169
-A good practice is to give a name to the image you are building. There are
170
-no hard rules here but it is best to give the names consideration. 
171
-
172
-The **-t**/**--tag** flag is used to rename an image. Here are some examples:
173
-
174
-Though it is not a good practice, image names can be arbitrary:
175
-
176
-    docker build -t myimage .
177
-
178
-A better approach is to provide a fully qualified and meaningful repository,
179
-name, and tag (where the tag in this context means the qualifier after 
180
-the ":"). In this example we build a JBoss image for the Fedora repository 
181
-and give it the version 1.0:
182
-
183
-    docker build -t fedora/jboss:1.0
184
-
185
-The next example is for the "whenry" user repository and uses Fedora and
186
-JBoss and gives it the version 2.1 :
187
-
188
-    docker build -t whenry/fedora-jboss:V2.1
189
-
190
-If you do not provide a version tag then Docker will assign `latest`:
191
-
192
-    docker build -t whenry/fedora-jboss
193
-
194
-When you list the images, the image above will have the tag `latest`.
195
-
196
-So renaming an image is arbitrary but consideration should be given to 
197
-a useful convention that makes sense for consumers and should also take
198
-into account Docker community conventions.
199
-
200
-
201
-## Building an image using a URL
202
-
203
-This will clone the specified Github repository from the URL and use it
204
-as context. The Dockerfile at the root of the repository is used as
205
-Dockerfile. This only works if the Github repository is a dedicated
206
-repository.
207
-
208
-    docker build github.com/scollier/Fedora-Dockerfiles/tree/master/apache
209
-
210
-Note: You can set an arbitrary Git repository via the `git://` schema.
211
-
212
-# HISTORY
213
-March 2014, Originally compiled by William Henry (whenry at redhat dot com)
214
-based on docker.com source material and internal work.
215
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
216 1
deleted file mode 100644
... ...
@@ -1,59 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-commit - Create a new image from a container's changes
6
-
7
-# SYNOPSIS
8
-**docker commit**
9
-[**-a**|**--author**[=*AUTHOR*]]
10
-[**--help**]
11
-[**-c**|**--change**[= []**]]
12
-[**-m**|**--message**[=*MESSAGE*]]
13
-[**-p**|**--pause**[=*true*]]
14
-CONTAINER [REPOSITORY[:TAG]]
15
-
16
-# DESCRIPTION
17
-Using an existing container's name or ID you can create a new image.
18
-
19
-# OPTIONS
20
-**-a**, **--author**=""
21
-   Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
22
-
23
-**-c** , **--change**=[]
24
-   Apply specified Dockerfile instructions while committing the image
25
-   Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
26
-
27
-**--help**
28
-  Print usage statement
29
-
30
-**-m**, **--message**=""
31
-   Commit message
32
-
33
-**-p**, **--pause**=*true*|*false*
34
-   Pause container during commit. The default is *true*.
35
-
36
-# EXAMPLES
37
-
38
-## Creating a new image from an existing container
39
-An existing Fedora based container has had Apache installed while running
40
-in interactive mode with the bash shell. Apache is also running. To
41
-create a new image run `docker ps` to find the container's ID and then run:
42
-
43
-    # docker commit -m="Added Apache to Fedora base image" \
44
-      -a="A D Ministrator" 98bd7fc99854 fedora/fedora_httpd:20
45
-
46
-## Apply specified Dockerfile instructions while committing the image
47
-If an existing container was created without the DEBUG environment
48
-variable set to "true", you can create a new image based on that
49
-container by first getting the container's ID with `docker ps` and
50
-then running:
51
-
52
-    # docker commit -c="ENV DEBUG true" 98bd7fc99854 debug-image
53
-
54
-# HISTORY
55
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
56
-based on docker.com source material and in
57
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
58
-July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
59
-Oct 2014, updated by Daniel, Dao Quang Minh <daniel at nitrous dot io>
60 1
deleted file mode 100644
... ...
@@ -1,70 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-cp - Copy files or folders from a container's PATH to a HOSTDIR
6
-or to STDOUT.
7
-
8
-# SYNOPSIS
9
-**docker cp**
10
-[**--help**]
11
-CONTAINER:PATH HOSTDIR|-
12
-
13
-# DESCRIPTION
14
-
15
-Copy files or folders from a `CONTAINER:PATH` to the `HOSTDIR` or to `STDOUT`. 
16
-The `CONTAINER:PATH` is relative to the root of the container's filesystem. You
17
-can copy from either a running or stopped container. 
18
-
19
-The `PATH` can be a file or directory. The `docker cp` command assumes all
20
-`PATH` values start at the `/` (root) directory. This means supplying the
21
-initial forward slash is optional; The command sees
22
-`compassionate_darwin:/tmp/foo/myfile.txt` and
23
-`compassionate_darwin:tmp/foo/myfile.txt` as identical.
24
-
25
-The `HOSTDIR` refers to a directory on the host. If you do not specify an
26
-absolute path for your `HOSTDIR` value, Docker creates the directory relative to
27
-where you run the `docker cp` command. For example, suppose you want to copy the
28
-`/tmp/foo` directory from a container to the `/tmp` directory on your host. If
29
-you run `docker cp` in your `~` (home) directory on the host:
30
-
31
-		$ docker cp compassionate_darwin:tmp/foo /tmp
32
-
33
-Docker creates a `/tmp/foo` directory on your host. Alternatively, you can omit
34
-the leading slash in the command. If you execute this command from your home directory:
35
-
36
-		$ docker cp compassionate_darwin:tmp/foo tmp
37
-
38
-Docker creates a `~/tmp/foo` subdirectory.  
39
-
40
-When copying files to an existing `HOSTDIR`, the `cp` command adds the new files to
41
-the directory. For example, this command:
42
-
43
-		$ docker cp sharp_ptolemy:/tmp/foo/myfile.txt /tmp
44
-
45
-Creates a `/tmp/foo` directory on the host containing the `myfile.txt` file. If
46
-you repeat the command but change the filename:
47
-
48
-		$ docker cp sharp_ptolemy:/tmp/foo/secondfile.txt /tmp
49
-
50
-Your host's `/tmp/foo` directory will contain both files:
51
-
52
-		$ ls /tmp/foo
53
-		myfile.txt secondfile.txt
54
-		
55
-Finally, use '-' to write the data as a `tar` file to STDOUT.
56
-
57
-# OPTIONS
58
-**--help**
59
-  Print usage statement
60
-
61
-# EXAMPLES
62
-An important shell script file, created in a bash shell, is copied from
63
-the exited container to the current dir on the host:
64
-
65
-    # docker cp c071f3c3ee81:setup.sh .
66
-
67
-# HISTORY
68
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
69
-based on docker.com source material and internal work.
70
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
71 1
deleted file mode 100644
... ...
@@ -1,236 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-create - Create a new container
6
-
7
-# SYNOPSIS
8
-**docker create**
9
-[**-a**|**--attach**[=*[]*]]
10
-[**--add-host**[=*[]*]]
11
-[**--blkio-weight**[=*[BLKIO-WEIGHT]*]]
12
-[**-c**|**--cpu-shares**[=*0*]]
13
-[**--cap-add**[=*[]*]]
14
-[**--cap-drop**[=*[]*]]
15
-[**--cidfile**[=*CIDFILE*]]
16
-[**--cpu-period**[=*0*]]
17
-[**--cpuset-cpus**[=*CPUSET-CPUS*]]
18
-[**--cpuset-mems**[=*CPUSET-MEMS*]]
19
-[**--cpu-quota**[=*0*]]
20
-[**--device**[=*[]*]]
21
-[**--dns-search**[=*[]*]]
22
-[**--dns**[=*[]*]]
23
-[**-e**|**--env**[=*[]*]]
24
-[**--entrypoint**[=*ENTRYPOINT*]]
25
-[**--env-file**[=*[]*]]
26
-[**--expose**[=*[]*]]
27
-[**-h**|**--hostname**[=*HOSTNAME*]]
28
-[**--help**]
29
-[**-i**|**--interactive**[=*false*]]
30
-[**--ipc**[=*IPC*]]
31
-[**-l**|**--label**[=*[]*]]
32
-[**--label-file**[=*[]*]]
33
-[**--link**[=*[]*]]
34
-[**--lxc-conf**[=*[]*]]
35
-[**--log-driver**[=*[]*]]
36
-[**--log-opt**[=*[]*]]
37
-[**-m**|**--memory**[=*MEMORY*]]
38
-[**--memory-swap**[=*MEMORY-SWAP*]]
39
-[**--mac-address**[=*MAC-ADDRESS*]]
40
-[**--name**[=*NAME*]]
41
-[**--net**[=*"bridge"*]]
42
-[**--oom-kill-disable**[=*false*]]
43
-[**-P**|**--publish-all**[=*false*]]
44
-[**-p**|**--publish**[=*[]*]]
45
-[**--pid**[=*[]*]]
46
-[**--uts**[=*[]*]]
47
-[**--privileged**[=*false*]]
48
-[**--read-only**[=*false*]]
49
-[**--restart**[=*RESTART*]]
50
-[**--security-opt**[=*[]*]]
51
-[**-t**|**--tty**[=*false*]]
52
-[**-u**|**--user**[=*USER*]]
53
-[**-v**|**--volume**[=*[]*]]
54
-[**--volumes-from**[=*[]*]]
55
-[**-w**|**--workdir**[=*WORKDIR*]]
56
-[**--cgroup-parent**[=*CGROUP-PATH*]]
57
-IMAGE [COMMAND] [ARG...]
58
-
59
-# OPTIONS
60
-**-a**, **--attach**=[]
61
-   Attach to STDIN, STDOUT or STDERR.
62
-
63
-**--add-host**=[]
64
-   Add a custom host-to-IP mapping (host:ip)
65
-
66
-**--blkio-weight**=0
67
-   Block IO weight (relative weight) accepts a weight value between 10 and 1000.
68
-
69
-**-c**, **--cpu-shares**=0
70
-   CPU shares (relative weight)
71
-
72
-**--cap-add**=[]
73
-   Add Linux capabilities
74
-
75
-**--cap-drop**=[]
76
-   Drop Linux capabilities
77
-
78
-**--cidfile**=""
79
-   Write the container ID to the file
80
-
81
-**--cgroup-parent**=""
82
-   Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
83
-
84
-**--cpu-peroid**=0
85
-    Limit the CPU CFS (Completely Fair Scheduler) period
86
-
87
-**--cpuset-cpus**=""
88
-   CPUs in which to allow execution (0-3, 0,1)
89
-
90
-**--cpuset-mems**=""
91
-   Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
92
-
93
-   If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
94
-then processes in your Docker container will only use memory from the first
95
-two memory nodes.
96
-
97
-**-cpu-quota**=0
98
-   Limit the CPU CFS (Completely Fair Scheduler) quota
99
-
100
-**--device**=[]
101
-   Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
102
-
103
-**--dns-search**=[]
104
-   Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
105
-
106
-**--dns**=[]
107
-   Set custom DNS servers
108
-
109
-**-e**, **--env**=[]
110
-   Set environment variables
111
-
112
-**--entrypoint**=""
113
-   Overwrite the default ENTRYPOINT of the image
114
-
115
-**--env-file**=[]
116
-   Read in a line delimited file of environment variables
117
-
118
-**--expose**=[]
119
-   Expose a port or a range of ports (e.g. --expose=3300-3310) from the container without publishing it to your host
120
-
121
-**-h**, **--hostname**=""
122
-   Container host name
123
-
124
-**--help**
125
-  Print usage statement
126
-
127
-**-i**, **--interactive**=*true*|*false*
128
-   Keep STDIN open even if not attached. The default is *false*.
129
-
130
-**--ipc**=""
131
-   Default is to create a private IPC namespace (POSIX SysV IPC) for the container
132
-                               'container:<name|id>': reuses another container shared memory, semaphores and message queues
133
-                               'host': use the host shared memory,semaphores and message queues inside the container.  Note: the host mode gives the container full access to local shared memory and is therefore considered insecure.
134
-
135
-**-l**, **--label**=[]
136
-   Adds metadata to a container (e.g., --label=com.example.key=value)
137
-
138
-**--label-file**=[]
139
-   Read labels from a file. Delimit each label with an EOL.
140
-
141
-**--link**=[]
142
-   Add link to another container in the form of <name or id>:alias or just
143
-   <name or id> in which case the alias will match the name.
144
-
145
-**--lxc-conf**=[]
146
-   (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
147
-
148
-**--log-driver**="|*json-file*|*syslog*|*journald*|*none*"
149
-  Logging driver for container. Default is defined by daemon `--log-driver` flag.
150
-  **Warning**: `docker logs` command works only for `json-file` logging driver.
151
-
152
-**--log-opt**=[]
153
-  Logging driver specific options.
154
-
155
-**-m**, **--memory**=""
156
-   Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
157
-
158
-   Allows you to constrain the memory available to a container. If the host
159
-supports swap memory, then the **-m** memory setting can be larger than physical
160
-RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
161
-not limited. The actual limit may be rounded up to a multiple of the operating
162
-system's page size (the value would be very large, that's millions of trillions).
163
-
164
-**--memory-swap**=""
165
-   Total memory limit (memory + swap)
166
-
167
-   Set `-1` to disable swap (format: <number><optional unit>, where unit = b, k, m or g).
168
-This value should always larger than **-m**, so you should always use this with **-m**.
169
-
170
-**--mac-address**=""
171
-   Container MAC address (e.g. 92:d0:c6:0a:29:33)
172
-
173
-**--name**=""
174
-   Assign a name to the container
175
-
176
-**--net**="bridge"
177
-   Set the Network mode for the container
178
-                               'bridge': creates a new network stack for the container on the docker bridge
179
-                               'none': no networking for this container
180
-                               'container:<name|id>': reuses another container network stack
181
-                               'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
182
-
183
-**--oom-kill-disable**=*true*|*false*
184
-	Whether to disable OOM Killer for the container or not.
185
-
186
-**-P**, **--publish-all**=*true*|*false*
187
-   Publish all exposed ports to random ports on the host interfaces. The default is *false*.
188
-
189
-**-p**, **--publish**=[]
190
-   Publish a container's port, or a range of ports, to the host
191
-                               format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
192
-                               Both hostPort and containerPort can be specified as a range of ports. 
193
-                               When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. (e.g., `-p 1234-1236:1234-1236/tcp`)
194
-                               (use 'docker port' to see the actual mapping)
195
-
196
-**--pid**=host
197
-   Set the PID mode for the container
198
-     **host**: use the host's PID namespace inside the container.
199
-     Note: the host mode gives the container full access to local PID and is therefore considered insecure.
200
-
201
-**--uts**=host
202
-   Set the UTS mode for the container
203
-     **host**: use the host's UTS namespace inside the container.
204
-     Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
205
-
206
-**--privileged**=*true*|*false*
207
-   Give extended privileges to this container. The default is *false*.
208
-
209
-**--read-only**=*true*|*false*
210
-   Mount the container's root filesystem as read only.
211
-
212
-**--restart**="no"
213
-   Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
214
-
215
-**--security-opt**=[]
216
-   Security Options
217
-
218
-**-t**, **--tty**=*true*|*false*
219
-   Allocate a pseudo-TTY. The default is *false*.
220
-
221
-**-u**, **--user**=""
222
-   Username or UID
223
-
224
-**-v**, **--volume**=[]
225
-   Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
226
-
227
-**--volumes-from**=[]
228
-   Mount volumes from the specified container(s)
229
-
230
-**-w**, **--workdir**=""
231
-   Working directory inside the container
232
-
233
-# HISTORY
234
-August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
235
-September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
236
-November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
237 1
deleted file mode 100644
... ...
@@ -1,49 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-diff - Inspect changes on a container's filesystem
6
-
7
-# SYNOPSIS
8
-**docker diff**
9
-[**--help**]
10
-CONTAINER
11
-
12
-# DESCRIPTION
13
-Inspect changes on a container's filesystem. You can use the full or
14
-shortened container ID or the container name set using
15
-**docker run --name** option.
16
-
17
-# OPTIONS
18
-**--help**
19
-  Print usage statement
20
-
21
-# EXAMPLES
22
-Inspect the changes to on a nginx container:
23
-
24
-    # docker diff 1fdfd1f54c1b
25
-    C /dev
26
-    C /dev/console
27
-    C /dev/core
28
-    C /dev/stdout
29
-    C /dev/fd
30
-    C /dev/ptmx
31
-    C /dev/stderr
32
-    C /dev/stdin
33
-    C /run
34
-    A /run/nginx.pid
35
-    C /var/lib/nginx/tmp
36
-    A /var/lib/nginx/tmp/client_body
37
-    A /var/lib/nginx/tmp/fastcgi
38
-    A /var/lib/nginx/tmp/proxy
39
-    A /var/lib/nginx/tmp/scgi
40
-    A /var/lib/nginx/tmp/uwsgi
41
-    C /var/log/nginx
42
-    A /var/log/nginx/access.log
43
-    A /var/log/nginx/error.log
44
-
45
-
46
-# HISTORY
47
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
48
-based on docker.com source material and internal work.
49
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
50 1
deleted file mode 100644
... ...
@@ -1,74 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-events - Get real time events from the server
6
-
7
-# SYNOPSIS
8
-**docker events**
9
-[**--help**]
10
-[**-f**|**--filter**[=*[]*]]
11
-[**--since**[=*SINCE*]]
12
-[**--until**[=*UNTIL*]]
13
-
14
-
15
-# DESCRIPTION
16
-Get event information from the Docker daemon. Information can include historical
17
-information and real-time information.
18
-
19
-Docker containers will report the following events:
20
-
21
-    create, destroy, die, export, kill, pause, restart, start, stop, unpause
22
-
23
-and Docker images will report:
24
-
25
-    untag, delete
26
-
27
-# OPTIONS
28
-**--help**
29
-  Print usage statement
30
-
31
-**-f**, **--filter**=[]
32
-   Provide filter values (i.e., 'event=stop')
33
-
34
-**--since**=""
35
-   Show all events created since timestamp
36
-
37
-**--until**=""
38
-   Stream events until this timestamp
39
-
40
-# EXAMPLES
41
-
42
-## Listening for Docker events
43
-
44
-After running docker events a container 786d698004576 is started and stopped
45
-(The container name has been shortened in the output below):
46
-
47
-    # docker events
48
-    2015-01-28T20:21:31.000000000-08:00 59211849bc10: (from whenry/testimage:latest) start
49
-    2015-01-28T20:21:31.000000000-08:00 59211849bc10: (from whenry/testimage:latest) die
50
-    2015-01-28T20:21:32.000000000-08:00 59211849bc10: (from whenry/testimage:latest) stop
51
-
52
-## Listening for events since a given date
53
-Again the output container IDs have been shortened for the purposes of this document:
54
-
55
-    # docker events --since '2015-01-28'
56
-    2015-01-28T20:25:38.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) create
57
-    2015-01-28T20:25:38.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
58
-    2015-01-28T20:25:39.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) create
59
-    2015-01-28T20:25:39.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
60
-    2015-01-28T20:25:40.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) die
61
-    2015-01-28T20:25:42.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) stop
62
-    2015-01-28T20:25:45.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
63
-    2015-01-28T20:25:45.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) die
64
-    2015-01-28T20:25:46.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) stop
65
-
66
-
67
-If you do not provide the --since option, the command returns only new and/or
68
-live events.
69
-
70
-# HISTORY
71
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
72
-based on docker.com source material and internal work.
73
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
74
-June 2015, updated by Brian Goff <cpuguy83@gmail.com>
75 1
deleted file mode 100644
... ...
@@ -1,51 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-exec - Run a command in a running container
6
-
7
-# SYNOPSIS
8
-**docker exec**
9
-[**-d**|**--detach**[=*false*]]
10
-[**--help**]
11
-[**-i**|**--interactive**[=*false*]]
12
-[**-t**|**--tty**[=*false*]]
13
-[**-u**|**--user**[=*USER*]]
14
-CONTAINER COMMAND [ARG...]
15
-
16
-# DESCRIPTION
17
-
18
-Run a process in a running container. 
19
-
20
-The command started using `docker exec` will only run while the container's primary
21
-process (`PID 1`) is running, and will not be restarted if the container is restarted.
22
-
23
-If the container is paused, then the `docker exec` command will wait until the
24
-container is unpaused, and then run
25
-
26
-# OPTIONS
27
-**-d**, **--detach**=*true*|*false*
28
-   Detached mode: run command in the background. The default is *false*.
29
-
30
-**--help**
31
-  Print usage statement
32
-
33
-**-i**, **--interactive**=*true*|*false*
34
-   Keep STDIN open even if not attached. The default is *false*.
35
-
36
-**-t**, **--tty**=*true*|*false*
37
-   Allocate a pseudo-TTY. The default is *false*.
38
-
39
-**-u**, **--user**=""
40
-   Sets the username or UID used and optionally the groupname or GID for the specified command.
41
-
42
-   The followings examples are all valid:
43
-   --user [user | user:group | uid | uid:gid | user:gid | uid:group ]
44
-
45
-   Without this argument the command will be run as root in the container.
46
-
47
-The **-t** option is incompatible with a redirection of the docker client
48
-standard input.
49
-
50
-# HISTORY
51
-November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
52 1
deleted file mode 100644
... ...
@@ -1,44 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-export - Export the contents of a filesystem as a tar archive to STDOUT
6
-
7
-# SYNOPSIS
8
-**docker export**
9
-[**--help**]
10
-CONTAINER
11
-
12
-# DESCRIPTION
13
-Export the contents of a container's filesystem using the full or shortened
14
-container ID or container name. The output is exported to STDOUT and can be
15
-redirected to a tar file.
16
-
17
-Stream to a file instead of STDOUT by using **-o**.
18
-
19
-# OPTIONS
20
-**--help**
21
-  Print usage statement
22
-**-o**, **--output**=""
23
-   Write to a file, instead of STDOUT
24
-
25
-# EXAMPLES
26
-Export the contents of the container called angry_bell to a tar file
27
-called angry_bell.tar:
28
-
29
-    # docker export angry_bell > angry_bell.tar
30
-    # docker export --output=angry_bell-latest.tar angry_bell
31
-    # ls -sh angry_bell.tar
32
-    321M angry_bell.tar
33
-    # ls -sh angry_bell-latest.tar
34
-    321M angry_bell-latest.tar
35
-
36
-# See also
37
-**docker-import(1)** to create an empty filesystem image
38
-and import the contents of the tarball into it, then optionally tag it.
39
-
40
-# HISTORY
41
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
42
-based on docker.com source material and internal work.
43
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
44
-Janurary 2015, updated by Joseph Kern (josephakern at gmail dot com)
45 1
deleted file mode 100644
... ...
@@ -1,51 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-history - Show the history of an image
6
-
7
-# SYNOPSIS
8
-**docker history**
9
-[**--help**]
10
-[**--no-trunc**[=*false*]]
11
-[**-q**|**--quiet**[=*false*]]
12
-IMAGE
13
-
14
-# DESCRIPTION
15
-
16
-Show the history of when and how an image was created.
17
-
18
-# OPTIONS
19
-**--help**
20
-  Print usage statement
21
-
22
-**-H**. **--human**=*true*|*false*
23
-    Print sizes and dates in human readable format. The default is *true*.
24
-
25
-**--no-trunc**=*true*|*false*
26
-   Don't truncate output. The default is *false*.
27
-
28
-**-q**, **--quiet**=*true*|*false*
29
-   Only show numeric IDs. The default is *false*.
30
-
31
-# EXAMPLES
32
-    $ docker history fedora
33
-    IMAGE          CREATED          CREATED BY                                      SIZE                COMMENT
34
-    105182bb5e8b   5 days ago       /bin/sh -c #(nop) ADD file:71356d2ad59aa3119d   372.7 MB
35
-    73bd853d2ea5   13 days ago      /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar   0 B
36
-    511136ea3c5a   10 months ago                                                    0 B                 Imported from -
37
-
38
-## Display comments in the image history
39
-The `docker commit` command has a **-m** flag for adding comments to the image. These comments will be displayed in the image history.
40
-
41
-    $ sudo docker history docker:scm
42
-    IMAGE               CREATED             CREATED BY                                      SIZE                COMMENT
43
-    2ac9d1098bf1        3 months ago        /bin/bash                                       241.4 MB            Added Apache to Fedora base image
44
-    88b42ffd1f7c        5 months ago        /bin/sh -c #(nop) ADD file:1fd8d7f9f6557cafc7   373.7 MB            
45
-    c69cab00d6ef        5 months ago        /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar   0 B                 
46
-    511136ea3c5a        19 months ago                                                       0 B                 Imported from -
47
-
48
-# HISTORY
49
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
50
-based on docker.com source material and internal work.
51
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
52 1
deleted file mode 100644
... ...
@@ -1,84 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-images - List images
6
-
7
-# SYNOPSIS
8
-**docker images**
9
-[**--help**]
10
-[**-a**|**--all**[=*false*]]
11
-[**--digests**[=*false*]]
12
-[**-f**|**--filter**[=*[]*]]
13
-[**--no-trunc**[=*false*]]
14
-[**-q**|**--quiet**[=*false*]]
15
-[REPOSITORY]
16
-
17
-# DESCRIPTION
18
-This command lists the images stored in the local Docker repository.
19
-
20
-By default, intermediate images, used during builds, are not listed. Some of the
21
-output, e.g., image ID, is truncated, for space reasons. However the truncated
22
-image ID, and often the first few characters, are enough to be used in other
23
-Docker commands that use the image ID. The output includes repository, tag, image
24
-ID, date created and the virtual size.
25
-
26
-The title REPOSITORY for the first title may seem confusing. It is essentially
27
-the image name. However, because you can tag a specific image, and multiple tags
28
-(image instances) can be associated with a single name, the name is really a
29
-repository for all tagged images of the same name. For example consider an image
30
-called fedora. It may be tagged with 18, 19, or 20, etc. to manage different
31
-versions.
32
-
33
-# OPTIONS
34
-**-a**, **--all**=*true*|*false*
35
-   Show all images (by default filter out the intermediate image layers). The default is *false*.
36
-
37
-**--digests**=*true*|*false*
38
-   Show image digests. The default is *false*.
39
-
40
-**-f**, **--filter**=[]
41
-   Filters the output. The dangling=true filter finds unused images. While label=com.foo=amd64 filters for images with a com.foo value of amd64. The label=com.foo filter finds images with the label com.foo of any value.
42
-
43
-**--help**
44
-  Print usage statement
45
-
46
-**--no-trunc**=*true*|*false*
47
-   Don't truncate output. The default is *false*.
48
-
49
-**-q**, **--quiet**=*true*|*false*
50
-   Only show numeric IDs. The default is *false*.
51
-
52
-# EXAMPLES
53
-
54
-## Listing the images
55
-
56
-To list the images in a local repository (not the registry) run:
57
-
58
-    docker images
59
-
60
-The list will contain the image repository name, a tag for the image, and an
61
-image ID, when it was created and its virtual size. Columns: REPOSITORY, TAG,
62
-IMAGE ID, CREATED, and VIRTUAL SIZE.
63
-
64
-To get a verbose list of images which contains all the intermediate images
65
-used in builds use **-a**:
66
-
67
-    docker images -a
68
-
69
-Previously, the docker images command supported the --tree and --dot arguments,
70
-which displayed different visualizations of the image data. Docker core removed
71
-this functionality in the 1.7 version. If you liked this functionality, you can
72
-still find it in the third-party dockviz tool: https://github.com/justone/dockviz.
73
-
74
-## Listing only the shortened image IDs
75
-
76
-Listing just the shortened image IDs. This can be useful for some automated
77
-tools.
78
-
79
-    docker images -q
80
-
81
-# HISTORY
82
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
83
-based on docker.com source material and internal work.
84
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
85 1
deleted file mode 100644
... ...
@@ -1,59 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-import - Create an empty filesystem image and import the contents of the tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it.
6
-
7
-# SYNOPSIS
8
-**docker import**
9
-[**-c**|**--change**[= []**]]
10
-[**--help**]
11
-URL|- [REPOSITORY[:TAG]]
12
-
13
-# OPTIONS
14
-**-c**, **--change**=[]
15
-   Apply specified Dockerfile instructions while importing the image
16
-   Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
17
-
18
-# DESCRIPTION
19
-Create a new filesystem image from the contents of a tarball (`.tar`,
20
-`.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it.
21
-
22
-# OPTIONS
23
-**--help**
24
-  Print usage statement
25
-
26
-# EXAMPLES
27
-
28
-## Import from a remote location
29
-
30
-    # docker import http://example.com/exampleimage.tgz example/imagerepo
31
-
32
-## Import from a local file
33
-
34
-Import to docker via pipe and stdin:
35
-
36
-    # cat exampleimage.tgz | docker import - example/imagelocal
37
-
38
-## Import from a local file and tag
39
-
40
-Import to docker via pipe and stdin:
41
-
42
-    # cat exampleimageV2.tgz | docker import - example/imagelocal:V-2.0
43
-
44
-## Import from a local directory
45
-
46
-    # tar -c . | docker import - exampleimagedir
47
-
48
-## Apply specified Dockerfile instructions while importing the image
49
-This example sets the docker image ENV variable DEBUG to true by default.
50
-
51
-    # tar -c . | docker import -c="ENV DEBUG true" - exampleimagedir
52
-
53
-# See also
54
-**docker-export(1)** to export the contents of a filesystem as a tar archive to STDOUT.
55
-
56
-# HISTORY
57
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
58
-based on docker.com source material and internal work.
59
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
60 1
deleted file mode 100644
... ...
@@ -1,49 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-info - Display system-wide information
6
-
7
-# SYNOPSIS
8
-**docker info**
9
-[**--help**]
10
-
11
-
12
-# DESCRIPTION
13
-This command displays system wide information regarding the Docker installation.
14
-Information displayed includes the number of containers and images, pool name,
15
-data file, metadata file, data space used, total data space, metadata space used
16
-, total metadata space, execution driver, and the kernel version.
17
-
18
-The data file is where the images are stored and the metadata file is where the
19
-meta data regarding those images are stored. When run for the first time Docker
20
-allocates a certain amount of data space and meta data space from the space
21
-available on the volume where `/var/lib/docker` is mounted.
22
-
23
-# OPTIONS
24
-**--help**
25
-  Print usage statement
26
-
27
-# EXAMPLES
28
-
29
-## Display Docker system information
30
-
31
-Here is a sample output:
32
-
33
-    # docker info
34
-    Containers: 14
35
-    Images: 52
36
-    Storage Driver: aufs
37
-     Root Dir: /var/lib/docker/aufs
38
-     Dirs: 80
39
-    Execution Driver: native-0.2
40
-    Logging Driver: json-file
41
-    Kernel Version: 3.13.0-24-generic
42
-    Operating System: Ubuntu 14.04 LTS
43
-    CPUs: 1
44
-    Total Memory: 2 GiB
45
-
46
-# HISTORY
47
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
48
-based on docker.com source material and internal work.
49
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
50 1
deleted file mode 100644
... ...
@@ -1,270 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-inspect - Return low-level information on a container or image
6
-
7
-# SYNOPSIS
8
-**docker inspect**
9
-[**--help**]
10
-[**-f**|**--format**[=*FORMAT*]]
11
-CONTAINER|IMAGE [CONTAINER|IMAGE...]
12
-
13
-# DESCRIPTION
14
-
15
-This displays all the information available in Docker for a given
16
-container or image. By default, this will render all results in a JSON
17
-array. If a format is specified, the given template will be executed for
18
-each result.
19
-
20
-# OPTIONS
21
-**--help**
22
-    Print usage statement
23
-
24
-**-f**, **--format**=""
25
-    Format the output using the given go template.
26
-
27
-# EXAMPLES
28
-
29
-## Getting information on a container
30
-
31
-To get information on a container use its ID or instance name:
32
-
33
-    $ docker inspect 1eb5fabf5a03
34
-    [{
35
-        "AppArmorProfile": "",
36
-        "Args": [],
37
-        "Config": {
38
-            "AttachStderr": false,
39
-            "AttachStdin": false,
40
-            "AttachStdout": false,
41
-            "Cmd": [
42
-                "/usr/sbin/nginx"
43
-            ],
44
-            "Domainname": "",
45
-            "Entrypoint": null,
46
-            "Env": [
47
-                "HOME=/",
48
-                "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
49
-            ],
50
-            "ExposedPorts": {
51
-                "80/tcp": {}
52
-            },
53
-            "Hostname": "1eb5fabf5a03",
54
-            "Image": "summit/nginx",
55
-            "Labels": {
56
-                "com.example.vendor": "Acme",
57
-                "com.example.license": "GPL",
58
-                "com.example.version": "1.0"
59
-            },
60
-            "MacAddress": "",
61
-            "NetworkDisabled": false,
62
-            "OnBuild": null,
63
-            "OpenStdin": false,
64
-            "PortSpecs": null,
65
-            "StdinOnce": false,
66
-            "Tty": true,
67
-            "User": "",
68
-            "Volumes": null,
69
-            "WorkingDir": "",
70
-        },
71
-        "Created": "2014-04-04T21:33:52.02361335Z",
72
-        "Driver": "devicemapper",
73
-        "ExecDriver": "native-0.1",
74
-        "ExecIDs": null,
75
-        "HostConfig": {
76
-            "Binds": null,
77
-            "CapAdd": null,
78
-            "CapDrop": null,
79
-            "CgroupParent": "",
80
-            "ContainerIDFile": "",
81
-            "CpuShares": 512,
82
-            "CpusetCpus": "0,1",
83
-            "CpusetMems": "",
84
-            "Devices": [],
85
-            "Dns": null,
86
-            "DnsSearch": null,
87
-            "ExtraHosts": null,
88
-            "IpcMode": "",
89
-            "Links": null,
90
-            "LogConfig": {
91
-                "Config": null,
92
-                "Type": "json-file"
93
-            },
94
-            "LxcConf": null,
95
-            "Memory": 16777216,
96
-            "MemorySwap": -1,
97
-            "NetworkMode": "",
98
-            "PidMode": "",
99
-            "PortBindings": {
100
-                "80/tcp": [
101
-                    {
102
-                        "HostIp": "0.0.0.0",
103
-                        "HostPort": "80"
104
-                    }
105
-                ]
106
-            },
107
-            "Privileged": false,
108
-            "PublishAllPorts": false,
109
-            "ReadonlyRootfs": false,
110
-            "RestartPolicy": {
111
-                "MaximumRetryCount": 0,
112
-                "Name": ""
113
-            },
114
-            "SecurityOpt": null,
115
-            "Ulimits": null,
116
-            "VolumesFrom": null
117
-        }
118
-        "HostnamePath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/hostname",
119
-        "HostsPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/hosts",
120
-        "ID": "1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b",
121
-        "Image": "df53773a4390e25936f9fd3739e0c0e60a62d024ea7b669282b27e65ae8458e6",
122
-        "LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log",
123
-        "MountLabel": "",
124
-        "Name": "/ecstatic_ptolemy",
125
-        "NetworkSettings": {
126
-            "Bridge": "docker0",
127
-            "Gateway": "172.17.42.1",
128
-            "GlobalIPv6Address": "",
129
-            "GlobalIPv6PrefixLen": 0,
130
-            "IPAddress": "172.17.0.2",
131
-            "IPPrefixLen": 16,
132
-            "IPv6Gateway": "",
133
-            "LinkLocalIPv6Address": "",
134
-            "LinkLocalIPv6PrefixLen": 0,
135
-            "MacAddress": "",
136
-            "PortMapping": null,
137
-            "Ports": {
138
-                "80/tcp": [
139
-                    {
140
-                        "HostIp": "0.0.0.0",
141
-                        "HostPort": "80"
142
-                    }
143
-                ]
144
-            }
145
-        },
146
-        "Path": "/usr/sbin/nginx",
147
-        "ProcessLabel": "",
148
-        "ResolvConfPath": "/etc/resolv.conf",
149
-        "RestartCount": 0,
150
-        "State": {
151
-            "Dead": false,
152
-            "Error": "",
153
-            "ExitCode": 0,
154
-            "FinishedAt": "0001-01-01T00:00:00Z",
155
-            "OOMKilled": false,
156
-            "Paused": false,
157
-            "Pid": 858,
158
-            "Restarting": false,
159
-            "Running": true,
160
-            "StartedAt": "2014-04-04T21:33:54.16259207Z",
161
-        },
162
-        "Volumes": {},
163
-        "VolumesRW": {},
164
-    }
165
-
166
-## Getting the IP address of a container instance
167
-
168
-To get the IP address of a container use:
169
-
170
-    $ docker inspect --format='{{.NetworkSettings.IPAddress}}' 1eb5fabf5a03
171
-    172.17.0.2
172
-
173
-## Listing all port bindings
174
-
175
-One can loop over arrays and maps in the results to produce simple text
176
-output:
177
-
178
-    $ docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} \
179
-      {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' 1eb5fabf5a03
180
-      80/tcp -> 80
181
-
182
-You can get more information about how to write a go template from:
183
-http://golang.org/pkg/text/template/.
184
-
185
-## Getting information on an image
186
-
187
-Use an image's ID or name (e.g., repository/name[:tag]) to get information
188
-on it.
189
-
190
-    $ docker inspect fc1203419df2
191
-    [{
192
-        "Architecture": "amd64",
193
-        "Author": "",
194
-        "Comment": "",
195
-        "Config": {
196
-            "AttachStderr": false,
197
-            "AttachStdin": false,
198
-            "AttachStdout": false,
199
-            "Cmd": [
200
-                "make",
201
-                "direct-test"
202
-            ],
203
-            "Domainname": "",
204
-            "Entrypoint": [
205
-                "/dind"
206
-            ],
207
-            "Env": [
208
-                "PATH=/go/bin:/usr/src/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
209
-            ],
210
-            "ExposedPorts": null,
211
-            "Hostname": "242978536a06",
212
-            "Image": "c2b774c744afc5bea603b5e6c5218539e506649326de3ea0135182f299d0519a",
213
-            "Labels": {},
214
-            "MacAddress": "",
215
-            "NetworkDisabled": false,
216
-            "OnBuild": [],
217
-            "OpenStdin": false,
218
-            "PortSpecs": null,
219
-            "StdinOnce": false,
220
-            "Tty": false,
221
-            "User": "",
222
-            "Volumes": null,
223
-            "WorkingDir": "/go/src/github.com/docker/libcontainer"
224
-        },
225
-        "Container": "1c00417f3812a96d3ebc29e7fdee69f3d586d703ab89c8233fd4678d50707b39",
226
-        "ContainerConfig": {
227
-            "AttachStderr": false,
228
-            "AttachStdin": false,
229
-            "AttachStdout": false,
230
-            "Cmd": [
231
-                "/bin/sh",
232
-                "-c",
233
-                "#(nop) CMD [\"make\" \"direct-test\"]"
234
-            ],
235
-            "Domainname": "",
236
-            "Entrypoint": [
237
-                "/dind"
238
-            ],
239
-            "Env": [
240
-                "PATH=/go/bin:/usr/src/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
241
-            ],
242
-            "ExposedPorts": null,
243
-            "Hostname": "242978536a06",
244
-            "Image": "c2b774c744afc5bea603b5e6c5218539e506649326de3ea0135182f299d0519a",
245
-            "Labels": {},
246
-            "MacAddress": "",
247
-            "NetworkDisabled": false,
248
-            "OnBuild": [],
249
-            "OpenStdin": false,
250
-            "PortSpecs": null,
251
-            "StdinOnce": false,
252
-            "Tty": false,
253
-            "User": "",
254
-            "Volumes": null,
255
-            "WorkingDir": "/go/src/github.com/docker/libcontainer"
256
-        },
257
-        "Created": "2015-04-07T05:34:39.079489206Z",
258
-        "DockerVersion": "1.5.0-dev",
259
-        "Id": "fc1203419df26ca82cad1dd04c709cb1b8a8a947bd5bcbdfbef8241a76f031db",
260
-        "Os": "linux",
261
-        "Parent": "c2b774c744afc5bea603b5e6c5218539e506649326de3ea0135182f299d0519a",
262
-        "Size": 0,
263
-        "VirtualSize": 613136466
264
-    }]
265
-
266
-# HISTORY
267
-April 2014, originally compiled by William Henry (whenry at redhat dot com)
268
-based on docker.com source material and internal work.
269
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
270
-April 2015, updated by Qiang Huang <h.huangqiang@huawei.com>
271 1
deleted file mode 100644
... ...
@@ -1,28 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-kill - Kill a running container using SIGKILL or a specified signal
6
-
7
-# SYNOPSIS
8
-**docker kill**
9
-[**--help**]
10
-[**-s**|**--signal**[=*"KILL"*]]
11
-CONTAINER [CONTAINER...]
12
-
13
-# DESCRIPTION
14
-
15
-The main process inside each container specified will be sent SIGKILL,
16
- or any signal specified with option --signal.
17
-
18
-# OPTIONS
19
-**--help**
20
-  Print usage statement
21
-
22
-**-s**, **--signal**="KILL"
23
-   Signal to send to the container
24
-
25
-# HISTORY
26
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
27
- based on docker.com source material and internal work.
28
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
29 1
deleted file mode 100644
... ...
@@ -1,45 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-load - Load an image from a tar archive on STDIN
6
-
7
-# SYNOPSIS
8
-**docker load**
9
-[**--help**]
10
-[**-i**|**--input**[=*INPUT*]]
11
-
12
-
13
-# DESCRIPTION
14
-
15
-Loads a tarred repository from a file or the standard input stream.
16
-Restores both images and tags.
17
-
18
-# OPTIONS
19
-**--help**
20
-  Print usage statement
21
-
22
-**-i**, **--input**=""
23
-   Read from a tar archive file, instead of STDIN
24
-
25
-# EXAMPLES
26
-
27
-    $ docker images
28
-    REPOSITORY          TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
29
-    busybox             latest              769b9341d937        7 weeks ago         2.489 MB
30
-    $ docker load --input fedora.tar
31
-    $ docker images
32
-    REPOSITORY          TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
33
-    busybox             latest              769b9341d937        7 weeks ago         2.489 MB
34
-    fedora              rawhide             0d20aec6529d        7 weeks ago         387 MB
35
-    fedora              20                  58394af37342        7 weeks ago         385.5 MB
36
-    fedora              heisenbug           58394af37342        7 weeks ago         385.5 MB
37
-    fedora              latest              58394af37342        7 weeks ago         385.5 MB
38
-
39
-# See also
40
-**docker-save(1)** to save an image(s) to a tar archive (streamed to STDOUT by default).
41
-
42
-# HISTORY
43
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
44
-based on docker.com source material and internal work.
45
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
46 1
deleted file mode 100644
... ...
@@ -1,51 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-login - Register or log in to a Docker registry. 
6
-
7
-# SYNOPSIS
8
-**docker login**
9
-[**-e**|**--email**[=*EMAIL*]]
10
-[**--help**]
11
-[**-p**|**--password**[=*PASSWORD*]]
12
-[**-u**|**--username**[=*USERNAME*]]
13
-[SERVER]
14
-
15
-# DESCRIPTION
16
-Register or log in to a Docker Registry located on the specified
17
-`SERVER`.  You can specify a URL or a `hostname` for the `SERVER` value. If you
18
-do not specify a `SERVER`, the command uses Docker's public registry located at
19
-`https://registry-1.docker.io/` by default.  To get a username/password for Docker's public registry, create an account on Docker Hub.
20
-
21
-You can log into any public or private repository for which you have
22
-credentials.  When you log in, the command stores encoded credentials in
23
-`$HOME/.dockercfg` on Linux or `%USERPROFILE%/.dockercfg` on Windows.
24
-
25
-# OPTIONS
26
-**-e**, **--email**=""
27
-   Email
28
-
29
-**--help**
30
-  Print usage statement
31
-
32
-**-p**, **--password**=""
33
-   Password
34
-
35
-**-u**, **--username**=""
36
-   Username
37
-
38
-# EXAMPLES
39
-
40
-## Login to a registry on your localhost
41
-
42
-    # docker login localhost:8080
43
-
44
-# See also
45
-**docker-logout(1)** to log out from a Docker registry.
46
-
47
-# HISTORY
48
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
49
-based on docker.com source material and internal work.
50
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
51
-April 2015, updated by Mary Anthony for v2 <mary@docker.com>
52 1
deleted file mode 100644
... ...
@@ -1,32 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-logout - Log out from a Docker Registry.
6
-
7
-# SYNOPSIS
8
-**docker logout**
9
-[SERVER]
10
-
11
-# DESCRIPTION
12
-Log out of a Docker Registry located on the specified `SERVER`. You can
13
-specify a URL or a `hostname` for the `SERVER` value. If you do not specify a
14
-`SERVER`, the command attempts to log you out of Docker's public registry
15
-located at `https://registry-1.docker.io/` by default.  
16
-
17
-# OPTIONS
18
-There are no available options.
19
-
20
-# EXAMPLES
21
-
22
-## Log out from a registry on your localhost
23
-
24
-    # docker logout localhost:8080
25
-
26
-# See also
27
-**docker-login(1)** to register or log in to a Docker registry server.
28
-
29
-# HISTORY
30
-June 2014, Originally compiled by Daniel, Dao Quang Minh (daniel at nitrous dot io)
31
-July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
32
-April 2015, updated by Mary Anthony for v2 <mary@docker.com>
33 1
deleted file mode 100644
... ...
@@ -1,49 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-logs - Fetch the logs of a container
6
-
7
-# SYNOPSIS
8
-**docker logs**
9
-[**-f**|**--follow**[=*false*]]
10
-[**--help**]
11
-[**--since**[=*SINCE*]]
12
-[**-t**|**--timestamps**[=*false*]]
13
-[**--tail**[=*"all"*]]
14
-CONTAINER
15
-
16
-# DESCRIPTION
17
-The **docker logs** command batch-retrieves whatever logs are present for
18
-a container at the time of execution. This does not guarantee execution
19
-order when combined with a docker run (i.e., your run may not have generated
20
-any logs at the time you execute docker logs).
21
-
22
-The **docker logs --follow** command combines commands **docker logs** and
23
-**docker attach**. It will first return all logs from the beginning and
24
-then continue streaming new output from the container’s stdout and stderr.
25
-
26
-**Warning**: This command works only for **json-file** logging driver.
27
-
28
-# OPTIONS
29
-**--help**
30
-  Print usage statement
31
-
32
-**-f**, **--follow**=*true*|*false*
33
-   Follow log output. The default is *false*.
34
-
35
-**--since**=""
36
-   Show logs since timestamp
37
-
38
-**-t**, **--timestamps**=*true*|*false*
39
-   Show timestamps. The default is *false*.
40
-
41
-**--tail**="all"
42
-   Output the specified number of lines at the end of logs (defaults to all logs)
43
-
44
-# HISTORY
45
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
46
-based on docker.com source material and internal work.
47
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
48
-July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
49
-April 2015, updated by Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
50 1
deleted file mode 100644
... ...
@@ -1,30 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-pause - Pause all processes within a container
6
-
7
-# SYNOPSIS
8
-**docker pause**
9
-CONTAINER [CONTAINER...]
10
-
11
-# DESCRIPTION
12
-
13
-The `docker pause` command uses the cgroups freezer to suspend all processes in
14
-a container.  Traditionally when suspending a process the `SIGSTOP` signal is
15
-used, which is observable by the process being suspended. With the cgroups freezer
16
-the process is unaware, and unable to capture, that it is being suspended,
17
-and subsequently resumed.
18
-
19
-See the [cgroups freezer documentation]
20
-(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for
21
-further details.
22
-
23
-# OPTIONS
24
-There are no available options.
25
-
26
-# See also
27
-**docker-unpause(1)** to unpause all processes within a container.
28
-
29
-# HISTORY
30
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
31 1
deleted file mode 100644
... ...
@@ -1,39 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-port - List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT
6
-
7
-# SYNOPSIS
8
-**docker port**
9
-[**--help**]
10
-CONTAINER [PRIVATE_PORT[/PROTO]]
11
-
12
-# DESCRIPTION
13
-List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT
14
-
15
-# OPTIONS
16
-**--help**
17
-  Print usage statement
18
-
19
-# EXAMPLES
20
-You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or
21
-ask for just a specific mapping:
22
-
23
-    $ docker ps test
24
-    CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS                                            NAMES
25
-    b650456536c7        busybox:latest      top                 54 minutes ago      Up 54 minutes       0.0.0.0:1234->9876/tcp, 0.0.0.0:4321->7890/tcp   test
26
-    $ docker port test
27
-    7890/tcp -> 0.0.0.0:4321
28
-    9876/tcp -> 0.0.0.0:1234
29
-    $ docker port test 7890/tcp
30
-    0.0.0.0:4321
31
-    $ docker port test 7890/udp
32
-    2014/06/24 11:53:36 Error: No public port '7890/udp' published for test
33
-    $ docker port test 7890
34
-    0.0.0.0:4321
35
-
36
-# HISTORY
37
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
38
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
39
-November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
40 1
deleted file mode 100644
... ...
@@ -1,91 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% FEBRUARY 2015
4
-# NAME
5
-docker-ps - List containers
6
-
7
-# SYNOPSIS
8
-**docker ps**
9
-[**-a**|**--all**[=*false*]]
10
-[**--before**[=*BEFORE*]]
11
-[**--help**]
12
-[**-f**|**--filter**[=*[]*]]
13
-[**-l**|**--latest**[=*false*]]
14
-[**-n**[=*-1*]]
15
-[**--no-trunc**[=*false*]]
16
-[**-q**|**--quiet**[=*false*]]
17
-[**-s**|**--size**[=*false*]]
18
-[**--since**[=*SINCE*]]
19
-
20
-
21
-# DESCRIPTION
22
-
23
-List the containers in the local repository. By default this show only
24
-the running containers.
25
-
26
-# OPTIONS
27
-**-a**, **--all**=*true*|*false*
28
-   Show all containers. Only running containers are shown by default. The default is *false*.
29
-
30
-**--before**=""
31
-   Show only container created before Id or Name, include non-running ones.
32
-
33
-**--help**
34
-  Print usage statement
35
-
36
-**-f**, **--filter**=[]
37
-   Provide filter values. Valid filters:
38
-                          exited=<int> - containers with exit code of <int>
39
-                          label=<key> or label=<key>=<value>
40
-                          status=(restarting|running|paused|exited)
41
-                          name=<string> - container's name
42
-                          id=<ID> - container's ID
43
-
44
-**-l**, **--latest**=*true*|*false*
45
-   Show only the latest created container, include non-running ones. The default is *false*.
46
-
47
-**-n**=-1
48
-   Show n last created containers, include non-running ones.
49
-
50
-**--no-trunc**=*true*|*false*
51
-   Don't truncate output. The default is *false*.
52
-
53
-**-q**, **--quiet**=*true*|*false*
54
-   Only display numeric IDs. The default is *false*.
55
-
56
-**-s**, **--size**=*true*|*false*
57
-   Display total file sizes. The default is *false*.
58
-
59
-**--since**=""
60
-   Show only containers created since Id or Name, include non-running ones.
61
-
62
-# EXAMPLES
63
-# Display all containers, including non-running
64
-
65
-    # docker ps -a
66
-    CONTAINER ID        IMAGE                 COMMAND                CREATED             STATUS      PORTS    NAMES
67
-    a87ecb4f327c        fedora:20             /bin/sh -c #(nop) MA   20 minutes ago      Exit 0               desperate_brattain
68
-    01946d9d34d8        vpavlin/rhel7:latest  /bin/sh -c #(nop) MA   33 minutes ago      Exit 0               thirsty_bell
69
-    c1d3b0166030        acffc0358b9e          /bin/sh -c yum -y up   2 weeks ago         Exit 1               determined_torvalds
70
-    41d50ecd2f57        fedora:20             /bin/sh -c #(nop) MA   2 weeks ago         Exit 0               drunk_pike
71
-
72
-# Display only IDs of all containers, including non-running
73
-
74
-    # docker ps -a -q
75
-    a87ecb4f327c
76
-    01946d9d34d8
77
-    c1d3b0166030
78
-    41d50ecd2f57
79
-
80
-# Display only IDs of all containers that have the name `determined_torvalds`
81
-
82
-    # docker ps -a -q --filter=name=determined_torvalds
83
-    c1d3b0166030
84
-
85
-# HISTORY
86
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
87
-based on docker.com source material and internal work.
88
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
89
-August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
90
-November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
91
-February 2015, updated by André Martins <martins@noironetworks.com>
92 1
deleted file mode 100644
... ...
@@ -1,73 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-pull - Pull an image or a repository from a registry
6
-
7
-# SYNOPSIS
8
-**docker pull**
9
-[**-a**|**--all-tags**[=*false*]]
10
-[**--help**] 
11
-NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
12
-
13
-# DESCRIPTION
14
-
15
-This command pulls down an image or a repository from a registry. If
16
-there is more than one image for a repository (e.g., fedora) then all
17
-images for that repository name are pulled down including any tags.
18
-
19
-If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
20
-registry located at `registry-1.docker.io` by default. 
21
-
22
-# OPTIONS
23
-**-a**, **--all-tags**=*true*|*false*
24
-   Download all tagged images in the repository. The default is *false*.
25
-**--help**
26
-  Print usage statement
27
-
28
-# EXAMPLE
29
-
30
-# Pull a repository with multiple images
31
-# Note that if the  image is previously downloaded then the status would be
32
-# 'Status: Image is up to date for fedora'
33
-
34
-    $ docker pull fedora
35
-    Pulling repository fedora
36
-    ad57ef8d78d7: Download complete
37
-    105182bb5e8b: Download complete
38
-    511136ea3c5a: Download complete
39
-    73bd853d2ea5: Download complete
40
-
41
-    Status: Downloaded newer image for fedora
42
-
43
-    $ docker images
44
-    REPOSITORY   TAG         IMAGE ID        CREATED      VIRTUAL SIZE
45
-    fedora       rawhide     ad57ef8d78d7    5 days ago   359.3 MB
46
-    fedora       20          105182bb5e8b    5 days ago   372.7 MB
47
-    fedora       heisenbug   105182bb5e8b    5 days ago   372.7 MB
48
-    fedora       latest      105182bb5e8b    5 days ago   372.7 MB
49
-
50
-# Pull an image, manually specifying path to Docker's public registry and tag
51
-# Note that if the  image is previously downloaded then the status would be
52
-# 'Status: Image is up to date for registry.hub.docker.com/fedora:20'
53
-
54
-    $ docker pull registry.hub.docker.com/fedora:20
55
-    Pulling repository fedora
56
-    3f2fed40e4b0: Download complete 
57
-    511136ea3c5a: Download complete 
58
-    fd241224e9cf: Download complete 
59
-
60
-    Status: Downloaded newer image for registry.hub.docker.com/fedora:20
61
-
62
-    $ docker images
63
-    REPOSITORY   TAG         IMAGE ID        CREATED      VIRTUAL SIZE
64
-    fedora       20          3f2fed40e4b0    4 days ago   372.7 MB
65
-
66
-
67
-# HISTORY
68
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
69
-based on docker.com source material and internal work.
70
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
71
-August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
72
-April 2015, updated by John Willis <john.willis@docker.com>
73
-April 2015, updated by Mary Anthony for v2 <mary@docker.com>
74 1
deleted file mode 100644
... ...
@@ -1,51 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-push - Push an image or a repository to a registry
6
-
7
-# SYNOPSIS
8
-**docker push**
9
-[**--help**]
10
-NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
11
-
12
-# DESCRIPTION
13
-
14
-This command pushes an image or a repository to a registry. If you do not
15
-specify a `REGISTRY_HOST`, the command uses Docker's public registry located at
16
-`registry-1.docker.io` by default. 
17
-
18
-# OPTIONS
19
-**--help**
20
-  Print usage statement
21
-
22
-# EXAMPLES
23
-
24
-# Pushing a new image to a registry
25
-
26
-First save the new image by finding the container ID (using **docker ps**)
27
-and then committing it to a new image name:
28
-
29
-    # docker commit c16378f943fe rhel-httpd
30
-
31
-Now, push the image to the registry using the image ID. In this example the
32
-registry is on host named `registry-host` and listening on port `5000`. To do
33
-this, tag the image with the host name or IP address, and the port of the
34
-registry:
35
-
36
-    # docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd
37
-    # docker push registry-host:5000/myadmin/rhel-httpd
38
-
39
-Check that this worked by running:
40
-
41
-    # docker images
42
-
43
-You should see both `rhel-httpd` and `registry-host:5000/myadmin/rhel-httpd`
44
-listed.
45
-
46
-# HISTORY
47
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
48
-based on docker.com source material and internal work.
49
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
50
-April 2015, updated by Mary Anthony for v2 <mary@docker.com>
51
-
52 1
deleted file mode 100644
... ...
@@ -1,13 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% OCTOBER 2014
4
-# NAME
5
-docker-rename - Rename a container
6
-
7
-# SYNOPSIS
8
-**docker rename**
9
-OLD_NAME NEW_NAME
10
-
11
-# OPTIONS
12
-There are no available options.
13
-
14 1
deleted file mode 100644
... ...
@@ -1,26 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-restart - Restart a running container
6
-
7
-# SYNOPSIS
8
-**docker restart**
9
-[**--help**]
10
-[**-t**|**--time**[=*10*]]
11
-CONTAINER [CONTAINER...]
12
-
13
-# DESCRIPTION
14
-Restart each container listed.
15
-
16
-# OPTIONS
17
-**--help**
18
-  Print usage statement
19
-
20
-**-t**, **--time**=10
21
-   Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.
22
-
23
-# HISTORY
24
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
25
-based on docker.com source material and internal work.
26
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
27 1
deleted file mode 100644
... ...
@@ -1,56 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-rm - Remove one or more containers
6
-
7
-# SYNOPSIS
8
-**docker rm**
9
-[**-f**|**--force**[=*false*]]
10
-[**-l**|**--link**[=*false*]]
11
-[**-v**|**--volumes**[=*false*]]
12
-CONTAINER [CONTAINER...]
13
-
14
-# DESCRIPTION
15
-
16
-**docker rm** will remove one or more containers from the host node. The
17
-container name or ID can be used. This does not remove images. You cannot
18
-remove a running container unless you use the \fB-f\fR option. To see all
19
-containers on a host use the **docker ps -a** command.
20
-
21
-# OPTIONS
22
-**--help**
23
-  Print usage statement
24
-
25
-**-f**, **--force**=*true*|*false*
26
-   Force the removal of a running container (uses SIGKILL). The default is *false*.
27
-
28
-**-l**, **--link**=*true*|*false*
29
-   Remove the specified link and not the underlying container. The default is *false*.
30
-
31
-**-v**, **--volumes**=*true*|*false*
32
-   Remove the volumes associated with the container. The default is *false*.
33
-
34
-# EXAMPLES
35
-
36
-##Removing a container using its ID##
37
-
38
-To remove a container using its ID, find either from a **docker ps -a**
39
-command, or use the ID returned from the **docker run** command, or retrieve
40
-it from a file used to store it using the **docker run --cidfile**:
41
-
42
-    docker rm abebf7571666
43
-
44
-##Removing a container using the container name##
45
-
46
-The name of the container can be found using the **docker ps -a**
47
-command. The use that name as follows:
48
-
49
-    docker rm hopeful_morse
50
-
51
-# HISTORY
52
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
53
-based on docker.com source material and internal work.
54
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
55
-July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
56
-August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
57 1
deleted file mode 100644
... ...
@@ -1,42 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-rmi - Remove one or more images
6
-
7
-# SYNOPSIS
8
-**docker rmi**
9
-[**-f**|**--force**[=*false*]]
10
-[**--help**]
11
-[**--no-prune**[=*false*]]
12
-IMAGE [IMAGE...]
13
-
14
-# DESCRIPTION
15
-
16
-Removes one or more images from the host node. This does not remove images from
17
-a registry. You cannot remove an image of a running container unless you use the
18
-**-f** option. To see all images on a host use the **docker images** command.
19
-
20
-# OPTIONS
21
-**-f**, **--force**=*true*|*false*
22
-   Force removal of the image. The default is *false*.
23
-
24
-**--help**
25
-  Print usage statement
26
-
27
-**--no-prune**=*true*|*false*
28
-   Do not delete untagged parents. The default is *false*.
29
-
30
-# EXAMPLES
31
-
32
-## Removing an image
33
-
34
-Here is an example of removing and image:
35
-
36
-    docker rmi fedora/httpd
37
-
38
-# HISTORY
39
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
40
-based on docker.com source material and internal work.
41
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
42
-April 2015, updated by Mary Anthony for v2 <mary@docker.com>
43 1
deleted file mode 100644
... ...
@@ -1,658 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-run - Run a command in a new container
6
-
7
-# SYNOPSIS
8
-**docker run**
9
-[**-a**|**--attach**[=*[]*]]
10
-[**--add-host**[=*[]*]]
11
-[**--blkio-weight**[=*[BLKIO-WEIGHT]*]]
12
-[**-c**|**--cpu-shares**[=*0*]]
13
-[**--cap-add**[=*[]*]]
14
-[**--cap-drop**[=*[]*]]
15
-[**--cidfile**[=*CIDFILE*]]
16
-[**--cpu-period**[=*0*]]
17
-[**--cpuset-cpus**[=*CPUSET-CPUS*]]
18
-[**--cpuset-mems**[=*CPUSET-MEMS*]]
19
-[**-d**|**--detach**[=*false*]]
20
-[**--cpu-quota**[=*0*]]
21
-[**--device**[=*[]*]]
22
-[**--dns-search**[=*[]*]]
23
-[**--dns**[=*[]*]]
24
-[**-e**|**--env**[=*[]*]]
25
-[**--entrypoint**[=*ENTRYPOINT*]]
26
-[**--env-file**[=*[]*]]
27
-[**--expose**[=*[]*]]
28
-[**-h**|**--hostname**[=*HOSTNAME*]]
29
-[**--help**]
30
-[**-i**|**--interactive**[=*false*]]
31
-[**--ipc**[=*IPC*]]
32
-[**-l**|**--label**[=*[]*]]
33
-[**--label-file**[=*[]*]]
34
-[**--link**[=*[]*]]
35
-[**--lxc-conf**[=*[]*]]
36
-[**--log-driver**[=*[]*]]
37
-[**--log-opt**[=*[]*]]
38
-[**-m**|**--memory**[=*MEMORY*]]
39
-[**--memory-swap**[=*MEMORY-SWAP*]]
40
-[**--mac-address**[=*MAC-ADDRESS*]]
41
-[**--name**[=*NAME*]]
42
-[**--net**[=*"bridge"*]]
43
-[**--oom-kill-disable**[=*false*]]
44
-[**-P**|**--publish-all**[=*false*]]
45
-[**-p**|**--publish**[=*[]*]]
46
-[**--pid**[=*[]*]]
47
-[**--uts**[=*[]*]]
48
-[**--privileged**[=*false*]]
49
-[**--read-only**[=*false*]]
50
-[**--restart**[=*RESTART*]]
51
-[**--rm**[=*false*]]
52
-[**--security-opt**[=*[]*]]
53
-[**--sig-proxy**[=*true*]]
54
-[**-t**|**--tty**[=*false*]]
55
-[**-u**|**--user**[=*USER*]]
56
-[**-v**|**--volume**[=*[]*]]
57
-[**--volumes-from**[=*[]*]]
58
-[**-w**|**--workdir**[=*WORKDIR*]]
59
-[**--cgroup-parent**[=*CGROUP-PATH*]]
60
-IMAGE [COMMAND] [ARG...]
61
-
62
-# DESCRIPTION
63
-
64
-Run a process in a new container. **docker run** starts a process with its own
65
-file system, its own networking, and its own isolated process tree. The IMAGE
66
-which starts the process may define defaults related to the process that will be
67
-run in the container, the networking to expose, and more, but **docker run**
68
-gives final control to the operator or administrator who starts the container
69
-from the image. For that reason **docker run** has more options than any other
70
-Docker command.
71
-
72
-If the IMAGE is not already loaded then **docker run** will pull the IMAGE, and
73
-all image dependencies, from the repository in the same way running **docker
74
-pull** IMAGE, before it starts the container from that image.
75
-
76
-# OPTIONS
77
-**-a**, **--attach**=[]
78
-   Attach to STDIN, STDOUT or STDERR.
79
-
80
-   In foreground mode (the default when **-d**
81
-is not specified), **docker run** can start the process in the container
82
-and attach the console to the process’s standard input, output, and standard
83
-error. It can even pretend to be a TTY (this is what most commandline
84
-executables expect) and pass along signals. The **-a** option can be set for
85
-each of stdin, stdout, and stderr.
86
-
87
-**--add-host**=[]
88
-   Add a custom host-to-IP mapping (host:ip)
89
-
90
-   Add a line to /etc/hosts. The format is hostname:ip.  The **--add-host**
91
-option can be set multiple times.
92
-
93
-**--blkio-weight**=0
94
-   Block IO weight (relative weight) accepts a weight value between 10 and 1000.
95
-
96
-**-c**, **--cpu-shares**=0
97
-   CPU shares (relative weight)
98
-
99
-   By default, all containers get the same proportion of CPU cycles. This proportion
100
-can be modified by changing the container's CPU share weighting relative
101
-to the weighting of all other running containers.
102
-
103
-To modify the proportion from the default of 1024, use the **-c** or **--cpu-shares**
104
-flag to set the weighting to 2 or higher.
105
-
106
-The proportion will only apply when CPU-intensive processes are running.
107
-When tasks in one container are idle, other containers can use the
108
-left-over CPU time. The actual amount of CPU time will vary depending on
109
-the number of containers running on the system.
110
-
111
-For example, consider three containers, one has a cpu-share of 1024 and
112
-two others have a cpu-share setting of 512. When processes in all three
113
-containers attempt to use 100% of CPU, the first container would receive
114
-50% of the total CPU time. If you add a fourth container with a cpu-share
115
-of 1024, the first container only gets 33% of the CPU. The remaining containers
116
-receive 16.5%, 16.5% and 33% of the CPU.
117
-
118
-On a multi-core system, the shares of CPU time are distributed over all CPU
119
-cores. Even if a container is limited to less than 100% of CPU time, it can
120
-use 100% of each individual CPU core.
121
-
122
-For example, consider a system with more than three cores. If you start one
123
-container **{C0}** with **-c=512** running one process, and another container
124
-**{C1}** with **-c=1024** running two processes, this can result in the following
125
-division of CPU shares:
126
-
127
-    PID    container	CPU	CPU share
128
-    100    {C0}		0	100% of CPU0
129
-    101    {C1}		1	100% of CPU1
130
-    102    {C1}		2	100% of CPU2
131
-
132
-**--cap-add**=[]
133
-   Add Linux capabilities
134
-
135
-**--cap-drop**=[]
136
-   Drop Linux capabilities
137
-
138
-**--cgroup-parent**=""
139
-   Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
140
-
141
-**--cidfile**=""
142
-   Write the container ID to the file
143
-
144
-**--cpu-period**=0
145
-   Limit the CPU CFS (Completely Fair Scheduler) period
146
-
147
-   Limit the container's CPU usage. This flag tell the kernel to restrict the container's CPU usage to the period you specify.
148
-
149
-**--cpuset-cpus**=""
150
-   CPUs in which to allow execution (0-3, 0,1)
151
-
152
-**--cpuset-mems**=""
153
-   Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
154
-
155
-   If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
156
-then processes in your Docker container will only use memory from the first
157
-two memory nodes.
158
-
159
-**--cpu-quota**=0
160
-   Limit the CPU CFS (Completely Fair Scheduler) quota
161
-
162
-   Limit the container's CPU usage. By default, containers run with the full
163
-CPU resource. This flag tell the kernel to restrict the container's CPU usage
164
-to the quota you specify.
165
-
166
-**-d**, **--detach**=*true*|*false*
167
-   Detached mode: run the container in the background and print the new container ID. The default is *false*.
168
-
169
-   At any time you can run **docker ps** in
170
-the other shell to view a list of the running containers. You can reattach to a
171
-detached container with **docker attach**. If you choose to run a container in
172
-the detached mode, then you cannot use the **-rm** option.
173
-
174
-   When attached in the tty mode, you can detach from a running container without
175
-stopping the process by pressing the keys CTRL-P CTRL-Q.
176
-
177
-**--device**=[]
178
-   Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
179
-
180
-**--dns-search**=[]
181
-   Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
182
-
183
-**--dns**=[]
184
-   Set custom DNS servers
185
-
186
-   This option can be used to override the DNS
187
-configuration passed to the container. Typically this is necessary when the
188
-host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this
189
-is the case the **--dns** flags is necessary for every run.
190
-
191
-**-e**, **--env**=[]
192
-   Set environment variables
193
-
194
-   This option allows you to specify arbitrary
195
-environment variables that are available for the process that will be launched
196
-inside of the container.
197
-
198
-**--entrypoint**=""
199
-   Overwrite the default ENTRYPOINT of the image
200
-
201
-   This option allows you to overwrite the default entrypoint of the image that
202
-is set in the Dockerfile. The ENTRYPOINT of an image is similar to a COMMAND
203
-because it specifies what executable to run when the container starts, but it is
204
-(purposely) more difficult to override. The ENTRYPOINT gives a container its
205
-default nature or behavior, so that when you set an ENTRYPOINT you can run the
206
-container as if it were that binary, complete with default options, and you can
207
-pass in more options via the COMMAND. But, sometimes an operator may want to run
208
-something else inside the container, so you can override the default ENTRYPOINT
209
-at runtime by using a **--entrypoint** and a string to specify the new
210
-ENTRYPOINT.
211
-
212
-**--env-file**=[]
213
-   Read in a line delimited file of environment variables
214
-
215
-**--expose**=[]
216
-   Expose a port, or a range of ports (e.g. --expose=3300-3310), from the container without publishing it to your host
217
-
218
-**-h**, **--hostname**=""
219
-   Container host name
220
-
221
-   Sets the container host name that is available inside the container.
222
-
223
-**--help**
224
-  Print usage statement
225
-
226
-**-i**, **--interactive**=*true*|*false*
227
-   Keep STDIN open even if not attached. The default is *false*.
228
-
229
-   When set to true, keep stdin open even if not attached. The default is false.
230
-
231
-**--ipc**=""
232
-   Default is to create a private IPC namespace (POSIX SysV IPC) for the container
233
-                               'container:<name|id>': reuses another container shared memory, semaphores and message queues
234
-                               'host': use the host shared memory,semaphores and message queues inside the container.  Note: the host mode gives the container full access to local shared memory and is therefore considered insecure.
235
-
236
-**-l**, **--label**=[]
237
-   Set metadata on the container (e.g., --label com.example.key=value)
238
-
239
-**--label-file**=[]
240
-   Read in a line delimited file of labels
241
-
242
-**--link**=[]
243
-   Add link to another container in the form of <name or id>:alias or just <name or id>
244
-in which case the alias will match the name
245
-
246
-   If the operator
247
-uses **--link** when starting the new client container, then the client
248
-container can access the exposed port via a private networking interface. Docker
249
-will set some environment variables in the client container to help indicate
250
-which interface and port to use.
251
-
252
-**--lxc-conf**=[]
253
-   (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
254
-
255
-**--log-driver**="|*json-file*|*syslog*|*journald*|*none*"
256
-  Logging driver for container. Default is defined by daemon `--log-driver` flag.
257
-  **Warning**: `docker logs` command works only for `json-file` logging driver.
258
-
259
-**--log-opt**=[]
260
-  Logging driver specific options.
261
-
262
-**-m**, **--memory**=""
263
-   Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
264
-
265
-   Allows you to constrain the memory available to a container. If the host
266
-supports swap memory, then the **-m** memory setting can be larger than physical
267
-RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
268
-not limited. The actual limit may be rounded up to a multiple of the operating
269
-system's page size (the value would be very large, that's millions of trillions).
270
-
271
-**--memory-swap**=""
272
-   Total memory limit (memory + swap)
273
-
274
-   Set `-1` to disable swap (format: <number><optional unit>, where unit = b, k, m or g).
275
-This value should always larger than **-m**, so you should always use this with **-m**.
276
-
277
-**--mac-address**=""
278
-   Container MAC address (e.g. 92:d0:c6:0a:29:33)
279
-
280
-   Remember that the MAC address in an Ethernet network must be unique.
281
-The IPv6 link-local address will be based on the device's MAC address
282
-according to RFC4862.
283
-
284
-**--name**=""
285
-   Assign a name to the container
286
-
287
-   The operator can identify a container in three ways:
288
-    UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
289
-    UUID short identifier (“f78375b1c487”)
290
-    Name (“jonah”)
291
-
292
-   The UUID identifiers come from the Docker daemon, and if a name is not assigned
293
-to the container with **--name** then the daemon will also generate a random
294
-string name. The name is useful when defining links (see **--link**) (or any
295
-other place you need to identify a container). This works for both background
296
-and foreground Docker containers.
297
-
298
-**--net**="bridge"
299
-   Set the Network mode for the container
300
-                               'bridge': creates a new network stack for the container on the docker bridge
301
-                               'none': no networking for this container
302
-                               'container:<name|id>': reuses another container network stack
303
-                               'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
304
-
305
-**--oom-kill-disable**=*true*|*false*
306
-   Whether to disable OOM Killer for the container or not.
307
-
308
-**-P**, **--publish-all**=*true*|*false*
309
-   Publish all exposed ports to random ports on the host interfaces. The default is *false*.
310
-
311
-   When set to true publish all exposed ports to the host interfaces. The
312
-default is false. If the operator uses -P (or -p) then Docker will make the
313
-exposed port accessible on the host and the ports will be available to any
314
-client that can reach the host. When using -P, Docker will bind any exposed
315
-port to a random port on the host within an *ephemeral port range* defined by
316
-`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
317
-ports and the exposed ports, use `docker port`.
318
-
319
-**-p**, **--publish**=[]
320
-   Publish a container's port, or range of ports, to the host.
321
-                               format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
322
-                               Both hostPort and containerPort can be specified as a range of ports. 
323
-                               When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. (e.g., `-p 1234-1236:1234-1236/tcp`)
324
-                               (use 'docker port' to see the actual mapping)
325
-
326
-**--pid**=host
327
-   Set the PID mode for the container
328
-     **host**: use the host's PID namespace inside the container.
329
-     Note: the host mode gives the container full access to local PID and is therefore considered insecure.
330
-
331
-**--uts**=host
332
-   Set the UTS mode for the container
333
-     **host**: use the host's UTS namespace inside the container.
334
-     Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
335
-
336
-**--privileged**=*true*|*false*
337
-   Give extended privileges to this container. The default is *false*.
338
-
339
-   By default, Docker containers are
340
-“unprivileged” (=false) and cannot, for example, run a Docker daemon inside the
341
-Docker container. This is because by default a container is not allowed to
342
-access any devices. A “privileged” container is given access to all devices.
343
-
344
-   When the operator executes **docker run --privileged**, Docker will enable access
345
-to all devices on the host as well as set some configuration in AppArmor to
346
-allow the container nearly all the same access to the host as processes running
347
-outside of a container on the host.
348
-
349
-**--read-only**=*true*|*false*
350
-   Mount the container's root filesystem as read only.
351
-
352
-   By default a container will have its root filesystem writable allowing processes
353
-to write files anywhere.  By specifying the `--read-only` flag the container will have
354
-its root filesystem mounted as read only prohibiting any writes.
355
-
356
-**--restart**="no"
357
-   Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
358
-      
359
-**--rm**=*true*|*false*
360
-   Automatically remove the container when it exits (incompatible with -d). The default is *false*.
361
-
362
-**--security-opt**=[]
363
-   Security Options
364
-
365
-   "label:user:USER"   : Set the label user for the container
366
-    "label:role:ROLE"   : Set the label role for the container
367
-    "label:type:TYPE"   : Set the label type for the container
368
-    "label:level:LEVEL" : Set the label level for the container
369
-    "label:disable"     : Turn off label confinement for the container
370
-
371
-**--sig-proxy**=*true*|*false*
372
-   Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
373
-
374
-**-t**, **--tty**=*true*|*false*
375
-   Allocate a pseudo-TTY. The default is *false*.
376
-
377
-   When set to true Docker can allocate a pseudo-tty and attach to the standard
378
-input of any container. This can be used, for example, to run a throwaway
379
-interactive shell. The default is value is false.
380
-
381
-The **-t** option is incompatible with a redirection of the docker client
382
-standard input.
383
-
384
-**-u**, **--user**=""
385
-   Sets the username or UID used and optionally the groupname or GID for the specified command.
386
-
387
-   The followings examples are all valid:
388
-   --user [user | user:group | uid | uid:gid | user:gid | uid:group ]
389
-
390
-   Without this argument the command will be run as root in the container.
391
-
392
-**-v**, **--volume**=[]
393
-   Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
394
-
395
-   The **-v** option can be used one or
396
-more times to add one or more mounts to a container. These mounts can then be
397
-used in other containers using the **--volumes-from** option.
398
-
399
-   The volume may be optionally suffixed with :ro or :rw to mount the volumes in
400
-read-only or read-write mode, respectively. By default, the volumes are mounted
401
-read-write. See examples.
402
-
403
-Labeling systems like SELinux require proper labels be placed on volume content
404
-mounted into a container, otherwise the secuirty system might prevent the
405
-processes running inside the container from using the content. By default,
406
-volumes are not relabeled.
407
-
408
-Two suffixes :z or :Z can be added to the volume mount. These suffixes tell
409
-Docker to relabel file objects on the shared volumes. The 'z' option tells
410
-Docker that the volume content will be shared between containers. Docker will
411
-label the content with a shared content label. Shared volumes labels allow all
412
-containers to read/write content. The 'Z' option tells Docker to label the
413
-content with a private unshared label. Private volumes can only be used by the
414
-current container.
415
-
416
-Note: Multiple Volume options can be added separated by a ","
417
-
418
-**--volumes-from**=[]
419
-   Mount volumes from the specified container(s)
420
-
421
-   Mounts already mounted volumes from a source container onto another
422
-   container. You must supply the source's container-id. To share 
423
-   a volume, use the **--volumes-from** option when running
424
-   the target container. You can share volumes even if the source container 
425
-   is not running.
426
-
427
-   By default, Docker mounts the volumes in the same mode (read-write or 
428
-   read-only) as it is mounted in the source container. Optionally, you 
429
-   can change this by suffixing the container-id with either the `:ro` or 
430
-   `:rw ` keyword.
431
-
432
-   If the location of the volume from the source container overlaps with
433
-   data residing on a target container, then the volume hides
434
-   that data on the target.
435
-
436
-**-w**, **--workdir**=""
437
-   Working directory inside the container
438
-
439
-   The default working directory for
440
-running binaries within a container is the root directory (/). The developer can
441
-set a different default with the Dockerfile WORKDIR instruction. The operator
442
-can override the working directory by using the **-w** option.
443
-
444
-# EXAMPLES
445
-
446
-## Exposing log messages from the container to the host's log
447
-
448
-If you want messages that are logged in your container to show up in the host's
449
-syslog/journal then you should bind mount the /dev/log directory as follows.
450
-
451
-    # docker run -v /dev/log:/dev/log -i -t fedora /bin/bash
452
-
453
-From inside the container you can test this by sending a message to the log.
454
-
455
-    (bash)# logger "Hello from my container"
456
-
457
-Then exit and check the journal.
458
-
459
-    # exit
460
-
461
-    # journalctl -b | grep Hello
462
-
463
-This should list the message sent to logger.
464
-
465
-## Attaching to one or more from STDIN, STDOUT, STDERR
466
-
467
-If you do not specify -a then Docker will attach everything (stdin,stdout,stderr)
468
-. You can specify to which of the three standard streams (stdin, stdout, stderr)
469
-you’d like to connect instead, as in:
470
-
471
-    # docker run -a stdin -a stdout -i -t fedora /bin/bash
472
-
473
-## Sharing IPC between containers
474
-
475
-Using shm_server.c available here: https://www.cs.cf.ac.uk/Dave/C/node27.html
476
-
477
-Testing `--ipc=host` mode:
478
-
479
-Host shows a shared memory segment with 7 pids attached, happens to be from httpd:
480
-
481
-```
482
- $ sudo ipcs -m
483
-
484
- ------ Shared Memory Segments --------
485
- key        shmid      owner      perms      bytes      nattch     status      
486
- 0x01128e25 0          root       600        1000       7                       
487
-```
488
-
489
-Now run a regular container, and it correctly does NOT see the shared memory segment from the host:
490
-
491
-```
492
- $ docker run -it shm ipcs -m
493
-
494
- ------ Shared Memory Segments --------	
495
- key        shmid      owner      perms      bytes      nattch     status      
496
-```
497
-
498
-Run a container with the new `--ipc=host` option, and it now sees the shared memory segment from the host httpd:
499
-
500
- ```
501
- $ docker run -it --ipc=host shm ipcs -m
502
-
503
- ------ Shared Memory Segments --------
504
- key        shmid      owner      perms      bytes      nattch     status      
505
- 0x01128e25 0          root       600        1000       7                   
506
-```
507
-Testing `--ipc=container:CONTAINERID` mode:
508
-
509
-Start a container with a program to create a shared memory segment:
510
-```
511
- $ docker run -it shm bash
512
- $ sudo shm/shm_server &
513
- $ sudo ipcs -m
514
-
515
- ------ Shared Memory Segments --------
516
- key        shmid      owner      perms      bytes      nattch     status      
517
- 0x0000162e 0          root       666        27         1                       
518
-```
519
-Create a 2nd container correctly shows no shared memory segment from 1st container:
520
-```
521
- $ docker run shm ipcs -m
522
-
523
- ------ Shared Memory Segments --------
524
- key        shmid      owner      perms      bytes      nattch     status      
525
-```
526
-
527
-Create a 3rd container using the new --ipc=container:CONTAINERID option, now it shows the shared memory segment from the first:
528
-
529
-```
530
- $ docker run -it --ipc=container:ed735b2264ac shm ipcs -m
531
- $ sudo ipcs -m
532
-
533
- ------ Shared Memory Segments --------
534
- key        shmid      owner      perms      bytes      nattch     status      
535
- 0x0000162e 0          root       666        27         1
536
-```
537
-
538
-## Linking Containers
539
-
540
-The link feature allows multiple containers to communicate with each other. For
541
-example, a container whose Dockerfile has exposed port 80 can be run and named
542
-as follows:
543
-
544
-    # docker run --name=link-test -d -i -t fedora/httpd
545
-
546
-A second container, in this case called linker, can communicate with the httpd
547
-container, named link-test, by running with the **--link=<name>:<alias>**
548
-
549
-    # docker run -t -i --link=link-test:lt --name=linker fedora /bin/bash
550
-
551
-Now the container linker is linked to container link-test with the alias lt.
552
-Running the **env** command in the linker container shows environment variables
553
- with the LT (alias) context (**LT_**)
554
-
555
-    # env
556
-    HOSTNAME=668231cb0978
557
-    TERM=xterm
558
-    LT_PORT_80_TCP=tcp://172.17.0.3:80
559
-    LT_PORT_80_TCP_PORT=80
560
-    LT_PORT_80_TCP_PROTO=tcp
561
-    LT_PORT=tcp://172.17.0.3:80
562
-    PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
563
-    PWD=/
564
-    LT_NAME=/linker/lt
565
-    SHLVL=1
566
-    HOME=/
567
-    LT_PORT_80_TCP_ADDR=172.17.0.3
568
-    _=/usr/bin/env
569
-
570
-When linking two containers Docker will use the exposed ports of the container
571
-to create a secure tunnel for the parent to access.
572
-
573
-
574
-## Mapping Ports for External Usage
575
-
576
-The exposed port of an application can be mapped to a host port using the **-p**
577
-flag. For example, a httpd port 80 can be mapped to the host port 8080 using the
578
-following:
579
-
580
-    # docker run -p 8080:80 -d -i -t fedora/httpd
581
-
582
-## Creating and Mounting a Data Volume Container
583
-
584
-Many applications require the sharing of persistent data across several
585
-containers. Docker allows you to create a Data Volume Container that other
586
-containers can mount from. For example, create a named container that contains
587
-directories /var/volume1 and /tmp/volume2. The image will need to contain these
588
-directories so a couple of RUN mkdir instructions might be required for you
589
-fedora-data image:
590
-
591
-    # docker run --name=data -v /var/volume1 -v /tmp/volume2 -i -t fedora-data true
592
-    # docker run --volumes-from=data --name=fedora-container1 -i -t fedora bash
593
-
594
-Multiple --volumes-from parameters will bring together multiple data volumes from
595
-multiple containers. And it's possible to mount the volumes that came from the
596
-DATA container in yet another container via the fedora-container1 intermediary
597
-container, allowing to abstract the actual data source from users of that data:
598
-
599
-    # docker run --volumes-from=fedora-container1 --name=fedora-container2 -i -t fedora bash
600
-
601
-## Mounting External Volumes
602
-
603
-To mount a host directory as a container volume, specify the absolute path to
604
-the directory and the absolute path for the container directory separated by a
605
-colon:
606
-
607
-    # docker run -v /var/db:/data1 -i -t fedora bash
608
-
609
-When using SELinux, be aware that the host has no knowledge of container SELinux
610
-policy. Therefore, in the above example, if SELinux policy is enforced, the
611
-`/var/db` directory is not writable to the container. A "Permission Denied"
612
-message will occur and an avc: message in the host's syslog.
613
-
614
-
615
-To work around this, at time of writing this man page, the following command
616
-needs to be run in order for the proper SELinux policy type label to be attached
617
-to the host directory:
618
-
619
-    # chcon -Rt svirt_sandbox_file_t /var/db
620
-
621
-
622
-Now, writing to the /data1 volume in the container will be allowed and the
623
-changes will also be reflected on the host in /var/db.
624
-
625
-## Using alternative security labeling
626
-
627
-You can override the default labeling scheme for each container by specifying
628
-the `--security-opt` flag. For example, you can specify the MCS/MLS level, a
629
-requirement for MLS systems. Specifying the level in the following command
630
-allows you to share the same content between containers.
631
-
632
-    # docker run --security-opt label:level:s0:c100,c200 -i -t fedora bash
633
-
634
-An MLS example might be:
635
-
636
-    # docker run --security-opt label:level:TopSecret -i -t rhel7 bash
637
-
638
-To disable the security labeling for this container versus running with the
639
-`--permissive` flag, use the following command:
640
-
641
-    # docker run --security-opt label:disable -i -t fedora bash
642
-
643
-If you want a tighter security policy on the processes within a container,
644
-you can specify an alternate type for the container. You could run a container
645
-that is only allowed to listen on Apache ports by executing the following
646
-command:
647
-
648
-    # docker run --security-opt label:type:svirt_apache_t -i -t centos bash
649
-
650
-Note:
651
-
652
-You would have to write policy defining a `svirt_apache_t` type.
653
-
654
-# HISTORY
655
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
656
-based on docker.com source material and internal work.
657
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
658
-July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
659 1
deleted file mode 100644
... ...
@@ -1,45 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-save - Save an image(s) to a tar archive (streamed to STDOUT by default)
6
-
7
-# SYNOPSIS
8
-**docker save**
9
-[**--help**]
10
-[**-o**|**--output**[=*OUTPUT*]]
11
-IMAGE [IMAGE...]
12
-
13
-# DESCRIPTION
14
-Produces a tarred repository to the standard output stream. Contains all
15
-parent layers, and all tags + versions, or specified repo:tag.
16
-
17
-Stream to a file instead of STDOUT by using **-o**.
18
-
19
-# OPTIONS
20
-**--help**
21
-  Print usage statement
22
-
23
-**-o**, **--output**=""
24
-   Write to a file, instead of STDOUT
25
-
26
-# EXAMPLES
27
-
28
-Save all fedora repository images to a fedora-all.tar and save the latest
29
-fedora image to a fedora-latest.tar:
30
-
31
-    $ docker save fedora > fedora-all.tar
32
-    $ docker save --output=fedora-latest.tar fedora:latest
33
-    $ ls -sh fedora-all.tar
34
-    721M fedora-all.tar
35
-    $ ls -sh fedora-latest.tar
36
-    367M fedora-latest.tar
37
-
38
-# See also
39
-**docker-load(1)** to load an image from a tar archive on STDIN.
40
-
41
-# HISTORY
42
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
43
-based on docker.com source material and internal work.
44
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
45
-November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
46 1
deleted file mode 100644
... ...
@@ -1,65 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-search - Search the Docker Hub for images
6
-
7
-# SYNOPSIS
8
-**docker search**
9
-[**--automated**[=*false*]]
10
-[**--help**]
11
-[**--no-trunc**[=*false*]]
12
-[**-s**|**--stars**[=*0*]]
13
-TERM
14
-
15
-# DESCRIPTION
16
-
17
-Search Docker Hub for an image with that matches the specified `TERM`. The table
18
-of images returned displays the name, description (truncated by default), number
19
-of stars awarded, whether the image is official, and whether it is automated.
20
-
21
-*Note* - Search queries will only return up to 25 results
22
-
23
-# OPTIONS
24
-**--automated**=*true*|*false*
25
-   Only show automated builds. The default is *false*.
26
-
27
-**--help**
28
-  Print usage statement
29
-
30
-**--no-trunc**=*true*|*false*
31
-   Don't truncate output. The default is *false*.
32
-
33
-**-s**, **--stars**=0
34
-   Only displays with at least x stars
35
-
36
-# EXAMPLES
37
-
38
-## Search Docker Hub for ranked images
39
-
40
-Search a registry for the term 'fedora' and only display those images
41
-ranked 3 or higher:
42
-
43
-    $ docker search -s 3 fedora
44
-    NAME                  DESCRIPTION                                    STARS OFFICIAL  AUTOMATED
45
-    mattdm/fedora         A basic Fedora image corresponding roughly...  50
46
-    fedora                (Semi) Official Fedora base image.             38
47
-    mattdm/fedora-small   A small Fedora image on which to build. Co...  8
48
-    goldmann/wildfly      A WildFly application server running on a ...  3               [OK]
49
-
50
-## Search Docker Hub for automated images
51
-
52
-Search Docker Hub for the term 'fedora' and only display automated images
53
-ranked 1 or higher:
54
-
55
-    $ docker search -s 1 -t fedora
56
-    NAME               DESCRIPTION                                     STARS OFFICIAL  AUTOMATED
57
-    goldmann/wildfly   A WildFly application server running on a ...   3               [OK]
58
-    tutum/fedora-20    Fedora 20 image with SSH access. For the r...   1               [OK]
59
-
60
-# HISTORY
61
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
62
-based on docker.com source material and internal work.
63
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
64
-April 2015, updated by Mary Anthony for v2 <mary@docker.com>
65
-
66 1
deleted file mode 100644
... ...
@@ -1,34 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-start - Start one or more stopped containers
6
-
7
-# SYNOPSIS
8
-**docker start**
9
-[**-a**|**--attach**[=*false*]]
10
-[**--help**]
11
-[**-i**|**--interactive**[=*false*]]
12
-CONTAINER [CONTAINER...]
13
-
14
-# DESCRIPTION
15
-
16
-Start one or more stopped containers.
17
-
18
-# OPTIONS
19
-**-a**, **--attach**=*true*|*false*
20
-   Attach container's STDOUT and STDERR and forward all signals to the process. The default is *false*.
21
-
22
-**--help**
23
-  Print usage statement
24
-
25
-**-i**, **--interactive**=*true*|*false*
26
-   Attach container's STDIN. The default is *false*.
27
-
28
-# See also
29
-**docker-stop(1)** to stop a running container.
30
-
31
-# HISTORY
32
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
33
-based on docker.com source material and internal work.
34
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
35 1
deleted file mode 100644
... ...
@@ -1,31 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-stats - Display a live stream of one or more containers' resource usage statistics
6
-
7
-# SYNOPSIS
8
-**docker stats**
9
-[**--help**]
10
-CONTAINER [CONTAINER...]
11
-
12
-# DESCRIPTION
13
-
14
-Display a live stream of one or more containers' resource usage statistics
15
-
16
-# OPTIONS
17
-**--help**
18
-  Print usage statement
19
-
20
-**--no-stream**="false"
21
-  Disable streaming stats and only pull the first result
22
-
23
-# EXAMPLES
24
-
25
-Run **docker stats** with multiple containers.
26
-
27
-    $ docker stats redis1 redis2
28
-    CONTAINER           CPU %               MEM USAGE/LIMIT     MEM %               NET I/O
29
-    redis1              0.07%               796 KB/64 MB        1.21%               788 B/648 B
30
-    redis2              0.07%               2.746 MB/64 MB      4.29%               1.266 KB/648 B
31
-
32 1
deleted file mode 100644
... ...
@@ -1,30 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period
6
-
7
-# SYNOPSIS
8
-**docker stop**
9
-[**--help**]
10
-[**-t**|**--time**[=*10*]]
11
-CONTAINER [CONTAINER...]
12
-
13
-# DESCRIPTION
14
-Stop a running container (Send SIGTERM, and then SIGKILL after
15
- grace period)
16
-
17
-# OPTIONS
18
-**--help**
19
-  Print usage statement
20
-
21
-**-t**, **--time**=10
22
-   Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.
23
-
24
-#See also
25
-**docker-start(1)** to restart a stopped container.
26
-
27
-# HISTORY
28
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
29
-based on docker.com source material and internal work.
30
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
31 1
deleted file mode 100644
... ...
@@ -1,65 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-tag - Tag an image into a repository
6
-
7
-# SYNOPSIS
8
-**docker tag**
9
-[**-f**|**--force**[=*false*]]
10
-[**--help**]
11
-IMAGE[:TAG] [REGISTRY_HOST/][USERNAME/]NAME[:TAG]
12
-
13
-# DESCRIPTION
14
-Assigns a new alias to an image in a registry. An alias refers to the
15
-entire image name including the optional `TAG` after the ':'. 
16
-
17
-If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
18
-registry located at `registry-1.docker.io` by default. 
19
-
20
-# "OPTIONS"
21
-**-f**, **--force**=*true*|*false*
22
-   When set to true, force the alias. The default is *false*.
23
-
24
-**REGISTRYHOST**
25
-   The hostname of the registry if required. This may also include the port
26
-separated by a ':'
27
-
28
-**USERNAME**
29
-   The username or other qualifying identifier for the image.
30
-
31
-**NAME**
32
-   The image name.
33
-
34
-**TAG**
35
-   The tag you are assigning to the image.  Though this is arbitrary it is
36
-recommended to be used for a version to distinguish images with the same name.
37
-Note that here TAG is a part of the overall name or "tag".
38
-
39
-# OPTIONS
40
-**-f**, **--force**=*true*|*false*
41
-   Force. The default is *false*.
42
-
43
-# EXAMPLES
44
-
45
-## Giving an image a new alias
46
-
47
-Here is an example of aliasing an image (e.g., 0e5574283393) as "httpd" and 
48
-tagging it into the "fedora" repository with "version1.0":
49
-
50
-    docker tag 0e5574283393 fedora/httpd:version1.0
51
-
52
-## Tagging an image for a private repository
53
-
54
-To push an image to an private registry and not the central Docker
55
-registry you must tag it with the registry hostname and port (if needed).
56
-
57
-    docker tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0
58
-
59
-# HISTORY
60
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
61
-based on docker.com source material and internal work.
62
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
63
-July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
64
-April 2015, updated by Mary Anthony for v2 <mary@docker.com>
65
-
66 1
deleted file mode 100644
... ...
@@ -1,33 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-top - Display the running processes of a container
6
-
7
-# SYNOPSIS
8
-**docker top**
9
-[**--help**]
10
-CONTAINER [ps OPTIONS]
11
-
12
-# DESCRIPTION
13
-
14
-Look up the running process of the container. ps-OPTION can be any of the
15
- options you would pass to a Linux ps command.
16
-
17
-# OPTIONS
18
-**--help**
19
-  Print usage statement
20
-
21
-# EXAMPLES
22
-
23
-Run **docker top** with the ps option of -x:
24
-
25
-    $ docker top 8601afda2b -x
26
-    PID      TTY       STAT       TIME         COMMAND
27
-    16623    ?         Ss         0:00         sleep 99999
28
-
29
-
30
-# HISTORY
31
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
32
-based on docker.com source material and internal work.
33
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
34 1
deleted file mode 100644
... ...
@@ -1,27 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-unpause - Unpause all processes within a container
6
-
7
-# SYNOPSIS
8
-**docker unpause**
9
-CONTAINER [CONTAINER...]
10
-
11
-# DESCRIPTION
12
-
13
-The `docker unpause` command uses the cgroups freezer to un-suspend all
14
-processes in a container.
15
-
16
-See the [cgroups freezer documentation]
17
-(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for
18
-further details.
19
-
20
-# OPTIONS
21
-There are no available options.
22
-
23
-# See also
24
-**docker-pause(1)** to pause all processes within a container.
25
-
26
-# HISTORY
27
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
28 1
deleted file mode 100644
... ...
@@ -1,15 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-version - Show the Docker version information.
6
-
7
-# SYNOPSIS
8
-**docker version**
9
-
10
-
11
-# OPTIONS
12
-There are no available options.
13
-
14
-# HISTORY
15
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
16 1
deleted file mode 100644
... ...
@@ -1,30 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% Docker Community
3
-% JUNE 2014
4
-# NAME
5
-docker-wait - Block until a container stops, then print its exit code.
6
-
7
-# SYNOPSIS
8
-**docker wait**
9
-[**--help**]
10
-CONTAINER [CONTAINER...]
11
-
12
-# DESCRIPTION
13
-
14
-Block until a container stops, then print its exit code.
15
-
16
-# OPTIONS
17
-**--help**
18
-  Print usage statement
19
-
20
-# EXAMPLES
21
-
22
-    $ docker run -d fedora sleep 99
23
-    079b83f558a2bc52ecad6b2a5de13622d584e6bb1aea058c11b36511e85e7622
24
-    $ docker wait 079b83f558a2bc
25
-    0
26
-
27
-# HISTORY
28
-April 2014, Originally compiled by William Henry (whenry at redhat dot com)
29
-based on docker.com source material and internal work.
30
-June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
31 1
deleted file mode 100644
... ...
@@ -1,391 +0,0 @@
1
-% DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
4
-# NAME
5
-docker \- Docker image and container command line interface
6
-
7
-# SYNOPSIS
8
-**docker** [OPTIONS] COMMAND [arg...]
9
-
10
-# DESCRIPTION
11
-**docker** has two distinct functions. It is used for starting the Docker
12
-daemon and to run the CLI (i.e., to command the daemon to manage images,
13
-containers etc.) So **docker** is both a server, as a daemon, and a client
14
-to the daemon, through the CLI.
15
-
16
-To run the Docker daemon you do not specify any of the commands listed below but
17
-must specify the **-d** option.  The other options listed below are for the
18
-daemon only.
19
-
20
-The Docker CLI has over 30 commands. The commands are listed below and each has
21
-its own man page which explain usage and arguments.
22
-
23
-To see the man page for a command run **man docker <command>**.
24
-
25
-# OPTIONS
26
-**-h**, **--help**
27
-  Print usage statement
28
-
29
-**--api-cors-header**=""
30
-  Set CORS headers in the remote API. Default is cors disabled. Give urls like "http://foo, http://bar, ...". Give "*" to allow all.
31
-
32
-**-b**, **--bridge**=""
33
-  Attach containers to a pre\-existing network bridge; use 'none' to disable container networking
34
-
35
-**--bip**=""
36
-  Use the provided CIDR notation address for the dynamically created bridge (docker0); Mutually exclusive of \-b
37
-
38
-**-D**, **--debug**=*true*|*false*
39
-  Enable debug mode. Default is false.
40
-
41
-**-d**, **--daemon**=*true*|*false*
42
-  Enable daemon mode. Default is false.
43
-
44
-**--default-gateway**=""
45
-  IPv4 address of the container default gateway; this address must be part of the bridge subnet (which is defined by \-b or \--bip)
46
-
47
-**--default-gateway-v6**=""
48
-  IPv6 address of the container default gateway
49
-
50
-**--dns**=""
51
-  Force Docker to use specific DNS servers
52
-
53
-**-e**, **--exec-driver**=""
54
-  Force Docker to use specific exec driver. Default is `native`.
55
-
56
-**--exec-opt**=[]
57
-  Set exec driver options. See EXEC DRIVER OPTIONS.
58
-
59
-**--exec-root**=""
60
-  Path to use as the root of the Docker execdriver. Default is `/var/run/docker`.
61
-
62
-**--fixed-cidr**=""
63
-  IPv4 subnet for fixed IPs (e.g., 10.20.0.0/16); this subnet must be nested in the bridge subnet (which is defined by \-b or \-\-bip)
64
-
65
-**--fixed-cidr-v6**=""
66
-  IPv6 subnet for global IPv6 addresses (e.g., 2a00:1450::/64)
67
-
68
-**-G**, **--group**=""
69
-  Group to assign the unix socket specified by -H when running in daemon mode.
70
-  use '' (the empty string) to disable setting of a group. Default is `docker`.
71
-
72
-**-g**, **--graph**=""
73
-  Path to use as the root of the Docker runtime. Default is `/var/lib/docker`.
74
-
75
-**-H**, **--host**=[unix:///var/run/docker.sock]: tcp://[host:port] to bind or
76
-unix://[/path/to/socket] to use.
77
-  The socket(s) to bind to in daemon mode specified using one or more
78
-  tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd.
79
-
80
-**--icc**=*true*|*false*
81
-  Allow unrestricted inter\-container and Docker daemon host communication. If disabled, containers can still be linked together using **--link** option (see **docker-run(1)**). Default is true.
82
-
83
-**--ip**=""
84
-  Default IP address to use when binding container ports. Default is `0.0.0.0`.
85
-
86
-**--ip-forward**=*true*|*false*
87
-  Docker will enable IP forwarding. Default is true. If `--fixed-cidr-v6` is set. IPv6 forwarding will be activated, too. This may reject Router Advertisements and interfere with the host's existing IPv6 configuration. For more information please consult the documentation about "Advanced Networking - IPv6".
88
-
89
-**--ip-masq**=*true*|*false*
90
-  Enable IP masquerading for bridge's IP range. Default is true.
91
-
92
-**--iptables**=*true*|*false*
93
-  Enable Docker's addition of iptables rules. Default is true.
94
-
95
-**--ipv6**=*true*|*false*
96
-  Enable IPv6 support. Default is false. Docker will create an IPv6-enabled bridge with address fe80::1 which will allow you to create IPv6-enabled containers. Use together with `--fixed-cidr-v6` to provide globally routable IPv6 addresses. IPv6 forwarding will be enabled if not used with `--ip-forward=false`. This may collide with your host's current IPv6 settings. For more information please consult the documentation about "Advanced Networking - IPv6".
97
-
98
-**-l**, **--log-level**="*debug*|*info*|*warn*|*error*|*fatal*""
99
-  Set the logging level. Default is `info`.
100
-
101
-**--label**="[]"
102
-  Set key=value labels to the daemon (displayed in `docker info`)
103
-
104
-**--log-driver**="*json-file*|*syslog*|*journald*|*none*"
105
-  Default driver for container logs. Default is `json-file`.
106
-  **Warning**: `docker logs` command works only for `json-file` logging driver.
107
-
108
-**--log-opt**=[]
109
-  Logging driver specific options.
110
-
111
-**--mtu**=VALUE
112
-  Set the containers network mtu. Default is `0`.
113
-
114
-**-p**, **--pidfile**=""
115
-  Path to use for daemon PID file. Default is `/var/run/docker.pid`
116
-
117
-**--registry-mirror**=<scheme>://<host>
118
-  Prepend a registry mirror to be used for image pulls. May be specified multiple times.
119
-
120
-**-s**, **--storage-driver**=""
121
-  Force the Docker runtime to use a specific storage driver.
122
-
123
-**--selinux-enabled**=*true*|*false*
124
-  Enable selinux support. Default is false. SELinux does not presently support the BTRFS storage driver.
125
-
126
-**--storage-opt**=[]
127
-  Set storage driver options. See STORAGE DRIVER OPTIONS.
128
-
129
-**-tls**=*true*|*false*
130
-  Use TLS; implied by --tlsverify. Default is false.
131
-
132
-**-tlsverify**=*true*|*false*
133
-  Use TLS and verify the remote (daemon: verify client, client: verify daemon).
134
-  Default is false.
135
-
136
-**--userland-proxy**=*true*|*false*
137
-    Rely on a userland proxy implementation for inter-container and outside-to-container loopback communications. Default is true.
138
-
139
-**-v**, **--version**=*true*|*false*
140
-  Print version information and quit. Default is false.
141
-
142
-# COMMANDS
143
-**attach**
144
-  Attach to a running container
145
-  See **docker-attach(1)** for full documentation on the **attach** command.
146
-
147
-**build**
148
-  Build an image from a Dockerfile
149
-  See **docker-build(1)** for full documentation on the **build** command.
150
-
151
-**commit**
152
-  Create a new image from a container's changes
153
-  See **docker-commit(1)** for full documentation on the **commit** command.
154
-
155
-**cp**
156
-  Copy files/folders from a container's filesystem to the host
157
-  See **docker-cp(1)** for full documentation on the **cp** command.
158
-
159
-**create**
160
-  Create a new container
161
-  See **docker-create(1)** for full documentation on the **create** command.
162
-
163
-**diff**
164
-  Inspect changes on a container's filesystem
165
-  See **docker-diff(1)** for full documentation on the **diff** command.
166
-
167
-**events**
168
-  Get real time events from the server
169
-  See **docker-events(1)** for full documentation on the **events** command.
170
-
171
-**exec**
172
-  Run a command in a running container
173
-  See **docker-exec(1)** for full documentation on the **exec** command.
174
-
175
-**export**
176
-  Stream the contents of a container as a tar archive
177
-  See **docker-export(1)** for full documentation on the **export** command.
178
-
179
-**history**
180
-  Show the history of an image
181
-  See **docker-history(1)** for full documentation on the **history** command.
182
-
183
-**images**
184
-  List images
185
-  See **docker-images(1)** for full documentation on the **images** command.
186
-
187
-**import**
188
-  Create a new filesystem image from the contents of a tarball
189
-  See **docker-import(1)** for full documentation on the **import** command.
190
-
191
-**info**
192
-  Display system-wide information
193
-  See **docker-info(1)** for full documentation on the **info** command.
194
-
195
-**inspect**
196
-  Return low-level information on a container or image
197
-  See **docker-inspect(1)** for full documentation on the **inspect** command.
198
-
199
-**kill**
200
-  Kill a running container (which includes the wrapper process and everything
201
-inside it)
202
-  See **docker-kill(1)** for full documentation on the **kill** command.
203
-
204
-**load**
205
-  Load an image from a tar archive
206
-  See **docker-load(1)** for full documentation on the **load** command.
207
-
208
-**login**
209
-  Register or login to a Docker Registry
210
-  See **docker-login(1)** for full documentation on the **login** command.
211
-
212
-**logout**
213
-  Log the user out of a Docker Registry
214
-  See **docker-logout(1)** for full documentation on the **logout** command.
215
-
216
-**logs**
217
-  Fetch the logs of a container
218
-  See **docker-logs(1)** for full documentation on the **logs** command.
219
-
220
-**pause**
221
-  Pause all processes within a container
222
-  See **docker-pause(1)** for full documentation on the **pause** command.
223
-
224
-**port**
225
-  Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
226
-  See **docker-port(1)** for full documentation on the **port** command.
227
-
228
-**ps**
229
-  List containers
230
-  See **docker-ps(1)** for full documentation on the **ps** command.
231
-
232
-**pull**
233
-  Pull an image or a repository from a Docker Registry
234
-  See **docker-pull(1)** for full documentation on the **pull** command.
235
-
236
-**push**
237
-  Push an image or a repository to a Docker Registry
238
-  See **docker-push(1)** for full documentation on the **push** command.
239
-
240
-**restart**
241
-  Restart a running container
242
-  See **docker-restart(1)** for full documentation on the **restart** command.
243
-
244
-**rm**
245
-  Remove one or more containers
246
-  See **docker-rm(1)** for full documentation on the **rm** command.
247
-
248
-**rmi**
249
-  Remove one or more images
250
-  See **docker-rmi(1)** for full documentation on the **rmi** command.
251
-
252
-**run**
253
-  Run a command in a new container
254
-  See **docker-run(1)** for full documentation on the **run** command.
255
-
256
-**save**
257
-  Save an image to a tar archive
258
-  See **docker-save(1)** for full documentation on the **save** command.
259
-
260
-**search**
261
-  Search for an image in the Docker index
262
-  See **docker-search(1)** for full documentation on the **search** command.
263
-
264
-**start**
265
-  Start a stopped container
266
-  See **docker-start(1)** for full documentation on the **start** command.
267
-
268
-**stats**
269
-  Display a live stream of one or more containers' resource usage statistics
270
-  See **docker-stats(1)** for full documentation on the **stats** command.
271
-
272
-**stop**
273
-  Stop a running container
274
-  See **docker-stop(1)** for full documentation on the **stop** command.
275
-
276
-**tag**
277
-  Tag an image into a repository
278
-  See **docker-tag(1)** for full documentation on the **tag** command.
279
-
280
-**top**
281
-  Lookup the running processes of a container
282
-  See **docker-top(1)** for full documentation on the **top** command.
283
-
284
-**unpause**
285
-  Unpause all processes within a container
286
-  See **docker-unpause(1)** for full documentation on the **unpause** command.
287
-
288
-**version**
289
-  Show the Docker version information
290
-  See **docker-version(1)** for full documentation on the **version** command.
291
-
292
-**wait**
293
-  Block until a container stops, then print its exit code
294
-  See **docker-wait(1)** for full documentation on the **wait** command.
295
-
296
-# STORAGE DRIVER OPTIONS
297
-
298
-Options to storage backend can be specified with **--storage-opt** flags. The
299
-only backend which currently takes options is *devicemapper*. Therefore use these
300
-flags with **-s=**devicemapper.
301
-
302
-Here is the list of *devicemapper* options:
303
-
304
-#### dm.basesize
305
-Specifies the size to use when creating the base device, which limits the size
306
-of images and containers. The default value is 10G. Note, thin devices are
307
-inherently "sparse", so a 10G device which is mostly empty doesn't use 10 GB
308
-of space on the pool. However, the filesystem will use more space for the empty
309
-case the larger the device is. **Warning**: This value affects the system-wide
310
-"base" empty filesystem that may already be initialized and inherited by pulled
311
-images.
312
-
313
-#### dm.loopdatasize
314
-Specifies the size to use when creating the loopback file for the "data"
315
-device which is used for the thin pool. The default size is 100G. Note that the
316
-file is sparse, so it will not initially take up this much space.
317
-
318
-#### dm.loopmetadatasize
319
-Specifies the size to use when creating the loopback file for the "metadadata"
320
-device which is used for the thin pool. The default size is 2G. Note that the
321
-file is sparse, so it will not initially take up this much space.
322
-
323
-#### dm.fs
324
-Specifies the filesystem type to use for the base device. The supported
325
-options are "ext4" and "xfs". The default is "ext4"
326
-
327
-#### dm.mkfsarg
328
-Specifies extra mkfs arguments to be used when creating the base device.
329
-
330
-#### dm.mountopt
331
-Specifies extra mount options used when mounting the thin devices.
332
-
333
-#### dm.datadev
334
-Specifies a custom blockdevice to use for data for the thin pool.
335
-
336
-If using a block device for device mapper storage, ideally both datadev and
337
-metadatadev should be specified to completely avoid using the loopback device.
338
-
339
-#### dm.metadatadev
340
-Specifies a custom blockdevice to use for metadata for the thin pool.
341
-
342
-For best performance the metadata should be on a different spindle than the
343
-data, or even better on an SSD.
344
-
345
-If setting up a new metadata pool it is required to be valid. This can be
346
-achieved by zeroing the first 4k to indicate empty metadata, like this:
347
-
348
-    dd if=/dev/zero of=/dev/metadata_dev bs=4096 count=1
349
-
350
-#### dm.blocksize
351
-Specifies a custom blocksize to use for the thin pool. The default blocksize
352
-is 64K.
353
-
354
-#### dm.blkdiscard
355
-Enables or disables the use of blkdiscard when removing devicemapper devices.
356
-This is enabled by default (only) if using loopback devices and is required to
357
-resparsify the loopback file on image/container removal.
358
-
359
-Disabling this on loopback can lead to *much* faster container removal times,
360
-but will prevent the space used in `/var/lib/docker` directory from being returned to
361
-the system for other use when containers are removed.
362
-
363
-# EXAMPLES
364
-Launching docker daemon with *devicemapper* backend with particular block devices
365
-for data and metadata:
366
-
367
-    docker -d -s=devicemapper \
368
-      --storage-opt dm.datadev=/dev/vdb \
369
-      --storage-opt dm.metadatadev=/dev/vdc \
370
-      --storage-opt dm.basesize=20G
371
-
372
-# EXEC DRIVER OPTIONS
373
-
374
-Use the **--exec-opt** flags to specify options to the exec-driver. The only
375
-driver that accepts this flag is the *native* (libcontainer) driver. As a
376
-result, you must also specify **-s=**native for this option to have effect. The 
377
-following is the only *native* option:
378
-
379
-#### native.cgroupdriver
380
-Specifies the management of the container's `cgroups`. You can specify 
381
-`cgroupfs` or `systemd`. If you specify `systemd` and it is not available, the 
382
-system uses `cgroupfs`.
383
-
384
-#### Client
385
-For specific client examples please see the man page for the specific Docker
386
-command. For example:
387
-
388
-    man docker-run
389
-
390
-# HISTORY
391
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work.
392 1
deleted file mode 100755
... ...
@@ -1,22 +0,0 @@
1
-#!/bin/bash
2
-set -e
3
-
4
-# get into this script's directory
5
-cd "$(dirname "$(readlink -f "$BASH_SOURCE")")"
6
-
7
-[ "$1" = '-q' ] || {
8
-	set -x
9
-	pwd
10
-}
11
-
12
-for FILE in *.md; do
13
-	base="$(basename "$FILE")"
14
-	name="${base%.md}"
15
-	num="${name##*.}"
16
-	if [ -z "$num" -o "$name" = "$num" ]; then
17
-		# skip files that aren't of the format xxxx.N.md (like README.md)
18
-		continue
19
-	fi
20
-	mkdir -p "./man${num}"
21
-	go-md2man -in "$FILE" -out "./man${num}/${name}"
22
-done
... ...
@@ -1 +1 @@
1
-docs/man/man*/*
1
+man/man*/*
... ...
@@ -9,7 +9,7 @@ override_dh_gencontrol:
9 9
 
10 10
 override_dh_auto_build:
11 11
 	./hack/make.sh dynbinary
12
-	# ./docs/man/md2man-all.sh runs outside the build container (if at all), since we don't have go-md2man here
12
+	# ./man/md2man-all.sh runs outside the build container (if at all), since we don't have go-md2man here
13 13
 
14 14
 override_dh_auto_test:
15 15
 	./bundles/$(VERSION)/dynbinary/docker -v
... ...
@@ -71,7 +71,7 @@ depending on a particular stack or provider.
71 71
 
72 72
 %build
73 73
 ./hack/make.sh dynbinary
74
-# ./docs/man/md2man-all.sh runs outside the build container (if at all), since we don't have go-md2man here
74
+# ./man/md2man-all.sh runs outside the build container (if at all), since we don't have go-md2man here
75 75
 
76 76
 %check
77 77
 ./bundles/%{_origversion}/dynbinary/docker -v
... ...
@@ -113,9 +113,9 @@ install -p -m 644 contrib/completion/fish/docker.fish $RPM_BUILD_ROOT/usr/share/
113 113
 
114 114
 # install manpages
115 115
 install -d %{buildroot}%{_mandir}/man1
116
-install -p -m 644 docs/man/man1/*.1 $RPM_BUILD_ROOT/%{_mandir}/man1
116
+install -p -m 644 man/man1/*.1 $RPM_BUILD_ROOT/%{_mandir}/man1
117 117
 install -d %{buildroot}%{_mandir}/man5
118
-install -p -m 644 docs/man/man5/*.5 $RPM_BUILD_ROOT/%{_mandir}/man5
118
+install -p -m 644 man/man5/*.5 $RPM_BUILD_ROOT/%{_mandir}/man5
119 119
 
120 120
 # add vimfiles
121 121
 install -d $RPM_BUILD_ROOT/usr/share/vim/vimfiles/doc
... ...
@@ -35,7 +35,7 @@ set -e
35 35
 	debDate="$(date --rfc-2822)"
36 36
 
37 37
 	# if go-md2man is available, pre-generate the man pages
38
-	./docs/man/md2man-all.sh -q || true
38
+	./man/md2man-all.sh -q || true
39 39
 	# TODO decide if it's worth getting go-md2man in _each_ builder environment to avoid this
40 40
 
41 41
 	# TODO add a configurable knob for _which_ debs to build so we don't have to modify the file or build all of them every time we need to test
... ...
@@ -38,7 +38,7 @@ set -e
38 38
 	rpmDate="$(date +'%a %b %d %Y')"
39 39
 
40 40
 	# if go-md2man is available, pre-generate the man pages
41
-	./docs/man/md2man-all.sh -q || true
41
+	./man/md2man-all.sh -q || true
42 42
 	# TODO decide if it's worth getting go-md2man in _each_ builder environment to avoid this
43 43
 
44 44
 	# TODO add a configurable knob for _which_ rpms to build so we don't have to modify the file or build all of them every time we need to test
... ...
@@ -60,10 +60,10 @@ bundle_ubuntu() {
60 60
 	cp contrib/completion/fish/docker.fish "$DIR/etc/fish/completions/"
61 61
 
62 62
 	# Include contributed man pages
63
-	docs/man/md2man-all.sh -q
63
+	man/md2man-all.sh -q
64 64
 	manRoot="$DIR/usr/share/man"
65 65
 	mkdir -p "$manRoot"
66
-	for manDir in docs/man/man?; do
66
+	for manDir in man/man?; do
67 67
 		manBase="$(basename "$manDir")" # "man1"
68 68
 		for manFile in "$manDir"/*; do
69 69
 			manName="$(basename "$manFile")" # "docker-build.1"
70 70
new file mode 100644
... ...
@@ -0,0 +1,7 @@
0
+FROM golang:1.3
1
+RUN mkdir -p /go/src/github.com/cpuguy83
2
+RUN mkdir -p /go/src/github.com/cpuguy83 \
3
+    && git clone -b v1 https://github.com/cpuguy83/go-md2man.git /go/src/github.com/cpuguy83/go-md2man \
4
+    && cd /go/src/github.com/cpuguy83/go-md2man \
5
+    && go get -v ./...
6
+CMD ["/go/bin/go-md2man", "--help"]
0 7
new file mode 100644
... ...
@@ -0,0 +1,329 @@
0
+% DOCKERFILE(5) Docker User Manuals
1
+% Zac Dover
2
+% May 2014
3
+# NAME
4
+
5
+Dockerfile - automate the steps of creating a Docker image
6
+
7
+# INTRODUCTION
8
+
9
+The **Dockerfile** is a configuration file that automates the steps of creating
10
+a Docker image. It is similar to a Makefile. Docker reads instructions from the
11
+**Dockerfile** to automate the steps otherwise performed manually to create an
12
+image. To build an image, create a file called **Dockerfile**.
13
+
14
+The **Dockerfile** describes the steps taken to assemble the image. When the
15
+**Dockerfile** has been created, call the `docker build` command, using the
16
+path of directory that contains **Dockerfile** as the argument.
17
+
18
+# SYNOPSIS
19
+
20
+INSTRUCTION arguments
21
+
22
+For example:
23
+
24
+  FROM image
25
+
26
+# DESCRIPTION
27
+
28
+A Dockerfile is a file that automates the steps of creating a Docker image. 
29
+A Dockerfile is similar to a Makefile.
30
+
31
+# USAGE
32
+
33
+  docker build .
34
+
35
+  -- Runs the steps and commits them, building a final image.
36
+  The path to the source repository defines where to find the context of the
37
+  build. The build is run by the Docker daemon, not the CLI. The whole
38
+  context must be transferred to the daemon. The Docker CLI reports
39
+  `"Sending build context to Docker daemon"` when the context is sent to the
40
+  daemon.
41
+
42
+  ```
43
+  docker build -t repository/tag .
44
+  ```
45
+
46
+  -- specifies a repository and tag at which to save the new image if the build
47
+  succeeds. The Docker daemon runs the steps one-by-one, committing the result
48
+  to a new image if necessary, before finally outputting the ID of the new
49
+  image. The Docker daemon automatically cleans up the context it is given.
50
+
51
+  Docker re-uses intermediate images whenever possible. This significantly
52
+  accelerates the *docker build* process.
53
+
54
+# FORMAT
55
+
56
+  `FROM image`
57
+
58
+  `FROM image:tag`
59
+
60
+  -- The **FROM** instruction sets the base image for subsequent instructions. A
61
+  valid Dockerfile must have **FROM** as its first instruction. The image can be any
62
+  valid image. It is easy to start by pulling an image from the public
63
+  repositories.
64
+
65
+  -- **FROM** must be the first non-comment instruction in Dockerfile.
66
+
67
+  -- **FROM** may appear multiple times within a single Dockerfile in order to create
68
+  multiple images. Make a note of the last image ID output by the commit before
69
+  each new **FROM** command.
70
+
71
+  -- If no tag is given to the **FROM** instruction, Docker applies the 
72
+  `latest` tag. If the used tag does not exist, an error is returned.
73
+
74
+**MAINTAINER**
75
+  -- **MAINTAINER** sets the Author field for the generated images.
76
+
77
+**RUN**
78
+  -- **RUN** has two forms:
79
+
80
+  ```
81
+  # the command is run in a shell - /bin/sh -c
82
+  RUN <command>
83
+
84
+  # Executable form
85
+  RUN ["executable", "param1", "param2"]
86
+  ```
87
+
88
+
89
+  -- The **RUN** instruction executes any commands in a new layer on top of the current
90
+  image and commits the results. The committed image is used for the next step in
91
+  Dockerfile.
92
+
93
+  -- Layering **RUN** instructions and generating commits conforms to the core
94
+  concepts of Docker where commits are cheap and containers can be created from
95
+  any point in the history of an image. This is similar to source control.  The
96
+  exec form makes it possible to avoid shell string munging. The exec form makes
97
+  it possible to **RUN** commands using a base image that does not contain `/bin/sh`.
98
+
99
+  Note that the exec form is parsed as a JSON array, which means that you must
100
+  use double-quotes (") around words not single-quotes (').
101
+
102
+**CMD**
103
+  -- **CMD** has three forms:
104
+
105
+  ```
106
+  # Executable form
107
+  CMD ["executable", "param1", "param2"]`
108
+
109
+  # Provide default arguments to ENTRYPOINT
110
+  CMD ["param1", "param2"]`
111
+
112
+  # the command is run in a shell - /bin/sh -c
113
+  CMD command param1 param2
114
+  ```
115
+
116
+  -- There can be only one **CMD** in a Dockerfile. If more than one **CMD** is listed, only
117
+  the last **CMD** takes effect.
118
+  The main purpose of a **CMD** is to provide defaults for an executing container.
119
+  These defaults may include an executable, or they can omit the executable. If
120
+  they omit the executable, an **ENTRYPOINT** must be specified.
121
+  When used in the shell or exec formats, the **CMD** instruction sets the command to
122
+  be executed when running the image.
123
+  If you use the shell form of the **CMD**, the `<command>` executes in `/bin/sh -c`:
124
+
125
+  Note that the exec form is parsed as a JSON array, which means that you must
126
+  use double-quotes (") around words not single-quotes (').
127
+
128
+  ```
129
+  FROM ubuntu
130
+  CMD echo "This is a test." | wc -
131
+  ```
132
+
133
+  -- If you run **command** without a shell, then you must express the command as a
134
+  JSON array and give the full path to the executable. This array form is the
135
+  preferred form of **CMD**. All additional parameters must be individually expressed
136
+  as strings in the array:
137
+
138
+  ```
139
+  FROM ubuntu
140
+  CMD ["/usr/bin/wc","--help"]
141
+  ```
142
+
143
+  -- To make the container run the same executable every time, use **ENTRYPOINT** in
144
+  combination with **CMD**. 
145
+  If the user specifies arguments to `docker run`, the specified commands
146
+  override the default in **CMD**.
147
+  Do not confuse **RUN** with **CMD**. **RUN** runs a command and commits the result.
148
+  **CMD** executes nothing at build time, but specifies the intended command for
149
+  the image.
150
+
151
+**LABEL**
152
+  -- `LABEL <key>[=<value>] [<key>[=<value>] ...]`
153
+  The **LABEL** instruction adds metadata to an image. A **LABEL** is a
154
+  key-value pair. To include spaces within a **LABEL** value, use quotes and
155
+  backslashes as you would in command-line parsing.
156
+
157
+  ```
158
+  LABEL "com.example.vendor"="ACME Incorporated"
159
+  ```
160
+
161
+  An image can have more than one label. To specify multiple labels, separate
162
+  each key-value pair by a space. 
163
+  
164
+  Labels are additive including `LABEL`s in `FROM` images. As the system
165
+  encounters and then applies a new label, new `key`s override any previous
166
+  labels with identical keys.
167
+
168
+  To display an image's labels, use the `docker inspect` command.
169
+
170
+**EXPOSE**
171
+  -- `EXPOSE <port> [<port>...]`
172
+  The **EXPOSE** instruction informs Docker that the container listens on the
173
+  specified network ports at runtime. Docker uses this information to
174
+  interconnect containers using links, and to set up port redirection on the host
175
+  system.
176
+
177
+**ENV**
178
+  -- `ENV <key> <value>`
179
+  The **ENV** instruction sets the environment variable <key> to
180
+  the value `<value>`. This value is passed to all future 
181
+  RUN, **ENTRYPOINT**, and **CMD** instructions. This is
182
+  functionally equivalent to prefixing the command with `<key>=<value>`.  The
183
+  environment variables that are set with **ENV** persist when a container is run
184
+  from the resulting image. Use `docker inspect` to inspect these values, and
185
+  change them using `docker run --env <key>=<value>`.
186
+
187
+  Note that setting "`ENV DEBIAN_FRONTEND noninteractive`" may cause
188
+  unintended consequences, because it will persist when the container is run
189
+  interactively, as with the following command: `docker run -t -i image bash`
190
+
191
+**ADD**
192
+  -- **ADD** has two forms:
193
+
194
+  ```
195
+  ADD <src> <dest>
196
+
197
+  # Required for paths with whitespace
198
+  ADD ["<src>",... "<dest>"]
199
+  ```
200
+
201
+  The **ADD** instruction copies new files, directories
202
+  or remote file URLs to the filesystem of the container at path `<dest>`.
203
+  Multiple `<src>` resources may be specified but if they are files or directories
204
+  then they must be relative to the source directory that is being built
205
+  (the context of the build). The `<dest>` is the absolute path, or path relative
206
+  to **WORKDIR**, into which the source is copied inside the target container.
207
+  All new files and directories are created with mode 0755 and with the uid 
208
+  and gid of **0**.
209
+
210
+**COPY**
211
+  -- **COPY** has two forms:
212
+
213
+  ```
214
+  COPY <src> <dest>
215
+
216
+  # Required for paths with whitespace
217
+  COPY ["<src>",... "<dest>"]
218
+  ```
219
+
220
+  The **COPY** instruction copies new files from `<src>` and
221
+  adds them to the filesystem of the container at path <dest>. The `<src>` must be
222
+  the path to a file or directory relative to the source directory that is
223
+  being built (the context of the build) or a remote file URL. The `<dest>` is an
224
+  absolute path, or a path relative to **WORKDIR**, into which the source will
225
+  be copied inside the target container. All new files and directories are
226
+  created with mode **0755** and with the uid and gid of **0**.
227
+
228
+**ENTRYPOINT**
229
+  -- **ENTRYPOINT** has two forms:
230
+
231
+  ```
232
+  # executable form
233
+  ENTRYPOINT ["executable", "param1", "param2"]`
234
+
235
+  # run command in a shell - /bin/sh -c
236
+  ENTRYPOINT command param1 param2
237
+  ```
238
+
239
+  -- An **ENTRYPOINT** helps you configure a
240
+  container that can be run as an executable. When you specify an **ENTRYPOINT**,
241
+  the whole container runs as if it was only that executable.  The **ENTRYPOINT**
242
+  instruction adds an entry command that is not overwritten when arguments are
243
+  passed to docker run. This is different from the behavior of CMD. This allows
244
+  arguments to be passed to the entrypoint, for instance `docker run <image> -d`
245
+  passes the -d argument to the **ENTRYPOINT**.  Specify parameters either in the
246
+  **ENTRYPOINT** JSON array (as in the preferred exec form above), or by using a **CMD**
247
+  statement.  Parameters in the **ENTRYPOINT** are not overwritten by the docker run
248
+  arguments.  Parameters specifies via **CMD** are overwritten by docker run
249
+  arguments.  Specify a plain string for the **ENTRYPOINT**, and it will execute in
250
+  `/bin/sh -c`, like a **CMD** instruction:
251
+
252
+  ```
253
+  FROM ubuntu
254
+  ENTRYPOINT wc -l -
255
+  ```
256
+
257
+  This means that the Dockerfile's image always takes stdin as input (that's
258
+  what "-" means), and prints the number of lines (that's what "-l" means). To
259
+  make this optional but default, use a **CMD**:
260
+
261
+  ```
262
+  FROM ubuntu
263
+  CMD ["-l", "-"]
264
+  ENTRYPOINT ["/usr/bin/wc"]
265
+  ```
266
+
267
+**VOLUME**
268
+  -- `VOLUME ["/data"]`
269
+  The **VOLUME** instruction creates a mount point with the specified name and marks
270
+  it as holding externally-mounted volumes from the native host or from other
271
+  containers.
272
+
273
+**USER**
274
+  -- `USER daemon`
275
+  Sets the username or UID used for running subsequent commands.
276
+
277
+  The **USER** instruction can optionally be used to set the group or GID. The
278
+  followings examples are all valid:
279
+  USER [user | user:group | uid | uid:gid | user:gid | uid:group ]
280
+
281
+  Until the **USER** instruction is set, instructions will be run as root. The USER
282
+  instruction can be used any number of times in a Dockerfile, and will only affect
283
+  subsequent commands.
284
+
285
+**WORKDIR**
286
+  -- `WORKDIR /path/to/workdir`
287
+  The **WORKDIR** instruction sets the working directory for the **RUN**, **CMD**,
288
+  **ENTRYPOINT**, **COPY** and **ADD** Dockerfile commands that follow it. It can
289
+  be used multiple times in a single Dockerfile. Relative paths are defined
290
+  relative to the path of the previous **WORKDIR** instruction. For example:
291
+
292
+  ```
293
+  WORKDIR /a
294
+  WORKDIR b
295
+  WORKDIR c
296
+  RUN pwd
297
+  ```
298
+
299
+  In the above example, the output of the **pwd** command is **a/b/c**.
300
+
301
+**ONBUILD**
302
+  -- `ONBUILD [INSTRUCTION]`
303
+  The **ONBUILD** instruction adds a trigger instruction to an image. The
304
+  trigger is executed at a later time, when the image is used as the base for
305
+  another build. Docker executes the trigger in the context of the downstream
306
+  build, as if the trigger existed immediately after the **FROM** instruction in
307
+  the downstream Dockerfile.
308
+
309
+  You can register any build instruction as a trigger. A trigger is useful if
310
+  you are defining an image to use as a base for building other images. For
311
+  example, if you are defining an application build environment or a daemon that
312
+  is customized with a user-specific configuration.  
313
+  
314
+  Consider an image intended as a reusable python application builder. It must
315
+  add application source code to a particular directory, and might need a build
316
+  script called after that. You can't just call **ADD** and **RUN** now, because
317
+  you don't yet have access to the application source code, and it is different
318
+  for each application build.
319
+
320
+  -- Providing application developers with a boilerplate Dockerfile to copy-paste
321
+  into their application is inefficient, error-prone, and
322
+  difficult to update because it mixes with application-specific code.
323
+  The solution is to use **ONBUILD** to register instructions in advance, to
324
+  run later, during the next build stage.
325
+
326
+# HISTORY
327
+*May 2014, Compiled by Zac Dover (zdover at redhat dot com) based on docker.com Dockerfile documentation.
328
+*Feb 2015, updated by Brian Goff (cpuguy83@gmail.com) for readability
0 329
new file mode 100644
... ...
@@ -0,0 +1,44 @@
0
+Docker Documentation
1
+====================
2
+
3
+This directory contains the Docker user manual in the Markdown format.
4
+Do *not* edit the man pages in the man1 directory. Instead, amend the
5
+Markdown (*.md) files.
6
+
7
+# Generating man pages from the Markdown files
8
+
9
+The recommended approach for generating the man pages is via a Docker
10
+container using the supplied `Dockerfile` to create an image with the correct
11
+environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
12
+
13
+### Generate the man pages 
14
+
15
+On Linux installations, Docker includes a set of man pages you can access by typing `man command-name` on the command line. For example, `man docker` displays the `docker` man page. When using Docker on Mac OSX the man pages are not automatically included. 
16
+
17
+You can generate and install the `man` pages yourself by following these steps:
18
+
19
+1. Checkout the `docker` source. 
20
+
21
+        $ git clone https://github.com/docker/docker.git
22
+        
23
+  If you are using Boot2Docker, you must clone into your `/Users` directory
24
+  because Boot2Docker can only share this path with the docker containers.
25
+		
26
+2. Build the docker image.
27
+   
28
+        $ cd docker/man
29
+        $ docker build -t docker/md2man .
30
+
31
+3. Build the man pages.
32
+
33
+        $ docker run -v <path-to-git-dir>/docker/man:/man:rw -w /man -i docker/md2man /man/md2man-all.sh
34
+        
35
+  The `md2man` Docker container processes the Markdown files and generates
36
+ a `man1` and `man5` subdirectories in the `docker/man` directory. 
37
+
38
+4. Copy the generated man pages to `/usr/share/man`
39
+
40
+        $ cp -R man* /usr/share/man/
41
+
42
+
43
+
0 44
new file mode 100644
... ...
@@ -0,0 +1,70 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-attach - Attach to a running container
5
+
6
+# SYNOPSIS
7
+**docker attach**
8
+[**--help**]/
9
+[**--no-stdin**[=*false*]]
10
+[**--sig-proxy**[=*true*]]
11
+CONTAINER
12
+
13
+# DESCRIPTION
14
+The **docker attach** command allows you to attach to a running container using
15
+the container's ID or name, either to view its ongoing output or to control it
16
+interactively.  You can attach to the same contained process multiple times
17
+simultaneously, screen sharing style, or quickly view the progress of your
18
+daemonized process.
19
+
20
+You can detach from the container (and leave it running) with `CTRL-p CTRL-q`
21
+(for a quiet exit) or `CTRL-c` which will send a `SIGKILL` to the container.
22
+When you are attached to a container, and exit its main process, the process's
23
+exit code will be returned to the client.
24
+
25
+It is forbidden to redirect the standard input of a `docker attach` command while
26
+attaching to a tty-enabled container (i.e.: launched with `-t`).
27
+
28
+# OPTIONS
29
+**--help**
30
+  Print usage statement
31
+
32
+**--no-stdin**=*true*|*false*
33
+   Do not attach STDIN. The default is *false*.
34
+
35
+**--sig-proxy**=*true*|*false*
36
+   Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
37
+
38
+# EXAMPLES
39
+
40
+## Attaching to a container
41
+
42
+In this example the top command is run inside a container, from an image called
43
+fedora, in detached mode. The ID from the container is passed into the **docker
44
+attach** command:
45
+
46
+    # ID=$(sudo docker run -d fedora /usr/bin/top -b)
47
+    # sudo docker attach $ID
48
+    top - 02:05:52 up  3:05,  0 users,  load average: 0.01, 0.02, 0.05
49
+    Tasks:   1 total,   1 running,   0 sleeping,   0 stopped,   0 zombie
50
+    Cpu(s):  0.1%us,  0.2%sy,  0.0%ni, 99.7%id,  0.0%wa,  0.0%hi,  0.0%si,  0.0%st
51
+    Mem:    373572k total,   355560k used,    18012k free,    27872k buffers
52
+    Swap:   786428k total,        0k used,   786428k free,   221740k cached
53
+
54
+    PID USER      PR  NI  VIRT  RES  SHR S %CPU %MEM    TIME+  COMMAND
55
+    1 root      20   0 17200 1116  912 R    0  0.3   0:00.03 top
56
+
57
+    top - 02:05:55 up  3:05,  0 users,  load average: 0.01, 0.02, 0.05
58
+    Tasks:   1 total,   1 running,   0 sleeping,   0 stopped,   0 zombie
59
+    Cpu(s):  0.0%us,  0.2%sy,  0.0%ni, 99.8%id,  0.0%wa,  0.0%hi,  0.0%si,  0.0%st
60
+    Mem:    373572k total,   355244k used,    18328k free,    27872k buffers
61
+    Swap:   786428k total,        0k used,   786428k free,   221776k cached
62
+
63
+    PID USER      PR  NI  VIRT  RES  SHR S %CPU %MEM    TIME+  COMMAND
64
+    1 root      20   0 17208 1144  932 R    0  0.3   0:00.03 top
65
+
66
+# HISTORY
67
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
68
+based on docker.com source material and internal work.
69
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 70
new file mode 100644
... ...
@@ -0,0 +1,215 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-build - Build a new image from the source code at PATH
5
+
6
+# SYNOPSIS
7
+**docker build**
8
+[**--help**]
9
+[**-f**|**--file**[=*PATH/Dockerfile*]]
10
+[**--force-rm**[=*false*]]
11
+[**--no-cache**[=*false*]]
12
+[**--pull**[=*false*]]
13
+[**-q**|**--quiet**[=*false*]]
14
+[**--rm**[=*true*]]
15
+[**-t**|**--tag**[=*TAG*]]
16
+[**-m**|**--memory**[=*MEMORY*]]
17
+[**--memory-swap**[=*MEMORY-SWAP*]]
18
+[**-c**|**--cpu-shares**[=*0*]]
19
+[**--cpu-period**[=*0*]]
20
+[**--cpu-quota**[=*0*]]
21
+[**--cpuset-cpus**[=*CPUSET-CPUS*]]
22
+[**--cpuset-mems**[=*CPUSET-MEMS*]]
23
+[**--cgroup-parent**[=*CGROUP-PARENT*]]
24
+
25
+PATH | URL | -
26
+
27
+# DESCRIPTION
28
+This will read the Dockerfile from the directory specified in **PATH**.
29
+It also sends any other files and directories found in the current
30
+directory to the Docker daemon. The contents of this directory would
31
+be used by **ADD** commands found within the Dockerfile.
32
+
33
+Warning, this will send a lot of data to the Docker daemon depending
34
+on the contents of the current directory. The build is run by the Docker 
35
+daemon, not by the CLI, so the whole context must be transferred to the daemon. 
36
+The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to 
37
+the daemon.
38
+
39
+When a single Dockerfile is given as the URL, then no context is set.
40
+When a Git repository is set as the **URL**, the repository is used
41
+as context.
42
+
43
+# OPTIONS
44
+**-f**, **--file**=*PATH/Dockerfile*
45
+   Path to the Dockerfile to use. If the path is a relative path then it must be relative to the current directory. The file must be within the build context. The default is *Dockerfile*.
46
+
47
+**--force-rm**=*true*|*false*
48
+   Always remove intermediate containers, even after unsuccessful builds. The default is *false*.
49
+
50
+**--no-cache**=*true*|*false*
51
+   Do not use cache when building the image. The default is *false*.
52
+
53
+**--help**
54
+  Print usage statement
55
+
56
+**--pull**=*true*|*false*
57
+   Always attempt to pull a newer version of the image. The default is *false*.
58
+
59
+**-q**, **--quiet**=*true*|*false*
60
+   Suppress the verbose output generated by the containers. The default is *false*.
61
+
62
+**--rm**=*true*|*false*
63
+   Remove intermediate containers after a successful build. The default is *true*.
64
+
65
+**-t**, **--tag**=""
66
+   Repository name (and optionally a tag) to be applied to the resulting image in case of success
67
+
68
+**-m**, **--memory**=*MEMORY*
69
+  Memory limit
70
+
71
+**--memory-swap**=*MEMORY-SWAP*
72
+  Total memory (memory + swap), '-1' to disable swap.
73
+
74
+**-c**, **--cpu-shares**=*0*
75
+  CPU shares (relative weight).
76
+
77
+  By default, all containers get the same proportion of CPU cycles. You can
78
+  change this proportion by adjusting the container's CPU share weighting
79
+  relative to the weighting of all other running containers.
80
+
81
+  To modify the proportion from the default of 1024, use the **-c** or
82
+  **--cpu-shares** flag to set the weighting to 2 or higher.
83
+
84
+  The proportion is only applied when CPU-intensive processes are running.
85
+  When tasks in one container are idle, the other containers can use the
86
+  left-over CPU time. The actual amount of CPU time used varies depending on
87
+  the number of containers running on the system.
88
+
89
+  For example, consider three containers, one has a cpu-share of 1024 and
90
+  two others have a cpu-share setting of 512. When processes in all three
91
+  containers attempt to use 100% of CPU, the first container would receive
92
+  50% of the total CPU time. If you add a fourth container with a cpu-share
93
+  of 1024, the first container only gets 33% of the CPU. The remaining containers
94
+  receive 16.5%, 16.5% and 33% of the CPU.
95
+
96
+  On a multi-core system, the shares of CPU time are distributed across the CPU
97
+  cores. Even if a container is limited to less than 100% of CPU time, it can
98
+  use 100% of each individual CPU core.
99
+
100
+  For example, consider a system with more than three cores. If you start one
101
+  container **{C0}** with **-c=512** running one process, and another container
102
+  **{C1}** with **-c=1024** running two processes, this can result in the following
103
+  division of CPU shares:
104
+
105
+      PID    container    CPU    CPU share
106
+      100    {C0}         0      100% of CPU0
107
+      101    {C1}         1      100% of CPU1
108
+      102    {C1}         2      100% of CPU2
109
+
110
+**--cpu-period**=*0*
111
+  Limit the CPU CFS (Completely Fair Scheduler) period.
112
+
113
+  Limit the container's CPU usage. This flag causes the kernel to restrict the
114
+  container's CPU usage to the period you specify.
115
+
116
+**--cpu-quota**=*0*
117
+  Limit the CPU CFS (Completely Fair Scheduler) quota. 
118
+
119
+  By default, containers run with the full CPU resource. This flag causes the
120
+kernel to restrict the container's CPU usage to the quota you specify.
121
+
122
+**--cpuset-cpus**=*CPUSET-CPUS*
123
+  CPUs in which to allow execution (0-3, 0,1).
124
+
125
+**--cpuset-mems**=*CPUSET-MEMS*
126
+  Memory nodes (MEMs) in which to allow execution (-1-3, 0,1). Only effective on
127
+  NUMA systems.
128
+
129
+  For example, if you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
130
+to ensure the processes in your Docker container only use memory from the first
131
+two memory nodes.
132
+
133
+**--cgroup-parent**=*CGROUP-PARENT*
134
+  Path to `cgroups` under which the container's `cgroup` are created.
135
+
136
+  If the path is not absolute, the path is considered relative to the `cgroups` path of the init process.
137
+Cgroups are created if they do not already exist.
138
+
139
+# EXAMPLES
140
+
141
+## Building an image using a Dockerfile located inside the current directory
142
+
143
+Docker images can be built using the build command and a Dockerfile:
144
+
145
+    docker build .
146
+
147
+During the build process Docker creates intermediate images. In order to
148
+keep them, you must explicitly set `--rm=false`.
149
+
150
+    docker build --rm=false .
151
+
152
+A good practice is to make a sub-directory with a related name and create
153
+the Dockerfile in that directory. For example, a directory called mongo may
154
+contain a Dockerfile to create a Docker MongoDB image. Likewise, another
155
+directory called httpd may be used to store Dockerfiles for Apache web
156
+server images.
157
+
158
+It is also a good practice to add the files required for the image to the
159
+sub-directory. These files will then be specified with the `COPY` or `ADD`
160
+instructions in the `Dockerfile`.
161
+
162
+Note: If you include a tar file (a good practice), then Docker will
163
+automatically extract the contents of the tar file specified within the `ADD`
164
+instruction into the specified target.
165
+
166
+## Building an image and naming that image
167
+
168
+A good practice is to give a name to the image you are building. There are
169
+no hard rules here but it is best to give the names consideration. 
170
+
171
+The **-t**/**--tag** flag is used to rename an image. Here are some examples:
172
+
173
+Though it is not a good practice, image names can be arbitrary:
174
+
175
+    docker build -t myimage .
176
+
177
+A better approach is to provide a fully qualified and meaningful repository,
178
+name, and tag (where the tag in this context means the qualifier after 
179
+the ":"). In this example we build a JBoss image for the Fedora repository 
180
+and give it the version 1.0:
181
+
182
+    docker build -t fedora/jboss:1.0
183
+
184
+The next example is for the "whenry" user repository and uses Fedora and
185
+JBoss and gives it the version 2.1 :
186
+
187
+    docker build -t whenry/fedora-jboss:V2.1
188
+
189
+If you do not provide a version tag then Docker will assign `latest`:
190
+
191
+    docker build -t whenry/fedora-jboss
192
+
193
+When you list the images, the image above will have the tag `latest`.
194
+
195
+So renaming an image is arbitrary but consideration should be given to 
196
+a useful convention that makes sense for consumers and should also take
197
+into account Docker community conventions.
198
+
199
+
200
+## Building an image using a URL
201
+
202
+This will clone the specified Github repository from the URL and use it
203
+as context. The Dockerfile at the root of the repository is used as
204
+Dockerfile. This only works if the Github repository is a dedicated
205
+repository.
206
+
207
+    docker build github.com/scollier/Fedora-Dockerfiles/tree/master/apache
208
+
209
+Note: You can set an arbitrary Git repository via the `git://` schema.
210
+
211
+# HISTORY
212
+March 2014, Originally compiled by William Henry (whenry at redhat dot com)
213
+based on docker.com source material and internal work.
214
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 215
new file mode 100644
... ...
@@ -0,0 +1,59 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-commit - Create a new image from a container's changes
5
+
6
+# SYNOPSIS
7
+**docker commit**
8
+[**-a**|**--author**[=*AUTHOR*]]
9
+[**--help**]
10
+[**-c**|**--change**[= []**]]
11
+[**-m**|**--message**[=*MESSAGE*]]
12
+[**-p**|**--pause**[=*true*]]
13
+CONTAINER [REPOSITORY[:TAG]]
14
+
15
+# DESCRIPTION
16
+Using an existing container's name or ID you can create a new image.
17
+
18
+# OPTIONS
19
+**-a**, **--author**=""
20
+   Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
21
+
22
+**-c** , **--change**=[]
23
+   Apply specified Dockerfile instructions while committing the image
24
+   Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
25
+
26
+**--help**
27
+  Print usage statement
28
+
29
+**-m**, **--message**=""
30
+   Commit message
31
+
32
+**-p**, **--pause**=*true*|*false*
33
+   Pause container during commit. The default is *true*.
34
+
35
+# EXAMPLES
36
+
37
+## Creating a new image from an existing container
38
+An existing Fedora based container has had Apache installed while running
39
+in interactive mode with the bash shell. Apache is also running. To
40
+create a new image run `docker ps` to find the container's ID and then run:
41
+
42
+    # docker commit -m="Added Apache to Fedora base image" \
43
+      -a="A D Ministrator" 98bd7fc99854 fedora/fedora_httpd:20
44
+
45
+## Apply specified Dockerfile instructions while committing the image
46
+If an existing container was created without the DEBUG environment
47
+variable set to "true", you can create a new image based on that
48
+container by first getting the container's ID with `docker ps` and
49
+then running:
50
+
51
+    # docker commit -c="ENV DEBUG true" 98bd7fc99854 debug-image
52
+
53
+# HISTORY
54
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
55
+based on docker.com source material and in
56
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
57
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
58
+Oct 2014, updated by Daniel, Dao Quang Minh <daniel at nitrous dot io>
0 59
new file mode 100644
... ...
@@ -0,0 +1,70 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-cp - Copy files or folders from a container's PATH to a HOSTDIR
5
+or to STDOUT.
6
+
7
+# SYNOPSIS
8
+**docker cp**
9
+[**--help**]
10
+CONTAINER:PATH HOSTDIR|-
11
+
12
+# DESCRIPTION
13
+
14
+Copy files or folders from a `CONTAINER:PATH` to the `HOSTDIR` or to `STDOUT`. 
15
+The `CONTAINER:PATH` is relative to the root of the container's filesystem. You
16
+can copy from either a running or stopped container. 
17
+
18
+The `PATH` can be a file or directory. The `docker cp` command assumes all
19
+`PATH` values start at the `/` (root) directory. This means supplying the
20
+initial forward slash is optional; The command sees
21
+`compassionate_darwin:/tmp/foo/myfile.txt` and
22
+`compassionate_darwin:tmp/foo/myfile.txt` as identical.
23
+
24
+The `HOSTDIR` refers to a directory on the host. If you do not specify an
25
+absolute path for your `HOSTDIR` value, Docker creates the directory relative to
26
+where you run the `docker cp` command. For example, suppose you want to copy the
27
+`/tmp/foo` directory from a container to the `/tmp` directory on your host. If
28
+you run `docker cp` in your `~` (home) directory on the host:
29
+
30
+		$ docker cp compassionate_darwin:tmp/foo /tmp
31
+
32
+Docker creates a `/tmp/foo` directory on your host. Alternatively, you can omit
33
+the leading slash in the command. If you execute this command from your home directory:
34
+
35
+		$ docker cp compassionate_darwin:tmp/foo tmp
36
+
37
+Docker creates a `~/tmp/foo` subdirectory.  
38
+
39
+When copying files to an existing `HOSTDIR`, the `cp` command adds the new files to
40
+the directory. For example, this command:
41
+
42
+		$ docker cp sharp_ptolemy:/tmp/foo/myfile.txt /tmp
43
+
44
+Creates a `/tmp/foo` directory on the host containing the `myfile.txt` file. If
45
+you repeat the command but change the filename:
46
+
47
+		$ docker cp sharp_ptolemy:/tmp/foo/secondfile.txt /tmp
48
+
49
+Your host's `/tmp/foo` directory will contain both files:
50
+
51
+		$ ls /tmp/foo
52
+		myfile.txt secondfile.txt
53
+		
54
+Finally, use '-' to write the data as a `tar` file to STDOUT.
55
+
56
+# OPTIONS
57
+**--help**
58
+  Print usage statement
59
+
60
+# EXAMPLES
61
+An important shell script file, created in a bash shell, is copied from
62
+the exited container to the current dir on the host:
63
+
64
+    # docker cp c071f3c3ee81:setup.sh .
65
+
66
+# HISTORY
67
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
68
+based on docker.com source material and internal work.
69
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 70
new file mode 100644
... ...
@@ -0,0 +1,236 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-create - Create a new container
5
+
6
+# SYNOPSIS
7
+**docker create**
8
+[**-a**|**--attach**[=*[]*]]
9
+[**--add-host**[=*[]*]]
10
+[**--blkio-weight**[=*[BLKIO-WEIGHT]*]]
11
+[**-c**|**--cpu-shares**[=*0*]]
12
+[**--cap-add**[=*[]*]]
13
+[**--cap-drop**[=*[]*]]
14
+[**--cidfile**[=*CIDFILE*]]
15
+[**--cpu-period**[=*0*]]
16
+[**--cpuset-cpus**[=*CPUSET-CPUS*]]
17
+[**--cpuset-mems**[=*CPUSET-MEMS*]]
18
+[**--cpu-quota**[=*0*]]
19
+[**--device**[=*[]*]]
20
+[**--dns-search**[=*[]*]]
21
+[**--dns**[=*[]*]]
22
+[**-e**|**--env**[=*[]*]]
23
+[**--entrypoint**[=*ENTRYPOINT*]]
24
+[**--env-file**[=*[]*]]
25
+[**--expose**[=*[]*]]
26
+[**-h**|**--hostname**[=*HOSTNAME*]]
27
+[**--help**]
28
+[**-i**|**--interactive**[=*false*]]
29
+[**--ipc**[=*IPC*]]
30
+[**-l**|**--label**[=*[]*]]
31
+[**--label-file**[=*[]*]]
32
+[**--link**[=*[]*]]
33
+[**--lxc-conf**[=*[]*]]
34
+[**--log-driver**[=*[]*]]
35
+[**--log-opt**[=*[]*]]
36
+[**-m**|**--memory**[=*MEMORY*]]
37
+[**--memory-swap**[=*MEMORY-SWAP*]]
38
+[**--mac-address**[=*MAC-ADDRESS*]]
39
+[**--name**[=*NAME*]]
40
+[**--net**[=*"bridge"*]]
41
+[**--oom-kill-disable**[=*false*]]
42
+[**-P**|**--publish-all**[=*false*]]
43
+[**-p**|**--publish**[=*[]*]]
44
+[**--pid**[=*[]*]]
45
+[**--uts**[=*[]*]]
46
+[**--privileged**[=*false*]]
47
+[**--read-only**[=*false*]]
48
+[**--restart**[=*RESTART*]]
49
+[**--security-opt**[=*[]*]]
50
+[**-t**|**--tty**[=*false*]]
51
+[**-u**|**--user**[=*USER*]]
52
+[**-v**|**--volume**[=*[]*]]
53
+[**--volumes-from**[=*[]*]]
54
+[**-w**|**--workdir**[=*WORKDIR*]]
55
+[**--cgroup-parent**[=*CGROUP-PATH*]]
56
+IMAGE [COMMAND] [ARG...]
57
+
58
+# OPTIONS
59
+**-a**, **--attach**=[]
60
+   Attach to STDIN, STDOUT or STDERR.
61
+
62
+**--add-host**=[]
63
+   Add a custom host-to-IP mapping (host:ip)
64
+
65
+**--blkio-weight**=0
66
+   Block IO weight (relative weight) accepts a weight value between 10 and 1000.
67
+
68
+**-c**, **--cpu-shares**=0
69
+   CPU shares (relative weight)
70
+
71
+**--cap-add**=[]
72
+   Add Linux capabilities
73
+
74
+**--cap-drop**=[]
75
+   Drop Linux capabilities
76
+
77
+**--cidfile**=""
78
+   Write the container ID to the file
79
+
80
+**--cgroup-parent**=""
81
+   Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
82
+
83
+**--cpu-peroid**=0
84
+    Limit the CPU CFS (Completely Fair Scheduler) period
85
+
86
+**--cpuset-cpus**=""
87
+   CPUs in which to allow execution (0-3, 0,1)
88
+
89
+**--cpuset-mems**=""
90
+   Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
91
+
92
+   If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
93
+then processes in your Docker container will only use memory from the first
94
+two memory nodes.
95
+
96
+**-cpu-quota**=0
97
+   Limit the CPU CFS (Completely Fair Scheduler) quota
98
+
99
+**--device**=[]
100
+   Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
101
+
102
+**--dns-search**=[]
103
+   Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
104
+
105
+**--dns**=[]
106
+   Set custom DNS servers
107
+
108
+**-e**, **--env**=[]
109
+   Set environment variables
110
+
111
+**--entrypoint**=""
112
+   Overwrite the default ENTRYPOINT of the image
113
+
114
+**--env-file**=[]
115
+   Read in a line delimited file of environment variables
116
+
117
+**--expose**=[]
118
+   Expose a port or a range of ports (e.g. --expose=3300-3310) from the container without publishing it to your host
119
+
120
+**-h**, **--hostname**=""
121
+   Container host name
122
+
123
+**--help**
124
+  Print usage statement
125
+
126
+**-i**, **--interactive**=*true*|*false*
127
+   Keep STDIN open even if not attached. The default is *false*.
128
+
129
+**--ipc**=""
130
+   Default is to create a private IPC namespace (POSIX SysV IPC) for the container
131
+                               'container:<name|id>': reuses another container shared memory, semaphores and message queues
132
+                               'host': use the host shared memory,semaphores and message queues inside the container.  Note: the host mode gives the container full access to local shared memory and is therefore considered insecure.
133
+
134
+**-l**, **--label**=[]
135
+   Adds metadata to a container (e.g., --label=com.example.key=value)
136
+
137
+**--label-file**=[]
138
+   Read labels from a file. Delimit each label with an EOL.
139
+
140
+**--link**=[]
141
+   Add link to another container in the form of <name or id>:alias or just
142
+   <name or id> in which case the alias will match the name.
143
+
144
+**--lxc-conf**=[]
145
+   (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
146
+
147
+**--log-driver**="|*json-file*|*syslog*|*journald*|*none*"
148
+  Logging driver for container. Default is defined by daemon `--log-driver` flag.
149
+  **Warning**: `docker logs` command works only for `json-file` logging driver.
150
+
151
+**--log-opt**=[]
152
+  Logging driver specific options.
153
+
154
+**-m**, **--memory**=""
155
+   Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
156
+
157
+   Allows you to constrain the memory available to a container. If the host
158
+supports swap memory, then the **-m** memory setting can be larger than physical
159
+RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
160
+not limited. The actual limit may be rounded up to a multiple of the operating
161
+system's page size (the value would be very large, that's millions of trillions).
162
+
163
+**--memory-swap**=""
164
+   Total memory limit (memory + swap)
165
+
166
+   Set `-1` to disable swap (format: <number><optional unit>, where unit = b, k, m or g).
167
+This value should always larger than **-m**, so you should always use this with **-m**.
168
+
169
+**--mac-address**=""
170
+   Container MAC address (e.g. 92:d0:c6:0a:29:33)
171
+
172
+**--name**=""
173
+   Assign a name to the container
174
+
175
+**--net**="bridge"
176
+   Set the Network mode for the container
177
+                               'bridge': creates a new network stack for the container on the docker bridge
178
+                               'none': no networking for this container
179
+                               'container:<name|id>': reuses another container network stack
180
+                               'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
181
+
182
+**--oom-kill-disable**=*true*|*false*
183
+	Whether to disable OOM Killer for the container or not.
184
+
185
+**-P**, **--publish-all**=*true*|*false*
186
+   Publish all exposed ports to random ports on the host interfaces. The default is *false*.
187
+
188
+**-p**, **--publish**=[]
189
+   Publish a container's port, or a range of ports, to the host
190
+                               format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
191
+                               Both hostPort and containerPort can be specified as a range of ports. 
192
+                               When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. (e.g., `-p 1234-1236:1234-1236/tcp`)
193
+                               (use 'docker port' to see the actual mapping)
194
+
195
+**--pid**=host
196
+   Set the PID mode for the container
197
+     **host**: use the host's PID namespace inside the container.
198
+     Note: the host mode gives the container full access to local PID and is therefore considered insecure.
199
+
200
+**--uts**=host
201
+   Set the UTS mode for the container
202
+     **host**: use the host's UTS namespace inside the container.
203
+     Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
204
+
205
+**--privileged**=*true*|*false*
206
+   Give extended privileges to this container. The default is *false*.
207
+
208
+**--read-only**=*true*|*false*
209
+   Mount the container's root filesystem as read only.
210
+
211
+**--restart**="no"
212
+   Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
213
+
214
+**--security-opt**=[]
215
+   Security Options
216
+
217
+**-t**, **--tty**=*true*|*false*
218
+   Allocate a pseudo-TTY. The default is *false*.
219
+
220
+**-u**, **--user**=""
221
+   Username or UID
222
+
223
+**-v**, **--volume**=[]
224
+   Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
225
+
226
+**--volumes-from**=[]
227
+   Mount volumes from the specified container(s)
228
+
229
+**-w**, **--workdir**=""
230
+   Working directory inside the container
231
+
232
+# HISTORY
233
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
234
+September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
235
+November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 236
new file mode 100644
... ...
@@ -0,0 +1,49 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-diff - Inspect changes on a container's filesystem
5
+
6
+# SYNOPSIS
7
+**docker diff**
8
+[**--help**]
9
+CONTAINER
10
+
11
+# DESCRIPTION
12
+Inspect changes on a container's filesystem. You can use the full or
13
+shortened container ID or the container name set using
14
+**docker run --name** option.
15
+
16
+# OPTIONS
17
+**--help**
18
+  Print usage statement
19
+
20
+# EXAMPLES
21
+Inspect the changes to on a nginx container:
22
+
23
+    # docker diff 1fdfd1f54c1b
24
+    C /dev
25
+    C /dev/console
26
+    C /dev/core
27
+    C /dev/stdout
28
+    C /dev/fd
29
+    C /dev/ptmx
30
+    C /dev/stderr
31
+    C /dev/stdin
32
+    C /run
33
+    A /run/nginx.pid
34
+    C /var/lib/nginx/tmp
35
+    A /var/lib/nginx/tmp/client_body
36
+    A /var/lib/nginx/tmp/fastcgi
37
+    A /var/lib/nginx/tmp/proxy
38
+    A /var/lib/nginx/tmp/scgi
39
+    A /var/lib/nginx/tmp/uwsgi
40
+    C /var/log/nginx
41
+    A /var/log/nginx/access.log
42
+    A /var/log/nginx/error.log
43
+
44
+
45
+# HISTORY
46
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
47
+based on docker.com source material and internal work.
48
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 49
new file mode 100644
... ...
@@ -0,0 +1,74 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-events - Get real time events from the server
5
+
6
+# SYNOPSIS
7
+**docker events**
8
+[**--help**]
9
+[**-f**|**--filter**[=*[]*]]
10
+[**--since**[=*SINCE*]]
11
+[**--until**[=*UNTIL*]]
12
+
13
+
14
+# DESCRIPTION
15
+Get event information from the Docker daemon. Information can include historical
16
+information and real-time information.
17
+
18
+Docker containers will report the following events:
19
+
20
+    create, destroy, die, export, kill, pause, restart, start, stop, unpause
21
+
22
+and Docker images will report:
23
+
24
+    untag, delete
25
+
26
+# OPTIONS
27
+**--help**
28
+  Print usage statement
29
+
30
+**-f**, **--filter**=[]
31
+   Provide filter values (i.e., 'event=stop')
32
+
33
+**--since**=""
34
+   Show all events created since timestamp
35
+
36
+**--until**=""
37
+   Stream events until this timestamp
38
+
39
+# EXAMPLES
40
+
41
+## Listening for Docker events
42
+
43
+After running docker events a container 786d698004576 is started and stopped
44
+(The container name has been shortened in the output below):
45
+
46
+    # docker events
47
+    2015-01-28T20:21:31.000000000-08:00 59211849bc10: (from whenry/testimage:latest) start
48
+    2015-01-28T20:21:31.000000000-08:00 59211849bc10: (from whenry/testimage:latest) die
49
+    2015-01-28T20:21:32.000000000-08:00 59211849bc10: (from whenry/testimage:latest) stop
50
+
51
+## Listening for events since a given date
52
+Again the output container IDs have been shortened for the purposes of this document:
53
+
54
+    # docker events --since '2015-01-28'
55
+    2015-01-28T20:25:38.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) create
56
+    2015-01-28T20:25:38.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
57
+    2015-01-28T20:25:39.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) create
58
+    2015-01-28T20:25:39.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
59
+    2015-01-28T20:25:40.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) die
60
+    2015-01-28T20:25:42.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) stop
61
+    2015-01-28T20:25:45.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
62
+    2015-01-28T20:25:45.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) die
63
+    2015-01-28T20:25:46.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) stop
64
+
65
+
66
+If you do not provide the --since option, the command returns only new and/or
67
+live events.
68
+
69
+# HISTORY
70
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
71
+based on docker.com source material and internal work.
72
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
73
+June 2015, updated by Brian Goff <cpuguy83@gmail.com>
0 74
new file mode 100644
... ...
@@ -0,0 +1,51 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-exec - Run a command in a running container
5
+
6
+# SYNOPSIS
7
+**docker exec**
8
+[**-d**|**--detach**[=*false*]]
9
+[**--help**]
10
+[**-i**|**--interactive**[=*false*]]
11
+[**-t**|**--tty**[=*false*]]
12
+[**-u**|**--user**[=*USER*]]
13
+CONTAINER COMMAND [ARG...]
14
+
15
+# DESCRIPTION
16
+
17
+Run a process in a running container. 
18
+
19
+The command started using `docker exec` will only run while the container's primary
20
+process (`PID 1`) is running, and will not be restarted if the container is restarted.
21
+
22
+If the container is paused, then the `docker exec` command will wait until the
23
+container is unpaused, and then run
24
+
25
+# OPTIONS
26
+**-d**, **--detach**=*true*|*false*
27
+   Detached mode: run command in the background. The default is *false*.
28
+
29
+**--help**
30
+  Print usage statement
31
+
32
+**-i**, **--interactive**=*true*|*false*
33
+   Keep STDIN open even if not attached. The default is *false*.
34
+
35
+**-t**, **--tty**=*true*|*false*
36
+   Allocate a pseudo-TTY. The default is *false*.
37
+
38
+**-u**, **--user**=""
39
+   Sets the username or UID used and optionally the groupname or GID for the specified command.
40
+
41
+   The followings examples are all valid:
42
+   --user [user | user:group | uid | uid:gid | user:gid | uid:group ]
43
+
44
+   Without this argument the command will be run as root in the container.
45
+
46
+The **-t** option is incompatible with a redirection of the docker client
47
+standard input.
48
+
49
+# HISTORY
50
+November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 51
new file mode 100644
... ...
@@ -0,0 +1,44 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-export - Export the contents of a filesystem as a tar archive to STDOUT
5
+
6
+# SYNOPSIS
7
+**docker export**
8
+[**--help**]
9
+CONTAINER
10
+
11
+# DESCRIPTION
12
+Export the contents of a container's filesystem using the full or shortened
13
+container ID or container name. The output is exported to STDOUT and can be
14
+redirected to a tar file.
15
+
16
+Stream to a file instead of STDOUT by using **-o**.
17
+
18
+# OPTIONS
19
+**--help**
20
+  Print usage statement
21
+**-o**, **--output**=""
22
+   Write to a file, instead of STDOUT
23
+
24
+# EXAMPLES
25
+Export the contents of the container called angry_bell to a tar file
26
+called angry_bell.tar:
27
+
28
+    # docker export angry_bell > angry_bell.tar
29
+    # docker export --output=angry_bell-latest.tar angry_bell
30
+    # ls -sh angry_bell.tar
31
+    321M angry_bell.tar
32
+    # ls -sh angry_bell-latest.tar
33
+    321M angry_bell-latest.tar
34
+
35
+# See also
36
+**docker-import(1)** to create an empty filesystem image
37
+and import the contents of the tarball into it, then optionally tag it.
38
+
39
+# HISTORY
40
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
41
+based on docker.com source material and internal work.
42
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
43
+Janurary 2015, updated by Joseph Kern (josephakern at gmail dot com)
0 44
new file mode 100644
... ...
@@ -0,0 +1,51 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-history - Show the history of an image
5
+
6
+# SYNOPSIS
7
+**docker history**
8
+[**--help**]
9
+[**--no-trunc**[=*false*]]
10
+[**-q**|**--quiet**[=*false*]]
11
+IMAGE
12
+
13
+# DESCRIPTION
14
+
15
+Show the history of when and how an image was created.
16
+
17
+# OPTIONS
18
+**--help**
19
+  Print usage statement
20
+
21
+**-H**. **--human**=*true*|*false*
22
+    Print sizes and dates in human readable format. The default is *true*.
23
+
24
+**--no-trunc**=*true*|*false*
25
+   Don't truncate output. The default is *false*.
26
+
27
+**-q**, **--quiet**=*true*|*false*
28
+   Only show numeric IDs. The default is *false*.
29
+
30
+# EXAMPLES
31
+    $ docker history fedora
32
+    IMAGE          CREATED          CREATED BY                                      SIZE                COMMENT
33
+    105182bb5e8b   5 days ago       /bin/sh -c #(nop) ADD file:71356d2ad59aa3119d   372.7 MB
34
+    73bd853d2ea5   13 days ago      /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar   0 B
35
+    511136ea3c5a   10 months ago                                                    0 B                 Imported from -
36
+
37
+## Display comments in the image history
38
+The `docker commit` command has a **-m** flag for adding comments to the image. These comments will be displayed in the image history.
39
+
40
+    $ sudo docker history docker:scm
41
+    IMAGE               CREATED             CREATED BY                                      SIZE                COMMENT
42
+    2ac9d1098bf1        3 months ago        /bin/bash                                       241.4 MB            Added Apache to Fedora base image
43
+    88b42ffd1f7c        5 months ago        /bin/sh -c #(nop) ADD file:1fd8d7f9f6557cafc7   373.7 MB            
44
+    c69cab00d6ef        5 months ago        /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar   0 B                 
45
+    511136ea3c5a        19 months ago                                                       0 B                 Imported from -
46
+
47
+# HISTORY
48
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
49
+based on docker.com source material and internal work.
50
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 51
new file mode 100644
... ...
@@ -0,0 +1,84 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-images - List images
5
+
6
+# SYNOPSIS
7
+**docker images**
8
+[**--help**]
9
+[**-a**|**--all**[=*false*]]
10
+[**--digests**[=*false*]]
11
+[**-f**|**--filter**[=*[]*]]
12
+[**--no-trunc**[=*false*]]
13
+[**-q**|**--quiet**[=*false*]]
14
+[REPOSITORY]
15
+
16
+# DESCRIPTION
17
+This command lists the images stored in the local Docker repository.
18
+
19
+By default, intermediate images, used during builds, are not listed. Some of the
20
+output, e.g., image ID, is truncated, for space reasons. However the truncated
21
+image ID, and often the first few characters, are enough to be used in other
22
+Docker commands that use the image ID. The output includes repository, tag, image
23
+ID, date created and the virtual size.
24
+
25
+The title REPOSITORY for the first title may seem confusing. It is essentially
26
+the image name. However, because you can tag a specific image, and multiple tags
27
+(image instances) can be associated with a single name, the name is really a
28
+repository for all tagged images of the same name. For example consider an image
29
+called fedora. It may be tagged with 18, 19, or 20, etc. to manage different
30
+versions.
31
+
32
+# OPTIONS
33
+**-a**, **--all**=*true*|*false*
34
+   Show all images (by default filter out the intermediate image layers). The default is *false*.
35
+
36
+**--digests**=*true*|*false*
37
+   Show image digests. The default is *false*.
38
+
39
+**-f**, **--filter**=[]
40
+   Filters the output. The dangling=true filter finds unused images. While label=com.foo=amd64 filters for images with a com.foo value of amd64. The label=com.foo filter finds images with the label com.foo of any value.
41
+
42
+**--help**
43
+  Print usage statement
44
+
45
+**--no-trunc**=*true*|*false*
46
+   Don't truncate output. The default is *false*.
47
+
48
+**-q**, **--quiet**=*true*|*false*
49
+   Only show numeric IDs. The default is *false*.
50
+
51
+# EXAMPLES
52
+
53
+## Listing the images
54
+
55
+To list the images in a local repository (not the registry) run:
56
+
57
+    docker images
58
+
59
+The list will contain the image repository name, a tag for the image, and an
60
+image ID, when it was created and its virtual size. Columns: REPOSITORY, TAG,
61
+IMAGE ID, CREATED, and VIRTUAL SIZE.
62
+
63
+To get a verbose list of images which contains all the intermediate images
64
+used in builds use **-a**:
65
+
66
+    docker images -a
67
+
68
+Previously, the docker images command supported the --tree and --dot arguments,
69
+which displayed different visualizations of the image data. Docker core removed
70
+this functionality in the 1.7 version. If you liked this functionality, you can
71
+still find it in the third-party dockviz tool: https://github.com/justone/dockviz.
72
+
73
+## Listing only the shortened image IDs
74
+
75
+Listing just the shortened image IDs. This can be useful for some automated
76
+tools.
77
+
78
+    docker images -q
79
+
80
+# HISTORY
81
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
82
+based on docker.com source material and internal work.
83
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 84
new file mode 100644
... ...
@@ -0,0 +1,59 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-import - Create an empty filesystem image and import the contents of the tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it.
5
+
6
+# SYNOPSIS
7
+**docker import**
8
+[**-c**|**--change**[= []**]]
9
+[**--help**]
10
+URL|- [REPOSITORY[:TAG]]
11
+
12
+# OPTIONS
13
+**-c**, **--change**=[]
14
+   Apply specified Dockerfile instructions while importing the image
15
+   Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
16
+
17
+# DESCRIPTION
18
+Create a new filesystem image from the contents of a tarball (`.tar`,
19
+`.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it.
20
+
21
+# OPTIONS
22
+**--help**
23
+  Print usage statement
24
+
25
+# EXAMPLES
26
+
27
+## Import from a remote location
28
+
29
+    # docker import http://example.com/exampleimage.tgz example/imagerepo
30
+
31
+## Import from a local file
32
+
33
+Import to docker via pipe and stdin:
34
+
35
+    # cat exampleimage.tgz | docker import - example/imagelocal
36
+
37
+## Import from a local file and tag
38
+
39
+Import to docker via pipe and stdin:
40
+
41
+    # cat exampleimageV2.tgz | docker import - example/imagelocal:V-2.0
42
+
43
+## Import from a local directory
44
+
45
+    # tar -c . | docker import - exampleimagedir
46
+
47
+## Apply specified Dockerfile instructions while importing the image
48
+This example sets the docker image ENV variable DEBUG to true by default.
49
+
50
+    # tar -c . | docker import -c="ENV DEBUG true" - exampleimagedir
51
+
52
+# See also
53
+**docker-export(1)** to export the contents of a filesystem as a tar archive to STDOUT.
54
+
55
+# HISTORY
56
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
57
+based on docker.com source material and internal work.
58
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 59
new file mode 100644
... ...
@@ -0,0 +1,49 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-info - Display system-wide information
5
+
6
+# SYNOPSIS
7
+**docker info**
8
+[**--help**]
9
+
10
+
11
+# DESCRIPTION
12
+This command displays system wide information regarding the Docker installation.
13
+Information displayed includes the number of containers and images, pool name,
14
+data file, metadata file, data space used, total data space, metadata space used
15
+, total metadata space, execution driver, and the kernel version.
16
+
17
+The data file is where the images are stored and the metadata file is where the
18
+meta data regarding those images are stored. When run for the first time Docker
19
+allocates a certain amount of data space and meta data space from the space
20
+available on the volume where `/var/lib/docker` is mounted.
21
+
22
+# OPTIONS
23
+**--help**
24
+  Print usage statement
25
+
26
+# EXAMPLES
27
+
28
+## Display Docker system information
29
+
30
+Here is a sample output:
31
+
32
+    # docker info
33
+    Containers: 14
34
+    Images: 52
35
+    Storage Driver: aufs
36
+     Root Dir: /var/lib/docker/aufs
37
+     Dirs: 80
38
+    Execution Driver: native-0.2
39
+    Logging Driver: json-file
40
+    Kernel Version: 3.13.0-24-generic
41
+    Operating System: Ubuntu 14.04 LTS
42
+    CPUs: 1
43
+    Total Memory: 2 GiB
44
+
45
+# HISTORY
46
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
47
+based on docker.com source material and internal work.
48
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 49
new file mode 100644
... ...
@@ -0,0 +1,270 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-inspect - Return low-level information on a container or image
5
+
6
+# SYNOPSIS
7
+**docker inspect**
8
+[**--help**]
9
+[**-f**|**--format**[=*FORMAT*]]
10
+CONTAINER|IMAGE [CONTAINER|IMAGE...]
11
+
12
+# DESCRIPTION
13
+
14
+This displays all the information available in Docker for a given
15
+container or image. By default, this will render all results in a JSON
16
+array. If a format is specified, the given template will be executed for
17
+each result.
18
+
19
+# OPTIONS
20
+**--help**
21
+    Print usage statement
22
+
23
+**-f**, **--format**=""
24
+    Format the output using the given go template.
25
+
26
+# EXAMPLES
27
+
28
+## Getting information on a container
29
+
30
+To get information on a container use its ID or instance name:
31
+
32
+    $ docker inspect 1eb5fabf5a03
33
+    [{
34
+        "AppArmorProfile": "",
35
+        "Args": [],
36
+        "Config": {
37
+            "AttachStderr": false,
38
+            "AttachStdin": false,
39
+            "AttachStdout": false,
40
+            "Cmd": [
41
+                "/usr/sbin/nginx"
42
+            ],
43
+            "Domainname": "",
44
+            "Entrypoint": null,
45
+            "Env": [
46
+                "HOME=/",
47
+                "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
48
+            ],
49
+            "ExposedPorts": {
50
+                "80/tcp": {}
51
+            },
52
+            "Hostname": "1eb5fabf5a03",
53
+            "Image": "summit/nginx",
54
+            "Labels": {
55
+                "com.example.vendor": "Acme",
56
+                "com.example.license": "GPL",
57
+                "com.example.version": "1.0"
58
+            },
59
+            "MacAddress": "",
60
+            "NetworkDisabled": false,
61
+            "OnBuild": null,
62
+            "OpenStdin": false,
63
+            "PortSpecs": null,
64
+            "StdinOnce": false,
65
+            "Tty": true,
66
+            "User": "",
67
+            "Volumes": null,
68
+            "WorkingDir": "",
69
+        },
70
+        "Created": "2014-04-04T21:33:52.02361335Z",
71
+        "Driver": "devicemapper",
72
+        "ExecDriver": "native-0.1",
73
+        "ExecIDs": null,
74
+        "HostConfig": {
75
+            "Binds": null,
76
+            "CapAdd": null,
77
+            "CapDrop": null,
78
+            "CgroupParent": "",
79
+            "ContainerIDFile": "",
80
+            "CpuShares": 512,
81
+            "CpusetCpus": "0,1",
82
+            "CpusetMems": "",
83
+            "Devices": [],
84
+            "Dns": null,
85
+            "DnsSearch": null,
86
+            "ExtraHosts": null,
87
+            "IpcMode": "",
88
+            "Links": null,
89
+            "LogConfig": {
90
+                "Config": null,
91
+                "Type": "json-file"
92
+            },
93
+            "LxcConf": null,
94
+            "Memory": 16777216,
95
+            "MemorySwap": -1,
96
+            "NetworkMode": "",
97
+            "PidMode": "",
98
+            "PortBindings": {
99
+                "80/tcp": [
100
+                    {
101
+                        "HostIp": "0.0.0.0",
102
+                        "HostPort": "80"
103
+                    }
104
+                ]
105
+            },
106
+            "Privileged": false,
107
+            "PublishAllPorts": false,
108
+            "ReadonlyRootfs": false,
109
+            "RestartPolicy": {
110
+                "MaximumRetryCount": 0,
111
+                "Name": ""
112
+            },
113
+            "SecurityOpt": null,
114
+            "Ulimits": null,
115
+            "VolumesFrom": null
116
+        }
117
+        "HostnamePath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/hostname",
118
+        "HostsPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/hosts",
119
+        "ID": "1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b",
120
+        "Image": "df53773a4390e25936f9fd3739e0c0e60a62d024ea7b669282b27e65ae8458e6",
121
+        "LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log",
122
+        "MountLabel": "",
123
+        "Name": "/ecstatic_ptolemy",
124
+        "NetworkSettings": {
125
+            "Bridge": "docker0",
126
+            "Gateway": "172.17.42.1",
127
+            "GlobalIPv6Address": "",
128
+            "GlobalIPv6PrefixLen": 0,
129
+            "IPAddress": "172.17.0.2",
130
+            "IPPrefixLen": 16,
131
+            "IPv6Gateway": "",
132
+            "LinkLocalIPv6Address": "",
133
+            "LinkLocalIPv6PrefixLen": 0,
134
+            "MacAddress": "",
135
+            "PortMapping": null,
136
+            "Ports": {
137
+                "80/tcp": [
138
+                    {
139
+                        "HostIp": "0.0.0.0",
140
+                        "HostPort": "80"
141
+                    }
142
+                ]
143
+            }
144
+        },
145
+        "Path": "/usr/sbin/nginx",
146
+        "ProcessLabel": "",
147
+        "ResolvConfPath": "/etc/resolv.conf",
148
+        "RestartCount": 0,
149
+        "State": {
150
+            "Dead": false,
151
+            "Error": "",
152
+            "ExitCode": 0,
153
+            "FinishedAt": "0001-01-01T00:00:00Z",
154
+            "OOMKilled": false,
155
+            "Paused": false,
156
+            "Pid": 858,
157
+            "Restarting": false,
158
+            "Running": true,
159
+            "StartedAt": "2014-04-04T21:33:54.16259207Z",
160
+        },
161
+        "Volumes": {},
162
+        "VolumesRW": {},
163
+    }
164
+
165
+## Getting the IP address of a container instance
166
+
167
+To get the IP address of a container use:
168
+
169
+    $ docker inspect --format='{{.NetworkSettings.IPAddress}}' 1eb5fabf5a03
170
+    172.17.0.2
171
+
172
+## Listing all port bindings
173
+
174
+One can loop over arrays and maps in the results to produce simple text
175
+output:
176
+
177
+    $ docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} \
178
+      {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' 1eb5fabf5a03
179
+      80/tcp -> 80
180
+
181
+You can get more information about how to write a go template from:
182
+http://golang.org/pkg/text/template/.
183
+
184
+## Getting information on an image
185
+
186
+Use an image's ID or name (e.g., repository/name[:tag]) to get information
187
+on it.
188
+
189
+    $ docker inspect fc1203419df2
190
+    [{
191
+        "Architecture": "amd64",
192
+        "Author": "",
193
+        "Comment": "",
194
+        "Config": {
195
+            "AttachStderr": false,
196
+            "AttachStdin": false,
197
+            "AttachStdout": false,
198
+            "Cmd": [
199
+                "make",
200
+                "direct-test"
201
+            ],
202
+            "Domainname": "",
203
+            "Entrypoint": [
204
+                "/dind"
205
+            ],
206
+            "Env": [
207
+                "PATH=/go/bin:/usr/src/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
208
+            ],
209
+            "ExposedPorts": null,
210
+            "Hostname": "242978536a06",
211
+            "Image": "c2b774c744afc5bea603b5e6c5218539e506649326de3ea0135182f299d0519a",
212
+            "Labels": {},
213
+            "MacAddress": "",
214
+            "NetworkDisabled": false,
215
+            "OnBuild": [],
216
+            "OpenStdin": false,
217
+            "PortSpecs": null,
218
+            "StdinOnce": false,
219
+            "Tty": false,
220
+            "User": "",
221
+            "Volumes": null,
222
+            "WorkingDir": "/go/src/github.com/docker/libcontainer"
223
+        },
224
+        "Container": "1c00417f3812a96d3ebc29e7fdee69f3d586d703ab89c8233fd4678d50707b39",
225
+        "ContainerConfig": {
226
+            "AttachStderr": false,
227
+            "AttachStdin": false,
228
+            "AttachStdout": false,
229
+            "Cmd": [
230
+                "/bin/sh",
231
+                "-c",
232
+                "#(nop) CMD [\"make\" \"direct-test\"]"
233
+            ],
234
+            "Domainname": "",
235
+            "Entrypoint": [
236
+                "/dind"
237
+            ],
238
+            "Env": [
239
+                "PATH=/go/bin:/usr/src/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
240
+            ],
241
+            "ExposedPorts": null,
242
+            "Hostname": "242978536a06",
243
+            "Image": "c2b774c744afc5bea603b5e6c5218539e506649326de3ea0135182f299d0519a",
244
+            "Labels": {},
245
+            "MacAddress": "",
246
+            "NetworkDisabled": false,
247
+            "OnBuild": [],
248
+            "OpenStdin": false,
249
+            "PortSpecs": null,
250
+            "StdinOnce": false,
251
+            "Tty": false,
252
+            "User": "",
253
+            "Volumes": null,
254
+            "WorkingDir": "/go/src/github.com/docker/libcontainer"
255
+        },
256
+        "Created": "2015-04-07T05:34:39.079489206Z",
257
+        "DockerVersion": "1.5.0-dev",
258
+        "Id": "fc1203419df26ca82cad1dd04c709cb1b8a8a947bd5bcbdfbef8241a76f031db",
259
+        "Os": "linux",
260
+        "Parent": "c2b774c744afc5bea603b5e6c5218539e506649326de3ea0135182f299d0519a",
261
+        "Size": 0,
262
+        "VirtualSize": 613136466
263
+    }]
264
+
265
+# HISTORY
266
+April 2014, originally compiled by William Henry (whenry at redhat dot com)
267
+based on docker.com source material and internal work.
268
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
269
+April 2015, updated by Qiang Huang <h.huangqiang@huawei.com>
0 270
new file mode 100644
... ...
@@ -0,0 +1,28 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-kill - Kill a running container using SIGKILL or a specified signal
5
+
6
+# SYNOPSIS
7
+**docker kill**
8
+[**--help**]
9
+[**-s**|**--signal**[=*"KILL"*]]
10
+CONTAINER [CONTAINER...]
11
+
12
+# DESCRIPTION
13
+
14
+The main process inside each container specified will be sent SIGKILL,
15
+ or any signal specified with option --signal.
16
+
17
+# OPTIONS
18
+**--help**
19
+  Print usage statement
20
+
21
+**-s**, **--signal**="KILL"
22
+   Signal to send to the container
23
+
24
+# HISTORY
25
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
26
+ based on docker.com source material and internal work.
27
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 28
new file mode 100644
... ...
@@ -0,0 +1,45 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-load - Load an image from a tar archive on STDIN
5
+
6
+# SYNOPSIS
7
+**docker load**
8
+[**--help**]
9
+[**-i**|**--input**[=*INPUT*]]
10
+
11
+
12
+# DESCRIPTION
13
+
14
+Loads a tarred repository from a file or the standard input stream.
15
+Restores both images and tags.
16
+
17
+# OPTIONS
18
+**--help**
19
+  Print usage statement
20
+
21
+**-i**, **--input**=""
22
+   Read from a tar archive file, instead of STDIN
23
+
24
+# EXAMPLES
25
+
26
+    $ docker images
27
+    REPOSITORY          TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
28
+    busybox             latest              769b9341d937        7 weeks ago         2.489 MB
29
+    $ docker load --input fedora.tar
30
+    $ docker images
31
+    REPOSITORY          TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
32
+    busybox             latest              769b9341d937        7 weeks ago         2.489 MB
33
+    fedora              rawhide             0d20aec6529d        7 weeks ago         387 MB
34
+    fedora              20                  58394af37342        7 weeks ago         385.5 MB
35
+    fedora              heisenbug           58394af37342        7 weeks ago         385.5 MB
36
+    fedora              latest              58394af37342        7 weeks ago         385.5 MB
37
+
38
+# See also
39
+**docker-save(1)** to save an image(s) to a tar archive (streamed to STDOUT by default).
40
+
41
+# HISTORY
42
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
43
+based on docker.com source material and internal work.
44
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 45
new file mode 100644
... ...
@@ -0,0 +1,51 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-login - Register or log in to a Docker registry. 
5
+
6
+# SYNOPSIS
7
+**docker login**
8
+[**-e**|**--email**[=*EMAIL*]]
9
+[**--help**]
10
+[**-p**|**--password**[=*PASSWORD*]]
11
+[**-u**|**--username**[=*USERNAME*]]
12
+[SERVER]
13
+
14
+# DESCRIPTION
15
+Register or log in to a Docker Registry located on the specified
16
+`SERVER`.  You can specify a URL or a `hostname` for the `SERVER` value. If you
17
+do not specify a `SERVER`, the command uses Docker's public registry located at
18
+`https://registry-1.docker.io/` by default.  To get a username/password for Docker's public registry, create an account on Docker Hub.
19
+
20
+You can log into any public or private repository for which you have
21
+credentials.  When you log in, the command stores encoded credentials in
22
+`$HOME/.dockercfg` on Linux or `%USERPROFILE%/.dockercfg` on Windows.
23
+
24
+# OPTIONS
25
+**-e**, **--email**=""
26
+   Email
27
+
28
+**--help**
29
+  Print usage statement
30
+
31
+**-p**, **--password**=""
32
+   Password
33
+
34
+**-u**, **--username**=""
35
+   Username
36
+
37
+# EXAMPLES
38
+
39
+## Login to a registry on your localhost
40
+
41
+    # docker login localhost:8080
42
+
43
+# See also
44
+**docker-logout(1)** to log out from a Docker registry.
45
+
46
+# HISTORY
47
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
48
+based on docker.com source material and internal work.
49
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
50
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
0 51
new file mode 100644
... ...
@@ -0,0 +1,32 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-logout - Log out from a Docker Registry.
5
+
6
+# SYNOPSIS
7
+**docker logout**
8
+[SERVER]
9
+
10
+# DESCRIPTION
11
+Log out of a Docker Registry located on the specified `SERVER`. You can
12
+specify a URL or a `hostname` for the `SERVER` value. If you do not specify a
13
+`SERVER`, the command attempts to log you out of Docker's public registry
14
+located at `https://registry-1.docker.io/` by default.  
15
+
16
+# OPTIONS
17
+There are no available options.
18
+
19
+# EXAMPLES
20
+
21
+## Log out from a registry on your localhost
22
+
23
+    # docker logout localhost:8080
24
+
25
+# See also
26
+**docker-login(1)** to register or log in to a Docker registry server.
27
+
28
+# HISTORY
29
+June 2014, Originally compiled by Daniel, Dao Quang Minh (daniel at nitrous dot io)
30
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
31
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
0 32
new file mode 100644
... ...
@@ -0,0 +1,49 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-logs - Fetch the logs of a container
5
+
6
+# SYNOPSIS
7
+**docker logs**
8
+[**-f**|**--follow**[=*false*]]
9
+[**--help**]
10
+[**--since**[=*SINCE*]]
11
+[**-t**|**--timestamps**[=*false*]]
12
+[**--tail**[=*"all"*]]
13
+CONTAINER
14
+
15
+# DESCRIPTION
16
+The **docker logs** command batch-retrieves whatever logs are present for
17
+a container at the time of execution. This does not guarantee execution
18
+order when combined with a docker run (i.e., your run may not have generated
19
+any logs at the time you execute docker logs).
20
+
21
+The **docker logs --follow** command combines commands **docker logs** and
22
+**docker attach**. It will first return all logs from the beginning and
23
+then continue streaming new output from the container’s stdout and stderr.
24
+
25
+**Warning**: This command works only for **json-file** logging driver.
26
+
27
+# OPTIONS
28
+**--help**
29
+  Print usage statement
30
+
31
+**-f**, **--follow**=*true*|*false*
32
+   Follow log output. The default is *false*.
33
+
34
+**--since**=""
35
+   Show logs since timestamp
36
+
37
+**-t**, **--timestamps**=*true*|*false*
38
+   Show timestamps. The default is *false*.
39
+
40
+**--tail**="all"
41
+   Output the specified number of lines at the end of logs (defaults to all logs)
42
+
43
+# HISTORY
44
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
45
+based on docker.com source material and internal work.
46
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
47
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
48
+April 2015, updated by Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
0 49
new file mode 100644
... ...
@@ -0,0 +1,30 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-pause - Pause all processes within a container
5
+
6
+# SYNOPSIS
7
+**docker pause**
8
+CONTAINER [CONTAINER...]
9
+
10
+# DESCRIPTION
11
+
12
+The `docker pause` command uses the cgroups freezer to suspend all processes in
13
+a container.  Traditionally when suspending a process the `SIGSTOP` signal is
14
+used, which is observable by the process being suspended. With the cgroups freezer
15
+the process is unaware, and unable to capture, that it is being suspended,
16
+and subsequently resumed.
17
+
18
+See the [cgroups freezer documentation]
19
+(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for
20
+further details.
21
+
22
+# OPTIONS
23
+There are no available options.
24
+
25
+# See also
26
+**docker-unpause(1)** to unpause all processes within a container.
27
+
28
+# HISTORY
29
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 30
new file mode 100644
... ...
@@ -0,0 +1,39 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-port - List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT
5
+
6
+# SYNOPSIS
7
+**docker port**
8
+[**--help**]
9
+CONTAINER [PRIVATE_PORT[/PROTO]]
10
+
11
+# DESCRIPTION
12
+List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT
13
+
14
+# OPTIONS
15
+**--help**
16
+  Print usage statement
17
+
18
+# EXAMPLES
19
+You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or
20
+ask for just a specific mapping:
21
+
22
+    $ docker ps test
23
+    CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS                                            NAMES
24
+    b650456536c7        busybox:latest      top                 54 minutes ago      Up 54 minutes       0.0.0.0:1234->9876/tcp, 0.0.0.0:4321->7890/tcp   test
25
+    $ docker port test
26
+    7890/tcp -> 0.0.0.0:4321
27
+    9876/tcp -> 0.0.0.0:1234
28
+    $ docker port test 7890/tcp
29
+    0.0.0.0:4321
30
+    $ docker port test 7890/udp
31
+    2014/06/24 11:53:36 Error: No public port '7890/udp' published for test
32
+    $ docker port test 7890
33
+    0.0.0.0:4321
34
+
35
+# HISTORY
36
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
37
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
38
+November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 39
new file mode 100644
... ...
@@ -0,0 +1,91 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% FEBRUARY 2015
3
+# NAME
4
+docker-ps - List containers
5
+
6
+# SYNOPSIS
7
+**docker ps**
8
+[**-a**|**--all**[=*false*]]
9
+[**--before**[=*BEFORE*]]
10
+[**--help**]
11
+[**-f**|**--filter**[=*[]*]]
12
+[**-l**|**--latest**[=*false*]]
13
+[**-n**[=*-1*]]
14
+[**--no-trunc**[=*false*]]
15
+[**-q**|**--quiet**[=*false*]]
16
+[**-s**|**--size**[=*false*]]
17
+[**--since**[=*SINCE*]]
18
+
19
+
20
+# DESCRIPTION
21
+
22
+List the containers in the local repository. By default this show only
23
+the running containers.
24
+
25
+# OPTIONS
26
+**-a**, **--all**=*true*|*false*
27
+   Show all containers. Only running containers are shown by default. The default is *false*.
28
+
29
+**--before**=""
30
+   Show only container created before Id or Name, include non-running ones.
31
+
32
+**--help**
33
+  Print usage statement
34
+
35
+**-f**, **--filter**=[]
36
+   Provide filter values. Valid filters:
37
+                          exited=<int> - containers with exit code of <int>
38
+                          label=<key> or label=<key>=<value>
39
+                          status=(restarting|running|paused|exited)
40
+                          name=<string> - container's name
41
+                          id=<ID> - container's ID
42
+
43
+**-l**, **--latest**=*true*|*false*
44
+   Show only the latest created container, include non-running ones. The default is *false*.
45
+
46
+**-n**=-1
47
+   Show n last created containers, include non-running ones.
48
+
49
+**--no-trunc**=*true*|*false*
50
+   Don't truncate output. The default is *false*.
51
+
52
+**-q**, **--quiet**=*true*|*false*
53
+   Only display numeric IDs. The default is *false*.
54
+
55
+**-s**, **--size**=*true*|*false*
56
+   Display total file sizes. The default is *false*.
57
+
58
+**--since**=""
59
+   Show only containers created since Id or Name, include non-running ones.
60
+
61
+# EXAMPLES
62
+# Display all containers, including non-running
63
+
64
+    # docker ps -a
65
+    CONTAINER ID        IMAGE                 COMMAND                CREATED             STATUS      PORTS    NAMES
66
+    a87ecb4f327c        fedora:20             /bin/sh -c #(nop) MA   20 minutes ago      Exit 0               desperate_brattain
67
+    01946d9d34d8        vpavlin/rhel7:latest  /bin/sh -c #(nop) MA   33 minutes ago      Exit 0               thirsty_bell
68
+    c1d3b0166030        acffc0358b9e          /bin/sh -c yum -y up   2 weeks ago         Exit 1               determined_torvalds
69
+    41d50ecd2f57        fedora:20             /bin/sh -c #(nop) MA   2 weeks ago         Exit 0               drunk_pike
70
+
71
+# Display only IDs of all containers, including non-running
72
+
73
+    # docker ps -a -q
74
+    a87ecb4f327c
75
+    01946d9d34d8
76
+    c1d3b0166030
77
+    41d50ecd2f57
78
+
79
+# Display only IDs of all containers that have the name `determined_torvalds`
80
+
81
+    # docker ps -a -q --filter=name=determined_torvalds
82
+    c1d3b0166030
83
+
84
+# HISTORY
85
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
86
+based on docker.com source material and internal work.
87
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
88
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
89
+November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
90
+February 2015, updated by André Martins <martins@noironetworks.com>
0 91
new file mode 100644
... ...
@@ -0,0 +1,73 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-pull - Pull an image or a repository from a registry
5
+
6
+# SYNOPSIS
7
+**docker pull**
8
+[**-a**|**--all-tags**[=*false*]]
9
+[**--help**] 
10
+NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
11
+
12
+# DESCRIPTION
13
+
14
+This command pulls down an image or a repository from a registry. If
15
+there is more than one image for a repository (e.g., fedora) then all
16
+images for that repository name are pulled down including any tags.
17
+
18
+If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
19
+registry located at `registry-1.docker.io` by default. 
20
+
21
+# OPTIONS
22
+**-a**, **--all-tags**=*true*|*false*
23
+   Download all tagged images in the repository. The default is *false*.
24
+**--help**
25
+  Print usage statement
26
+
27
+# EXAMPLE
28
+
29
+# Pull a repository with multiple images
30
+# Note that if the  image is previously downloaded then the status would be
31
+# 'Status: Image is up to date for fedora'
32
+
33
+    $ docker pull fedora
34
+    Pulling repository fedora
35
+    ad57ef8d78d7: Download complete
36
+    105182bb5e8b: Download complete
37
+    511136ea3c5a: Download complete
38
+    73bd853d2ea5: Download complete
39
+
40
+    Status: Downloaded newer image for fedora
41
+
42
+    $ docker images
43
+    REPOSITORY   TAG         IMAGE ID        CREATED      VIRTUAL SIZE
44
+    fedora       rawhide     ad57ef8d78d7    5 days ago   359.3 MB
45
+    fedora       20          105182bb5e8b    5 days ago   372.7 MB
46
+    fedora       heisenbug   105182bb5e8b    5 days ago   372.7 MB
47
+    fedora       latest      105182bb5e8b    5 days ago   372.7 MB
48
+
49
+# Pull an image, manually specifying path to Docker's public registry and tag
50
+# Note that if the  image is previously downloaded then the status would be
51
+# 'Status: Image is up to date for registry.hub.docker.com/fedora:20'
52
+
53
+    $ docker pull registry.hub.docker.com/fedora:20
54
+    Pulling repository fedora
55
+    3f2fed40e4b0: Download complete 
56
+    511136ea3c5a: Download complete 
57
+    fd241224e9cf: Download complete 
58
+
59
+    Status: Downloaded newer image for registry.hub.docker.com/fedora:20
60
+
61
+    $ docker images
62
+    REPOSITORY   TAG         IMAGE ID        CREATED      VIRTUAL SIZE
63
+    fedora       20          3f2fed40e4b0    4 days ago   372.7 MB
64
+
65
+
66
+# HISTORY
67
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
68
+based on docker.com source material and internal work.
69
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
70
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
71
+April 2015, updated by John Willis <john.willis@docker.com>
72
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
0 73
new file mode 100644
... ...
@@ -0,0 +1,51 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-push - Push an image or a repository to a registry
5
+
6
+# SYNOPSIS
7
+**docker push**
8
+[**--help**]
9
+NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
10
+
11
+# DESCRIPTION
12
+
13
+This command pushes an image or a repository to a registry. If you do not
14
+specify a `REGISTRY_HOST`, the command uses Docker's public registry located at
15
+`registry-1.docker.io` by default. 
16
+
17
+# OPTIONS
18
+**--help**
19
+  Print usage statement
20
+
21
+# EXAMPLES
22
+
23
+# Pushing a new image to a registry
24
+
25
+First save the new image by finding the container ID (using **docker ps**)
26
+and then committing it to a new image name:
27
+
28
+    # docker commit c16378f943fe rhel-httpd
29
+
30
+Now, push the image to the registry using the image ID. In this example the
31
+registry is on host named `registry-host` and listening on port `5000`. To do
32
+this, tag the image with the host name or IP address, and the port of the
33
+registry:
34
+
35
+    # docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd
36
+    # docker push registry-host:5000/myadmin/rhel-httpd
37
+
38
+Check that this worked by running:
39
+
40
+    # docker images
41
+
42
+You should see both `rhel-httpd` and `registry-host:5000/myadmin/rhel-httpd`
43
+listed.
44
+
45
+# HISTORY
46
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
47
+based on docker.com source material and internal work.
48
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
49
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
50
+
0 51
new file mode 100644
... ...
@@ -0,0 +1,13 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% OCTOBER 2014
3
+# NAME
4
+docker-rename - Rename a container
5
+
6
+# SYNOPSIS
7
+**docker rename**
8
+OLD_NAME NEW_NAME
9
+
10
+# OPTIONS
11
+There are no available options.
12
+
0 13
new file mode 100644
... ...
@@ -0,0 +1,26 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-restart - Restart a running container
5
+
6
+# SYNOPSIS
7
+**docker restart**
8
+[**--help**]
9
+[**-t**|**--time**[=*10*]]
10
+CONTAINER [CONTAINER...]
11
+
12
+# DESCRIPTION
13
+Restart each container listed.
14
+
15
+# OPTIONS
16
+**--help**
17
+  Print usage statement
18
+
19
+**-t**, **--time**=10
20
+   Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.
21
+
22
+# HISTORY
23
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
24
+based on docker.com source material and internal work.
25
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 26
new file mode 100644
... ...
@@ -0,0 +1,56 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-rm - Remove one or more containers
5
+
6
+# SYNOPSIS
7
+**docker rm**
8
+[**-f**|**--force**[=*false*]]
9
+[**-l**|**--link**[=*false*]]
10
+[**-v**|**--volumes**[=*false*]]
11
+CONTAINER [CONTAINER...]
12
+
13
+# DESCRIPTION
14
+
15
+**docker rm** will remove one or more containers from the host node. The
16
+container name or ID can be used. This does not remove images. You cannot
17
+remove a running container unless you use the \fB-f\fR option. To see all
18
+containers on a host use the **docker ps -a** command.
19
+
20
+# OPTIONS
21
+**--help**
22
+  Print usage statement
23
+
24
+**-f**, **--force**=*true*|*false*
25
+   Force the removal of a running container (uses SIGKILL). The default is *false*.
26
+
27
+**-l**, **--link**=*true*|*false*
28
+   Remove the specified link and not the underlying container. The default is *false*.
29
+
30
+**-v**, **--volumes**=*true*|*false*
31
+   Remove the volumes associated with the container. The default is *false*.
32
+
33
+# EXAMPLES
34
+
35
+##Removing a container using its ID##
36
+
37
+To remove a container using its ID, find either from a **docker ps -a**
38
+command, or use the ID returned from the **docker run** command, or retrieve
39
+it from a file used to store it using the **docker run --cidfile**:
40
+
41
+    docker rm abebf7571666
42
+
43
+##Removing a container using the container name##
44
+
45
+The name of the container can be found using the **docker ps -a**
46
+command. The use that name as follows:
47
+
48
+    docker rm hopeful_morse
49
+
50
+# HISTORY
51
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
52
+based on docker.com source material and internal work.
53
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
54
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
55
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 56
new file mode 100644
... ...
@@ -0,0 +1,42 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-rmi - Remove one or more images
5
+
6
+# SYNOPSIS
7
+**docker rmi**
8
+[**-f**|**--force**[=*false*]]
9
+[**--help**]
10
+[**--no-prune**[=*false*]]
11
+IMAGE [IMAGE...]
12
+
13
+# DESCRIPTION
14
+
15
+Removes one or more images from the host node. This does not remove images from
16
+a registry. You cannot remove an image of a running container unless you use the
17
+**-f** option. To see all images on a host use the **docker images** command.
18
+
19
+# OPTIONS
20
+**-f**, **--force**=*true*|*false*
21
+   Force removal of the image. The default is *false*.
22
+
23
+**--help**
24
+  Print usage statement
25
+
26
+**--no-prune**=*true*|*false*
27
+   Do not delete untagged parents. The default is *false*.
28
+
29
+# EXAMPLES
30
+
31
+## Removing an image
32
+
33
+Here is an example of removing and image:
34
+
35
+    docker rmi fedora/httpd
36
+
37
+# HISTORY
38
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
39
+based on docker.com source material and internal work.
40
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
41
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
0 42
new file mode 100644
... ...
@@ -0,0 +1,658 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-run - Run a command in a new container
5
+
6
+# SYNOPSIS
7
+**docker run**
8
+[**-a**|**--attach**[=*[]*]]
9
+[**--add-host**[=*[]*]]
10
+[**--blkio-weight**[=*[BLKIO-WEIGHT]*]]
11
+[**-c**|**--cpu-shares**[=*0*]]
12
+[**--cap-add**[=*[]*]]
13
+[**--cap-drop**[=*[]*]]
14
+[**--cidfile**[=*CIDFILE*]]
15
+[**--cpu-period**[=*0*]]
16
+[**--cpuset-cpus**[=*CPUSET-CPUS*]]
17
+[**--cpuset-mems**[=*CPUSET-MEMS*]]
18
+[**-d**|**--detach**[=*false*]]
19
+[**--cpu-quota**[=*0*]]
20
+[**--device**[=*[]*]]
21
+[**--dns-search**[=*[]*]]
22
+[**--dns**[=*[]*]]
23
+[**-e**|**--env**[=*[]*]]
24
+[**--entrypoint**[=*ENTRYPOINT*]]
25
+[**--env-file**[=*[]*]]
26
+[**--expose**[=*[]*]]
27
+[**-h**|**--hostname**[=*HOSTNAME*]]
28
+[**--help**]
29
+[**-i**|**--interactive**[=*false*]]
30
+[**--ipc**[=*IPC*]]
31
+[**-l**|**--label**[=*[]*]]
32
+[**--label-file**[=*[]*]]
33
+[**--link**[=*[]*]]
34
+[**--lxc-conf**[=*[]*]]
35
+[**--log-driver**[=*[]*]]
36
+[**--log-opt**[=*[]*]]
37
+[**-m**|**--memory**[=*MEMORY*]]
38
+[**--memory-swap**[=*MEMORY-SWAP*]]
39
+[**--mac-address**[=*MAC-ADDRESS*]]
40
+[**--name**[=*NAME*]]
41
+[**--net**[=*"bridge"*]]
42
+[**--oom-kill-disable**[=*false*]]
43
+[**-P**|**--publish-all**[=*false*]]
44
+[**-p**|**--publish**[=*[]*]]
45
+[**--pid**[=*[]*]]
46
+[**--uts**[=*[]*]]
47
+[**--privileged**[=*false*]]
48
+[**--read-only**[=*false*]]
49
+[**--restart**[=*RESTART*]]
50
+[**--rm**[=*false*]]
51
+[**--security-opt**[=*[]*]]
52
+[**--sig-proxy**[=*true*]]
53
+[**-t**|**--tty**[=*false*]]
54
+[**-u**|**--user**[=*USER*]]
55
+[**-v**|**--volume**[=*[]*]]
56
+[**--volumes-from**[=*[]*]]
57
+[**-w**|**--workdir**[=*WORKDIR*]]
58
+[**--cgroup-parent**[=*CGROUP-PATH*]]
59
+IMAGE [COMMAND] [ARG...]
60
+
61
+# DESCRIPTION
62
+
63
+Run a process in a new container. **docker run** starts a process with its own
64
+file system, its own networking, and its own isolated process tree. The IMAGE
65
+which starts the process may define defaults related to the process that will be
66
+run in the container, the networking to expose, and more, but **docker run**
67
+gives final control to the operator or administrator who starts the container
68
+from the image. For that reason **docker run** has more options than any other
69
+Docker command.
70
+
71
+If the IMAGE is not already loaded then **docker run** will pull the IMAGE, and
72
+all image dependencies, from the repository in the same way running **docker
73
+pull** IMAGE, before it starts the container from that image.
74
+
75
+# OPTIONS
76
+**-a**, **--attach**=[]
77
+   Attach to STDIN, STDOUT or STDERR.
78
+
79
+   In foreground mode (the default when **-d**
80
+is not specified), **docker run** can start the process in the container
81
+and attach the console to the process’s standard input, output, and standard
82
+error. It can even pretend to be a TTY (this is what most commandline
83
+executables expect) and pass along signals. The **-a** option can be set for
84
+each of stdin, stdout, and stderr.
85
+
86
+**--add-host**=[]
87
+   Add a custom host-to-IP mapping (host:ip)
88
+
89
+   Add a line to /etc/hosts. The format is hostname:ip.  The **--add-host**
90
+option can be set multiple times.
91
+
92
+**--blkio-weight**=0
93
+   Block IO weight (relative weight) accepts a weight value between 10 and 1000.
94
+
95
+**-c**, **--cpu-shares**=0
96
+   CPU shares (relative weight)
97
+
98
+   By default, all containers get the same proportion of CPU cycles. This proportion
99
+can be modified by changing the container's CPU share weighting relative
100
+to the weighting of all other running containers.
101
+
102
+To modify the proportion from the default of 1024, use the **-c** or **--cpu-shares**
103
+flag to set the weighting to 2 or higher.
104
+
105
+The proportion will only apply when CPU-intensive processes are running.
106
+When tasks in one container are idle, other containers can use the
107
+left-over CPU time. The actual amount of CPU time will vary depending on
108
+the number of containers running on the system.
109
+
110
+For example, consider three containers, one has a cpu-share of 1024 and
111
+two others have a cpu-share setting of 512. When processes in all three
112
+containers attempt to use 100% of CPU, the first container would receive
113
+50% of the total CPU time. If you add a fourth container with a cpu-share
114
+of 1024, the first container only gets 33% of the CPU. The remaining containers
115
+receive 16.5%, 16.5% and 33% of the CPU.
116
+
117
+On a multi-core system, the shares of CPU time are distributed over all CPU
118
+cores. Even if a container is limited to less than 100% of CPU time, it can
119
+use 100% of each individual CPU core.
120
+
121
+For example, consider a system with more than three cores. If you start one
122
+container **{C0}** with **-c=512** running one process, and another container
123
+**{C1}** with **-c=1024** running two processes, this can result in the following
124
+division of CPU shares:
125
+
126
+    PID    container	CPU	CPU share
127
+    100    {C0}		0	100% of CPU0
128
+    101    {C1}		1	100% of CPU1
129
+    102    {C1}		2	100% of CPU2
130
+
131
+**--cap-add**=[]
132
+   Add Linux capabilities
133
+
134
+**--cap-drop**=[]
135
+   Drop Linux capabilities
136
+
137
+**--cgroup-parent**=""
138
+   Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
139
+
140
+**--cidfile**=""
141
+   Write the container ID to the file
142
+
143
+**--cpu-period**=0
144
+   Limit the CPU CFS (Completely Fair Scheduler) period
145
+
146
+   Limit the container's CPU usage. This flag tell the kernel to restrict the container's CPU usage to the period you specify.
147
+
148
+**--cpuset-cpus**=""
149
+   CPUs in which to allow execution (0-3, 0,1)
150
+
151
+**--cpuset-mems**=""
152
+   Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
153
+
154
+   If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
155
+then processes in your Docker container will only use memory from the first
156
+two memory nodes.
157
+
158
+**--cpu-quota**=0
159
+   Limit the CPU CFS (Completely Fair Scheduler) quota
160
+
161
+   Limit the container's CPU usage. By default, containers run with the full
162
+CPU resource. This flag tell the kernel to restrict the container's CPU usage
163
+to the quota you specify.
164
+
165
+**-d**, **--detach**=*true*|*false*
166
+   Detached mode: run the container in the background and print the new container ID. The default is *false*.
167
+
168
+   At any time you can run **docker ps** in
169
+the other shell to view a list of the running containers. You can reattach to a
170
+detached container with **docker attach**. If you choose to run a container in
171
+the detached mode, then you cannot use the **-rm** option.
172
+
173
+   When attached in the tty mode, you can detach from a running container without
174
+stopping the process by pressing the keys CTRL-P CTRL-Q.
175
+
176
+**--device**=[]
177
+   Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
178
+
179
+**--dns-search**=[]
180
+   Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
181
+
182
+**--dns**=[]
183
+   Set custom DNS servers
184
+
185
+   This option can be used to override the DNS
186
+configuration passed to the container. Typically this is necessary when the
187
+host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this
188
+is the case the **--dns** flags is necessary for every run.
189
+
190
+**-e**, **--env**=[]
191
+   Set environment variables
192
+
193
+   This option allows you to specify arbitrary
194
+environment variables that are available for the process that will be launched
195
+inside of the container.
196
+
197
+**--entrypoint**=""
198
+   Overwrite the default ENTRYPOINT of the image
199
+
200
+   This option allows you to overwrite the default entrypoint of the image that
201
+is set in the Dockerfile. The ENTRYPOINT of an image is similar to a COMMAND
202
+because it specifies what executable to run when the container starts, but it is
203
+(purposely) more difficult to override. The ENTRYPOINT gives a container its
204
+default nature or behavior, so that when you set an ENTRYPOINT you can run the
205
+container as if it were that binary, complete with default options, and you can
206
+pass in more options via the COMMAND. But, sometimes an operator may want to run
207
+something else inside the container, so you can override the default ENTRYPOINT
208
+at runtime by using a **--entrypoint** and a string to specify the new
209
+ENTRYPOINT.
210
+
211
+**--env-file**=[]
212
+   Read in a line delimited file of environment variables
213
+
214
+**--expose**=[]
215
+   Expose a port, or a range of ports (e.g. --expose=3300-3310), from the container without publishing it to your host
216
+
217
+**-h**, **--hostname**=""
218
+   Container host name
219
+
220
+   Sets the container host name that is available inside the container.
221
+
222
+**--help**
223
+  Print usage statement
224
+
225
+**-i**, **--interactive**=*true*|*false*
226
+   Keep STDIN open even if not attached. The default is *false*.
227
+
228
+   When set to true, keep stdin open even if not attached. The default is false.
229
+
230
+**--ipc**=""
231
+   Default is to create a private IPC namespace (POSIX SysV IPC) for the container
232
+                               'container:<name|id>': reuses another container shared memory, semaphores and message queues
233
+                               'host': use the host shared memory,semaphores and message queues inside the container.  Note: the host mode gives the container full access to local shared memory and is therefore considered insecure.
234
+
235
+**-l**, **--label**=[]
236
+   Set metadata on the container (e.g., --label com.example.key=value)
237
+
238
+**--label-file**=[]
239
+   Read in a line delimited file of labels
240
+
241
+**--link**=[]
242
+   Add link to another container in the form of <name or id>:alias or just <name or id>
243
+in which case the alias will match the name
244
+
245
+   If the operator
246
+uses **--link** when starting the new client container, then the client
247
+container can access the exposed port via a private networking interface. Docker
248
+will set some environment variables in the client container to help indicate
249
+which interface and port to use.
250
+
251
+**--lxc-conf**=[]
252
+   (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
253
+
254
+**--log-driver**="|*json-file*|*syslog*|*journald*|*none*"
255
+  Logging driver for container. Default is defined by daemon `--log-driver` flag.
256
+  **Warning**: `docker logs` command works only for `json-file` logging driver.
257
+
258
+**--log-opt**=[]
259
+  Logging driver specific options.
260
+
261
+**-m**, **--memory**=""
262
+   Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
263
+
264
+   Allows you to constrain the memory available to a container. If the host
265
+supports swap memory, then the **-m** memory setting can be larger than physical
266
+RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
267
+not limited. The actual limit may be rounded up to a multiple of the operating
268
+system's page size (the value would be very large, that's millions of trillions).
269
+
270
+**--memory-swap**=""
271
+   Total memory limit (memory + swap)
272
+
273
+   Set `-1` to disable swap (format: <number><optional unit>, where unit = b, k, m or g).
274
+This value should always larger than **-m**, so you should always use this with **-m**.
275
+
276
+**--mac-address**=""
277
+   Container MAC address (e.g. 92:d0:c6:0a:29:33)
278
+
279
+   Remember that the MAC address in an Ethernet network must be unique.
280
+The IPv6 link-local address will be based on the device's MAC address
281
+according to RFC4862.
282
+
283
+**--name**=""
284
+   Assign a name to the container
285
+
286
+   The operator can identify a container in three ways:
287
+    UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
288
+    UUID short identifier (“f78375b1c487”)
289
+    Name (“jonah”)
290
+
291
+   The UUID identifiers come from the Docker daemon, and if a name is not assigned
292
+to the container with **--name** then the daemon will also generate a random
293
+string name. The name is useful when defining links (see **--link**) (or any
294
+other place you need to identify a container). This works for both background
295
+and foreground Docker containers.
296
+
297
+**--net**="bridge"
298
+   Set the Network mode for the container
299
+                               'bridge': creates a new network stack for the container on the docker bridge
300
+                               'none': no networking for this container
301
+                               'container:<name|id>': reuses another container network stack
302
+                               'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
303
+
304
+**--oom-kill-disable**=*true*|*false*
305
+   Whether to disable OOM Killer for the container or not.
306
+
307
+**-P**, **--publish-all**=*true*|*false*
308
+   Publish all exposed ports to random ports on the host interfaces. The default is *false*.
309
+
310
+   When set to true publish all exposed ports to the host interfaces. The
311
+default is false. If the operator uses -P (or -p) then Docker will make the
312
+exposed port accessible on the host and the ports will be available to any
313
+client that can reach the host. When using -P, Docker will bind any exposed
314
+port to a random port on the host within an *ephemeral port range* defined by
315
+`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
316
+ports and the exposed ports, use `docker port`.
317
+
318
+**-p**, **--publish**=[]
319
+   Publish a container's port, or range of ports, to the host.
320
+                               format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
321
+                               Both hostPort and containerPort can be specified as a range of ports. 
322
+                               When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. (e.g., `-p 1234-1236:1234-1236/tcp`)
323
+                               (use 'docker port' to see the actual mapping)
324
+
325
+**--pid**=host
326
+   Set the PID mode for the container
327
+     **host**: use the host's PID namespace inside the container.
328
+     Note: the host mode gives the container full access to local PID and is therefore considered insecure.
329
+
330
+**--uts**=host
331
+   Set the UTS mode for the container
332
+     **host**: use the host's UTS namespace inside the container.
333
+     Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
334
+
335
+**--privileged**=*true*|*false*
336
+   Give extended privileges to this container. The default is *false*.
337
+
338
+   By default, Docker containers are
339
+“unprivileged” (=false) and cannot, for example, run a Docker daemon inside the
340
+Docker container. This is because by default a container is not allowed to
341
+access any devices. A “privileged” container is given access to all devices.
342
+
343
+   When the operator executes **docker run --privileged**, Docker will enable access
344
+to all devices on the host as well as set some configuration in AppArmor to
345
+allow the container nearly all the same access to the host as processes running
346
+outside of a container on the host.
347
+
348
+**--read-only**=*true*|*false*
349
+   Mount the container's root filesystem as read only.
350
+
351
+   By default a container will have its root filesystem writable allowing processes
352
+to write files anywhere.  By specifying the `--read-only` flag the container will have
353
+its root filesystem mounted as read only prohibiting any writes.
354
+
355
+**--restart**="no"
356
+   Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
357
+      
358
+**--rm**=*true*|*false*
359
+   Automatically remove the container when it exits (incompatible with -d). The default is *false*.
360
+
361
+**--security-opt**=[]
362
+   Security Options
363
+
364
+   "label:user:USER"   : Set the label user for the container
365
+    "label:role:ROLE"   : Set the label role for the container
366
+    "label:type:TYPE"   : Set the label type for the container
367
+    "label:level:LEVEL" : Set the label level for the container
368
+    "label:disable"     : Turn off label confinement for the container
369
+
370
+**--sig-proxy**=*true*|*false*
371
+   Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
372
+
373
+**-t**, **--tty**=*true*|*false*
374
+   Allocate a pseudo-TTY. The default is *false*.
375
+
376
+   When set to true Docker can allocate a pseudo-tty and attach to the standard
377
+input of any container. This can be used, for example, to run a throwaway
378
+interactive shell. The default is value is false.
379
+
380
+The **-t** option is incompatible with a redirection of the docker client
381
+standard input.
382
+
383
+**-u**, **--user**=""
384
+   Sets the username or UID used and optionally the groupname or GID for the specified command.
385
+
386
+   The followings examples are all valid:
387
+   --user [user | user:group | uid | uid:gid | user:gid | uid:group ]
388
+
389
+   Without this argument the command will be run as root in the container.
390
+
391
+**-v**, **--volume**=[]
392
+   Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
393
+
394
+   The **-v** option can be used one or
395
+more times to add one or more mounts to a container. These mounts can then be
396
+used in other containers using the **--volumes-from** option.
397
+
398
+   The volume may be optionally suffixed with :ro or :rw to mount the volumes in
399
+read-only or read-write mode, respectively. By default, the volumes are mounted
400
+read-write. See examples.
401
+
402
+Labeling systems like SELinux require proper labels be placed on volume content
403
+mounted into a container, otherwise the secuirty system might prevent the
404
+processes running inside the container from using the content. By default,
405
+volumes are not relabeled.
406
+
407
+Two suffixes :z or :Z can be added to the volume mount. These suffixes tell
408
+Docker to relabel file objects on the shared volumes. The 'z' option tells
409
+Docker that the volume content will be shared between containers. Docker will
410
+label the content with a shared content label. Shared volumes labels allow all
411
+containers to read/write content. The 'Z' option tells Docker to label the
412
+content with a private unshared label. Private volumes can only be used by the
413
+current container.
414
+
415
+Note: Multiple Volume options can be added separated by a ","
416
+
417
+**--volumes-from**=[]
418
+   Mount volumes from the specified container(s)
419
+
420
+   Mounts already mounted volumes from a source container onto another
421
+   container. You must supply the source's container-id. To share 
422
+   a volume, use the **--volumes-from** option when running
423
+   the target container. You can share volumes even if the source container 
424
+   is not running.
425
+
426
+   By default, Docker mounts the volumes in the same mode (read-write or 
427
+   read-only) as it is mounted in the source container. Optionally, you 
428
+   can change this by suffixing the container-id with either the `:ro` or 
429
+   `:rw ` keyword.
430
+
431
+   If the location of the volume from the source container overlaps with
432
+   data residing on a target container, then the volume hides
433
+   that data on the target.
434
+
435
+**-w**, **--workdir**=""
436
+   Working directory inside the container
437
+
438
+   The default working directory for
439
+running binaries within a container is the root directory (/). The developer can
440
+set a different default with the Dockerfile WORKDIR instruction. The operator
441
+can override the working directory by using the **-w** option.
442
+
443
+# EXAMPLES
444
+
445
+## Exposing log messages from the container to the host's log
446
+
447
+If you want messages that are logged in your container to show up in the host's
448
+syslog/journal then you should bind mount the /dev/log directory as follows.
449
+
450
+    # docker run -v /dev/log:/dev/log -i -t fedora /bin/bash
451
+
452
+From inside the container you can test this by sending a message to the log.
453
+
454
+    (bash)# logger "Hello from my container"
455
+
456
+Then exit and check the journal.
457
+
458
+    # exit
459
+
460
+    # journalctl -b | grep Hello
461
+
462
+This should list the message sent to logger.
463
+
464
+## Attaching to one or more from STDIN, STDOUT, STDERR
465
+
466
+If you do not specify -a then Docker will attach everything (stdin,stdout,stderr)
467
+. You can specify to which of the three standard streams (stdin, stdout, stderr)
468
+you’d like to connect instead, as in:
469
+
470
+    # docker run -a stdin -a stdout -i -t fedora /bin/bash
471
+
472
+## Sharing IPC between containers
473
+
474
+Using shm_server.c available here: https://www.cs.cf.ac.uk/Dave/C/node27.html
475
+
476
+Testing `--ipc=host` mode:
477
+
478
+Host shows a shared memory segment with 7 pids attached, happens to be from httpd:
479
+
480
+```
481
+ $ sudo ipcs -m
482
+
483
+ ------ Shared Memory Segments --------
484
+ key        shmid      owner      perms      bytes      nattch     status      
485
+ 0x01128e25 0          root       600        1000       7                       
486
+```
487
+
488
+Now run a regular container, and it correctly does NOT see the shared memory segment from the host:
489
+
490
+```
491
+ $ docker run -it shm ipcs -m
492
+
493
+ ------ Shared Memory Segments --------	
494
+ key        shmid      owner      perms      bytes      nattch     status      
495
+```
496
+
497
+Run a container with the new `--ipc=host` option, and it now sees the shared memory segment from the host httpd:
498
+
499
+ ```
500
+ $ docker run -it --ipc=host shm ipcs -m
501
+
502
+ ------ Shared Memory Segments --------
503
+ key        shmid      owner      perms      bytes      nattch     status      
504
+ 0x01128e25 0          root       600        1000       7                   
505
+```
506
+Testing `--ipc=container:CONTAINERID` mode:
507
+
508
+Start a container with a program to create a shared memory segment:
509
+```
510
+ $ docker run -it shm bash
511
+ $ sudo shm/shm_server &
512
+ $ sudo ipcs -m
513
+
514
+ ------ Shared Memory Segments --------
515
+ key        shmid      owner      perms      bytes      nattch     status      
516
+ 0x0000162e 0          root       666        27         1                       
517
+```
518
+Create a 2nd container correctly shows no shared memory segment from 1st container:
519
+```
520
+ $ docker run shm ipcs -m
521
+
522
+ ------ Shared Memory Segments --------
523
+ key        shmid      owner      perms      bytes      nattch     status      
524
+```
525
+
526
+Create a 3rd container using the new --ipc=container:CONTAINERID option, now it shows the shared memory segment from the first:
527
+
528
+```
529
+ $ docker run -it --ipc=container:ed735b2264ac shm ipcs -m
530
+ $ sudo ipcs -m
531
+
532
+ ------ Shared Memory Segments --------
533
+ key        shmid      owner      perms      bytes      nattch     status      
534
+ 0x0000162e 0          root       666        27         1
535
+```
536
+
537
+## Linking Containers
538
+
539
+The link feature allows multiple containers to communicate with each other. For
540
+example, a container whose Dockerfile has exposed port 80 can be run and named
541
+as follows:
542
+
543
+    # docker run --name=link-test -d -i -t fedora/httpd
544
+
545
+A second container, in this case called linker, can communicate with the httpd
546
+container, named link-test, by running with the **--link=<name>:<alias>**
547
+
548
+    # docker run -t -i --link=link-test:lt --name=linker fedora /bin/bash
549
+
550
+Now the container linker is linked to container link-test with the alias lt.
551
+Running the **env** command in the linker container shows environment variables
552
+ with the LT (alias) context (**LT_**)
553
+
554
+    # env
555
+    HOSTNAME=668231cb0978
556
+    TERM=xterm
557
+    LT_PORT_80_TCP=tcp://172.17.0.3:80
558
+    LT_PORT_80_TCP_PORT=80
559
+    LT_PORT_80_TCP_PROTO=tcp
560
+    LT_PORT=tcp://172.17.0.3:80
561
+    PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
562
+    PWD=/
563
+    LT_NAME=/linker/lt
564
+    SHLVL=1
565
+    HOME=/
566
+    LT_PORT_80_TCP_ADDR=172.17.0.3
567
+    _=/usr/bin/env
568
+
569
+When linking two containers Docker will use the exposed ports of the container
570
+to create a secure tunnel for the parent to access.
571
+
572
+
573
+## Mapping Ports for External Usage
574
+
575
+The exposed port of an application can be mapped to a host port using the **-p**
576
+flag. For example, a httpd port 80 can be mapped to the host port 8080 using the
577
+following:
578
+
579
+    # docker run -p 8080:80 -d -i -t fedora/httpd
580
+
581
+## Creating and Mounting a Data Volume Container
582
+
583
+Many applications require the sharing of persistent data across several
584
+containers. Docker allows you to create a Data Volume Container that other
585
+containers can mount from. For example, create a named container that contains
586
+directories /var/volume1 and /tmp/volume2. The image will need to contain these
587
+directories so a couple of RUN mkdir instructions might be required for you
588
+fedora-data image:
589
+
590
+    # docker run --name=data -v /var/volume1 -v /tmp/volume2 -i -t fedora-data true
591
+    # docker run --volumes-from=data --name=fedora-container1 -i -t fedora bash
592
+
593
+Multiple --volumes-from parameters will bring together multiple data volumes from
594
+multiple containers. And it's possible to mount the volumes that came from the
595
+DATA container in yet another container via the fedora-container1 intermediary
596
+container, allowing to abstract the actual data source from users of that data:
597
+
598
+    # docker run --volumes-from=fedora-container1 --name=fedora-container2 -i -t fedora bash
599
+
600
+## Mounting External Volumes
601
+
602
+To mount a host directory as a container volume, specify the absolute path to
603
+the directory and the absolute path for the container directory separated by a
604
+colon:
605
+
606
+    # docker run -v /var/db:/data1 -i -t fedora bash
607
+
608
+When using SELinux, be aware that the host has no knowledge of container SELinux
609
+policy. Therefore, in the above example, if SELinux policy is enforced, the
610
+`/var/db` directory is not writable to the container. A "Permission Denied"
611
+message will occur and an avc: message in the host's syslog.
612
+
613
+
614
+To work around this, at time of writing this man page, the following command
615
+needs to be run in order for the proper SELinux policy type label to be attached
616
+to the host directory:
617
+
618
+    # chcon -Rt svirt_sandbox_file_t /var/db
619
+
620
+
621
+Now, writing to the /data1 volume in the container will be allowed and the
622
+changes will also be reflected on the host in /var/db.
623
+
624
+## Using alternative security labeling
625
+
626
+You can override the default labeling scheme for each container by specifying
627
+the `--security-opt` flag. For example, you can specify the MCS/MLS level, a
628
+requirement for MLS systems. Specifying the level in the following command
629
+allows you to share the same content between containers.
630
+
631
+    # docker run --security-opt label:level:s0:c100,c200 -i -t fedora bash
632
+
633
+An MLS example might be:
634
+
635
+    # docker run --security-opt label:level:TopSecret -i -t rhel7 bash
636
+
637
+To disable the security labeling for this container versus running with the
638
+`--permissive` flag, use the following command:
639
+
640
+    # docker run --security-opt label:disable -i -t fedora bash
641
+
642
+If you want a tighter security policy on the processes within a container,
643
+you can specify an alternate type for the container. You could run a container
644
+that is only allowed to listen on Apache ports by executing the following
645
+command:
646
+
647
+    # docker run --security-opt label:type:svirt_apache_t -i -t centos bash
648
+
649
+Note:
650
+
651
+You would have to write policy defining a `svirt_apache_t` type.
652
+
653
+# HISTORY
654
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
655
+based on docker.com source material and internal work.
656
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
657
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 658
new file mode 100644
... ...
@@ -0,0 +1,45 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-save - Save an image(s) to a tar archive (streamed to STDOUT by default)
5
+
6
+# SYNOPSIS
7
+**docker save**
8
+[**--help**]
9
+[**-o**|**--output**[=*OUTPUT*]]
10
+IMAGE [IMAGE...]
11
+
12
+# DESCRIPTION
13
+Produces a tarred repository to the standard output stream. Contains all
14
+parent layers, and all tags + versions, or specified repo:tag.
15
+
16
+Stream to a file instead of STDOUT by using **-o**.
17
+
18
+# OPTIONS
19
+**--help**
20
+  Print usage statement
21
+
22
+**-o**, **--output**=""
23
+   Write to a file, instead of STDOUT
24
+
25
+# EXAMPLES
26
+
27
+Save all fedora repository images to a fedora-all.tar and save the latest
28
+fedora image to a fedora-latest.tar:
29
+
30
+    $ docker save fedora > fedora-all.tar
31
+    $ docker save --output=fedora-latest.tar fedora:latest
32
+    $ ls -sh fedora-all.tar
33
+    721M fedora-all.tar
34
+    $ ls -sh fedora-latest.tar
35
+    367M fedora-latest.tar
36
+
37
+# See also
38
+**docker-load(1)** to load an image from a tar archive on STDIN.
39
+
40
+# HISTORY
41
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
42
+based on docker.com source material and internal work.
43
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
44
+November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 45
new file mode 100644
... ...
@@ -0,0 +1,65 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-search - Search the Docker Hub for images
5
+
6
+# SYNOPSIS
7
+**docker search**
8
+[**--automated**[=*false*]]
9
+[**--help**]
10
+[**--no-trunc**[=*false*]]
11
+[**-s**|**--stars**[=*0*]]
12
+TERM
13
+
14
+# DESCRIPTION
15
+
16
+Search Docker Hub for an image with that matches the specified `TERM`. The table
17
+of images returned displays the name, description (truncated by default), number
18
+of stars awarded, whether the image is official, and whether it is automated.
19
+
20
+*Note* - Search queries will only return up to 25 results
21
+
22
+# OPTIONS
23
+**--automated**=*true*|*false*
24
+   Only show automated builds. The default is *false*.
25
+
26
+**--help**
27
+  Print usage statement
28
+
29
+**--no-trunc**=*true*|*false*
30
+   Don't truncate output. The default is *false*.
31
+
32
+**-s**, **--stars**=0
33
+   Only displays with at least x stars
34
+
35
+# EXAMPLES
36
+
37
+## Search Docker Hub for ranked images
38
+
39
+Search a registry for the term 'fedora' and only display those images
40
+ranked 3 or higher:
41
+
42
+    $ docker search -s 3 fedora
43
+    NAME                  DESCRIPTION                                    STARS OFFICIAL  AUTOMATED
44
+    mattdm/fedora         A basic Fedora image corresponding roughly...  50
45
+    fedora                (Semi) Official Fedora base image.             38
46
+    mattdm/fedora-small   A small Fedora image on which to build. Co...  8
47
+    goldmann/wildfly      A WildFly application server running on a ...  3               [OK]
48
+
49
+## Search Docker Hub for automated images
50
+
51
+Search Docker Hub for the term 'fedora' and only display automated images
52
+ranked 1 or higher:
53
+
54
+    $ docker search -s 1 -t fedora
55
+    NAME               DESCRIPTION                                     STARS OFFICIAL  AUTOMATED
56
+    goldmann/wildfly   A WildFly application server running on a ...   3               [OK]
57
+    tutum/fedora-20    Fedora 20 image with SSH access. For the r...   1               [OK]
58
+
59
+# HISTORY
60
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
61
+based on docker.com source material and internal work.
62
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
63
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
64
+
0 65
new file mode 100644
... ...
@@ -0,0 +1,34 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-start - Start one or more stopped containers
5
+
6
+# SYNOPSIS
7
+**docker start**
8
+[**-a**|**--attach**[=*false*]]
9
+[**--help**]
10
+[**-i**|**--interactive**[=*false*]]
11
+CONTAINER [CONTAINER...]
12
+
13
+# DESCRIPTION
14
+
15
+Start one or more stopped containers.
16
+
17
+# OPTIONS
18
+**-a**, **--attach**=*true*|*false*
19
+   Attach container's STDOUT and STDERR and forward all signals to the process. The default is *false*.
20
+
21
+**--help**
22
+  Print usage statement
23
+
24
+**-i**, **--interactive**=*true*|*false*
25
+   Attach container's STDIN. The default is *false*.
26
+
27
+# See also
28
+**docker-stop(1)** to stop a running container.
29
+
30
+# HISTORY
31
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
32
+based on docker.com source material and internal work.
33
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 34
new file mode 100644
... ...
@@ -0,0 +1,31 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-stats - Display a live stream of one or more containers' resource usage statistics
5
+
6
+# SYNOPSIS
7
+**docker stats**
8
+[**--help**]
9
+CONTAINER [CONTAINER...]
10
+
11
+# DESCRIPTION
12
+
13
+Display a live stream of one or more containers' resource usage statistics
14
+
15
+# OPTIONS
16
+**--help**
17
+  Print usage statement
18
+
19
+**--no-stream**="false"
20
+  Disable streaming stats and only pull the first result
21
+
22
+# EXAMPLES
23
+
24
+Run **docker stats** with multiple containers.
25
+
26
+    $ docker stats redis1 redis2
27
+    CONTAINER           CPU %               MEM USAGE/LIMIT     MEM %               NET I/O
28
+    redis1              0.07%               796 KB/64 MB        1.21%               788 B/648 B
29
+    redis2              0.07%               2.746 MB/64 MB      4.29%               1.266 KB/648 B
30
+
0 31
new file mode 100644
... ...
@@ -0,0 +1,30 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period
5
+
6
+# SYNOPSIS
7
+**docker stop**
8
+[**--help**]
9
+[**-t**|**--time**[=*10*]]
10
+CONTAINER [CONTAINER...]
11
+
12
+# DESCRIPTION
13
+Stop a running container (Send SIGTERM, and then SIGKILL after
14
+ grace period)
15
+
16
+# OPTIONS
17
+**--help**
18
+  Print usage statement
19
+
20
+**-t**, **--time**=10
21
+   Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.
22
+
23
+#See also
24
+**docker-start(1)** to restart a stopped container.
25
+
26
+# HISTORY
27
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
28
+based on docker.com source material and internal work.
29
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 30
new file mode 100644
... ...
@@ -0,0 +1,65 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-tag - Tag an image into a repository
5
+
6
+# SYNOPSIS
7
+**docker tag**
8
+[**-f**|**--force**[=*false*]]
9
+[**--help**]
10
+IMAGE[:TAG] [REGISTRY_HOST/][USERNAME/]NAME[:TAG]
11
+
12
+# DESCRIPTION
13
+Assigns a new alias to an image in a registry. An alias refers to the
14
+entire image name including the optional `TAG` after the ':'. 
15
+
16
+If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
17
+registry located at `registry-1.docker.io` by default. 
18
+
19
+# "OPTIONS"
20
+**-f**, **--force**=*true*|*false*
21
+   When set to true, force the alias. The default is *false*.
22
+
23
+**REGISTRYHOST**
24
+   The hostname of the registry if required. This may also include the port
25
+separated by a ':'
26
+
27
+**USERNAME**
28
+   The username or other qualifying identifier for the image.
29
+
30
+**NAME**
31
+   The image name.
32
+
33
+**TAG**
34
+   The tag you are assigning to the image.  Though this is arbitrary it is
35
+recommended to be used for a version to distinguish images with the same name.
36
+Note that here TAG is a part of the overall name or "tag".
37
+
38
+# OPTIONS
39
+**-f**, **--force**=*true*|*false*
40
+   Force. The default is *false*.
41
+
42
+# EXAMPLES
43
+
44
+## Giving an image a new alias
45
+
46
+Here is an example of aliasing an image (e.g., 0e5574283393) as "httpd" and 
47
+tagging it into the "fedora" repository with "version1.0":
48
+
49
+    docker tag 0e5574283393 fedora/httpd:version1.0
50
+
51
+## Tagging an image for a private repository
52
+
53
+To push an image to an private registry and not the central Docker
54
+registry you must tag it with the registry hostname and port (if needed).
55
+
56
+    docker tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0
57
+
58
+# HISTORY
59
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
60
+based on docker.com source material and internal work.
61
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
62
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
63
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
64
+
0 65
new file mode 100644
... ...
@@ -0,0 +1,33 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-top - Display the running processes of a container
5
+
6
+# SYNOPSIS
7
+**docker top**
8
+[**--help**]
9
+CONTAINER [ps OPTIONS]
10
+
11
+# DESCRIPTION
12
+
13
+Look up the running process of the container. ps-OPTION can be any of the
14
+ options you would pass to a Linux ps command.
15
+
16
+# OPTIONS
17
+**--help**
18
+  Print usage statement
19
+
20
+# EXAMPLES
21
+
22
+Run **docker top** with the ps option of -x:
23
+
24
+    $ docker top 8601afda2b -x
25
+    PID      TTY       STAT       TIME         COMMAND
26
+    16623    ?         Ss         0:00         sleep 99999
27
+
28
+
29
+# HISTORY
30
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
31
+based on docker.com source material and internal work.
32
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 33
new file mode 100644
... ...
@@ -0,0 +1,27 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-unpause - Unpause all processes within a container
5
+
6
+# SYNOPSIS
7
+**docker unpause**
8
+CONTAINER [CONTAINER...]
9
+
10
+# DESCRIPTION
11
+
12
+The `docker unpause` command uses the cgroups freezer to un-suspend all
13
+processes in a container.
14
+
15
+See the [cgroups freezer documentation]
16
+(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for
17
+further details.
18
+
19
+# OPTIONS
20
+There are no available options.
21
+
22
+# See also
23
+**docker-pause(1)** to pause all processes within a container.
24
+
25
+# HISTORY
26
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 27
new file mode 100644
... ...
@@ -0,0 +1,15 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-version - Show the Docker version information.
5
+
6
+# SYNOPSIS
7
+**docker version**
8
+
9
+
10
+# OPTIONS
11
+There are no available options.
12
+
13
+# HISTORY
14
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 15
new file mode 100644
... ...
@@ -0,0 +1,30 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-wait - Block until a container stops, then print its exit code.
5
+
6
+# SYNOPSIS
7
+**docker wait**
8
+[**--help**]
9
+CONTAINER [CONTAINER...]
10
+
11
+# DESCRIPTION
12
+
13
+Block until a container stops, then print its exit code.
14
+
15
+# OPTIONS
16
+**--help**
17
+  Print usage statement
18
+
19
+# EXAMPLES
20
+
21
+    $ docker run -d fedora sleep 99
22
+    079b83f558a2bc52ecad6b2a5de13622d584e6bb1aea058c11b36511e85e7622
23
+    $ docker wait 079b83f558a2bc
24
+    0
25
+
26
+# HISTORY
27
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
28
+based on docker.com source material and internal work.
29
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 30
new file mode 100644
... ...
@@ -0,0 +1,391 @@
0
+% DOCKER(1) Docker User Manuals
1
+% William Henry
2
+% APRIL 2014
3
+# NAME
4
+docker \- Docker image and container command line interface
5
+
6
+# SYNOPSIS
7
+**docker** [OPTIONS] COMMAND [arg...]
8
+
9
+# DESCRIPTION
10
+**docker** has two distinct functions. It is used for starting the Docker
11
+daemon and to run the CLI (i.e., to command the daemon to manage images,
12
+containers etc.) So **docker** is both a server, as a daemon, and a client
13
+to the daemon, through the CLI.
14
+
15
+To run the Docker daemon you do not specify any of the commands listed below but
16
+must specify the **-d** option.  The other options listed below are for the
17
+daemon only.
18
+
19
+The Docker CLI has over 30 commands. The commands are listed below and each has
20
+its own man page which explain usage and arguments.
21
+
22
+To see the man page for a command run **man docker <command>**.
23
+
24
+# OPTIONS
25
+**-h**, **--help**
26
+  Print usage statement
27
+
28
+**--api-cors-header**=""
29
+  Set CORS headers in the remote API. Default is cors disabled. Give urls like "http://foo, http://bar, ...". Give "*" to allow all.
30
+
31
+**-b**, **--bridge**=""
32
+  Attach containers to a pre\-existing network bridge; use 'none' to disable container networking
33
+
34
+**--bip**=""
35
+  Use the provided CIDR notation address for the dynamically created bridge (docker0); Mutually exclusive of \-b
36
+
37
+**-D**, **--debug**=*true*|*false*
38
+  Enable debug mode. Default is false.
39
+
40
+**-d**, **--daemon**=*true*|*false*
41
+  Enable daemon mode. Default is false.
42
+
43
+**--default-gateway**=""
44
+  IPv4 address of the container default gateway; this address must be part of the bridge subnet (which is defined by \-b or \--bip)
45
+
46
+**--default-gateway-v6**=""
47
+  IPv6 address of the container default gateway
48
+
49
+**--dns**=""
50
+  Force Docker to use specific DNS servers
51
+
52
+**-e**, **--exec-driver**=""
53
+  Force Docker to use specific exec driver. Default is `native`.
54
+
55
+**--exec-opt**=[]
56
+  Set exec driver options. See EXEC DRIVER OPTIONS.
57
+
58
+**--exec-root**=""
59
+  Path to use as the root of the Docker execdriver. Default is `/var/run/docker`.
60
+
61
+**--fixed-cidr**=""
62
+  IPv4 subnet for fixed IPs (e.g., 10.20.0.0/16); this subnet must be nested in the bridge subnet (which is defined by \-b or \-\-bip)
63
+
64
+**--fixed-cidr-v6**=""
65
+  IPv6 subnet for global IPv6 addresses (e.g., 2a00:1450::/64)
66
+
67
+**-G**, **--group**=""
68
+  Group to assign the unix socket specified by -H when running in daemon mode.
69
+  use '' (the empty string) to disable setting of a group. Default is `docker`.
70
+
71
+**-g**, **--graph**=""
72
+  Path to use as the root of the Docker runtime. Default is `/var/lib/docker`.
73
+
74
+**-H**, **--host**=[unix:///var/run/docker.sock]: tcp://[host:port] to bind or
75
+unix://[/path/to/socket] to use.
76
+  The socket(s) to bind to in daemon mode specified using one or more
77
+  tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd.
78
+
79
+**--icc**=*true*|*false*
80
+  Allow unrestricted inter\-container and Docker daemon host communication. If disabled, containers can still be linked together using **--link** option (see **docker-run(1)**). Default is true.
81
+
82
+**--ip**=""
83
+  Default IP address to use when binding container ports. Default is `0.0.0.0`.
84
+
85
+**--ip-forward**=*true*|*false*
86
+  Docker will enable IP forwarding. Default is true. If `--fixed-cidr-v6` is set. IPv6 forwarding will be activated, too. This may reject Router Advertisements and interfere with the host's existing IPv6 configuration. For more information please consult the documentation about "Advanced Networking - IPv6".
87
+
88
+**--ip-masq**=*true*|*false*
89
+  Enable IP masquerading for bridge's IP range. Default is true.
90
+
91
+**--iptables**=*true*|*false*
92
+  Enable Docker's addition of iptables rules. Default is true.
93
+
94
+**--ipv6**=*true*|*false*
95
+  Enable IPv6 support. Default is false. Docker will create an IPv6-enabled bridge with address fe80::1 which will allow you to create IPv6-enabled containers. Use together with `--fixed-cidr-v6` to provide globally routable IPv6 addresses. IPv6 forwarding will be enabled if not used with `--ip-forward=false`. This may collide with your host's current IPv6 settings. For more information please consult the documentation about "Advanced Networking - IPv6".
96
+
97
+**-l**, **--log-level**="*debug*|*info*|*warn*|*error*|*fatal*""
98
+  Set the logging level. Default is `info`.
99
+
100
+**--label**="[]"
101
+  Set key=value labels to the daemon (displayed in `docker info`)
102
+
103
+**--log-driver**="*json-file*|*syslog*|*journald*|*none*"
104
+  Default driver for container logs. Default is `json-file`.
105
+  **Warning**: `docker logs` command works only for `json-file` logging driver.
106
+
107
+**--log-opt**=[]
108
+  Logging driver specific options.
109
+
110
+**--mtu**=VALUE
111
+  Set the containers network mtu. Default is `0`.
112
+
113
+**-p**, **--pidfile**=""
114
+  Path to use for daemon PID file. Default is `/var/run/docker.pid`
115
+
116
+**--registry-mirror**=<scheme>://<host>
117
+  Prepend a registry mirror to be used for image pulls. May be specified multiple times.
118
+
119
+**-s**, **--storage-driver**=""
120
+  Force the Docker runtime to use a specific storage driver.
121
+
122
+**--selinux-enabled**=*true*|*false*
123
+  Enable selinux support. Default is false. SELinux does not presently support the BTRFS storage driver.
124
+
125
+**--storage-opt**=[]
126
+  Set storage driver options. See STORAGE DRIVER OPTIONS.
127
+
128
+**-tls**=*true*|*false*
129
+  Use TLS; implied by --tlsverify. Default is false.
130
+
131
+**-tlsverify**=*true*|*false*
132
+  Use TLS and verify the remote (daemon: verify client, client: verify daemon).
133
+  Default is false.
134
+
135
+**--userland-proxy**=*true*|*false*
136
+    Rely on a userland proxy implementation for inter-container and outside-to-container loopback communications. Default is true.
137
+
138
+**-v**, **--version**=*true*|*false*
139
+  Print version information and quit. Default is false.
140
+
141
+# COMMANDS
142
+**attach**
143
+  Attach to a running container
144
+  See **docker-attach(1)** for full documentation on the **attach** command.
145
+
146
+**build**
147
+  Build an image from a Dockerfile
148
+  See **docker-build(1)** for full documentation on the **build** command.
149
+
150
+**commit**
151
+  Create a new image from a container's changes
152
+  See **docker-commit(1)** for full documentation on the **commit** command.
153
+
154
+**cp**
155
+  Copy files/folders from a container's filesystem to the host
156
+  See **docker-cp(1)** for full documentation on the **cp** command.
157
+
158
+**create**
159
+  Create a new container
160
+  See **docker-create(1)** for full documentation on the **create** command.
161
+
162
+**diff**
163
+  Inspect changes on a container's filesystem
164
+  See **docker-diff(1)** for full documentation on the **diff** command.
165
+
166
+**events**
167
+  Get real time events from the server
168
+  See **docker-events(1)** for full documentation on the **events** command.
169
+
170
+**exec**
171
+  Run a command in a running container
172
+  See **docker-exec(1)** for full documentation on the **exec** command.
173
+
174
+**export**
175
+  Stream the contents of a container as a tar archive
176
+  See **docker-export(1)** for full documentation on the **export** command.
177
+
178
+**history**
179
+  Show the history of an image
180
+  See **docker-history(1)** for full documentation on the **history** command.
181
+
182
+**images**
183
+  List images
184
+  See **docker-images(1)** for full documentation on the **images** command.
185
+
186
+**import**
187
+  Create a new filesystem image from the contents of a tarball
188
+  See **docker-import(1)** for full documentation on the **import** command.
189
+
190
+**info**
191
+  Display system-wide information
192
+  See **docker-info(1)** for full documentation on the **info** command.
193
+
194
+**inspect**
195
+  Return low-level information on a container or image
196
+  See **docker-inspect(1)** for full documentation on the **inspect** command.
197
+
198
+**kill**
199
+  Kill a running container (which includes the wrapper process and everything
200
+inside it)
201
+  See **docker-kill(1)** for full documentation on the **kill** command.
202
+
203
+**load**
204
+  Load an image from a tar archive
205
+  See **docker-load(1)** for full documentation on the **load** command.
206
+
207
+**login**
208
+  Register or login to a Docker Registry
209
+  See **docker-login(1)** for full documentation on the **login** command.
210
+
211
+**logout**
212
+  Log the user out of a Docker Registry
213
+  See **docker-logout(1)** for full documentation on the **logout** command.
214
+
215
+**logs**
216
+  Fetch the logs of a container
217
+  See **docker-logs(1)** for full documentation on the **logs** command.
218
+
219
+**pause**
220
+  Pause all processes within a container
221
+  See **docker-pause(1)** for full documentation on the **pause** command.
222
+
223
+**port**
224
+  Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
225
+  See **docker-port(1)** for full documentation on the **port** command.
226
+
227
+**ps**
228
+  List containers
229
+  See **docker-ps(1)** for full documentation on the **ps** command.
230
+
231
+**pull**
232
+  Pull an image or a repository from a Docker Registry
233
+  See **docker-pull(1)** for full documentation on the **pull** command.
234
+
235
+**push**
236
+  Push an image or a repository to a Docker Registry
237
+  See **docker-push(1)** for full documentation on the **push** command.
238
+
239
+**restart**
240
+  Restart a running container
241
+  See **docker-restart(1)** for full documentation on the **restart** command.
242
+
243
+**rm**
244
+  Remove one or more containers
245
+  See **docker-rm(1)** for full documentation on the **rm** command.
246
+
247
+**rmi**
248
+  Remove one or more images
249
+  See **docker-rmi(1)** for full documentation on the **rmi** command.
250
+
251
+**run**
252
+  Run a command in a new container
253
+  See **docker-run(1)** for full documentation on the **run** command.
254
+
255
+**save**
256
+  Save an image to a tar archive
257
+  See **docker-save(1)** for full documentation on the **save** command.
258
+
259
+**search**
260
+  Search for an image in the Docker index
261
+  See **docker-search(1)** for full documentation on the **search** command.
262
+
263
+**start**
264
+  Start a stopped container
265
+  See **docker-start(1)** for full documentation on the **start** command.
266
+
267
+**stats**
268
+  Display a live stream of one or more containers' resource usage statistics
269
+  See **docker-stats(1)** for full documentation on the **stats** command.
270
+
271
+**stop**
272
+  Stop a running container
273
+  See **docker-stop(1)** for full documentation on the **stop** command.
274
+
275
+**tag**
276
+  Tag an image into a repository
277
+  See **docker-tag(1)** for full documentation on the **tag** command.
278
+
279
+**top**
280
+  Lookup the running processes of a container
281
+  See **docker-top(1)** for full documentation on the **top** command.
282
+
283
+**unpause**
284
+  Unpause all processes within a container
285
+  See **docker-unpause(1)** for full documentation on the **unpause** command.
286
+
287
+**version**
288
+  Show the Docker version information
289
+  See **docker-version(1)** for full documentation on the **version** command.
290
+
291
+**wait**
292
+  Block until a container stops, then print its exit code
293
+  See **docker-wait(1)** for full documentation on the **wait** command.
294
+
295
+# STORAGE DRIVER OPTIONS
296
+
297
+Options to storage backend can be specified with **--storage-opt** flags. The
298
+only backend which currently takes options is *devicemapper*. Therefore use these
299
+flags with **-s=**devicemapper.
300
+
301
+Here is the list of *devicemapper* options:
302
+
303
+#### dm.basesize
304
+Specifies the size to use when creating the base device, which limits the size
305
+of images and containers. The default value is 10G. Note, thin devices are
306
+inherently "sparse", so a 10G device which is mostly empty doesn't use 10 GB
307
+of space on the pool. However, the filesystem will use more space for the empty
308
+case the larger the device is. **Warning**: This value affects the system-wide
309
+"base" empty filesystem that may already be initialized and inherited by pulled
310
+images.
311
+
312
+#### dm.loopdatasize
313
+Specifies the size to use when creating the loopback file for the "data"
314
+device which is used for the thin pool. The default size is 100G. Note that the
315
+file is sparse, so it will not initially take up this much space.
316
+
317
+#### dm.loopmetadatasize
318
+Specifies the size to use when creating the loopback file for the "metadadata"
319
+device which is used for the thin pool. The default size is 2G. Note that the
320
+file is sparse, so it will not initially take up this much space.
321
+
322
+#### dm.fs
323
+Specifies the filesystem type to use for the base device. The supported
324
+options are "ext4" and "xfs". The default is "ext4"
325
+
326
+#### dm.mkfsarg
327
+Specifies extra mkfs arguments to be used when creating the base device.
328
+
329
+#### dm.mountopt
330
+Specifies extra mount options used when mounting the thin devices.
331
+
332
+#### dm.datadev
333
+Specifies a custom blockdevice to use for data for the thin pool.
334
+
335
+If using a block device for device mapper storage, ideally both datadev and
336
+metadatadev should be specified to completely avoid using the loopback device.
337
+
338
+#### dm.metadatadev
339
+Specifies a custom blockdevice to use for metadata for the thin pool.
340
+
341
+For best performance the metadata should be on a different spindle than the
342
+data, or even better on an SSD.
343
+
344
+If setting up a new metadata pool it is required to be valid. This can be
345
+achieved by zeroing the first 4k to indicate empty metadata, like this:
346
+
347
+    dd if=/dev/zero of=/dev/metadata_dev bs=4096 count=1
348
+
349
+#### dm.blocksize
350
+Specifies a custom blocksize to use for the thin pool. The default blocksize
351
+is 64K.
352
+
353
+#### dm.blkdiscard
354
+Enables or disables the use of blkdiscard when removing devicemapper devices.
355
+This is enabled by default (only) if using loopback devices and is required to
356
+resparsify the loopback file on image/container removal.
357
+
358
+Disabling this on loopback can lead to *much* faster container removal times,
359
+but will prevent the space used in `/var/lib/docker` directory from being returned to
360
+the system for other use when containers are removed.
361
+
362
+# EXAMPLES
363
+Launching docker daemon with *devicemapper* backend with particular block devices
364
+for data and metadata:
365
+
366
+    docker -d -s=devicemapper \
367
+      --storage-opt dm.datadev=/dev/vdb \
368
+      --storage-opt dm.metadatadev=/dev/vdc \
369
+      --storage-opt dm.basesize=20G
370
+
371
+# EXEC DRIVER OPTIONS
372
+
373
+Use the **--exec-opt** flags to specify options to the exec-driver. The only
374
+driver that accepts this flag is the *native* (libcontainer) driver. As a
375
+result, you must also specify **-s=**native for this option to have effect. The 
376
+following is the only *native* option:
377
+
378
+#### native.cgroupdriver
379
+Specifies the management of the container's `cgroups`. You can specify 
380
+`cgroupfs` or `systemd`. If you specify `systemd` and it is not available, the 
381
+system uses `cgroupfs`.
382
+
383
+#### Client
384
+For specific client examples please see the man page for the specific Docker
385
+command. For example:
386
+
387
+    man docker-run
388
+
389
+# HISTORY
390
+April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work.
0 391
new file mode 100755
... ...
@@ -0,0 +1,22 @@
0
+#!/bin/bash
1
+set -e
2
+
3
+# get into this script's directory
4
+cd "$(dirname "$(readlink -f "$BASH_SOURCE")")"
5
+
6
+[ "$1" = '-q' ] || {
7
+	set -x
8
+	pwd
9
+}
10
+
11
+for FILE in *.md; do
12
+	base="$(basename "$FILE")"
13
+	name="${base%.md}"
14
+	num="${name##*.}"
15
+	if [ -z "$num" -o "$name" = "$num" ]; then
16
+		# skip files that aren't of the format xxxx.N.md (like README.md)
17
+		continue
18
+	fi
19
+	mkdir -p "./man${num}"
20
+	go-md2man -in "$FILE" -out "./man${num}/${name}"
21
+done
... ...
@@ -22,7 +22,7 @@ Before triaging an issue very far, make sure that the issue's author provided th
22 22
 -   the output of `uname -a`
23 23
 -   a reproducible case if this is a bug, Dockerfiles FTW
24 24
 -   host distribution and version ( ubuntu 14.04, RHEL, fedora 21 )
25
--   page URL if this is a docs issue
25
+-   page URL if this is a docs issue or the name of a man page 
26 26
 
27 27
 Depending on the issue, you might not feel all this information is needed. Use your best judgement.  If you cannot triage an issue using what its author provided, explain kindly to the author that they must provide the above information to clarify the problem. 
28 28