aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Helgesson <robert@rycee.net>2019-01-20 18:01:22 +0100
committerRobert Helgesson <robert@rycee.net>2019-01-20 18:01:22 +0100
commitf3f7c5cc57bb6b0e357fa076ea0a2416122687c8 (patch)
treed16be00e60246150b6dd0a37a2fe0b41f255a7a3 /doc
parentc03504699969127715dfc666f6aa00da74a94203 (diff)
doc: reformat XML files
Diffstat (limited to 'doc')
-rw-r--r--doc/installation.xml4
-rw-r--r--doc/man-configuration.xml11
-rw-r--r--doc/man-home-manager.xml57
-rw-r--r--doc/man-pages.xml6
-rw-r--r--doc/manual.xml7
5 files changed, 49 insertions, 36 deletions
diff --git a/doc/installation.xml b/doc/installation.xml
index ea3c49fa40b..ab24e8a472c 100644
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -86,8 +86,8 @@ $ nix-channel --update
if you follow a Nixpkgs version 18.09 channel.
</para>
<para>
- On NixOS you may need to log out and back in for the channel to
- become available. On non-NixOS you may have to add
+ On NixOS you may need to log out and back in for the channel to become
+ available. On non-NixOS you may have to add
<programlisting>
export NIX_PATH=$HOME/.nix-defexpr/channels${NIX_PATH:+:}$NIX_PATH
</programlisting>
diff --git a/doc/man-configuration.xml b/doc/man-configuration.xml
index c36cf619d33..835ba3213da 100644
--- a/doc/man-configuration.xml
+++ b/doc/man-configuration.xml
@@ -7,22 +7,19 @@
<refmiscinfo class="source">Home Manager</refmiscinfo>
<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
</refmeta>
-
<refnamediv>
<refname><filename>home-configuration.nix</filename></refname>
<refpurpose>Home Manager configuration specification</refpurpose>
</refnamediv>
-
<refsection>
<title>Description</title>
<para>
- The file <filename>~/.config/nixpkgs/home.nix</filename> contains
- the declarative specification of your Home Manager configuration.
- The command <command>home-manager</command> takes this file and
- realises the user environment configuration specified therein.
+ The file <filename>~/.config/nixpkgs/home.nix</filename> contains the
+ declarative specification of your Home Manager configuration. The command
+ <command>home-manager</command> takes this file and realises the user
+ environment configuration specified therein.
</para>
</refsection>
-
<refsection>
<title>Options</title>
<para>
diff --git a/doc/man-home-manager.xml b/doc/man-home-manager.xml
index 79ae5b45713..093c3ae1a0c 100644
--- a/doc/man-home-manager.xml
+++ b/doc/man-home-manager.xml
@@ -7,54 +7,71 @@
<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>
+ <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>.
+ 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>
+ <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.
+ 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
+ Please report any bugs on the
+ <link
xlink:href="https://github.com/rycee/home-manager/issues">project
issue tracker</link>.
</para>
diff --git a/doc/man-pages.xml b/doc/man-pages.xml
index b94b01413b2..5c2d73c9b2b 100644
--- a/doc/man-pages.xml
+++ b/doc/man-pages.xml
@@ -3,12 +3,10 @@
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Home Manager Reference Pages</title>
<info>
- <author>
- <personname>Home Manager contributors</personname>
+ <author><personname>Home Manager contributors</personname>
<contrib>Author</contrib>
</author>
- <copyright>
- <year>2017-2018</year><holder>Home Manager contributors</holder>
+ <copyright><year>2017-2018</year><holder>Home Manager contributors</holder>
</copyright>
</info>
<xi:include href="man-configuration.xml" />
diff --git a/doc/manual.xml b/doc/manual.xml
index 4eef9892364..c4493254b7c 100644
--- a/doc/manual.xml
+++ b/doc/manual.xml
@@ -9,12 +9,13 @@
<preface>
<title>Preface</title>
<para>
- This manual will eventually describes how to install, use, and
- extend Home Manager.
+ 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>.
+ <link xlink:href="https://github.com/rycee/home-manager/issues">Home Manager
+ issue tracker</link>.
</para>
<note>
<para>