b0601cb34a
Somewhere in the CIv2 migration we lost the man page vs --help
cross-checker. Add it back, by adding it into the man-page-check
Makefile target; this is part of 'make validate', which is run
in CI even on CI:DOCS PRs.
As happens when CI doesn't run, things broke. Man pages got out
of sync with --help. This PR:
1) Fixes hack/xref-helpmsgs-manpages to deal with the new
"Options" (instead of "Flags") form of podman help. #8034
did part of that, but one of my review comments was
accidentally left out.
2) Fixes hack/xref-helpmsgs-manpages to deal with the new
option syntax in man pages, post- #8292, in which each
option is preceded by four hashes so as to make them
HTML <h4> elements with named anchors.
3) Fixes man pages that #8292 accidentally missed.
4) Adds man page entries for two flags that got added
to podman but not documented (pod create --network-alias,
play kube --log-driver)
Fixes: #8296
Signed-off-by: Ed Santiago <santiago@redhat.com>
1.8 KiB
% podman-volume-create(1)
NAME
podman-volume-create - Create a new volume
SYNOPSIS
podman volume create [options]
DESCRIPTION
Creates an empty volume and prepares it to be used by containers. The volume can be created with a specific name, if a name is not given a random name is generated. You can add metadata to the volume by using the --label flag and driver options can be set using the --opt flag.
OPTIONS
--driver=driver
Specify the volume driver name (default local).
--help
Print usage statement
-l, --label=label
Set metadata for a volume (e.g., --label mykey=value).
-o, --opt=option
Set driver specific options.
For the default driver, local, this allows a volume to be configured to mount a filesystem on the host.
For the local driver the following options are supported: type, device, and o.
The type option sets the type of the filesystem to be mounted, and is equivalent to the -t flag to mount(8).
The device option sets the device to be mounted, and is equivalent to the device argument to mount(8).
The o option sets options for the mount, and is equivalent to the -o flag to mount(8) with two exceptions.
The o option supports uid and gid options to set the UID and GID of the created volume that are not normally supported by mount(8).
Using volume options with the local driver requires root privileges.
EXAMPLES
$ podman volume create myvol
$ podman volume create
$ podman volume create --label foo=bar myvol
# podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=nodev,noexec myvol
# podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=uid=1000,gid=1000 testvol
SEE ALSO
podman-volume(1), mount(8)
HISTORY
November 2018, Originally compiled by Urvashi Mohnani umohnani@redhat.com