diff options
| author | W. Trevor King <wking@tremily.us> | 2018-06-29 10:53:33 -0700 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-07-04 09:40:37 +0000 |
| commit | f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d (patch) | |
| tree | b5e90ce8ce97d498f379d58ce31b2bd0249f7516 /docs/podman-pull.1.md | |
| parent | 6d8fac87ed20c7bb3214e28e2ef74d3d8831eadd (diff) | |
| download | podman-f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d.tar.gz podman-f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d.tar.bz2 podman-f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d.zip | |
docs: Follow man-pages(7) suggestions for SYNOPSIS
man-pages(7) has [1]:
> For commands, this shows the syntax of the command and its arguments
> (including options); boldface is used for as-is text and italics are
> used to indicate replaceable arguments. Brackets ([]) surround
> optional arguments, vertical bars (|) separate choices, and ellipses
> (...) can be repeated.
I've adjusted our SYNOPSIS entries to match that formatting, and
generally tried to make them more consistent with the precedent set by
the man-pages project. Outside of the SYNOPSIS entry, I prefer using
backticks for literals, although in some places I've left the **
bolding to keep things visually similar to a nearby SYNOPSIS entry.
[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #1027
Approved by: rhatdan
Diffstat (limited to 'docs/podman-pull.1.md')
| -rw-r--r-- | docs/podman-pull.1.md | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/docs/podman-pull.1.md b/docs/podman-pull.1.md index 0061dfc70..a0f516068 100644 --- a/docs/podman-pull.1.md +++ b/docs/podman-pull.1.md @@ -4,9 +4,7 @@ podman\-pull - Pull an image from a registry ## SYNOPSIS -**podman pull** -**NAME[:TAG|@DIGEST]** -[**--help**|**-h**] +**podman pull** [*options*] *name*[:*tag*|@*digest*] ## DESCRIPTION Copies an image from a registry onto the local machine. **podman pull** pulls an @@ -14,7 +12,7 @@ image from Docker Hub if a registry is not specified in the command line argumen If an image tag is not specified, **podman pull** defaults to the image with the **latest** tag (if it exists) and pulls it. After the image is pulled, podman will print the full image ID. **podman pull** can also pull an image -using its digest **podman pull [image]@[digest]**. **podman pull** can be used to pull +using its digest **podman pull** *image*@*digest*. **podman pull** can be used to pull images from archives and local storage using different transports. ## imageID @@ -45,12 +43,6 @@ Image stored in local container/storage **ostree:**_image_[**@**_/absolute/repo/path_] An image in local OSTree repository. _/absolute/repo/path_ defaults to _/ostree/repo_. -**podman [GLOBAL OPTIONS]** - -**podman pull [GLOBAL OPTIONS]** - -**podman pull NAME[:TAG|@DIGEST]** - ## OPTIONS **--authfile** @@ -85,6 +77,10 @@ Require HTTPS and verify certificates when contacting registries (default: true) then tls verification will be used, If set to false then tls verification will not be used. If not specified tls verification will be used unless the target registry is listed as an insecure registry in registries.conf. +**--help**, **-h** + +Print usage statement + ## EXAMPLES ``` |