nixpkgs/nixos/doc/manual/manual.xml

<book xmlns="http://docbook.org/ns/docbook"
      xmlns:xlink="http://www.w3.org/1999/xlink"
      xmlns:xi="http://www.w3.org/2001/XInclude"
      version="5.0"
      xml:id="book-nixos-manual">

  <info>
    <title>NixOS Manual</title>
    <subtitle>Version <xi:include href="version" parse="text" /></subtitle>
  </info>

  <preface>
    <title>Preface</title>

    <para>This manual describes how to install, use and extend NixOS,
    a Linux distribution based on the purely functional package
    management system Nix.</para>

    <para>If you encounter problems, please report them on the
    <literal
    xlink:href="https://groups.google.com/forum/#!forum/nix-devel">nix-devel</literal>
    mailing list or on the <link
    xlink:href="irc://irc.freenode.net/#nixos">
    <literal>#nixos</literal> channel on Freenode</link>.  Bugs should
    be reported in <link
    xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’ GitHub
    issue tracker</link>.</para>

    <note><para>Commands prefixed with <literal>#</literal> have to be run as
    root, either requiring to login as root user or temporarily switching
    to it using <literal>sudo</literal> for example.</para></note>
  </preface>

  <xi:include href="installation/installation.xml" />
  <xi:include href="configuration/configuration.xml" />
  <xi:include href="administration/running.xml" />
  <!-- <xi:include href="userconfiguration.xml" /> -->
  <xi:include href="development/development.xml" />

  <appendix xml:id="ch-options">
    <title>Configuration Options</title>
    <xi:include href="options-db.xml" />
  </appendix>

  <xi:include href="release-notes/release-notes.xml" />

</book>
-												* Add a top-level book.
* Copy the stylesheet from the Nix manual.  We should really put this
  somewhere central.

svn path=/nixos/trunk/; revision=7766

											
										
										
											2007-01-23 11:11:58 +00:00
+								<book xmlns="http://docbook.org/ns/docbook"
-												* Manual.

svn path=/nixos/trunk/; revision=7868

											
										
										
											2007-02-06 21:14:02 +00:00
+								      xmlns:xlink="http://www.w3.org/1999/xlink"
-												Chunk NixOS manual

[Squashed commits to make git blame etc. more likely to work. -ED]

											
										
										
											2014-08-24 18:18:18 +01:00
+								      xmlns:xi="http://www.w3.org/2001/XInclude"
 								      version="5.0"
-												Manual: Reduce chunking

Fixes #7607.

											
										
										
											2015-07-22 15:09:00 +01:00
+								      xml:id="book-nixos-manual">
-												Manual: Explicitly mark commands that require to be run as root (#15589)

* manual: Mark commands that require root

Mark every command that requires to be run as root by prefixing them
with '#' instead of '$'.

* manual: Add note about commands that require root

											
										
										
											2016-06-01 15:23:32 +01:00
-												* Add a top-level book.
* Copy the stylesheet from the Nix manual.  We should really put this
  somewhere central.

svn path=/nixos/trunk/; revision=7766

											
										
										
											2007-01-23 11:11:58 +00:00
+								  <info>
 								    <title>NixOS Manual</title>
-												Include the NixOS version in the manual

In particular, this will make it clear what version of the manual is
shown at http://nixos.org/nixos/manual/.

											
										
										
											2013-11-01 15:44:03 +00:00
+								    <subtitle>Version <xi:include href="version" parse="text" /></subtitle>
-												* Add a top-level book.
* Copy the stylesheet from the Nix manual.  We should really put this
  somewhere central.

svn path=/nixos/trunk/; revision=7766

											
										
										
											2007-01-23 11:11:58 +00:00
+								  </info>
-												* Manual.

svn path=/nixos/trunk/; revision=7868

											
										
										
											2007-02-06 21:14:02 +00:00
+								  <preface>
 								    <title>Preface</title>
-												Manual: Remove "bleeding edge" remark

											
										
										
											2013-08-20 12:28:33 +01:00
+								    <para>This manual describes how to install, use and extend NixOS,
 								    a Linux distribution based on the purely functional package
 								    management system Nix.</para>
-												Add section on network configuration topics

											
										
										
											2013-01-07 23:35:27 +00:00
-												Manual: Remove "bleeding edge" remark

											
										
										
											2013-08-20 12:28:33 +01:00
+								    <para>If you encounter problems, please report them on the
-												* Fix some links.

svn path=/nixos/trunk/; revision=33910

											
										
										
											2012-04-24 16:19:24 +01:00
+								    <literal
-												Point to the new mailing list by replacing the old link

											
										
										
											2017-07-18 12:41:28 +01:00
+								    xlink:href="https://groups.google.com/forum/#!forum/nix-devel">nix-devel</literal>
-												Manual: Remove "bleeding edge" remark

											
										
										
											2013-08-20 12:28:33 +01:00
+								    mailing list or on the <link
 								    xlink:href="irc://irc.freenode.net/#nixos">
 								    <literal>#nixos</literal> channel on Freenode</link>.  Bugs should
 								    be reported in <link
-												Manual: Update installation section

											
										
										
											2013-10-21 09:46:24 +01:00
+								    xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’ GitHub
-												Manual: Remove "bleeding edge" remark

											
										
										
											2013-08-20 12:28:33 +01:00
+								    issue tracker</link>.</para>
-												Add section on network configuration topics

											
										
										
											2013-01-07 23:35:27 +00:00
-												fix manual

											
										
										
											2016-06-01 21:55:18 +01:00
+								    <note><para>Commands prefixed with <literal>#</literal> have to be run as
-												Manual: Explicitly mark commands that require to be run as root (#15589)

* manual: Mark commands that require root

Mark every command that requires to be run as root by prefixing them
with '#' instead of '$'.

* manual: Add note about commands that require root

											
										
										
											2016-06-01 15:23:32 +01:00
+								    root, either requiring to login as root user or temporarily switching
-												fix manual

											
										
										
											2016-06-01 21:55:18 +01:00
+								    to it using <literal>sudo</literal> for example.</para></note>
-												* Manual.

svn path=/nixos/trunk/; revision=7868

											
										
										
											2007-02-06 21:14:02 +00:00
+								  </preface>
-												Add section on network configuration topics

											
										
										
											2013-01-07 23:35:27 +00:00
-												Chunk NixOS manual

[Squashed commits to make git blame etc. more likely to work. -ED]

											
										
										
											2014-08-24 18:18:18 +01:00
+								  <xi:include href="installation/installation.xml" />
 								  <xi:include href="configuration/configuration.xml" />
 								  <xi:include href="administration/running.xml" />
-												* Comment out the "Configuration in home directory" chapter.
  Everything described in that chapter is a bug (e.g. needing to
  manually create symlinks) that properly belongs in the issue tracker
  or wiki, not in the manual.

svn path=/nixos/trunk/; revision=34085

											
										
										
											2012-05-14 05:01:47 +01:00
+								  <!-- <xi:include href="userconfiguration.xml" /> -->
-												nixos/manual: Re-add development section.

I think this has been accidentally dropped by a099ca4, at least there is
no reason stated, why it shouldn't be included, so I'm bringing it back.

Signed-off-by: aszlig <aszlig@redmoonstudios.org>

											
										
										
											2015-01-25 19:12:06 +00:00
+								  <xi:include href="development/development.xml" />
-												Start of 14.02 release notes

											
										
										
											2014-02-18 16:05:34 +00:00
 								  <appendix xml:id="ch-options">
-												Chunk NixOS manual

[Squashed commits to make git blame etc. more likely to work. -ED]

											
										
										
											2014-08-24 18:18:18 +01:00
+								    <title>Configuration Options</title>
-												* Generate a manual page for configuration.nix containing all the
  options.

svn path=/nixos/branches/modular-nixos/; revision=16358

											
										
										
											2009-07-14 16:47:03 +01:00
+								    <xi:include href="options-db.xml" />
-												Start of 14.02 release notes

											
										
										
											2014-02-18 16:05:34 +00:00
+								  </appendix>
-												* Add a top-level book.
* Copy the stylesheet from the Nix manual.  We should really put this
  somewhere central.

svn path=/nixos/trunk/; revision=7766

											
										
										
											2007-01-23 11:11:58 +00:00
-												Move release notes to an appendix and a separate chunk

											
										
										
											2015-07-22 15:17:06 +01:00
+								  <xi:include href="release-notes/release-notes.xml" />
-												Added user configuration chapter - currently about Compiz.

svn path=/nixos/trunk/; revision=9589

											
										
										
											2007-11-05 21:17:16 +00:00
+								</book>