[PATCH docs 3/7] pve-network-interface-pinning: init man(1) page

[Christoph Heiss <c.heiss@proxmox.com>]

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
FWIW; this already includes the help text for the new `rename`
subcommand introduced in patch #6.

 ...-network-interface-pinning.1-synopsis.adoc | 50 ++++++++++++++++
 pve-admin-guide.adoc                          |  8 +++
 pve-network-interface-pinning.adoc            | 60 +++++++++++++++++++
 3 files changed, 118 insertions(+)
 create mode 100644 generated/pve-network-interface-pinning.1-synopsis.adoc
 create mode 100644 pve-network-interface-pinning.adoc

diff --git a/generated/pve-network-interface-pinning.1-synopsis.adoc b/generated/pve-network-interface-pinning.1-synopsis.adoc
new file mode 100644
index 0000000..f8eb18d
--- /dev/null
+++ b/generated/pve-network-interface-pinning.1-synopsis.adoc
@@ -0,0 +1,50 @@
+[[cli_pve-network-interface-pinning]]
+*pve-network-interface-pinning* `<COMMAND> [ARGS] [OPTIONS]`
+
+[[cli_pve-network-interface-pinning_generate]]
+*pve-network-interface-pinning generate* `[OPTIONS]`
+
+Generate systemd.link files to pin the names of one or more network
+interfaces and update all network-related configuration files.
+
+`--interface` `<string>` ('default =' `<all>`)::
+
+Only pin a specific interface.
+
+`--prefix` `^[a-zA-Z][a-zA-Z0-9-_]{0,7}$` ('default =' `nic`)::
+
+Use a specific prefix for automatically choosing the pinned name.
+
+`--target-name` `<string>` ::
+
+Pin the interface to a specific name.
++
+NOTE: Requires option(s): `interface`
+
+[[cli_pve-network-interface-pinning_help]]
+*pve-network-interface-pinning help* `[OPTIONS]`
+
+Get help about specified command.
+
+`--extra-args` `<array>` ::
+
+Shows help for a specific command
+
+`--verbose` `<boolean>` ::
+
+Verbose output format.
+
+[[cli_pve-network-interface-pinning_rename]]
+*pve-network-interface-pinning rename* `<interface> <target-name>`
+
+Rename an existing pin for a network interface to a specific name.
+
+`<interface>`: `<string>` ::
+
+The interface to rename.
+
+`<target-name>`: `<string>` ::
+
+The new pinned interface name.
+
+
diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc
index fd37b1e..c086377 100644
--- a/pve-admin-guide.adoc
+++ b/pve-admin-guide.adoc
@@ -226,6 +226,14 @@ include::generated/ha-manager.1-synopsis.adoc[]
 
 :leveloffset: 0
 
+*pve-network-interface-pinning* - {pve} Network Interface Pinning Tool
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:leveloffset: 1
+include::generated/pve-network-interface-pinning.1-synopsis.adoc[]
+
+:leveloffset: 0
+
 
 [appendix]
 Service Daemons
diff --git a/pve-network-interface-pinning.adoc b/pve-network-interface-pinning.adoc
new file mode 100644
index 0000000..79d6aeb
--- /dev/null
+++ b/pve-network-interface-pinning.adoc
@@ -0,0 +1,60 @@
+ifdef::manvolnum[]
+pve-network-interface-pinning(1)
+================================
+:pve-toplevel:
+
+NAME
+----
+
+pve-network-interface-pinning - Proxmox VE Network Interface Pinning Tool
+
+SYNOPSIS
+--------
+
+include::generated/pve-network-interface-pinning.1-synopsis.adoc[]
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+
+ifndef::manvolnum[]
+Overriding Network Device Names
+===============================
+endif::manvolnum[]
+
+Command line tool to generate and rename pinned network interface names.
+
+ifdef::manvolnum[]
+
+In order to apply the changes made by `pve-network-interface-pinning`, the node
+needs to be rebooted.
+
+EXAMPLES
+--------
+
+To generate .link for all present physical interfaces:
+
+----
+pve-network-interface-pinning generate
+----
+
+As above, but with a custom prefix instead of `nic`:
+
+----
+pve-network-interface-pinning generate --prefix myprefix
+----
+
+Or just pin a specific network interface to a chosen name:
+
+----
+pve-network-interface-pinning generate --interface enp1s0 --target-name mynic
+----
+
+To rename an already pinned interface, e.g. `nic0` to `fiber10g0`:
+
+----
+pve-network-interface-pinning rename nic0 fiber10g0
+----
+
+include::pve-copyright.adoc[]
+endif::manvolnum[]
-- 
2.54.0