summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDebarshi Ray <rishi@fedoraproject.org>2019-01-08 18:36:56 +0100
committerDebarshi Ray <rishi@fedoraproject.org>2019-01-09 11:14:06 +0100
commitbdf89658467ec3d6ff2a5e844e9155846d21142a (patch)
treed424f24fc58988bbeef23fde88d965d25c0b63aa
parentc9d63fe89d0a79b069b56249aaa4c168b47649c0 (diff)
downloadpodman-bdf89658467ec3d6ff2a5e844e9155846d21142a.tar.gz
podman-bdf89658467ec3d6ff2a5e844e9155846d21142a.tar.bz2
podman-bdf89658467ec3d6ff2a5e844e9155846d21142a.zip
List the long variant of each option before its shorter counterpart
This is the style followed in most of the other man pages. Signed-off-by: Debarshi Ray <rishi@fedoraproject.org>
-rw-r--r--docs/podman-create.1.md26
-rw-r--r--docs/podman-run.1.md26
2 files changed, 26 insertions, 26 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 3a75a4b00..178542f0d 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -29,7 +29,7 @@ option can be set multiple times.
Add an annotation to the container. The format is key=value.
The **--annotation** option can be set multiple times.
-**-a**, **--attach**=[]
+**--attach**, **-a**=[]
Attach to STDIN, STDOUT or STDERR.
@@ -158,7 +158,7 @@ If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
then processes in your container will only use memory from the first
two memory nodes.
-**-d**, **--detach**=*true*|*false*
+**--detach**, **-d**=*true*|*false*
Detached mode: run the container in the background and print the new container ID. The default is *false*.
@@ -230,7 +230,7 @@ ENTRYPOINT.
You need to specify multi option commands in the form of a json string.
-**-e**, **--env**=[]
+**--env**, **-e**=[]
Set environment variables
@@ -284,7 +284,7 @@ Run an init inside the container that forwards signals and reaps processes.
Path to the container-init binary.
-**-i**, **--interactive**=*true*|*false*
+**--interactive**, **-i**=*true*|*false*
Keep STDIN open even if not attached. The default is *false*.
@@ -315,7 +315,7 @@ is not limited. If you specify a limit, it may be rounded up to a multiple
of the operating system's page size and the value can be very large,
millions of trillions.
-**-l**, **--label**=[]
+**--label**, **-l**=[]
Add metadata to a container (e.g., --label com.example.key=value)
@@ -347,7 +347,7 @@ according to RFC4862.
Not currently supported
-**-m**, **--memory**=""
+**--memory**, **-m**=""
Memory limit (format: <number>[<unit>], where unit = b, k, m or g)
@@ -426,7 +426,7 @@ to the container with **--name** then it will generate a random
string name. The name is useful any place you need to identify a container.
This works for both background and foreground containers.
-**--net**, **--network**="*bridge*"
+**--network**, **--net**="*bridge*"
Set the Network mode for the container
'bridge': create a network stack on the default bridge
@@ -480,7 +480,7 @@ to all devices on the host, turns off graphdriver mount options, as well as
turning off most of the security measures protecting the host from the
container.
-**-p**, **--publish**=[]
+**--publish**, **-p**=[]
Publish a container's port, or range of ports, to the host
@@ -492,7 +492,7 @@ but not `podman run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanR
With ip: `podman run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPORT`
-**-P**, **--publish-all**=*true*|*false*
+**--publish-all**, **-P**=*true*|*false*
Publish all exposed ports to random ports on the host interfaces. The default is *false*.
@@ -621,7 +621,7 @@ options are the same as the Linux default `mount` flags. If you do not specify
any options, the systems uses the following options:
`rw,noexec,nosuid,nodev,size=65536k`.
-**-t**, **--tty**=*true*|*false*
+**--tty**, **-t**=*true*|*false*
Allocate a pseudo-TTY. The default is *false*.
@@ -642,7 +642,7 @@ The following example maps uids 0-2000 in the container to the uids 30000-31999
Ulimit options
-**-u**, **--user**=""
+**--user**, **-u**=""
Sets the username or UID used and optionally the groupname or GID for the specified command.
@@ -665,7 +665,7 @@ Set the UTS mode for the container
**ns**: specify the usernamespace to use.
Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
-**-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
+**--volume**, **-v**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman
bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the podman
@@ -764,7 +764,7 @@ If the location of the volume from the source container overlaps with
data residing on a target container, then the volume hides
that data on the target.
-**-w**, **--workdir**=""
+**--workdir**, **-w**=""
Working directory inside the container
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index 971b8829a..8b96ea6d9 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -41,7 +41,7 @@ option can be set multiple times.
Add an annotation to the container. The format is key=value.
The **--annotation** option can be set multiple times.
-**-a**, **--attach**=[]
+**--attach**, **-a**=[]
Attach to STDIN, STDOUT or STDERR.
@@ -162,7 +162,7 @@ If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
then processes in your container will only use memory from the first
two memory nodes.
-**-d**, **--detach**=*true*|*false*
+**--detach**, **-d**=*true*|*false*
Detached mode: run the container in the background and print the new container ID. The default is *false*.
@@ -235,7 +235,7 @@ ENTRYPOINT.
You need to specify multi option commands in the form of a json string.
-**-e**, **--env**=[]
+**--env**, **-e**=[]
Set environment variables
@@ -293,7 +293,7 @@ Run an init inside the container that forwards signals and reaps processes.
Path to the container-init binary.
-**-i**, **--interactive**=*true*|*false*
+**--interactive**, **-i**=*true*|*false*
Keep STDIN open even if not attached. The default is *false*.
@@ -327,7 +327,7 @@ is not limited. If you specify a limit, it may be rounded up to a multiple
of the operating system's page size and the value can be very large,
millions of trillions.
-**-l**, **--label**=[]
+**--label**, **-l**=[]
Add metadata to a container (e.g., --label com.example.key=value)
@@ -359,7 +359,7 @@ according to RFC4862.
Not currently supported
-**-m**, **--memory**=""
+**--memory**, **-m**=""
Memory limit (format: <number>[<unit>], where unit = b, k, m or g)
@@ -408,7 +408,7 @@ to the container with **--name** then it will generate a random
string name. The name is useful any place you need to identify a container.
This works for both background and foreground containers.
-**--net**, **--network**="*bridge*"
+**--network**, **--net**="*bridge*"
Set the Network mode for the container:
- `bridge`: create a network stack on the default bridge
@@ -464,7 +464,7 @@ to all devices on the host, turns off graphdriver mount options, as well as
turning off most of the security measures protecting the host from the
container.
-**-p**, **--publish**=[]
+**--publish**, **-p**=[]
Publish a container's port, or range of ports, to the host
@@ -480,7 +480,7 @@ With ip: `podman run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t s
Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPORT`
-**-P**, **--publish-all**=*true*|*false*
+**--publish-all**, **-P**=*true*|*false*
Publish all exposed ports to random ports on the host interfaces. The default is *false*.
@@ -623,7 +623,7 @@ options are the same as the Linux default `mount` flags. If you do not specify
any options, the systems uses the following options:
`rw,noexec,nosuid,nodev,size=65536k`.
-**-t**, **--tty**=*true*|*false*
+**--tty**, **-t**=*true*|*false*
Allocate a pseudo-TTY. The default is *false*.
@@ -645,7 +645,7 @@ The example maps uids 0-2000 in the container to the uids 30000-31999 on the hos
Ulimit options
-**-u**, **--user**=""
+**--user**, **-u**=""
Sets the username or UID used and optionally the groupname or GID for the specified command.
@@ -703,7 +703,7 @@ Current supported mount TYPES are bind, and tmpfs.
ยท tmpfs-mode: File mode of the tmpfs in octal. (e.g. 700 or 0700.) Defaults to 1777 in Linux.
-**-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
+**--volume**, **-v**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman
bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the podman
@@ -802,7 +802,7 @@ If the location of the volume from the source container overlaps with
data residing on a target container, then the volume hides
that data on the target.
-**-w**, **--workdir**=""
+**--workdir**, **-w**=""
Working directory inside the container