aboutsummaryrefslogtreecommitdiff
path: root/home-manager/doc/manual.xml
diff options
context:
space:
mode:
Diffstat (limited to 'home-manager/doc/manual.xml')
-rw-r--r--home-manager/doc/manual.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/home-manager/doc/manual.xml b/home-manager/doc/manual.xml
new file mode 100644
index 00000000000..8ff81308b2c
--- /dev/null
+++ b/home-manager/doc/manual.xml
@@ -0,0 +1,38 @@
+<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 or bugs then please report them on the
+ <link xlink:href="https://github.com/rycee/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" />
+ <appendix xml:id="ch-options">
+ <title>Configuration Options</title>
+ <xi:include href="./nmd-result/home-manager-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>