home-manager/doc/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-home-manager-manual">
 <info>
  <title>Home Manager Manual</title>
 </info>
 <preface>
  <title>Preface</title>
  <para>
   This manual will eventually describes how to install, use, and extend Home
   Manager.
  </para>
  <para>
   If you encounter problems then please reach out on the IRC channel
   <link xlink:href="https://webchat.oftc.net/?channels=home-manager">#home-manager</link>
   hosted by <link xlink:href="https://oftc.net/">OFTC</link>.
   If your problem is caused by a bug in Home Manager then it should
   be reported on the
   <link xlink:href="https://github.com/nix-community/home-manager/issues">Home Manager 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.xml" />
 <xi:include href="writing-modules.xml" />
 <xi:include href="contributing.xml" />
 <xi:include href="faq.xml" />
 <appendix xml:id="ch-options">
  <title>Configuration Options</title>
  <xi:include href="./nmd-result/home-manager-options.xml" />
 </appendix>
 <appendix xml:id="ch-nixos-options">
  <title>NixOS Module Options</title>
  <xi:include href="./nmd-result/nixos-options.xml" />
 </appendix>
 <appendix xml:id="ch-nix-darwin-options">
  <title>nix-darwin Module Options</title>
  <xi:include href="./nmd-result/nix-darwin-options.xml" />
 </appendix>
 <appendix xml:id="ch-tools">
  <title>Tools</title>
  <xi:include href="./man-home-manager.xml" />
 </appendix>
 <xi:include href="./release-notes/release-notes.xml" />
</book>