eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-14 15:19:45 +01:00
Code Issues Releases Wiki Activity
home-manager/docs/manual.xml

58 lines
2.2 KiB
XML
Raw Normal View History

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.
2018-05-06 22:14:50 +02:00
<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"
manual: some cleanups
2018-05-11 19:25:06 +02:00
xml:id="book-home-manager-manual">
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.
2018-05-06 22:14:50 +02:00
<info>
<title>Home Manager Manual</title>
</info>
<preface>
<title>Preface</title>
<para>
docs/manual: describes -> describe
2021-08-26 03:05:00 +02:00
This manual will eventually describe how to install, use, and extend Home
doc: reformat XML files
2019-01-20 18:01:22 +01:00
Manager.
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.
2018-05-06 22:14:50 +02:00
</para>
<para>
doc: include IRC channel in preface
2020-05-23 14:06:34 +02:00
If you encounter problems then please reach out on the IRC channel
docs: switch IRC to OFTC
2021-05-29 19:29:15 +02:00
<link xlink:href="https://webchat.oftc.net/?channels=home-manager">#home-manager</link>
hosted by <link xlink:href="https://oftc.net/">OFTC</link>.
docs: add link to Matrix room Fixes #2639
2022-01-16 18:42:31 +01:00
There is also a <link xlink:href="https://matrix.to/#/%23hm:rycee.net">Matrix room</link>,
which is bridged to the IRC channel.
doc: include IRC channel in preface
2020-05-23 14:06:34 +02:00
If your problem is caused by a bug in Home Manager then it should
be reported on the
tree-wide: update url to the repo
2020-10-19 21:20:37 +02:00
<link xlink:href="https://github.com/nix-community/home-manager/issues">Home Manager issue tracker</link>.
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.
2018-05-06 22:14:50 +02:00
</para>
<note>
<para>
docs: replace use of `#` by `$ sudo` The hope is that this makes it more obvious that these commands should be run as the root user.
2022-09-08 11:17:36 +02:00
Commands prefixed with <literal>$ sudo</literal> have to be run as root, either
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.
2018-05-06 22:14:50 +02:00
requiring to login as root user or temporarily switching to it using
<literal>sudo</literal> for example.
</para>
</note>
</preface>
doc: add installation instructions to manual Also minor cleanups in README.
2018-09-15 13:27:21 +02:00
<xi:include href="installation.xml" />
docs: move usage section to chapter in manual Also expand the chapter in various ways.
2021-11-14 00:12:54 +01:00
<xi:include href="usage.xml" />
docs: move Nix Flakes documentation to manual In the manual: * Add chapter Nix Flakes * Add links to sections of chapter "Using Home Manager" In README.md: * Remove section "Nix Flakes" * Add manual reference at the buttom of section "Installation"
2022-02-04 16:39:40 +01:00
<xi:include href="nix-flakes.xml" />
doc: document `dagOf` and `gvariant` types
2020-04-21 01:02:20 +02:00
<xi:include href="writing-modules.xml" />
doc: add chapter with contribution guidelines
2020-05-20 01:03:20 +02:00
<xi:include href="contributing.xml" />
docs: add chapter on 3rd-party extensions Fixes #3459
2022-12-08 22:55:41 +01:00
<xi:include href="3rd-party.xml" />
doc: move FAQ to manual This converts the FAQ into AsciiDoc and includes it in the HTML manual.
2020-05-07 00:16:51 +02:00
<xi:include href="faq.xml" />
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.
2018-05-06 22:14:50 +02:00
<appendix xml:id="ch-options">
<title>Configuration Options</title>
docs: use `nixosOptionsDoc` Output is mostly unchanged aside from some minor typographical and formatting changes, along with better source links. We temporarily export `options.docBookForMigration` to allow `nix-doc-munge` to check its conversions.
2023-06-28 23:55:00 +02:00
<xi:include href="./nmd-result/home-manager-options.xml" xpointer="home-manager-options" />
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.
2018-05-06 22:14:50 +02:00
</appendix>
docs: NixOS and nix-darwin option documentation
2021-01-18 23:21:32 +01:00
<appendix xml:id="ch-nixos-options">
<title>NixOS Module Options</title>
docs: use `nixosOptionsDoc` Output is mostly unchanged aside from some minor typographical and formatting changes, along with better source links. We temporarily export `options.docBookForMigration` to allow `nix-doc-munge` to check its conversions.
2023-06-28 23:55:00 +02:00
<xi:include href="./nmd-result/nixos-options.xml" xpointer="nixos-options" />
docs: NixOS and nix-darwin option documentation
2021-01-18 23:21:32 +01:00
</appendix>
<appendix xml:id="ch-nix-darwin-options">
<title>nix-darwin Module Options</title>
docs: use `nixosOptionsDoc` Output is mostly unchanged aside from some minor typographical and formatting changes, along with better source links. We temporarily export `options.docBookForMigration` to allow `nix-doc-munge` to check its conversions.
2023-06-28 23:55:00 +02:00
<xi:include href="./nmd-result/nix-darwin-options.xml" xpointer="nix-darwin-options" />
docs: NixOS and nix-darwin option documentation
2021-01-18 23:21:32 +01:00
</appendix>
home-manager: rewrite argument parsing This rewrite allows "long options" but unfortunately does not allow merged options such as `-vn`. Also improve the home-manager manual page, with this it should include all sub-commands and arguments. Finally, include the home-manager manual page in the generated HTML documentation.
2019-06-09 01:47:43 +02:00
<appendix xml:id="ch-tools">
<title>Tools</title>
<xi:include href="./man-home-manager.xml" />
</appendix>
doc: add basic release notes
2019-01-20 17:38:34 +01:00
<xi:include href="./release-notes/release-notes.xml" />
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.
2018-05-06 22:14:50 +02:00
</book>
Reference in a new issue Copy permalink