From 7ce743b4226e44067e1562eac125d267dcce04f3 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra <eelco.dolstra@logicblox.com> Date: Mon, 14 Apr 2014 19:27:26 +0200 Subject: [PATCH] Manual: Add some IDs --- nixos/doc/manual/configuration.xml | 32 +++++++++++++++------------- nixos/doc/manual/installation.xml | 8 +++---- nixos/doc/manual/release-notes.xml | 2 +- nixos/doc/manual/running.xml | 12 +++++------ nixos/doc/manual/troubleshooting.xml | 13 +++++------ 5 files changed, 35 insertions(+), 32 deletions(-) diff --git a/nixos/doc/manual/configuration.xml b/nixos/doc/manual/configuration.xml index 246ab11587a8..1dff9d2f21e5 100644 --- a/nixos/doc/manual/configuration.xml +++ b/nixos/doc/manual/configuration.xml @@ -237,7 +237,7 @@ postgresql.package = pkgs.postgresql90; </section> -<section><title>Abstractions</title> +<section xml:id="sec-module-abstractions"><title>Abstractions</title> <para>If you find yourself repeating yourself over and over, it’s time to abstract. Take, for instance, this Apache HTTP Server configuration: @@ -399,7 +399,7 @@ of an expression to be spliced into a string.</para> </section> -<section><title>Modularity</title> +<section xml:id="sec-modularity"><title>Modularity</title> <para>The NixOS configuration mechanism is modular. If your <filename>configuration.nix</filename> becomes too big, you can split @@ -538,7 +538,7 @@ nix-repl> map (x: x.hostName) config.services.httpd.virtualHosts </section> -<section><title>Syntax summary</title> +<section xml:id="sec-nix-syntax-summary"><title>Syntax summary</title> <para>Below is a summary of the most important syntactic constructs in the Nix expression language. It’s not complete. In particular, there @@ -730,7 +730,7 @@ manual</link> for the rest.</para> <!--===============================================================--> -<section><title>Package management</title> +<section xml:id="sec-package-management"><title>Package management</title> <para>This section describes how to add additional packages to your system. NixOS has two distinct styles of package management: @@ -1183,7 +1183,7 @@ fileSystems."/".device = "/dev/mapper/crypted"; <!--===============================================================--> -<section><title>X Window System</title> +<section xml:id="sec-x11"><title>X Window System</title> <para>The X Window System (X11) provides the basis of NixOS’ graphical user interface. It can be enabled as follows: @@ -1275,9 +1275,9 @@ services.xserver.synaptics.twoFingerScroll = true; <!--===============================================================--> -<section><title>Networking</title> +<section xml:id="sec-networking"><title>Networking</title> -<section><title>Secure shell access</title> +<section xml:id="sec-ssh"><title>Secure shell access</title> <para>Secure shell (SSH) access to your machine can be enabled by setting: @@ -1305,7 +1305,7 @@ users.extraUsers.alice.openssh.authorizedKeys.keys = </section> -<section><title>IPv4 configuration</title> +<section xml:id="sec-ipv4"><title>IPv4 configuration</title> <para>By default, NixOS uses DHCP (specifically, <command>dhcpcd</command>) to automatically configure network @@ -1348,7 +1348,7 @@ provide the host name.</para> </section> -<section><title>IPv6 configuration</title> +<section xml:id="sec-ipv6"><title>IPv6 configuration</title> <para>IPv6 is enabled by default. Stateless address autoconfiguration is used to automatically assign IPv6 addresses to all interfaces. You @@ -1363,17 +1363,19 @@ networking.enableIPv6 = false; </section> -<section><title>Firewall</title> +<section xml:id="sec-firewall"><title>Firewall</title> <para>NixOS has a simple stateful firewall that blocks incoming connections and other unexpected packets. The firewall applies to -both IPv4 and IPv6 traffic. It can be enabled as follows: +both IPv4 and IPv6 traffic. It is enabled by default. It can be +disabled as follows: <programlisting> -networking.firewall.enable = true; +networking.firewall.enable = false; </programlisting> -You can open specific TCP ports to the outside world: +If the firewall is enabled, you can open specific TCP ports to the +outside world: <programlisting> networking.firewall.allowedTCPPorts = [ 80 443 ]; @@ -1395,7 +1397,7 @@ always allowed.)</para> </section> -<section><title>Wireless networks</title> +<section xml:id="sec-wireless"><title>Wireless networks</title> <para> NixOS will start wpa_supplicant for you if you enable this setting: @@ -1456,7 +1458,7 @@ networking.localCommands = <!--===============================================================--> -<section><title>Linux kernel</title> +<section xml:id="sec-kernel-config"><title>Linux kernel</title> <para>You can override the Linux kernel and associated packages using the option <option>boot.kernelPackages</option>. For instance, this diff --git a/nixos/doc/manual/installation.xml b/nixos/doc/manual/installation.xml index f6b477ed69bc..03540aa83aaa 100644 --- a/nixos/doc/manual/installation.xml +++ b/nixos/doc/manual/installation.xml @@ -1,13 +1,13 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" - xml:id="installing-nixos"> + xml:id="ch-installation"> <title>Installing NixOS</title> <!--===============================================================--> -<section> +<section xml:id="sec-obtaining"> <title>Obtaining NixOS</title> @@ -51,7 +51,7 @@ running NixOS system through several other means: <!--===============================================================--> -<section> +<section xml:id="sec-installation"> <title>Installation</title> @@ -339,7 +339,7 @@ changes: <section> -<title>Booting from a USB stick</title> +<title xml:id="sec-booting-from-usb">Booting from a USB stick</title> <para>For systems withoua CD drive, the NixOS livecd can be booted from a usb stick. For non-UEFI installations, diff --git a/nixos/doc/manual/release-notes.xml b/nixos/doc/manual/release-notes.xml index 10815ba613ad..7995497708e0 100644 --- a/nixos/doc/manual/release-notes.xml +++ b/nixos/doc/manual/release-notes.xml @@ -5,7 +5,7 @@ <!--==================================================================--> -<section xml:id="sec-release-14.02"> +<section xml:id="sec-release-14.04"> <title>Release 14.04 (“Baboon”, 2014/04/??)</title> diff --git a/nixos/doc/manual/running.xml b/nixos/doc/manual/running.xml index e50099707cc5..e1a358df2aac 100644 --- a/nixos/doc/manual/running.xml +++ b/nixos/doc/manual/running.xml @@ -11,7 +11,7 @@ service manager.</para> <!--===============================================================--> -<section><title>Service management</title> +<section xml:id="sec-systemctl"><title>Service management</title> <para>In NixOS, all system services are started and monitored using the systemd program. Systemd is the “init” process of the system @@ -92,7 +92,7 @@ necessary).</para> <!--===============================================================--> -<section><title>Rebooting and shutting down</title> +<section xml:id="sec-rebooting"><title>Rebooting and shutting down</title> <para>The system can be shut down (and automatically powered off) by doing: @@ -134,7 +134,7 @@ authentication.</para> <!--===============================================================--> -<section><title>User sessions</title> +<section xml:id="sec-user-sessions"><title>User sessions</title> <para>Systemd keeps track of all users who are logged into the system (e.g. on a virtual console or remotely via SSH). The command @@ -185,7 +185,7 @@ $ loginctl terminate-session c3 <!--===============================================================--> -<section><title>Control groups</title> +<section xml:id="sec-cgroups"><title>Control groups</title> <para>To keep track of the processes in a running system, systemd uses <emphasis>control groups</emphasis> (cgroups). A control group is a @@ -258,7 +258,7 @@ usage.</para> <!--===============================================================--> -<section><title>Logging</title> +<section xml:id="sec-logging"><title>Logging</title> <para>System-wide logging is provided by systemd’s <emphasis>journal</emphasis>, which subsumes traditional logging @@ -308,7 +308,7 @@ groups. All users have a private journal that can be read using <!--===============================================================--> -<section><title>Cleaning up the Nix store</title> +<section xml:id="sec-nix-gc"><title>Cleaning up the Nix store</title> <para>Nix has a purely functional model, meaning that packages are never upgraded in place. Instead new versions of packages end up in a diff --git a/nixos/doc/manual/troubleshooting.xml b/nixos/doc/manual/troubleshooting.xml index c6e0a3a7888c..c7d65112b649 100644 --- a/nixos/doc/manual/troubleshooting.xml +++ b/nixos/doc/manual/troubleshooting.xml @@ -1,12 +1,13 @@ <chapter xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink"> + xmlns:xlink="http://www.w3.org/1999/xlink" + xml:id="ch-troubleshooting"> <title>Troubleshooting</title> <!--===============================================================--> -<section><title>Boot problems</title> +<section xml:id="sec-boot-problems"><title>Boot problems</title> <para>If NixOS fails to boot, there are a number of kernel command line parameters that may help you to identify or fix the issue. You @@ -69,7 +70,7 @@ unless something is very wrong.)</para> <!--===============================================================--> -<section><title>Maintenance mode</title> +<section xml:id="sec-maintenance-mode"><title>Maintenance mode</title> <para>You can enter rescue mode by running: @@ -85,7 +86,7 @@ just exit from the rescue shell.</para> <!--===============================================================--> -<section><title>Rolling back configuration changes</title> +<section xml:id="sec-rollback"><title>Rolling back configuration changes</title> <para>After running <command>nixos-rebuild</command> to switch to a new configuration, you may find that the new configuration doesn’t @@ -131,7 +132,7 @@ lrwxrwxrwx 1 root root 78 Aug 12 13:54 /nix/var/nix/profiles/system-268-link -> <!--===============================================================--> -<section><title>Nix store corruption</title> +<section xml:id="sec-nix-store-corruption"><title>Nix store corruption</title> <para>After a system crash, it’s possible for files in the Nix store to become corrupted. (For instance, the Ext4 file system has the @@ -166,7 +167,7 @@ binary cache; otherwise, they cannot be repaired.</para> <!--===============================================================--> -<section><title>Nix network issues</title> +<section xml:id="sec-nix-network-issues"><title>Nix network issues</title> <para>Nix uses a so-called <emphasis>binary cache</emphasis> to optimise building a package from source into downloading it as a