commit 0a70ea5e69f4027fba3016ca42e184f4062eace8 · pyrox.dev/nixpkgs

nixos/modules/programs/digitalbitbox/default.nix

···

       33
        
         };

     

       34
        
       

     

       35
        
         meta = {

     

       0
        
       
     

       0
        
       
     

       36
        
           doc = ./doc.xml;

     

       37
        
           maintainers = with lib.maintainers; [ vidbina ];

     

       38
        
         };

···

       33
        
         };

     

       34
        
       

     

       35
        
         meta = {

     

       36
       +
           # Don't edit the docbook xml directly, edit the md and generate it:

     

       37
       +
           # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart > doc.xml`

     

       38
        
           doc = ./doc.xml;

     

       39
        
           maintainers = with lib.maintainers; [ vidbina ];

     

       40
        
         };

+47

nixos/modules/programs/digitalbitbox/doc.md

···

       1
       +
       # Digital Bitbox {#module-programs-digitalbitbox}

     

       2
       +
       

     

       3
       +
       Digital Bitbox is a hardware wallet and second-factor authenticator.

     

       4
       +
       

     

       5
       +
       The `digitalbitbox` programs module may be installed by setting

     

       6
       +
       `programs.digitalbitbox` to `true` in a manner similar to

     

       7
       +
       ```

     

       8
       +
       programs.digitalbitbox.enable = true;

     

       9
       +
       ```

     

       10
       +
       and bundles the `digitalbitbox` package (see [](#sec-digitalbitbox-package)),

     

       11
       +
       which contains the `dbb-app` and `dbb-cli` binaries, along with the hardware

     

       12
       +
       module (see [](#sec-digitalbitbox-hardware-module)) which sets up the necessary

     

       13
       +
       udev rules to access the device.

     

       14
       +
       

     

       15
       +
       Enabling the digitalbitbox module is pretty much the easiest way to get a

     

       16
       +
       Digital Bitbox device working on your system.

     

       17
       +
       

     

       18
       +
       For more information, see <https://digitalbitbox.com/start_linux>.

     

       19
       +
       

     

       20
       +
       ## Package {#sec-digitalbitbox-package}

     

       21
       +
       

     

       22
       +
       The binaries, `dbb-app` (a GUI tool) and `dbb-cli` (a CLI tool), are available

     

       23
       +
       through the `digitalbitbox` package which could be installed as follows:

     

       24
       +
       ```

     

       25
       +
       environment.systemPackages = [

     

       26
       +
         pkgs.digitalbitbox

     

       27
       +
       ];

     

       28
       +
       ```

     

       29
       +
       

     

       30
       +
       ## Hardware {#sec-digitalbitbox-hardware-module}

     

       31
       +
       

     

       32
       +
       The digitalbitbox hardware package enables the udev rules for Digital Bitbox

     

       33
       +
       devices and may be installed as follows:

     

       34
       +
       ```

     

       35
       +
       hardware.digitalbitbox.enable = true;

     

       36
       +
       ```

     

       37
       +
       

     

       38
       +
       In order to alter the udev rules, one may provide different values for the

     

       39
       +
       `udevRule51` and `udevRule52` attributes by means of overriding as follows:

     

       40
       +
       ```

     

       41
       +
       programs.digitalbitbox = {

     

       42
       +
         enable = true;

     

       43
       +
         package = pkgs.digitalbitbox.override {

     

       44
       +
           udevRule51 = "something else";

     

       45
       +
         };

     

       46
       +
       };

     

       47
       +
       ```

+52 -58

nixos/modules/programs/digitalbitbox/doc.xml

···

       1
       -
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       -
                version="5.0"

     

       5
       -
                xml:id="module-programs-digitalbitbox">

     

       6
       -
        <title>Digital Bitbox</title>

     

       7
       -
        <para>

     

       8
       -
         Digital Bitbox is a hardware wallet and second-factor authenticator.

     

       9
       -
        </para>

     

       10
       -
        <para>

     

       11
       -
         The <literal>digitalbitbox</literal> programs module may be installed by

     

       12
       -
         setting <literal>programs.digitalbitbox</literal> to <literal>true</literal>

     

       13
       -
         in a manner similar to

     

       14
       -
       <programlisting>

     

       15
        
       programs.digitalbitbox.enable = true;

     

       16
        
       </programlisting>

     

       17
       -
         and bundles the <literal>digitalbitbox</literal> package (see

     

       18
       -
         <xref

     

       19
       -
             linkend="sec-digitalbitbox-package" />), which contains the

     

       20
       -
         <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries, along

     

       21
       -
         with the hardware module (see

     

       22
       -
         <xref

     

       23
       -
             linkend="sec-digitalbitbox-hardware-module" />) which sets up the

     

       24
       -
         necessary udev rules to access the device.

     

       25
       -
        </para>

     

       26
       -
        <para>

     

       27
       -
         Enabling the digitalbitbox module is pretty much the easiest way to get a

     

       28
       -
         Digital Bitbox device working on your system.

     

       29
       -
        </para>

     

       30
       -
        <para>

     

       31
       -
         For more information, see

     

       32
       -
         <link xlink:href="https://digitalbitbox.com/start_linux" />.

     

       33
       -
        </para>

     

       34
       -
        <section xml:id="sec-digitalbitbox-package">

     

       35
       -
         <title>Package</title>

     

       36
       -
       

     

       37
        
         <para>

     

       38
       -
          The binaries, <literal>dbb-app</literal> (a GUI tool) and

     

       39
       -
          <literal>dbb-cli</literal> (a CLI tool), are available through the

     

       40
       -
          <literal>digitalbitbox</literal> package which could be installed as

     

       41
       -
          follows:

     

       42
       -
       <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       43
        
       environment.systemPackages = [

     

       44
        
         pkgs.digitalbitbox

     

       45
        
       ];

     

       46
        
       </programlisting>

     

       47
       -
         </para>

     

       48
       -
        </section>

     

       49
       -
        <section xml:id="sec-digitalbitbox-hardware-module">

     

       50
       -
         <title>Hardware</title>

     

       51
       -
       

     

       52
       -
         <para>

     

       53
       -
          The digitalbitbox hardware package enables the udev rules for Digital Bitbox

     

       54
       -
          devices and may be installed as follows:

     

       55
       -
       <programlisting>

     

       56
        
       hardware.digitalbitbox.enable = true;

     

       57
        
       </programlisting>

     

       58
       -
         </para>

     

       59
       -
       

     

       60
       -
         <para>

     

       61
       -
          In order to alter the udev rules, one may provide different values for the

     

       62
       -
          <literal>udevRule51</literal> and <literal>udevRule52</literal> attributes

     

       63
       -
          by means of overriding as follows:

     

       64
       -
       <programlisting>

     

       65
        
       programs.digitalbitbox = {

     

       66
        
         enable = true;

     

       67
        
         package = pkgs.digitalbitbox.override {

     

       68
       -
           udevRule51 = "something else";

     

       69
        
         };

     

       70
        
       };

     

       71
        
       </programlisting>

     

       72
       -
         </para>

     

       73
       -
        </section>

     

       74
        
       </chapter>

···

       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-programs-digitalbitbox">

     

       2
       +
         <title>Digital Bitbox</title>

     

       3
       +
         <para>

     

       4
       +
           Digital Bitbox is a hardware wallet and second-factor authenticator.

     

       5
       +
         </para>

     

       6
       +
         <para>

     

       7
       +
           The <literal>digitalbitbox</literal> programs module may be

     

       8
       +
           installed by setting <literal>programs.digitalbitbox</literal> to

     

       9
       +
           <literal>true</literal> in a manner similar to

     

       10
       +
         </para>

     

       11
       +
         <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       12
        
       programs.digitalbitbox.enable = true;

     

       13
        
       </programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       14
        
         <para>

     

       15
       +
           and bundles the <literal>digitalbitbox</literal> package (see

     

       16
       +
           <xref linkend="sec-digitalbitbox-package"></xref>), which contains

     

       17
       +
           the <literal>dbb-app</literal> and <literal>dbb-cli</literal>

     

       18
       +
           binaries, along with the hardware module (see

     

       19
       +
           <xref linkend="sec-digitalbitbox-hardware-module"></xref>) which

     

       20
       +
           sets up the necessary udev rules to access the device.

     

       21
       +
         </para>

     

       22
       +
         <para>

     

       23
       +
           Enabling the digitalbitbox module is pretty much the easiest way to

     

       24
       +
           get a Digital Bitbox device working on your system.

     

       25
       +
         </para>

     

       26
       +
         <para>

     

       27
       +
           For more information, see

     

       28
       +
           <link xlink:href="https://digitalbitbox.com/start_linux" role="uri">https://digitalbitbox.com/start_linux</link>.

     

       29
       +
         </para>

     

       30
       +
         <section xml:id="sec-digitalbitbox-package">

     

       31
       +
           <title>Package</title>

     

       32
       +
           <para>

     

       33
       +
             The binaries, <literal>dbb-app</literal> (a GUI tool) and

     

       34
       +
             <literal>dbb-cli</literal> (a CLI tool), are available through the

     

       35
       +
             <literal>digitalbitbox</literal> package which could be installed

     

       36
       +
             as follows:

     

       37
       +
           </para>

     

       38
       +
           <programlisting>

     

       39
        
       environment.systemPackages = [

     

       40
        
         pkgs.digitalbitbox

     

       41
        
       ];

     

       42
        
       </programlisting>

     

       43
       +
         </section>

     

       44
       +
         <section xml:id="sec-digitalbitbox-hardware-module">

     

       45
       +
           <title>Hardware</title>

     

       46
       +
           <para>

     

       47
       +
             The digitalbitbox hardware package enables the udev rules for

     

       48
       +
             Digital Bitbox devices and may be installed as follows:

     

       49
       +
           </para>

     

       50
       +
           <programlisting>

     

       0
        
       
     

       51
        
       hardware.digitalbitbox.enable = true;

     

       52
        
       </programlisting>

     

       53
       +
           <para>

     

       54
       +
             In order to alter the udev rules, one may provide different values

     

       55
       +
             for the <literal>udevRule51</literal> and

     

       56
       +
             <literal>udevRule52</literal> attributes by means of overriding as

     

       57
       +
             follows:

     

       58
       +
           </para>

     

       59
       +
           <programlisting>

     

       60
        
       programs.digitalbitbox = {

     

       61
        
         enable = true;

     

       62
        
         package = pkgs.digitalbitbox.override {

     

       63
       +
           udevRule51 = &quot;something else&quot;;

     

       64
        
         };

     

       65
        
       };

     

       66
        
       </programlisting>

     

       67
       +
         </section>

     

       0
        
       
     

       68
        
       </chapter>