diff options
Diffstat (limited to 'man/nm-settings-keyfile.xsl')
| -rw-r--r-- | man/nm-settings-keyfile.xsl | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index d63abf0f..450cc6fd 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -32,7 +32,7 @@ <refsect1 id='description'><title>Description</title> <para> NetworkManager is based on the concept of connection profiles that contain - network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle> + network configuration (see <citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle> <manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing the data. The plugins can be configured in <citerefentry> @@ -54,23 +54,32 @@ <refsect1 id='file_format'><title>File Format</title> <para> The <emphasis>keyfile</emphasis> config format is a simple .ini-style - format. It consists of sections (groups) of key-value pairs. Each section - corresponds to a setting name as described in the settings specification - (<citerefentry><refentrytitle>nm-settings</refentrytitle> - <manvolnum>5</manvolnum></citerefentry>). Each configuration key/value - pair in the section is one of the properties listed in the settings - specification. The majority of properties of the specification is written - in the same format into the <emphasis>keyfile</emphasis> too. However - some values are inconvenient for people to use. These are stored in the - files in more readable ways. These properties are described below. - An example could be IP addresses that are not written as integer arrays, - but more reasonably as "1.2.3.4/12 1.2.3.254". + format. It consists of sections (groups) of key-value pairs. More information of the generic key file format can be found at <ulink url="https://developer.gnome.org/glib/stable/glib-Key-value-file-parser.html#glib-Key-value-file-parser.description"> GLib key file format</ulink> (Lines beginning with a '#' are comments, lists are separated by character <literal>;</literal> etc.). </para> <para> + Each section corresponds to a setting name as described in the settings + specification (<citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>). Each key/value pair in a + section is one of the properties from the specification. + </para> + <para> + The majority of properties are written in the same format as the + specification into the <emphasis>keyfile</emphasis>. However, some + values are inconvenient for people to use so they are stored in the + <emphasis>keyfile</emphasis> in more readable ways. These properties + that differ from the specification are described below. + An example could be IP addresses that are not written as integer arrays, + but more reasonably as "1.2.3.4/12 1.2.3.254". + Also, some lists of complex values (addresses, routes, routing-rules), + instead of using a semicolon separated list, use one key-value pair + per list element, with the key being the singular of the property name + followed by the numeric index (i.e address1, address2, ...). + </para> + <para> Users can create or modify the <emphasis>keyfile</emphasis> connection files manually, even if that is not the recommended way of managing the profiles. However, if they choose to do that, they must inform NetworkManager about @@ -195,7 +204,7 @@ id=4 There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by <emphasis>keyfile</emphasis> plugin are listed below. Refer to - <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> for all available settings and properties and their description. </para> <formalpara><title>Name aliases</title> @@ -246,7 +255,7 @@ id=4 </refsect1> <refsect1 id='see_also'><title>See Also</title> - <para><link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + <para><link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='nm-settings-ifcfg-rh'><citerefentry><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, <link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, |