diff options
author | Robert Helgesson <robert@rycee.net> | 2018-05-06 22:14:50 +0200 |
---|---|---|
committer | Robert Helgesson <robert@rycee.net> | 2018-05-06 22:16:48 +0200 |
commit | 12603493848be0e22369ade385cf0ba3567673f8 (patch) | |
tree | 11e3e4243f5f5217edeeebf304d79e4f7f751d7c /doc/man-home-manager.xml | |
parent | 74f4ed5fd25e5c698e97807c567141cccdd1d033 (diff) |
doc: make documentation independent from NixOS
Unfortunately this duplicates some code from NixOS but it does allow
much more flexibility and, hopefully, stability in the Home Manager
documentation.
Fixes #254.
Diffstat (limited to 'doc/man-home-manager.xml')
-rw-r--r-- | doc/man-home-manager.xml | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/man-home-manager.xml b/doc/man-home-manager.xml new file mode 100644 index 00000000000..79ae5b45713 --- /dev/null +++ b/doc/man-home-manager.xml @@ -0,0 +1,62 @@ +<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>home-manager</command></refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="source">Home Manager</refmiscinfo> +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + + <refnamediv> + <refname><command>home-manager</command></refname> + <refpurpose>reconfigure a user environment</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>home-manager</command> + <group choice='req'> + <arg choice='plain'><option>help</option></arg> + <arg choice='plain'><option>build</option></arg> + <arg choice='plain'><option>switch</option></arg> + <arg choice='plain'><option>generations</option></arg> + <arg choice='plain'><option>remove-generations</option></arg> + <arg choice='plain'><option>packages</option></arg> + <arg choice='plain'><option>news</option></arg> + </group> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + <para> + This command updates the user environment so that it corresponds to the configuration + specified in <filename>~/.config/nixpkgs/home.nix</filename>. + </para> + </refsection> + + <refsection> + <title>Files</title> + <variablelist> + <varlistentry> + <term><filename>~/.local/share/home-manager/news-read-ids</filename></term> + <listitem> + <para> + Identifiers of news items that have been shown. Can be deleted + to reset the read news indicator. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Bugs</title> + <para> + Please report any bugs on the <link + xlink:href="https://github.com/rycee/home-manager/issues">project + issue tracker</link>. + </para> + </refsection> +</refentry> |