doc: reformat XML files

This commit is contained in:
Robert Helgesson 2019-01-20 18:01:22 +01:00
parent c035046999
commit f3f7c5cc57
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
5 changed files with 49 additions and 36 deletions

View file

@ -86,8 +86,8 @@ $ nix-channel --update
if you follow a Nixpkgs version 18.09 channel. if you follow a Nixpkgs version 18.09 channel.
</para> </para>
<para> <para>
On NixOS you may need to log out and back in for the channel to On NixOS you may need to log out and back in for the channel to become
become available. On non-NixOS you may have to add available. On non-NixOS you may have to add
<programlisting> <programlisting>
export NIX_PATH=$HOME/.nix-defexpr/channels${NIX_PATH:+:}$NIX_PATH export NIX_PATH=$HOME/.nix-defexpr/channels${NIX_PATH:+:}$NIX_PATH
</programlisting> </programlisting>

View file

@ -7,22 +7,19 @@
<refmiscinfo class="source">Home Manager</refmiscinfo> <refmiscinfo class="source">Home Manager</refmiscinfo>
<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname><filename>home-configuration.nix</filename></refname> <refname><filename>home-configuration.nix</filename></refname>
<refpurpose>Home Manager configuration specification</refpurpose> <refpurpose>Home Manager configuration specification</refpurpose>
</refnamediv> </refnamediv>
<refsection> <refsection>
<title>Description</title> <title>Description</title>
<para> <para>
The file <filename>~/.config/nixpkgs/home.nix</filename> contains The file <filename>~/.config/nixpkgs/home.nix</filename> contains the
the declarative specification of your Home Manager configuration. declarative specification of your Home Manager configuration. The command
The command <command>home-manager</command> takes this file and <command>home-manager</command> takes this file and realises the user
realises the user environment configuration specified therein. environment configuration specified therein.
</para> </para>
</refsection> </refsection>
<refsection> <refsection>
<title>Options</title> <title>Options</title>
<para> <para>

View file

@ -7,54 +7,71 @@
<refmiscinfo class="source">Home Manager</refmiscinfo> <refmiscinfo class="source">Home Manager</refmiscinfo>
<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname><command>home-manager</command></refname> <refname><command>home-manager</command></refname>
<refpurpose>reconfigure a user environment</refpurpose> <refpurpose>reconfigure a user environment</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>home-manager</command> <command>home-manager</command> <group choice="req">
<group choice='req'> <arg choice="plain">
<arg choice='plain'><option>help</option></arg> <option>help</option>
<arg choice='plain'><option>build</option></arg> </arg>
<arg choice='plain'><option>switch</option></arg>
<arg choice='plain'><option>generations</option></arg> <arg choice="plain">
<arg choice='plain'><option>remove-generations</option></arg> <option>build</option>
<arg choice='plain'><option>packages</option></arg> </arg>
<arg choice='plain'><option>news</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> </group>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsection> <refsection>
<title>Description</title> <title>Description</title>
<para> <para>
This command updates the user environment so that it corresponds to the configuration This command updates the user environment so that it corresponds to the
specified in <filename>~/.config/nixpkgs/home.nix</filename>. configuration specified in <filename>~/.config/nixpkgs/home.nix</filename>.
</para> </para>
</refsection> </refsection>
<refsection> <refsection>
<title>Files</title> <title>Files</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><filename>~/.local/share/home-manager/news-read-ids</filename></term> <term>
<filename>~/.local/share/home-manager/news-read-ids</filename>
</term>
<listitem> <listitem>
<para> <para>
Identifiers of news items that have been shown. Can be deleted Identifiers of news items that have been shown. Can be deleted to reset
to reset the read news indicator. the read news indicator.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsection> </refsection>
<refsection> <refsection>
<title>Bugs</title> <title>Bugs</title>
<para> <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 xlink:href="https://github.com/rycee/home-manager/issues">project
issue tracker</link>. issue tracker</link>.
</para> </para>

View file

@ -3,12 +3,10 @@
xmlns:xi="http://www.w3.org/2001/XInclude"> xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Home Manager Reference Pages</title> <title>Home Manager Reference Pages</title>
<info> <info>
<author> <author><personname>Home Manager contributors</personname>
<personname>Home Manager contributors</personname>
<contrib>Author</contrib> <contrib>Author</contrib>
</author> </author>
<copyright> <copyright><year>2017-2018</year><holder>Home Manager contributors</holder>
<year>2017-2018</year><holder>Home Manager contributors</holder>
</copyright> </copyright>
</info> </info>
<xi:include href="man-configuration.xml" /> <xi:include href="man-configuration.xml" />

View file

@ -9,12 +9,13 @@
<preface> <preface>
<title>Preface</title> <title>Preface</title>
<para> <para>
This manual will eventually describes how to install, use, and This manual will eventually describes how to install, use, and extend Home
extend Home Manager. Manager.
</para> </para>
<para> <para>
If you encounter problems or bugs then please report them on the 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> </para>
<note> <note>
<para> <para>