summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-network-create.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-03-23 12:29:08 -0600
committerEd Santiago <santiago@redhat.com>2022-03-23 13:49:42 -0600
commit9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541 (patch)
tree37dad6631948e2cfa28165a423c6bf22f9ab4d1e /docs/source/markdown/podman-network-create.1.md
parent73713062806aa4c2db25dc62e2fff47406085dc8 (diff)
downloadpodman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.tar.gz
podman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.tar.bz2
podman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.zip
man pages: sort flags, and keep them that way
Command flags (OPTIONS) in man pages have to date been in haphazard order. Sometimes that order is sensible, e.g., most-important options first, but more often they're just in arbitrary places. This makes life hard for users. Here, I update the man-page-check Makefile script so it checks and enforces alphabetical order in OPTIONS sections. Then -- the hard part -- update all existing man pages to conform to this requirement. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-network-create.1.md')
-rw-r--r--docs/source/markdown/podman-network-create.1.md38
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md
index 5a3224501..479c36318 100644
--- a/docs/source/markdown/podman-network-create.1.md
+++ b/docs/source/markdown/podman-network-create.1.md
@@ -32,21 +32,6 @@ Special considerations for the *netavark* backend:
- The `macvlan` driver requires the `--subnet` option, DHCP is currently not supported.
- The `ipvlan` driver is not currently supported.
-#### **--opt**=*option*, **-o**
-
-Set driver specific options.
-
-All drivers accept the `mtu` option. The `mtu` option sets the Maximum Transmission Unit (MTU) and takes an integer value.
-
-Additionally the `bridge` driver supports the following option:
-- `vlan`: This option assign VLAN tag and enables vlan\_filtering. Defaults to none.
-
-The `macvlan` and `ipvlan` driver support the following options:
-- `parent`: The host device which should be used for the macvlan interface. Defaults to the default route interface.
-- `mode`: This option sets the specified ip/macvlan mode on the interface.
- - Supported values for `macvlan` are `bridge`, `private`, `vepa`, `passthru`. Defaults to `bridge`.
- - Supported values for `ipvlan` are `l2`, `l3`, `l3s`. Defaults to `l2`.
-
#### **--gateway**
Define a gateway for the subnet. If you want to provide a gateway address, you must also provide a
@@ -64,20 +49,35 @@ Allocate container IP from a range. The range must be a complete subnet and in
must be used with a *subnet* option. Can be specified multiple times.
The argument order of the **--subnet**, **--gateway** and **--ip-range** options must match.
+#### **--ipv6**
+
+Enable IPv6 (Dual Stack) networking. If not subnets are given it will allocate a ipv4 and ipv6 subnet.
+
#### **--label**
Set metadata for a network (e.g., --label mykey=value).
+#### **--opt**=*option*, **-o**
+
+Set driver specific options.
+
+All drivers accept the `mtu` option. The `mtu` option sets the Maximum Transmission Unit (MTU) and takes an integer value.
+
+Additionally the `bridge` driver supports the following option:
+- `vlan`: This option assign VLAN tag and enables vlan\_filtering. Defaults to none.
+
+The `macvlan` and `ipvlan` driver support the following options:
+- `parent`: The host device which should be used for the macvlan interface. Defaults to the default route interface.
+- `mode`: This option sets the specified ip/macvlan mode on the interface.
+ - Supported values for `macvlan` are `bridge`, `private`, `vepa`, `passthru`. Defaults to `bridge`.
+ - Supported values for `ipvlan` are `l2`, `l3`, `l3s`. Defaults to `l2`.
+
#### **--subnet**
The subnet in CIDR notation. Can be specified multiple times to allocate more than one subnet for this network.
The argument order of the **--subnet**, **--gateway** and **--ip-range** options must match.
This is useful to set a static ipv4 and ipv6 subnet.
-#### **--ipv6**
-
-Enable IPv6 (Dual Stack) networking. If not subnets are given it will allocate a ipv4 and ipv6 subnet.
-
## EXAMPLE
Create a network with no options.