diff options
author | Bobby Rong <rjl931189261@126.com> | 2021-07-01 23:09:53 +0800 |
---|---|---|
committer | Bobby Rong <rjl931189261@126.com> | 2021-07-01 23:09:53 +0800 |
commit | c10ad53007d228f547026e31742ea7da46140824 (patch) | |
tree | f3afb94ad43e875a31c0f64e9593b0d3ee42a59a | |
parent | c713d17ecde2b7b4854abcb6cf4f905db6876be3 (diff) | |
download | nixpkgs-c10ad53007d228f547026e31742ea7da46140824.tar nixpkgs-c10ad53007d228f547026e31742ea7da46140824.tar.gz nixpkgs-c10ad53007d228f547026e31742ea7da46140824.tar.bz2 nixpkgs-c10ad53007d228f547026e31742ea7da46140824.tar.lz nixpkgs-c10ad53007d228f547026e31742ea7da46140824.tar.xz nixpkgs-c10ad53007d228f547026e31742ea7da46140824.tar.zst nixpkgs-c10ad53007d228f547026e31742ea7da46140824.zip |
nixos: nixos/doc/manual/configuration/network-manager.xml to CommonMark
4 files changed, 92 insertions, 49 deletions
diff --git a/nixos/doc/manual/configuration/network-manager.section.md b/nixos/doc/manual/configuration/network-manager.section.md new file mode 100644 index 00000000000..f269d5bbd17 --- /dev/null +++ b/nixos/doc/manual/configuration/network-manager.section.md @@ -0,0 +1,42 @@ +# NetworkManager {#sec-networkmanager} + +To facilitate network configuration, some desktop environments use +NetworkManager. You can enable NetworkManager by setting: + +```nix +networking.networkmanager.enable = true; +``` + +some desktop managers (e.g., GNOME) enable NetworkManager automatically +for you. + +All users that should have permission to change network settings must +belong to the `networkmanager` group: + +```nix +users.users.alice.extraGroups = [ "networkmanager" ]; +``` + +NetworkManager is controlled using either `nmcli` or `nmtui` +(curses-based terminal user interface). See their manual pages for +details on their usage. Some desktop environments (GNOME, KDE) have +their own configuration tools for NetworkManager. On XFCE, there is no +configuration tool for NetworkManager by default: by enabling +[`programs.nm-applet.enable`](options.html#opt-programs.nm-applet.enable), the graphical applet will be +installed and will launch automatically when the graphical session is +started. + +::: {.note} +`networking.networkmanager` and `networking.wireless` (WPA Supplicant) +can be used together if desired. To do this you need to instruct +NetworkManager to ignore those interfaces like: + +```nix +networking.networkmanager.unmanaged = [ + "*" "except:type:wwan" "except:type:gsm" +]; +``` + +Refer to the option description for the exact syntax and references to +external documentation. +::: diff --git a/nixos/doc/manual/configuration/network-manager.xml b/nixos/doc/manual/configuration/network-manager.xml deleted file mode 100644 index 94d229fd803..00000000000 --- a/nixos/doc/manual/configuration/network-manager.xml +++ /dev/null @@ -1,48 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-networkmanager"> - <title>NetworkManager</title> - - <para> - To facilitate network configuration, some desktop environments use - NetworkManager. You can enable NetworkManager by setting: -<programlisting> -<xref linkend="opt-networking.networkmanager.enable"/> = true; -</programlisting> - some desktop managers (e.g., GNOME) enable NetworkManager automatically for - you. - </para> - - <para> - All users that should have permission to change network settings must belong - to the <code>networkmanager</code> group: -<programlisting> -<link linkend="opt-users.users._name_.extraGroups">users.users.alice.extraGroups</link> = [ "networkmanager" ]; -</programlisting> - </para> - - <para> - NetworkManager is controlled using either <command>nmcli</command> or - <command>nmtui</command> (curses-based terminal user interface). See their - manual pages for details on their usage. Some desktop environments (GNOME, - KDE) have their own configuration tools for NetworkManager. On XFCE, there is - no configuration tool for NetworkManager by default: by enabling <xref linkend="opt-programs.nm-applet.enable"/>, the - graphical applet will be installed and will launch automatically when the graphical session is started. - </para> - - <note> - <para> - <code>networking.networkmanager</code> and <code>networking.wireless</code> - (WPA Supplicant) can be used together if desired. To do this you need to instruct - NetworkManager to ignore those interfaces like: -<programlisting> -<xref linkend="opt-networking.networkmanager.unmanaged"/> = [ - "*" "except:type:wwan" "except:type:gsm" -]; -</programlisting> - Refer to the option description for the exact syntax and references to external documentation. - </para> - </note> -</section> diff --git a/nixos/doc/manual/configuration/networking.xml b/nixos/doc/manual/configuration/networking.xml index 8369e9c9c85..6b078bb3b6c 100644 --- a/nixos/doc/manual/configuration/networking.xml +++ b/nixos/doc/manual/configuration/networking.xml @@ -8,7 +8,7 @@ This section describes how to configure networking components on your NixOS machine. </para> - <xi:include href="network-manager.xml" /> + <xi:include href="../from_md/configuration/network-manager.section.xml" /> <xi:include href="ssh.xml" /> <xi:include href="ipv4-config.xml" /> <xi:include href="ipv6-config.xml" /> diff --git a/nixos/doc/manual/from_md/configuration/network-manager.section.xml b/nixos/doc/manual/from_md/configuration/network-manager.section.xml new file mode 100644 index 00000000000..fd3f26ab621 --- /dev/null +++ b/nixos/doc/manual/from_md/configuration/network-manager.section.xml @@ -0,0 +1,49 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-networkmanager"> + <title>NetworkManager</title> + <para> + To facilitate network configuration, some desktop environments use + NetworkManager. You can enable NetworkManager by setting: + </para> + <programlisting language="bash"> +networking.networkmanager.enable = true; +</programlisting> + <para> + some desktop managers (e.g., GNOME) enable NetworkManager + automatically for you. + </para> + <para> + All users that should have permission to change network settings + must belong to the <literal>networkmanager</literal> group: + </para> + <programlisting language="bash"> +users.users.alice.extraGroups = [ "networkmanager" ]; +</programlisting> + <para> + NetworkManager is controlled using either <literal>nmcli</literal> + or <literal>nmtui</literal> (curses-based terminal user interface). + See their manual pages for details on their usage. Some desktop + environments (GNOME, KDE) have their own configuration tools for + NetworkManager. On XFCE, there is no configuration tool for + NetworkManager by default: by enabling + <link xlink:href="options.html#opt-programs.nm-applet.enable"><literal>programs.nm-applet.enable</literal></link>, + the graphical applet will be installed and will launch automatically + when the graphical session is started. + </para> + <note> + <para> + <literal>networking.networkmanager</literal> and + <literal>networking.wireless</literal> (WPA Supplicant) can be + used together if desired. To do this you need to instruct + NetworkManager to ignore those interfaces like: + </para> + <programlisting language="bash"> +networking.networkmanager.unmanaged = [ + "*" "except:type:wwan" "except:type:gsm" +]; +</programlisting> + <para> + Refer to the option description for the exact syntax and + references to external documentation. + </para> + </note> +</section> |