diff options
author | Bobby Rong <rjl931189261@126.com> | 2021-07-04 09:56:26 +0800 |
---|---|---|
committer | Bobby Rong <rjl931189261@126.com> | 2021-07-04 09:56:26 +0800 |
commit | 69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6 (patch) | |
tree | 371aa5a9402e2a89a94acf58b8c611b1b56ce6be | |
parent | e602771722d1820620f0e5cbecc821d561684a71 (diff) | |
download | nixpkgs-69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6.tar nixpkgs-69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6.tar.gz nixpkgs-69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6.tar.bz2 nixpkgs-69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6.tar.lz nixpkgs-69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6.tar.xz nixpkgs-69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6.tar.zst nixpkgs-69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6.zip |
nixos: use only URI fragment in manual options links
14 files changed, 25 insertions, 26 deletions
diff --git a/nixos/doc/manual/configuration/ad-hoc-network-config.section.md b/nixos/doc/manual/configuration/ad-hoc-network-config.section.md index 9131f42842b..4478d77f361 100644 --- a/nixos/doc/manual/configuration/ad-hoc-network-config.section.md +++ b/nixos/doc/manual/configuration/ad-hoc-network-config.section.md @@ -1,6 +1,6 @@ # Ad-Hoc Configuration {#ad-hoc-network-config} -You can use [`networking.localCommands`](options.html#opt-networking.localCommands) to +You can use [](#opt-networking.localCommands) to specify shell commands to be run at the end of `network-setup.service`. This is useful for doing network configuration not covered by the existing NixOS modules. For instance, to statically configure an IPv6 address: diff --git a/nixos/doc/manual/configuration/firewall.section.md b/nixos/doc/manual/configuration/firewall.section.md index 40f7fb7c6d5..dbf0ffb9273 100644 --- a/nixos/doc/manual/configuration/firewall.section.md +++ b/nixos/doc/manual/configuration/firewall.section.md @@ -17,7 +17,7 @@ networking.firewall.allowedTCPPorts = [ 80 443 ]; Note that TCP port 22 (ssh) is opened automatically if the SSH daemon is enabled (`services.openssh.enable = true`). UDP ports can be opened through -[`networking.firewall.allowedUDPPorts`](options.html#opt-networking.firewall.allowedUDPPorts). +[](#opt-networking.firewall.allowedUDPPorts). To open ranges of TCP ports: @@ -29,4 +29,4 @@ networking.firewall.allowedTCPPortRanges = [ ``` Similarly, UDP port ranges can be opened through -[`networking.firewall.allowedUDPPortRanges`](options.html#opt-networking.firewall.allowedUDPPortRanges). +[](#opt-networking.firewall.allowedUDPPortRanges). diff --git a/nixos/doc/manual/configuration/ipv4-config.section.md b/nixos/doc/manual/configuration/ipv4-config.section.md index 8a870df6094..c73024b856d 100644 --- a/nixos/doc/manual/configuration/ipv4-config.section.md +++ b/nixos/doc/manual/configuration/ipv4-config.section.md @@ -25,7 +25,7 @@ Statically configured interfaces are set up by the systemd service configuration is performed by `network-setup.service`. ::: -The host name is set using [`networking.hostName`](options.html#opt-networking.hostName): +The host name is set using [](#opt-networking.hostName): ```nix networking.hostName = "cartman"; diff --git a/nixos/doc/manual/configuration/ipv6-config.section.md b/nixos/doc/manual/configuration/ipv6-config.section.md index 6d51a21aa64..ce66f53ed47 100644 --- a/nixos/doc/manual/configuration/ipv6-config.section.md +++ b/nixos/doc/manual/configuration/ipv6-config.section.md @@ -3,9 +3,9 @@ IPv6 is enabled by default. Stateless address autoconfiguration is used to automatically assign IPv6 addresses to all interfaces, and Privacy Extensions (RFC 4946) are enabled by default. You can adjust the default -for this by setting [`networking.tempAddresses`](options.html#opt-networking.tempAddresses). This option +for this by setting [](#opt-networking.tempAddresses). This option may be overridden on a per-interface basis by -[`networking.interfaces.<name>.tempAddress`](options.html#opt-networking.interfaces._name_.tempAddress). You can disable +[](#opt-networking.interfaces._name_.tempAddress). You can disable IPv6 support globally by setting: ```nix diff --git a/nixos/doc/manual/configuration/network-manager.section.md b/nixos/doc/manual/configuration/network-manager.section.md index f269d5bbd17..4bda21d34a1 100644 --- a/nixos/doc/manual/configuration/network-manager.section.md +++ b/nixos/doc/manual/configuration/network-manager.section.md @@ -22,7 +22,7 @@ NetworkManager is controlled using either `nmcli` or `nmtui` 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 +[](#opt-programs.nm-applet.enable), the graphical applet will be installed and will launch automatically when the graphical session is started. diff --git a/nixos/doc/manual/configuration/renaming-interfaces.section.md b/nixos/doc/manual/configuration/renaming-interfaces.section.md index affa1e0147d..b124e8303fe 100644 --- a/nixos/doc/manual/configuration/renaming-interfaces.section.md +++ b/nixos/doc/manual/configuration/renaming-interfaces.section.md @@ -14,7 +14,7 @@ settings can result in a [name change](https://github.com/systemd/systemd/issues/3715#issue-165347602). If this is undesirable, for example if you have a single ethernet card, you can revert to the traditional scheme by setting -[`networking.usePredictableInterfaceNames`](options.html#opt-networking.usePredictableInterfaceNames) +[](#opt-networking.usePredictableInterfaceNames) to `false`. ## Assigning custom names {#sec-custom-ifnames} diff --git a/nixos/doc/manual/configuration/ssh.section.md b/nixos/doc/manual/configuration/ssh.section.md index 9390108ad8b..cba81eb43f4 100644 --- a/nixos/doc/manual/configuration/ssh.section.md +++ b/nixos/doc/manual/configuration/ssh.section.md @@ -8,7 +8,7 @@ services.openssh.enable = true; By default, root logins using a password are disallowed. They can be disabled entirely by setting -[`services.openssh.permitRootLogin`](options.html#opt-services.openssh.permitRootLogin) to `"no"`. +[](#opt-services.openssh.permitRootLogin) to `"no"`. You can declaratively specify authorised RSA/DSA public keys for a user as follows: diff --git a/nixos/doc/manual/from_md/configuration/ad-hoc-network-config.section.xml b/nixos/doc/manual/from_md/configuration/ad-hoc-network-config.section.xml index 0424642b978..035ee3122e1 100644 --- a/nixos/doc/manual/from_md/configuration/ad-hoc-network-config.section.xml +++ b/nixos/doc/manual/from_md/configuration/ad-hoc-network-config.section.xml @@ -1,9 +1,8 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ad-hoc-network-config"> <title>Ad-Hoc Configuration</title> <para> - You can use - <link xlink:href="options.html#opt-networking.localCommands"><literal>networking.localCommands</literal></link> - to specify shell commands to be run at the end of + You can use <xref linkend="opt-networking.localCommands" /> to + specify shell commands to be run at the end of <literal>network-setup.service</literal>. This is useful for doing network configuration not covered by the existing NixOS modules. For instance, to statically configure an IPv6 address: diff --git a/nixos/doc/manual/from_md/configuration/firewall.section.xml b/nixos/doc/manual/from_md/configuration/firewall.section.xml index ebb121f75ff..24c19bb1c66 100644 --- a/nixos/doc/manual/from_md/configuration/firewall.section.xml +++ b/nixos/doc/manual/from_md/configuration/firewall.section.xml @@ -21,7 +21,7 @@ networking.firewall.allowedTCPPorts = [ 80 443 ]; daemon is enabled (<literal>services.openssh.enable = true</literal>). UDP ports can be opened through - <link xlink:href="options.html#opt-networking.firewall.allowedUDPPorts"><literal>networking.firewall.allowedUDPPorts</literal></link>. + <xref linkend="opt-networking.firewall.allowedUDPPorts" />. </para> <para> To open ranges of TCP ports: @@ -34,6 +34,6 @@ networking.firewall.allowedTCPPortRanges = [ </programlisting> <para> Similarly, UDP port ranges can be opened through - <link xlink:href="options.html#opt-networking.firewall.allowedUDPPortRanges"><literal>networking.firewall.allowedUDPPortRanges</literal></link>. + <xref linkend="opt-networking.firewall.allowedUDPPortRanges" />. </para> </section> diff --git a/nixos/doc/manual/from_md/configuration/ipv4-config.section.xml b/nixos/doc/manual/from_md/configuration/ipv4-config.section.xml index 06a70b65cfb..047ba2165f0 100644 --- a/nixos/doc/manual/from_md/configuration/ipv4-config.section.xml +++ b/nixos/doc/manual/from_md/configuration/ipv4-config.section.xml @@ -30,7 +30,7 @@ networking.nameservers = [ "8.8.8.8" ]; </note> <para> The host name is set using - <link xlink:href="options.html#opt-networking.hostName"><literal>networking.hostName</literal></link>: + <xref linkend="opt-networking.hostName" />: </para> <programlisting language="bash"> networking.hostName = "cartman"; diff --git a/nixos/doc/manual/from_md/configuration/ipv6-config.section.xml b/nixos/doc/manual/from_md/configuration/ipv6-config.section.xml index ac3c2cd4b21..137c3d772a8 100644 --- a/nixos/doc/manual/from_md/configuration/ipv6-config.section.xml +++ b/nixos/doc/manual/from_md/configuration/ipv6-config.section.xml @@ -5,10 +5,10 @@ used to automatically assign IPv6 addresses to all interfaces, and Privacy Extensions (RFC 4946) are enabled by default. You can adjust the default for this by setting - <link xlink:href="options.html#opt-networking.tempAddresses"><literal>networking.tempAddresses</literal></link>. - This option may be overridden on a per-interface basis by - <link xlink:href="options.html#opt-networking.interfaces._name_.tempAddress"><literal>networking.interfaces.<name>.tempAddress</literal></link>. - You can disable IPv6 support globally by setting: + <xref linkend="opt-networking.tempAddresses" />. This option may be + overridden on a per-interface basis by + <xref linkend="opt-networking.interfaces._name_.tempAddress" />. You + can disable IPv6 support globally by setting: </para> <programlisting language="bash"> networking.enableIPv6 = false; diff --git a/nixos/doc/manual/from_md/configuration/network-manager.section.xml b/nixos/doc/manual/from_md/configuration/network-manager.section.xml index fd3f26ab621..8f0d6d680ae 100644 --- a/nixos/doc/manual/from_md/configuration/network-manager.section.xml +++ b/nixos/doc/manual/from_md/configuration/network-manager.section.xml @@ -25,9 +25,9 @@ users.users.alice.extraGroups = [ "networkmanager" ]; 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. + <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> diff --git a/nixos/doc/manual/from_md/configuration/renaming-interfaces.section.xml b/nixos/doc/manual/from_md/configuration/renaming-interfaces.section.xml index 80c162ca85e..1c32e30b3f8 100644 --- a/nixos/doc/manual/from_md/configuration/renaming-interfaces.section.xml +++ b/nixos/doc/manual/from_md/configuration/renaming-interfaces.section.xml @@ -18,8 +18,8 @@ change</link>. If this is undesirable, for example if you have a single ethernet card, you can revert to the traditional scheme by setting - <link xlink:href="options.html#opt-networking.usePredictableInterfaceNames"><literal>networking.usePredictableInterfaceNames</literal></link> - to <literal>false</literal>. + <xref linkend="opt-networking.usePredictableInterfaceNames" /> to + <literal>false</literal>. </para> <section xml:id="sec-custom-ifnames"> <title>Assigning custom names</title> diff --git a/nixos/doc/manual/from_md/configuration/ssh.section.xml b/nixos/doc/manual/from_md/configuration/ssh.section.xml index 46046064535..037418d8ea4 100644 --- a/nixos/doc/manual/from_md/configuration/ssh.section.xml +++ b/nixos/doc/manual/from_md/configuration/ssh.section.xml @@ -9,8 +9,8 @@ services.openssh.enable = true; <para> By default, root logins using a password are disallowed. They can be disabled entirely by setting - <link xlink:href="options.html#opt-services.openssh.permitRootLogin"><literal>services.openssh.permitRootLogin</literal></link> - to <literal>"no"</literal>. + <xref linkend="opt-services.openssh.permitRootLogin" /> to + <literal>"no"</literal>. </para> <para> You can declaratively specify authorised RSA/DSA public keys for a |