From 46b0925d4febce47d2d3b4cf83518c330730c3f6 Mon Sep 17 00:00:00 2001 From: Tom Gundersen Date: Sun, 10 Nov 2013 20:52:53 +0100 Subject: [PATCH] man: networkd - add documentation --- Makefile-man.am | 6 ++ make-directive-index.py | 3 +- man/systemd-networkd.service.xml | 179 +++++++++++++++++++++++++++++++ 3 files changed, 187 insertions(+), 1 deletion(-) create mode 100644 man/systemd-networkd.service.xml diff --git a/Makefile-man.am b/Makefile-man.am index 0939bc528..6239651b0 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -62,6 +62,7 @@ MANPAGES += \ man/systemd-initctl.service.8 \ man/systemd-journald.service.8 \ man/systemd-machine-id-setup.1 \ + man/systemd-networkd.service.8 \ man/systemd-notify.1 \ man/systemd-nspawn.1 \ man/systemd-remount-fs.service.8 \ @@ -186,6 +187,7 @@ MANPAGES_ALIAS += \ man/systemd-journald.8 \ man/systemd-journald.socket.8 \ man/systemd-kexec.service.8 \ + man/systemd-networkd.8 \ man/systemd-poweroff.service.8 \ man/systemd-reboot.service.8 \ man/systemd-remount-fs.8 \ @@ -287,6 +289,7 @@ man/systemd-initctl.socket.8: man/systemd-initctl.service.8 man/systemd-journald.8: man/systemd-journald.service.8 man/systemd-journald.socket.8: man/systemd-journald.service.8 man/systemd-kexec.service.8: man/systemd-halt.service.8 +man/systemd-networkd.8: man/systemd-networkd.service.8 man/systemd-poweroff.service.8: man/systemd-halt.service.8 man/systemd-reboot.service.8: man/systemd-halt.service.8 man/systemd-remount-fs.8: man/systemd-remount-fs.service.8 @@ -554,6 +557,9 @@ man/systemd-journald.socket.html: man/systemd-journald.service.html man/systemd-kexec.service.html: man/systemd-halt.service.html $(html-alias) +man/systemd-networkd.html: man/systemd-networkd.service.html + $(html-alias) + man/systemd-poweroff.service.html: man/systemd-halt.service.html $(html-alias) diff --git a/make-directive-index.py b/make-directive-index.py index b2dd2e1b7..2ff304fdd 100755 --- a/make-directive-index.py +++ b/make-directive-index.py @@ -90,7 +90,8 @@ TEMPLATE = '''\ Network directives Directives for configuring network links through the - net-setup-link udev builtin. + net-setup-link udev builtin and networks through + systemd-networkd. diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml new file mode 100644 index 000000000..209e3be9e --- /dev/null +++ b/man/systemd-networkd.service.xml @@ -0,0 +1,179 @@ + + + + + + + + + systemd-networkd.service + systemd + + + + Developer + Tom + Gundersen + teg@jklm.no + + + + + + systemd-networkd.service + 8 + + + + systemd-networkd.service + systemd-networkd + Network manager + + + + systemd-networkd.service + /usr/lib/systemd/systemd-networkd + + + + Description + + systemd-networkd is a system + service that manages networks. It detects and configures + network devices as they appear. + + Network devices are managed by networkd only if they + have the udev tag systemd-networkd. + + Network configurations applied before networkd is started + are not removed, and configuration applied by networkd are not + removed when networkd exits. This ensures restarting networkd + does not cut the network connection, and in particular that it + is safe to transition between the initrd and the real root, + and back. + + + Network Configuration + The network files are read from the files located in the + system network directory /usr/lib/systemd/network, + the volatile runtime network directory + /run/systemd/network and the local administration + network directory /etc/systemd/network. + All link files are collectively sorted and processed in lexical order, + regardless of the directories in which they live. However, files with + identical filenames replace each other. Files in + /etc have the highest priority, files in + /run take precedence over files with the same + name in /lib. This can be used to override a + system-supplied network file with a local file if needed; a symlink in + /etc with the same name as a network file in + /lib, pointing to /dev/null, + disables the network file entirely. Network files must have the extension + .network; other extensions are ignored. + + The network file contains a [Match] section, + which determines if a given network file may be applied to a given device; + and a [Network] section specifying how the device should + be configured. The first (in lexical order) of the network files that + matches a given device is applied. + + A network file is said to match a device if each of the entries in the + [Match] section matches, or if the section is empty. + The following keys are accepted: + + + + MACAddress + + The hardware address. + + + + Path + + The persistent path, as exposed by the udev + property ID_PATH. + + + + Driver + + The driver currently bound to the device, as + exposed by the udev property DRIVER. + + + + + Type + + The device type, as exposed by the udev property + DEVTYPE. + + + + Name + + The device name, as exposed by the udev property + INTERFACE. + + + + + The [Network] section accepts the following keys: + + + + Description + + A description of the device. This is only used for + presentation purposes. + + + + Address + + A static IPv4 or IPv6 address and its prefix length, + separated by a '/' character. The format of the address must + be as described in + inet_pton3 + . + + + + Gateway + + The gateway address, which must be in the format described in + inet_pton3 + . + + + + + + + See Also + + systemd1, + udev7, + + + + -- 2.30.2