summary refs log tree commit diff
path: root/nixos/doc/manual/man-nixos-generate-config.xml
diff options
context:
space:
mode:
authorGraham Christensen <graham@grahamc.com>2018-05-01 19:57:09 -0400
committerGraham Christensen <graham@grahamc.com>2018-05-01 19:57:09 -0400
commiteca5c99bf8a115ffd9513f91decc064a5bb3ff6d (patch)
tree7b49bc123be12ca5344428c6975e4487e69d55e3 /nixos/doc/manual/man-nixos-generate-config.xml
parent77161de4546697f9bf2da6d081eeba4c399b3313 (diff)
downloadnixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.gz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.bz2
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.lz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.xz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.zst
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.zip
nixos docs: format =)
Diffstat (limited to 'nixos/doc/manual/man-nixos-generate-config.xml')
-rw-r--r--nixos/doc/manual/man-nixos-generate-config.xml289
1 files changed, 140 insertions, 149 deletions
diff --git a/nixos/doc/manual/man-nixos-generate-config.xml b/nixos/doc/manual/man-nixos-generate-config.xml
index 993a932ddfb..8bf90f452db 100644
--- a/nixos/doc/manual/man-nixos-generate-config.xml
+++ b/nixos/doc/manual/man-nixos-generate-config.xml
@@ -1,152 +1,149 @@
 <refentry xmlns="http://docbook.org/ns/docbook"
           xmlns:xlink="http://www.w3.org/1999/xlink"
           xmlns:xi="http://www.w3.org/2001/XInclude">
-
-<refmeta>
-  <refentrytitle><command>nixos-generate-config</command></refentrytitle>
-  <manvolnum>8</manvolnum>
+ <refmeta>
+  <refentrytitle><command>nixos-generate-config</command>
+  </refentrytitle><manvolnum>8</manvolnum>
   <refmiscinfo class="source">NixOS</refmiscinfo>
-  <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
-</refmeta>
-
-<refnamediv>
-  <refname><command>nixos-generate-config</command></refname>
-  <refpurpose>generate NixOS configuration modules</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv>
-  <cmdsynopsis>
-    <command>nixos-generate-config</command>
-    <arg><option>--force</option></arg>
-    <arg>
-      <arg choice='plain'><option>--root</option></arg>
-      <replaceable>root</replaceable>
-    </arg>
-    <arg>
-      <arg choice='plain'><option>--dir</option></arg>
-      <replaceable>dir</replaceable>
-    </arg>
+<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
+ </refmeta>
+ <refnamediv>
+  <refname><command>nixos-generate-config</command>
+  </refname><refpurpose>generate NixOS configuration modules</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+  <cmdsynopsis><command>nixos-generate-config</command>
+   <arg><option>--force</option>
+   </arg>
+   <arg>
+    <arg choice='plain'><option>--root</option>
+    </arg><replaceable>root</replaceable>
+   </arg>
+   <arg>
+    <arg choice='plain'><option>--dir</option>
+    </arg><replaceable>dir</replaceable>
+   </arg>
   </cmdsynopsis>
-</refsynopsisdiv>
-
-
-<refsection><title>Description</title>
-
-<para>This command writes two NixOS configuration modules:
-
-<variablelist>
-
-  <varlistentry>
-    <term><option>/etc/nixos/hardware-configuration.nix</option></term>
+ </refsynopsisdiv>
+ <refsection>
+  <title>Description</title>
+  <para>
+   This command writes two NixOS configuration modules:
+   <variablelist>
+    <varlistentry>
+     <term><option>/etc/nixos/hardware-configuration.nix</option>
+     </term>
+     <listitem>
+      <para>
+       This module sets NixOS configuration options based on your current
+       hardware configuration. In particular, it sets the
+       <option>fileSystem</option> option to reflect all currently mounted file
+       systems, the <option>swapDevices</option> option to reflect active swap
+       devices, and the <option>boot.initrd.*</option> options to ensure that
+       the initial ramdisk contains any kernel modules necessary for mounting
+       the root file system.
+      </para>
+      <para>
+       If this file already exists, it is overwritten. Thus, you should not
+       modify it manually. Rather, you should include it from your
+       <filename>/etc/nixos/configuration.nix</filename>, and re-run
+       <command>nixos-generate-config</command> to update it whenever your
+       hardware configuration changes.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><option>/etc/nixos/configuration.nix</option>
+     </term>
+     <listitem>
+      <para>
+       This is the main NixOS system configuration module. If it already
+       exists, it’s left unchanged. Otherwise,
+       <command>nixos-generate-config</command> will write a template for you
+       to customise.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsection>
+ <refsection>
+  <title>Options</title>
+  <para>
+   This command accepts the following options:
+  </para>
+  <variablelist>
+   <varlistentry>
+    <term><option>--root</option>
+    </term>
     <listitem>
-      <para>This module sets NixOS configuration options based on your
-      current hardware configuration.  In particular, it sets the
-      <option>fileSystem</option> option to reflect all currently
-      mounted file systems, the <option>swapDevices</option> option to
-      reflect active swap devices, and the
-      <option>boot.initrd.*</option> options to ensure that the
-      initial ramdisk contains any kernel modules necessary for
-      mounting the root file system.</para>
-
-      <para>If this file already exists, it is overwritten.  Thus, you
-      should not modify it manually.  Rather, you should include it
-      from your <filename>/etc/nixos/configuration.nix</filename>, and
-      re-run <command>nixos-generate-config</command> to update it
-      whenever your hardware configuration changes.</para>
+     <para>
+      If this option is given, treat the directory
+      <replaceable>root</replaceable> as the root of the file system. This
+      means that configuration files will be written to
+      <filename><replaceable>root</replaceable>/etc/nixos</filename>, and that
+      any file systems outside of <replaceable>root</replaceable> are ignored
+      for the purpose of generating the <option>fileSystems</option> option.
+     </para>
     </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>/etc/nixos/configuration.nix</option></term>
+   </varlistentry>
+   <varlistentry>
+    <term><option>--dir</option>
+    </term>
     <listitem>
-      <para>This is the main NixOS system configuration module.  If it
-      already exists, it’s left unchanged.  Otherwise,
-      <command>nixos-generate-config</command> will write a template
-      for you to customise.</para>
+     <para>
+      If this option is given, write the configuration files to the directory
+      <replaceable>dir</replaceable> instead of
+      <filename>/etc/nixos</filename>.
+     </para>
     </listitem>
-  </varlistentry>
-
-</variablelist>
-
-</para>
-
-</refsection>
-
-
-<refsection><title>Options</title>
-
-<para>This command accepts the following options:</para>
-
-<variablelist>
-
-  <varlistentry>
-    <term><option>--root</option></term>
+   </varlistentry>
+   <varlistentry>
+    <term><option>--force</option>
+    </term>
     <listitem>
-      <para>If this option is given, treat the directory
-      <replaceable>root</replaceable> as the root of the file system.
-      This means that configuration files will be written to
-      <filename><replaceable>root</replaceable>/etc/nixos</filename>,
-      and that any file systems outside of
-      <replaceable>root</replaceable> are ignored for the purpose of
-      generating the <option>fileSystems</option> option.</para>
+     <para>
+      Overwrite <filename>/etc/nixos/configuration.nix</filename> if it already
+      exists.
+     </para>
     </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>--dir</option></term>
+   </varlistentry>
+   <varlistentry>
+    <term><option>--no-filesystems</option>
+    </term>
     <listitem>
-      <para>If this option is given, write the configuration files to
-      the directory <replaceable>dir</replaceable> instead of
-      <filename>/etc/nixos</filename>.</para>
+     <para>
+      Omit everything concerning file systems and swap devices from the
+      hardware configuration.
+     </para>
     </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>--force</option></term>
+   </varlistentry>
+   <varlistentry>
+    <term><option>--show-hardware-config</option>
+    </term>
     <listitem>
-      <para>Overwrite
-      <filename>/etc/nixos/configuration.nix</filename> if it already
-      exists.</para>
+     <para>
+      Don't generate <filename>configuration.nix</filename> or
+      <filename>hardware-configuration.nix</filename> and print the hardware
+      configuration to stdout only.
+     </para>
     </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>--no-filesystems</option></term>
-    <listitem>
-      <para>Omit everything concerning file systems and swap devices
-      from the hardware configuration.</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>--show-hardware-config</option></term>
-    <listitem>
-      <para>Don't generate <filename>configuration.nix</filename> or
-      <filename>hardware-configuration.nix</filename> and print the
-      hardware configuration to stdout only.</para>
-    </listitem>
-  </varlistentry>
-
-</variablelist>
-
-</refsection>
-
-
-<refsection><title>Examples</title>
-
-<para>This command is typically used during NixOS installation to
-write initial configuration modules.  For example, if you created and
-mounted the target file systems on <filename>/mnt</filename> and
-<filename>/mnt/boot</filename>, you would run:
-
+   </varlistentry>
+  </variablelist>
+ </refsection>
+ <refsection>
+  <title>Examples</title>
+  <para>
+   This command is typically used during NixOS installation to write initial
+   configuration modules. For example, if you created and mounted the target
+   file systems on <filename>/mnt</filename> and
+   <filename>/mnt/boot</filename>, you would run:
 <screen>
 $ nixos-generate-config --root /mnt
 </screen>
-
-The resulting file
-<filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might
-look like this:
-
+   The resulting file
+   <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might look
+   like this:
 <programlisting>
 # Do not modify this file!  It was generated by ‘nixos-generate-config’
 # and may be overwritten by future invocations.  Please make changes
@@ -181,28 +178,22 @@ look like this:
   nix.maxJobs = 8;
 }
 </programlisting>
-
-It will also create a basic
-<filename>/mnt/etc/nixos/configuration.nix</filename>, which you
-should edit to customise the logical configuration of your system.
-This file includes the result of the hardware scan as follows:
-
+   It will also create a basic
+   <filename>/mnt/etc/nixos/configuration.nix</filename>, which you should edit
+   to customise the logical configuration of your system. This file includes
+   the result of the hardware scan as follows:
 <programlisting>
   imports = [ ./hardware-configuration.nix ];
 </programlisting>
-</para>
-
-<para>After installation, if your hardware configuration changes, you
-can run:
-
+  </para>
+  <para>
+   After installation, if your hardware configuration changes, you can run:
 <screen>
 $ nixos-generate-config
 </screen>
-
-to update <filename>/etc/nixos/hardware-configuration.nix</filename>.
-Your <filename>/etc/nixos/configuration.nix</filename> will
-<emphasis>not</emphasis> be overwritten.</para>
-
-</refsection>
-
+   to update <filename>/etc/nixos/hardware-configuration.nix</filename>. Your
+   <filename>/etc/nixos/configuration.nix</filename> will
+   <emphasis>not</emphasis> be overwritten.
+  </para>
+ </refsection>
 </refentry>