summaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/mac-address.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-08 15:51:34 -0600
committerEd Santiago <santiago@redhat.com>2022-08-09 06:33:17 -0600
commitd7f134d687459834e1b9c805fe30bf40b2df767a (patch)
tree12fd5a82fa271c9c8e6d1b4c5ccf265f9b927fde /docs/source/markdown/options/mac-address.md
parent7992d86ab3f69f5c3b4872a4fecbc340579ba78d (diff)
downloadpodman-d7f134d687459834e1b9c805fe30bf40b2df767a.tar.gz
podman-d7f134d687459834e1b9c805fe30bf40b2df767a.tar.bz2
podman-d7f134d687459834e1b9c805fe30bf40b2df767a.zip
Refactor common man page options, phase 2
Followup to #15174. These are the options that are easy(ish) to review: those that have only drifted slightly, and need only minor tweaks to bring back to sanity. For the most part, I went with the text in podman-run because that was cleaned up in #5192 way back in 2020. These diffs primarily consist of using '**' (star star) instead of backticks, plus other formatting and punctuation changes. This PR also adds a README in the options dir, and a new convention: <<container text...|pod text...>> which tries to do the right thing based on whether the man page name includes "-pod-" or not. Since that's kind of hairy code, I've also added a test suite for it. Finally, since this is impossible to review by normal means, I'm temporarily committing hack/markdown-preprocess-review, a script that will diff option-by-option. I will remove it once we finish this cleanup, but be advised that there are still 130+ options left to examine, and some of those are going to be really hard to reunite. Review script usage: simply run it (you need to have 'diffuse' installed). It isn't exactly obvious, but it shouldn't take more than a minute to figure out. The rightmost column (zzz-chosen.md) is the "winner", the actual content that will be used henceforth. You really want an ultrawide screen here. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options/mac-address.md')
-rw-r--r--docs/source/markdown/options/mac-address.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/source/markdown/options/mac-address.md b/docs/source/markdown/options/mac-address.md
new file mode 100644
index 000000000..0939ceaad
--- /dev/null
+++ b/docs/source/markdown/options/mac-address.md
@@ -0,0 +1,11 @@
+#### **--mac-address**=*address*
+
+<<Container|Pod>> network interface MAC address (e.g. 92:d0:c6:0a:29:33)
+This option can only be used if the <<container|pod>> is joined to only a single network - i.e., **--network=_network-name_** is used at most once -
+and if the <<container|pod>> is not joining another container's network namespace via **--network=container:_id_**.
+
+Remember that the MAC address in an Ethernet network must be unique.
+The IPv6 link-local address will be based on the device's MAC address
+according to RFC4862.
+
+To specify multiple static MAC addresses per <<container|pod>>, set multiple networks using the **--network** option with a static MAC address specified for each using the `mac` mode for that option.