JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

nixos: use only URI fragment in manual options links

Browse Source
This commit is contained in:
Bobby Rong 2021-07-04 09:56:26 +08:00
parent e602771722
commit 69bf2d1ed5
14 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nixos/doc/manual/configuration/ad-hoc-network-config.section.md
View File

@ -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:

4
nixos/doc/manual/configuration/firewall.section.md
View File

@ -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).

2
nixos/doc/manual/configuration/ipv4-config.section.md
View File

@ -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";

4
nixos/doc/manual/configuration/ipv6-config.section.md
View File

@ -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

2
nixos/doc/manual/configuration/network-manager.section.md
View File

@ -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.

2
nixos/doc/manual/configuration/renaming-interfaces.section.md
View File

@ -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}

2
nixos/doc/manual/configuration/ssh.section.md
View File

@ -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:

5
nixos/doc/manual/from_md/configuration/ad-hoc-network-config.section.xml
View File

@ -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:

4
nixos/doc/manual/from_md/configuration/firewall.section.xml
View File

@ -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>

2
nixos/doc/manual/from_md/configuration/ipv4-config.section.xml
View File

@ -30,7 +30,7 @@ networking.nameservers = [ &quot;8.8.8.8&quot; ];
</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 = &quot;cartman&quot;;

8
nixos/doc/manual/from_md/configuration/ipv6-config.section.xml
View File

@ -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.&lt;name&gt;.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;

6
nixos/doc/manual/from_md/configuration/network-manager.section.xml
View File

@ -25,9 +25,9 @@ users.users.alice.extraGroups = [ &quot;networkmanager&quot; ];
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>

4
nixos/doc/manual/from_md/configuration/renaming-interfaces.section.xml
View File

@ -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>

4
nixos/doc/manual/from_md/configuration/ssh.section.xml
View File

@ -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>&quot;no&quot;</literal>.
<xref linkend="opt-services.openssh.permitRootLogin" /> to
<literal>&quot;no&quot;</literal>.
</para>
<para>
You can declaratively specify authorised RSA/DSA public keys for a