<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/manual.xml - fork/home-manager @ master</title>
<meta name="description" content="docs/manual.xml in fork/home-manager at master.">
<meta property="og:title" content="docs/manual.xml - fork/home-manager @ master">
<meta property="og:description" content="docs/manual.xml in fork/home-manager at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="831b4fa31749208e576050c563e9773aafd04941">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/home-manager</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/home-manager</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Robert Helgesson</span><span class="commit-message" data-commit="75790441498b1ed64dca6511b28d99a7d170f645">Merge PR #4215</span><span class="snapshot-sha sha" data-commit="75790441498b1ed64dca6511b28d99a7d170f645">75790441</span><time datetime="2023-07-19T18:04:07+02:00" title="2023-07-19 18:04:07 +0200">2023-07-19</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/home-manager/ref/master/">master</a><a class="all" href="/fork/home-manager/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/home-manager/">home-manager</a> / <a href="/fork/home-manager/ref/master/tree/docs/">docs</a> / <span class="cur">manual.xml</span></nav>
<span class="view-stats"><span>2.2 KiB</span><span>57 lines</span></span><span class="actions"><a class="raw" href="/fork/home-manager/raw/af757caf87f80382e9f9caa090a23ed30d4a935c/docs/manual.xml">raw</a></span></header>
<pre class="code src language-xml"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>&lt;</a-p><a-tg>book</a-tg> <a-pr>xmlns</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>http://docbook.org/ns/docbook</a-s><a-p>&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">      <a-pr>xmlns:xlink</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>http://www.w3.org/1999/xlink</a-s><a-p>&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">      <a-pr>xmlns:xi</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>http://www.w3.org/2001/XInclude</a-s><a-p>&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">      <a-pr>version</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>5.0</a-s><a-p>&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">      <a-pr>xml:id</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>book-home-manager-manual</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>info</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>title</a-tg><a-p>&gt;</a-p>Home Manager Manual<a-p>&lt;/</a-p><a-tg>title</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"> <a-p>&lt;/</a-p><a-tg>info</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>preface</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>title</a-tg><a-p>&gt;</a-p>Preface<a-p>&lt;/</a-p><a-tg>title</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>para</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">   This manual will eventually describe how to install, use, and extend Home</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">   Manager.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">  <a-p>&lt;/</a-p><a-tg>para</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>para</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">   If you encounter problems then please reach out on the IRC channel</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">   <a-p>&lt;</a-p><a-tg>link</a-tg> <a-pr>xlink:href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>https://webchat.oftc.net/?channels=home-manager</a-s><a-p>&quot;&gt;</a-p>#home-manager<a-p>&lt;/</a-p><a-tg>link</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">   hosted by <a-p>&lt;</a-p><a-tg>link</a-tg> <a-pr>xlink:href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>https://oftc.net/</a-s><a-p>&quot;&gt;</a-p>OFTC<a-p>&lt;/</a-p><a-tg>link</a-tg><a-p>&gt;</a-p>.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">   There is also a <a-p>&lt;</a-p><a-tg>link</a-tg> <a-pr>xlink:href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>https://matrix.to/#/%23hm:rycee.net</a-s><a-p>&quot;&gt;</a-p>Matrix room<a-p>&lt;/</a-p><a-tg>link</a-tg><a-p>&gt;</a-p>,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">   which is bridged to the IRC channel.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">   If your problem is caused by a bug in Home Manager then it should</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">   be reported on the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">   <a-p>&lt;</a-p><a-tg>link</a-tg> <a-pr>xlink:href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>https://github.com/nix-community/home-manager/issues</a-s><a-p>&quot;&gt;</a-p>Home Manager issue tracker<a-p>&lt;/</a-p><a-tg>link</a-tg><a-p>&gt;</a-p>.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">  <a-p>&lt;/</a-p><a-tg>para</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>note</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">   <a-p>&lt;</a-p><a-tg>para</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">    Commands prefixed with <a-p>&lt;</a-p><a-tg>literal</a-tg><a-p>&gt;</a-p>$ sudo<a-p>&lt;/</a-p><a-tg>literal</a-tg><a-p>&gt;</a-p> have to be run as root, either</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">    requiring to login as root user or temporarily switching to it using</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">    <a-p>&lt;</a-p><a-tg>literal</a-tg><a-p>&gt;</a-p>sudo<a-p>&lt;/</a-p><a-tg>literal</a-tg><a-p>&gt;</a-p> for example.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">   <a-p>&lt;/</a-p><a-tg>para</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">  <a-p>&lt;/</a-p><a-tg>note</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"> <a-p>&lt;/</a-p><a-tg>preface</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>installation.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>usage.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>nix-flakes.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>writing-modules.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>contributing.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>3rd-party.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>faq.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>appendix</a-tg> <a-pr>xml:id</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>ch-options</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>title</a-tg><a-p>&gt;</a-p>Configuration Options<a-p>&lt;/</a-p><a-tg>title</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>./nmd-result/home-manager-options.xml</a-s><a-p>&quot;</a-p> <a-pr>xpointer</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>home-manager-options</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"> <a-p>&lt;/</a-p><a-tg>appendix</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>appendix</a-tg> <a-pr>xml:id</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>ch-nixos-options</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>title</a-tg><a-p>&gt;</a-p>NixOS Module Options<a-p>&lt;/</a-p><a-tg>title</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>./nmd-result/nixos-options.xml</a-s><a-p>&quot;</a-p> <a-pr>xpointer</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>nixos-options</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"> <a-p>&lt;/</a-p><a-tg>appendix</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>appendix</a-tg> <a-pr>xml:id</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>ch-nix-darwin-options</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>title</a-tg><a-p>&gt;</a-p>nix-darwin Module Options<a-p>&lt;/</a-p><a-tg>title</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>./nmd-result/nix-darwin-options.xml</a-s><a-p>&quot;</a-p> <a-pr>xpointer</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>nix-darwin-options</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"> <a-p>&lt;/</a-p><a-tg>appendix</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>appendix</a-tg> <a-pr>xml:id</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>ch-tools</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>title</a-tg><a-p>&gt;</a-p>Tools<a-p>&lt;/</a-p><a-tg>title</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">  <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>./man-home-manager.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"> <a-p>&lt;/</a-p><a-tg>appendix</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"> <a-p>&lt;</a-p><a-tg>xi:include</a-tg> <a-pr>href</a-pr><a-o>=</a-o><a-p>&quot;</a-p><a-s>./release-notes/release-notes.xml</a-s><a-p>&quot;</a-p> <a-p>/&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>book</a-tg><a-p>&gt;</a-p></span></span></pre>
</main>
</body>
</html>
