system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-07-21 18:24:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

man: use <filename> to mark file names

Browse source 
This gives the templates a chance to do something extra clever with the
formatting. The templates, of course, choose not to :(
This commit is contained in:
Lubomir Rintel 2016-11-11 14:26:25 +01:00
parent 42e1e669bc
commit 7b589e2b72
2 changed files with 24 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
man/NetworkManager.conf.xml
View file

@ -300,7 +300,7 @@ no-auto-default=*
manual page for more details).</para>
<para><literal>unbound</literal>: NetworkManager will talk
to unbound and dnssec-triggerd, providing a "split DNS"
configuration with DNSSEC support. The /etc/resolv.conf
configuration with DNSSEC support. The <filename>/etc/resolv.conf</filename>
will be managed by dnssec-trigger daemon.</para>
<para><literal>systemd-resolved</literal>: NetworkManager will
push the DNS configuration to systemd-resolved</para>
@ -389,8 +389,8 @@ no-auto-default=*
<varlistentry>
<term><varname>hostname</varname></term>
<listitem><para>This key is deprecated and has no effect
since the hostname is now stored in /etc/hostname or other
system configuration files according to build options.
since the hostname is now stored in <filename>/etc/hostname</filename>
or other system configuration files according to build options.
</para></listitem>
</varlistentry>
<varlistentry>
@ -1017,7 +1017,7 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16
plugin that supports all the connection types and
capabilities that NetworkManager has. It writes files out
in an .ini-style format in
/etc/NetworkManager/system-connections.
<filename>/etc/NetworkManager/system-connections</filename>.
</para>
<para>
The stored connection file may contain passwords and
@ -1082,15 +1082,16 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16
<listitem>
<para>
This plugin allows to read iBFT configuration (iSCSI Boot Firmware Table).
The configuration is read using /sbin/iscsiadm. Users are expected to
configure iBFT connections via the firmware interfaces.
The configuration is read using <filename>/sbin/iscsiadm</filename>. Users are
expected to configure iBFT connections via the firmware interfaces.
If ibft support is available, it is automatically enabled after
<literal>ifcfg-rh</literal>. This can be disabled by <literal>no-ibft</literal>.
You can also explicitly specify <literal>ibft</literal> to load the
plugin without <literal>ifcfg-rh</literal> or to change the plugin order.
</para>
<para>
Note that ibft plugin uses /sbin/iscsiadm and thus requires CAP_SYS_ADMIN capability.
Note that ibft plugin uses <filename>/sbin/iscsiadm</filename> and thus requires
CAP_SYS_ADMIN capability.
</para>
</listitem>
</varlistentry>

28
man/NetworkManager.xml
View file

@ -69,7 +69,8 @@
<title>Dispatcher scripts</title>
<para>
NetworkManager will execute scripts in the
/etc/NetworkManager/dispatcher.d directory or subdirectories in
<filename>/etc/NetworkManager/dispatcher.d</filename>
directory or subdirectories in
alphabetical order in response to network events. Each script should
be a regular executable file owned by root. Furthermore, it must not be
writable by group or other, and not setuid.
@ -88,8 +89,8 @@
<term><varname>pre-up</varname></term>
<listitem><para>The interface is connected to the network but is not
yet fully activated. Scripts acting on this event must be placed or
symlinked into the /etc/NetworkManager/dispatcher.d/pre-up.d directory,
and NetworkManager will wait for script execution to complete before
symlinked into the <filename>/etc/NetworkManager/dispatcher.d/pre-up.d</filename>
directory, and NetworkManager will wait for script execution to complete before
indicating to applications that the interface is fully activated.
</para></listitem>
</varlistentry>
@ -101,7 +102,7 @@
<term><varname>pre-down</varname></term>
<listitem><para>The interface will be deactivated but has not yet been
disconnected from the network. Scripts acting on this event must be
placed or symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d
placed or symlinked into the <filename>/etc/NetworkManager/dispatcher.d/pre-down.d</filename>
directory, and NetworkManager will wait for script execution to complete
before disconnecting the interface from its network. Note that this
event is not emitted for forced disconnections, like when carrier is
@ -119,8 +120,8 @@
<term><varname>vpn-pre-up</varname></term>
<listitem><para>The VPN is connected to the network but is not yet
fully activated. Scripts acting on this event must be placed or
symlinked into the /etc/NetworkManager/dispatcher.d/pre-up.d directory,
and NetworkManager will wait for script execution to complete before
symlinked into the <filename>/etc/NetworkManager/dispatcher.d/pre-up.d</filename>
directory, and NetworkManager will wait for script execution to complete before
indicating to applications that the VPN is fully activated.
</para></listitem>
</varlistentry>
@ -134,7 +135,7 @@
<term><varname>vpn-pre-down</varname></term>
<listitem><para>The VPN will be deactivated but has not yet been
disconnected from the network. Scripts acting on this event must be
placed or symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d
placed or symlinked into the <filename>/etc/NetworkManager/dispatcher.d/pre-down.d</filename>
directory, and NetworkManager will wait for script execution to complete
before disconnecting the VPN from its network. Note that this
event is not emitted for forced disconnections, like when the VPN
@ -308,7 +309,8 @@
NetworkManager process, and will be killed if they run for too long. If your script
might take arbitrarily long to complete, you should spawn a child process and have the
parent return immediately. Scripts that are symbolic links pointing inside the
/etc/NetworkManager/dispatcher.d/no-wait.d/ directory are run immediately, without
<filename>/etc/NetworkManager/dispatcher.d/no-wait.d/</filename>
directory are run immediately, without
waiting for the termination of previous scripts, and in parallel. Also beware that
once a script is queued, it will always be run, even if a later event renders it
obsolete. (Eg, if an interface goes up, and then back down again quickly, it is
@ -354,14 +356,16 @@
<term><option>--state-file</option></term>
<listitem><para>Specify file for storing state of the
NetworkManager persistently. If not specified, the default
value of /var/lib/NetworkManager/NetworkManager.state is used.
value of <filename>/var/lib/NetworkManager/NetworkManager.state</filename>
is used.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--config</option></term>
<listitem><para> Specify configuration file to set up various
settings for NetworkManager. If not specified, the default
value of /etc/NetworkManager/NetworkManager.conf is used with
value of <filename>/etc/NetworkManager/NetworkManager.conf</filename>
is used with
a fallback to the older 'nm-system-settings.conf' if located
in the same directory. See
<link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>
@ -448,8 +452,8 @@
A SIGHUP also involves further reloading actions, like doing
a DNS update and restarting the DNS plugin. The latter can be
useful for example when using the dnsmasq plugin and changing
its configuration in /etc/NetworkManager/dnsmasq.d. However,
it also means this will shortly interrupt name resolution.
its configuration in <filename>/etc/NetworkManager/dnsmasq.d</filename>.
However, it also means this will shortly interrupt name resolution.
In the future, there may be further actions added.
A SIGHUP means to update NetworkManager configuration and reload
everything that is supported. Note that this does not reload