diff options
author | pennae <github@quasiparticle.net> | 2023-01-25 00:33:40 +0100 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2023-01-27 20:07:34 +0100 |
commit | 0a6e6cf7e698a6a08a62d8863e2c66b36d5db0d9 (patch) | |
tree | 6e28cb9ba90a3d03d6efab999b958527af45f84c /nixos/modules/programs/digitalbitbox/default.xml | |
parent | 8b8670db100efed03a979f7ec24c353f72c0bdbd (diff) |
nixos/manual: render module chapters with nixos-render-docs
this converts meta.doc into an md pointer, not an xml pointer. since we no longer need xml for manual chapters we can also remove support for manual chapters from md-to-db.sh since pandoc converts smart quotes to docbook quote elements and our nixos-render-docs does not we lose this distinction in the rendered output. that's probably not that bad, our stylesheet didn't make use of this anyway (and pre-23.05 versions of the chapters didn't use quote elements either). also updates the nixpkgs manual to clarify that option docs support all extensions (although it doesn't support headings at all, so heading anchors don't work by extension).
Diffstat (limited to 'nixos/modules/programs/digitalbitbox/default.xml')
-rw-r--r-- | nixos/modules/programs/digitalbitbox/default.xml | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/nixos/modules/programs/digitalbitbox/default.xml b/nixos/modules/programs/digitalbitbox/default.xml deleted file mode 100644 index ee892523223c8..0000000000000 --- a/nixos/modules/programs/digitalbitbox/default.xml +++ /dev/null @@ -1,70 +0,0 @@ -<!-- Do not edit this file directly, edit its companion .md instead - and regenerate this file using nixos/doc/manual/md-to-db.sh --> -<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-programs-digitalbitbox"> - <title>Digital Bitbox</title> - <para> - Digital Bitbox is a hardware wallet and second-factor authenticator. - </para> - <para> - The <literal>digitalbitbox</literal> programs module may be - installed by setting <literal>programs.digitalbitbox</literal> to - <literal>true</literal> in a manner similar to - </para> - <programlisting> -programs.digitalbitbox.enable = true; -</programlisting> - <para> - and bundles the <literal>digitalbitbox</literal> package (see - <xref linkend="sec-digitalbitbox-package" />), which contains the - <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries, - along with the hardware module (see - <xref linkend="sec-digitalbitbox-hardware-module" />) which sets up - the necessary udev rules to access the device. - </para> - <para> - Enabling the digitalbitbox module is pretty much the easiest way to - get a Digital Bitbox device working on your system. - </para> - <para> - For more information, see - <link xlink:href="https://digitalbitbox.com/start_linux">https://digitalbitbox.com/start_linux</link>. - </para> - <section xml:id="sec-digitalbitbox-package"> - <title>Package</title> - <para> - The binaries, <literal>dbb-app</literal> (a GUI tool) and - <literal>dbb-cli</literal> (a CLI tool), are available through the - <literal>digitalbitbox</literal> package which could be installed - as follows: - </para> - <programlisting> -environment.systemPackages = [ - pkgs.digitalbitbox -]; -</programlisting> - </section> - <section xml:id="sec-digitalbitbox-hardware-module"> - <title>Hardware</title> - <para> - The digitalbitbox hardware package enables the udev rules for - Digital Bitbox devices and may be installed as follows: - </para> - <programlisting> -hardware.digitalbitbox.enable = true; -</programlisting> - <para> - In order to alter the udev rules, one may provide different values - for the <literal>udevRule51</literal> and - <literal>udevRule52</literal> attributes by means of overriding as - follows: - </para> - <programlisting> -programs.digitalbitbox = { - enable = true; - package = pkgs.digitalbitbox.override { - udevRule51 = "something else"; - }; -}; -</programlisting> - </section> -</chapter> |