Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#923 - Docker man pages need some love #5056

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions man/docker-build.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ set as the **URL**, the repository is cloned locally and then sent as the contex
layers in tact, and one for the squashed version.

**--add-host** []
Add a custom host-to-IP mapping (host=ip, or host:ip)
Add a custom host-to-IP mapping (host=ip, or host:ip).

Add a line to /etc/hosts. The format is hostname=ip, or hostname:ip.
The **--add-host** option can be set multiple times.
Expand All @@ -98,7 +98,7 @@ set as the **URL**, the repository is cloned locally and then sent as the contex
Set image that will be used as a build cache source.

**--force-rm** *true*|*false*
Always remove intermediate containers, even after unsuccessful builds. The default is *false*.
Always remove intermediate containers, even after unsuccessful builds. The default is **false**.

**--isolation** "*default*"
Isolation specifies the type of isolation technology used by containers.
Expand All @@ -107,33 +107,33 @@ set as the **URL**, the repository is cloned locally and then sent as the contex
Set metadata for an image

**--no-cache** *true*|*false*
Do not use cache when building the image. The default is *false*.
Do not use cache when building the image. The default is **false**.

**--iidfile** ""
Write the image ID to the file
Write the image ID to the file.

**--help**
Print usage statement
Print usage statement.

**--pull** *true*|*false*
Always attempt to pull a newer version of the image. The default is *false*.
Always attempt to pull a newer version of the image. The default is **false**.

**--compress** *true*|*false*
Compress the build context using gzip. The default is *false*.
Compress the build context using gzip. The default is **false**.

**-q**, **--quiet** *true*|*false*
Suppress the build output and print image ID on success. The default is *false*.
Suppress the build output and print image ID on success. The default is **false**.

**--rm** *true*|*false*
Remove intermediate containers after a successful build. The default is *true*.
Remove intermediate containers after a successful build. The default is **true**.

**-t**, **--tag** ""
Repository names (and optionally with tags) to be applied to the resulting
image in case of success. Refer to **docker-tag(1)** for more information
about valid tag names.

**-m**, **--memory** *MEMORY*
Memory limit
Memory limit.

**--memory-swap** *number*[*S*]
Combined memory plus swap limit; *S* is an optional suffix which can be one
Expand All @@ -143,13 +143,13 @@ set as the **URL**, the repository is cloned locally and then sent as the contex

**--network** *type*
Set the networking mode for the RUN instructions during build. Supported standard
values are: **none**, **bridge**, **host** and **container:**<_name_|_id_>. Any other value
values are: **none**, **bridge**, **host** and **container:** <_name_|_id_>. Any other value
is taken as a custom network's name or ID which this container should connect to.

In Linux, default is **bridge**.

**--shm-size** *SHM-SIZE*
Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`.
Size of `/dev/shm`. The format is `numberunit`. `number` must be greater than `0`.
Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes.
If you omit the size entirely, the system uses `64m`.

Expand Down Expand Up @@ -340,7 +340,7 @@ Note: supported compression formats are 'xz', 'bzip2', 'gzip' and 'identity' (no
## Specify isolation technology for container (--isolation)

This option is useful in situations where you are running Docker containers on
Windows. The `--isolation <value>` option sets a container's isolation
Windows. The `--isolation value` option sets a container's isolation
technology. On Linux, the only supported is the `default` option which uses
Linux namespaces. On Microsoft Windows, you can specify these values:

Expand Down
8 changes: 4 additions & 4 deletions man/docker-config-json.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@ properties you specify in a `config.json` file.

The `config.json` file stores a JSON encoding of several properties:

* The `HttpHeaders` property specifies a set of headers to include in all messages
\[bu] The `HttpHeaders` property specifies a set of headers to include in all messages
sent from the Docker client to the daemon. Docker does not try to interpret or
understand these header; it simply puts them into the messages. Docker does not
allow these headers to change any headers it sets for itself.

* The `psFormat` property specifies the default format for `docker ps` output.
\[bu] The `psFormat` property specifies the default format for `docker ps` output.
When the `--format` flag is not provided with the `docker ps` command,
Docker's client uses this property. If this property is not set, the client
falls back to the default table format. For a list of supported formatting
directives, see **docker-ps(1)**.

* The `detachKeys` property specifies the default key sequence which
\[bu] The `detachKeys` property specifies the default key sequence which
detaches the container. When the `--detach-keys` flag is not provide
with the `docker attach`, `docker exec`, `docker run` or `docker
start`, Docker's client uses this property. If this property is not
set, the client falls back to the default sequence `ctrl-p,ctrl-q`.


* The `imagesFormat` property specifies the default format for `docker images`
\[bu] The `imagesFormat` property specifies the default format for `docker images`
output. When the `--format` flag is not provided with the `docker images`
command, Docker's client uses this property. If this property is not set, the
client falls back to the default table format. For a list of supported
Expand Down
Loading