From 69bf2d1ed5e4d933cc395a5a25d2b5181d26ffd6 Mon Sep 17 00:00:00 2001 From: Bobby Rong Date: Sun, 4 Jul 2021 09:56:26 +0800 Subject: [PATCH] nixos: use only URI fragment in manual options links --- .../manual/configuration/ad-hoc-network-config.section.md | 2 +- nixos/doc/manual/configuration/firewall.section.md | 4 ++-- nixos/doc/manual/configuration/ipv4-config.section.md | 2 +- nixos/doc/manual/configuration/ipv6-config.section.md | 4 ++-- nixos/doc/manual/configuration/network-manager.section.md | 2 +- .../manual/configuration/renaming-interfaces.section.md | 2 +- nixos/doc/manual/configuration/ssh.section.md | 2 +- .../configuration/ad-hoc-network-config.section.xml | 5 ++--- .../doc/manual/from_md/configuration/firewall.section.xml | 4 ++-- .../manual/from_md/configuration/ipv4-config.section.xml | 2 +- .../manual/from_md/configuration/ipv6-config.section.xml | 8 ++++---- .../from_md/configuration/network-manager.section.xml | 6 +++--- .../from_md/configuration/renaming-interfaces.section.xml | 4 ++-- nixos/doc/manual/from_md/configuration/ssh.section.xml | 4 ++-- 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 9131f42842b7..4478d77f361d 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 40f7fb7c6d51..dbf0ffb9273e 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 8a870df60945..c73024b856d7 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 6d51a21aa64a..ce66f53ed472 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..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 f269d5bbd170..4bda21d34a10 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 affa1e0147da..b124e8303fee 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 9390108ad8b2..cba81eb43f49 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 0424642b978c..035ee3122e15 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 @@
Ad-Hoc Configuration - You can use - networking.localCommands - to specify shell commands to be run at the end of + You can use 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/from_md/configuration/firewall.section.xml b/nixos/doc/manual/from_md/configuration/firewall.section.xml index ebb121f75ffb..24c19bb1c66d 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 (services.openssh.enable = true). UDP ports can be opened through - networking.firewall.allowedUDPPorts. + . To open ranges of TCP ports: @@ -34,6 +34,6 @@ networking.firewall.allowedTCPPortRanges = [ Similarly, UDP port ranges can be opened through - networking.firewall.allowedUDPPortRanges. + .
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 06a70b65cfbc..047ba2165f07 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" ]; The host name is set using - networking.hostName: + : 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 ac3c2cd4b21c..137c3d772a86 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 - networking.tempAddresses. - This option may be overridden on a per-interface basis by - networking.interfaces.<name>.tempAddress. - You can disable IPv6 support globally by setting: + . This option may be + overridden on a per-interface basis by + . You + can disable IPv6 support globally by setting: 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 fd3f26ab621c..8f0d6d680ae0 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 - programs.nm-applet.enable, - the graphical applet will be installed and will launch automatically - when the graphical session is started. + , the graphical + applet will be installed and will launch automatically when the + graphical session is started. 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 80c162ca85e0..1c32e30b3f85 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. If this is undesirable, for example if you have a single ethernet card, you can revert to the traditional scheme by setting - networking.usePredictableInterfaceNames - to false. + to + false.
Assigning custom names diff --git a/nixos/doc/manual/from_md/configuration/ssh.section.xml b/nixos/doc/manual/from_md/configuration/ssh.section.xml index 46046064535e..037418d8ea4d 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; By default, root logins using a password are disallowed. They can be disabled entirely by setting - services.openssh.permitRootLogin - to "no". + to + "no". You can declaratively specify authorised RSA/DSA public keys for a