fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-20 07:00:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: describe the allowed boolean values in NetworkManager.conf

Browse source 
The NetworkManager.conf man page is describing some options as
"whether X is enabled", without explicitly saying that it's a
boolean. Also, the allowed values are not mentioned. Clarify those
aspects.
This commit is contained in:
Beniamino Galvani 2025-11-25 18:01:20 +01:00
parent 78519589b9
commit 9e01443b14
1 changed files with 28 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
man/NetworkManager.conf.xml
View file

@ -83,6 +83,11 @@
note that your distribution or other packages may drop configuration snippets for NetworkManager, such note that your distribution or other packages may drop configuration snippets for NetworkManager, such
that they are part of the factory default. that they are part of the factory default.
</para> </para>
<para>
The options that are indicated as boolean can be set to one of these values:
<literal>yes</literal>, <literal>true</literal>, <literal>on</literal>, <literal>1</literal>,
<literal>no</literal>, <literal>false</literal>, <literal>off</literal>, <literal>0</literal>.
</para>
</refsect1> </refsect1>
@ -1249,12 +1254,13 @@ managed=1
<term><varname>managed</varname></term> <term><varname>managed</varname></term>
<listitem> <listitem>
<para> <para>
Whether the device is managed or not. A device can be A boolean value specifying whether the device is
marked as managed via udev rules (ENV{NM_UNMANAGED}), managed or not. A device can be marked as managed via
or via setting plugins (keyfile.unmanaged-devices). udev rules (ENV{NM_UNMANAGED}), or via setting plugins
This is yet another way. Note that this configuration (keyfile.unmanaged-devices). This is yet another
can be overruled at runtime via D-Bus. Also, it has way. Note that this configuration can be overruled at
higher priority then udev rules. runtime via D-Bus. Also, it has higher priority than
udev rules.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1326,6 +1332,10 @@ managed=1
<varlistentry id="keep-configuration"> <varlistentry id="keep-configuration">
<term><varname>keep-configuration</varname></term> <term><varname>keep-configuration</varname></term>
<listitem> <listitem>
<para>
A boolean value indicating whether the existing device
configuration is kept at startup.
</para>
<para> <para>
On startup, NetworkManager tries to not interfere with On startup, NetworkManager tries to not interfere with
interfaces that are already configured. It does so by interfaces that are already configured. It does so by
@ -1422,16 +1432,16 @@ managed=1
<term><varname>wifi.iwd.autoconnect</varname></term> <term><varname>wifi.iwd.autoconnect</varname></term>
<listitem> <listitem>
<para> <para>
If <literal>wifi.backend</literal> is <literal>iwd</literal>, setting this to A boolean value. If <literal>wifi.backend</literal> is <literal>iwd</literal>,
<literal>false</literal> forces IWD's autoconnect mechanism to be disabled for setting this to <literal>false</literal> forces IWD's autoconnect mechanism to be
this device and connections will only be initiated by NetworkManager whether disabled for this device and connections will only be initiated by NetworkManager
commanded by a client or automatically. Leaving it <literal>true</literal> (default) whether commanded by a client or automatically. Leaving it <literal>true</literal>
stops NetworkManager from automatically initiating connections and allows (default) stops NetworkManager from automatically initiating connections and allows
IWD to use its network ranking and scanning logic to decide the best networks IWD to use its network ranking and scanning logic to decide the best networks to
to autoconnect to next. Connections' <literal>autoconnect-priority</literal>, autoconnect to next. Connections' <literal>autoconnect-priority</literal>,
<literal>autoconnect-retries</literal> settings will be ignored. Other settings <literal>autoconnect-retries</literal> settings will be ignored. Other settings like
like <literal>permissions</literal> or <literal>multi-connect</literal> may interfere <literal>permissions</literal> or <literal>multi-connect</literal> may interfere with
with IWD connection attempts. IWD connection attempts.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1490,7 +1500,7 @@ managed=1
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>enabled</varname></term> <term><varname>enabled</varname></term>
<listitem><para>Whether connectivity check is enabled. <listitem><para>A boolean indicating whether connectivity check is enabled.
Note that to enable connectivity check, a valid uri must Note that to enable connectivity check, a valid uri must
also be configured. The value defaults to true, but since also be configured. The value defaults to true, but since
the uri is unset by default, connectivity check may be disabled. the uri is unset by default, connectivity check may be disabled.