summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2019-02-26 14:11:27 -0700
committerEd Santiago <santiago@redhat.com>2019-02-26 18:10:36 -0700
commita20ff42134e0b4e3ba9d26c25d93df50e637fd69 (patch)
treec823944460b9b2c06f87b2db31a2b970ad76652a /docs
parentee667dcf97df4ed38b2046b33911dad882829bf8 (diff)
downloadpodman-a20ff42134e0b4e3ba9d26c25d93df50e637fd69.tar.gz
podman-a20ff42134e0b4e3ba9d26c25d93df50e637fd69.tar.bz2
podman-a20ff42134e0b4e3ba9d26c25d93df50e637fd69.zip
Better usage synopses for subcommands
Conceptually simple: include, where applicable, a brief description of command-line options for each subcommand. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-import.1.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/podman-import.1.md b/docs/podman-import.1.md
index c80c4ff77..03055018a 100644
--- a/docs/podman-import.1.md
+++ b/docs/podman-import.1.md
@@ -4,13 +4,14 @@
podman\-import - Import a tarball and save it as a filesystem image
## SYNOPSIS
-**podman import** [*options*] *path*
+**podman import** [*options*] *path* [*reference*]
## DESCRIPTION
**podman import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz)
and saves it as a filesystem image. Remote tarballs can be specified using a URL.
Various image instructions can be configured with the **--change** flag and
a commit message can be set using the **--message** flag.
+**reference**, if present, is a tag to assign to the image.
Note: `:` is a restricted character and cannot be part of the file name.
## OPTIONS