eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-06-28 09:28:32 +02:00
Code Issues Releases Wiki Activity

treewide: convert options with lists to Markdown

Browse Source 
`nix-doc-munge` can't handle these, which is understandable as I can
barely handle them either. There are a few infelicities here: the
current processor can't handle multiple terms to one description in
a description list so they get comma-separated in one case, and one
case that should ideally render as a `<figure>` with a `<figcaption>`
in HTML is reduced to a paragraph with some `<strong>` text. (Which, in
fairness, is how it rendered in practice with the DocBook anyway.) The
docs generator has since been updated to handle figures, but we can't
use it until moving off DocBook output.
This commit is contained in:
Emily 2023-07-01 01:40:42 +01:00
parent 9e4a73c25e
commit 21c700d14b
13 changed files with 341 additions and 531 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
modules/i18n/input-method/default.nix
View File

@ -31,47 +31,33 @@ in {
(types.enum [ "fcitx" "fcitx5" "nabi" "uim" "hime" "kime" ]); (types.enum [ "fcitx" "fcitx5" "nabi" "uim" "hime" "kime" ]);
default = null; default = null;
example = "fcitx5"; example = "fcitx5";
description = '' description = lib.mdDoc ''
Select the enabled input method. Input methods is a software to input Select the enabled input method. Input methods are software to input
symbols that are not available on standard input devices. symbols that are not available on standard input devices.
</para><para>
Input methods are specially used to input Chinese, Japanese and Korean Input methods are especially used to input Chinese, Japanese and
characters. Korean characters.
</para><para>
Currently the following input methods are available in Home Manager: Currently the following input methods are available in Home Manager:
<variablelist> `fcitx5`
<varlistentry> : A customizable lightweight input method.
<term><literal>fcitx5</literal></term> The next generation of fcitx.
<listitem><para> Addons (including engines, dictionaries, skins) can be added using
A customizable lightweight input method. [](#opt-i18n.inputMethod.fcitx5.addons).
The next generation of fcitx,
addons (including engines, dictionaries, skins) can be added using `nabi`
<literal>i18n.inputMethod.fcitx5.addons</literal>. : A Korean input method based on XIM. Nabi doesn't support Qt 5.
</para></listitem>
</varlistentry> `uim`
<varlistentry> : The "universal input method" is a library with an XIM bridge.
<term><literal>nabi</literal></term> uim mainly supports Chinese, Japanese and Korean.
<listitem><para>
A Korean input method based on XIM. Nabi doesn't support Qt 5. `hime`
</para></listitem> : An extremely easy-to-use input method framework.
</varlistentry>
<varlistentry> `kime`
<term><literal>uim</literal></term> : A Korean IME.
<listitem><para>
The universal input method, is a library with a XIM bridge.
uim mainly support Chinese, Japanese and Korean.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>hime</literal></term>
<listitem><para>An extremely easy-to-use input method framework.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>kime</literal></term>
<listitem><para>A Korean IME.</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };

51
modules/misc/news.nix
View File

@ -57,46 +57,25 @@ in
display = mkOption { display = mkOption {
type = types.enum [ "silent" "notify" "show" ]; type = types.enum [ "silent" "notify" "show" ];
default = "notify"; default = "notify";
description = '' description = lib.mdDoc ''
How unread and relevant news should be presented when How unread and relevant news should be presented when
running <command>home-manager build</command> and running {command}`home-manager build` and
<command>home-manager switch</command>. {command}`home-manager switch`.
</para><para>
The options are The options are
<variablelist> `silent`
<varlistentry> : Do not print anything during build or switch. The
<term><literal>silent</literal></term> {command}`home-manager news` command still
<listitem> works for viewing the entries.
<para>
Do not print anything during build or switch. The `notify`
<command>home-manager news</command> command still : The number of unread and relevant news entries will be
works for viewing the entries. printed to standard output. The {command}`home-manager
</para> news` command can later be used to view the entries.
</listitem>
</varlistentry> `show`
<varlistentry> : A pager showing unread news entries is opened.
<term><literal>notify</literal></term>
<listitem>
<para>
The number of unread and relevant news entries will be
printed to standard output. The <command>home-manager
news</command> command can later be used to view the
entries.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>show</literal></term>
<listitem>
<para>
A pager showing unread news entries is opened.
</para>
</listitem>
</varlistentry>
</variablelist>
''; '';
}; };

107
modules/misc/qt.nix
View File

@ -55,35 +55,27 @@ in {
[ "libsForQt5" "plasma-integration" ] [ "libsForQt5" "plasma-integration" ]
[ "libsForQt5" "systemsettings" ] [ "libsForQt5" "systemsettings" ]
]; ];
description = '' description = lib.mdDoc ''
Platform theme to use for Qt applications.</para> Platform theme to use for Qt applications.
<para>The options are
<variablelist> The options are
<varlistentry>
<term><literal>gtk</literal></term> `gtk`
<listitem><para>Use GTK theme with : Use GTK theme with
<link xlink:href="https://github.com/qt/qtstyleplugins">qtstyleplugins</link> [`qtstyleplugins`](https://github.com/qt/qtstyleplugins)
</para></listitem>
</varlistentry> `gnome`
<varlistentry> : Use GNOME theme with
<term><literal>gnome</literal></term> [`qgnomeplatform`](https://github.com/FedoraQt/QGnomePlatform)
<listitem><para>Use GNOME theme with
<link xlink:href="https://github.com/FedoraQt/QGnomePlatform">qgnomeplatform</link> `qtct`
</para></listitem> : Use Qt style set using
</varlistentry> [`qt5ct`](https://github.com/desktop-app/qt5ct)
<varlistentry> and [`qt6ct`](https://github.com/trialuser02/qt6ct)
<term><literal>qtct</literal></term> applications
<listitem><para>Use Qt style set using
<link xlink:href="https://github.com/desktop-app/qt5ct">qt5ct</link> `kde`
and : Use Qt settings from Plasma
<link xlink:href="https://github.com/trialuser02/qt6ct">qt6ct</link>
applications</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>kde</literal></term>
<listitem><para>Use Qt settings from Plasma</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
@ -100,45 +92,26 @@ in {
[ "libsForQt5" "qtstyleplugin-kvantum" ] [ "libsForQt5" "qtstyleplugin-kvantum" ]
[ "qt6Packages" "qtstyleplugin-kvantum" ] [ "qt6Packages" "qtstyleplugin-kvantum" ]
]; ];
description = '' description = lib.mdDoc ''
Style to use for Qt5/Qt6 applications. Case-insensitive. Style to use for Qt5/Qt6 applications. Case-insensitive.
</para>
<para>Some examples are Some examples are
<variablelist>
<varlistentry> `adwaita`, `adwaita-dark`, `adwaita-highcontrast`, `adwaita-highcontrastinverse`
<term><literal>adwaita</literal></term> : Use the Adwaita style from
<term><literal>adwaita-dark</literal></term> [`adwaita-qt`](https://github.com/FedoraQt/adwaita-qt)
<term><literal>adwaita-highcontrast</literal></term>
<term><literal>adwaita-highcontrastinverse</literal></term> `breeze`
<listitem><para>Use the Adwaita style from : Use the Breeze style from
<link xlink:href="https://github.com/FedoraQt/adwaita-qt">adwaita</link> [`breeze`](https://github.com/KDE/breeze)
</para></listitem>
</varlistentry> `bb10bright`, `bb10dark`, `cde`, `cleanlooks`, `gtk2`, `motif`, `plastique`
<varlistentry> : Use styles from
<term><literal>breeze</literal></term> [`qtstyleplugins`](https://github.com/qt/qtstyleplugins)
<listitem><para>Use the Breeze style from
<link xlink:href="https://github.com/KDE/breeze">breeze</link> `kvantum`
</para></listitem> : Use styles from
</varlistentry> [`kvantum`](https://github.com/tsujan/Kvantum)
<varlistentry>
<term><literal>bb10bright</literal></term>
<term><literal>bb10dark</literal></term>
<term><literal>cde</literal></term>
<term><literal>cleanlooks</literal></term>
<term><literal>gtk2</literal></term>
<term><literal>motif</literal></term>
<term><literal>plastique</literal></term>
<listitem><para>Use styles from
<link xlink:href="https://github.com/qt/qtstyleplugins">qtstyleplugins</link>
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>kvantum</literal></term>
<listitem><para>Use styles from
<link xlink:href="https://github.com/tsujan/Kvantum">kvantum</link>
</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };

23
modules/programs/astroid.nix
View File

@ -79,15 +79,20 @@ in {
}; };
example = example =
"nvim-qt -- -c 'set ft=mail' '+set fileencoding=utf-8' '+set ff=unix' '+set enc=utf-8' '+set fo+=w' %1"; "nvim-qt -- -c 'set ft=mail' '+set fileencoding=utf-8' '+set ff=unix' '+set enc=utf-8' '+set fo+=w' %1";
description = '' description = lib.mdDoc ''
You can use <code>%1</code>, <code>%2</code>, and You can use the following variables:
<code>%3</code> to refer respectively to:
<orderedlist numeration="arabic"> `%1`
<listitem><para>file name</para></listitem> : file name
<listitem><para>server name</para></listitem>
<listitem><para>socket ID</para></listitem> `%2`
</orderedlist> : server name
See <link xlink:href='https://github.com/astroidmail/astroid/wiki/Customizing-editor' />.
`%3`
: socket ID
See [Customizing editor](https://github.com/astroidmail/astroid/wiki/Customizing-editor)
on the Astroid wiki.
''; '';
}; };

114
modules/programs/broot.nix
View File

@ -30,44 +30,33 @@ let
} }
] ]
''; '';
description = '' description = lib.mdDoc ''
Define new verbs. For more information, see Define new verbs. For more information, see
<link xlink:href="https://dystroy.org/broot/documentation/configuration/#verb-definition-attributes"/>. [Verb Definition Attributes](https://dystroy.org/broot/documentation/configuration/#verb-definition-attributes)
</para><para> in the broot documentation.
The possible attributes are:
</para>
<para> The possible attributes are:
<variablelist>
<varlistentry> `invocation` (optional)
<term><literal>invocation</literal> (optional)</term> : how the verb is called by the user, with placeholders for arguments
<listitem><para>how the verb is called by the user, with placeholders for arguments</para></listitem>
</varlistentry> `execution` (mandatory)
<varlistentry> : how the verb is executed
<term><literal>execution</literal> (mandatory)</term>
<listitem><para>how the verb is executed</para></listitem> `key` (optional)
</varlistentry> : a keyboard key triggering execution
<varlistentry>
<term><literal>key</literal> (optional)</term> `shortcut` (optional)
<listitem><para>a keyboard key triggering execution</para></listitem> : an alternate way to call the verb (without
</varlistentry> the arguments part)
<varlistentry>
<term><literal>shortcut</literal> (optional)</term> `leave_broot` (optional)
<listitem><para>an alternate way to call the verb (without : whether to quit broot on execution
the arguments part)</para></listitem> (default: `true`)
</varlistentry>
<varlistentry> `from_shell` (optional)</term>
<term><literal>leave_broot</literal> (optional)</term> : whether the verb must be executed from the
<listitem><para>whether to quit broot on execution parent shell (default: `false`)
(default: <literal>true</literal>)</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>from_shell</literal> (optional)</term>
<listitem><para>whether the verb must be executed from the
parent shell (default:
<literal>false</literal>)</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
@ -92,38 +81,35 @@ let
code_fg = "lightyellow"; code_fg = "lightyellow";
} }
''; '';
description = '' description = lib.mdDoc ''
Color configuration. Color configuration.
</para><para>
Complete list of keys (expected to change before the v1 of broot): Complete list of keys (expected to change before the v1 of broot):
<itemizedlist> * `char_match`
<listitem><para><literal>char_match</literal></para></listitem> * `code`
<listitem><para><literal>code</literal></para></listitem> * `directory`
<listitem><para><literal>directory</literal></para></listitem> * `exe`
<listitem><para><literal>exe</literal></para></listitem> * `file`
<listitem><para><literal>file</literal></para></listitem> * `file_error`
<listitem><para><literal>file_error</literal></para></listitem> * `flag_label`
<listitem><para><literal>flag_label</literal></para></listitem> * `flag_value`
<listitem><para><literal>flag_value</literal></para></listitem> * `input`
<listitem><para><literal>input</literal></para></listitem> * `link`
<listitem><para><literal>link</literal></para></listitem> * `permissions`
<listitem><para><literal>permissions</literal></para></listitem> * `selected_line`
<listitem><para><literal>selected_line</literal></para></listitem> * `size_bar_full`
<listitem><para><literal>size_bar_full</literal></para></listitem> * `size_bar_void`
<listitem><para><literal>size_bar_void</literal></para></listitem> * `size_text`
<listitem><para><literal>size_text</literal></para></listitem> * `spinner`
<listitem><para><literal>spinner</literal></para></listitem> * `status_error`
<listitem><para><literal>status_error</literal></para></listitem> * `status_normal`
<listitem><para><literal>status_normal</literal></para></listitem> * `table_border`
<listitem><para><literal>table_border</literal></para></listitem> * `tree`
<listitem><para><literal>tree</literal></para></listitem> * `unlisted`
<listitem><para><literal>unlisted</literal></para></listitem>
</itemizedlist></para>
<para> Add `_fg` for a foreground color and
Add <literal>_fg</literal> for a foreground color and `_bg` for a background color.
<literal>_bg</literal> for a background colors.
''; '';
}; };
}; };

100
modules/programs/gnome-terminal.nix
View File

@ -148,42 +148,24 @@ let
backspaceBinding = mkOption { backspaceBinding = mkOption {
default = "ascii-delete"; default = "ascii-delete";
type = eraseBinding; type = eraseBinding;
description = '' description = lib.mdDoc ''
Which string the terminal should send to an application when the user Which string the terminal should send to an application when the user
presses the <emphasis>Backspace</emphasis> key. presses the *Backspace* key.
<variablelist> `auto`
<varlistentry> : Attempt to determine the right value from the terminal's IO settings.
<term><literal>auto</literal></term>
<listitem><para> `ascii-backspace`
Attempt to determine the right value from the terminal's IO settings. : Send an ASCII backspace character (`0x08`).
</para></listitem>
</varlistentry> `ascii-delete`
<varlistentry> : Send an ASCII delete character (`0x7F`).
<term><literal>ascii-backspace</literal></term>
<listitem><para> `delete-sequence`
Send an ASCII backspace character (0x08). : Send the `@7` control sequence.
</para></listitem>
</varlistentry> `tty`
<varlistentry> : Send terminal's "erase" setting.
<term><literal>ascii-delete</literal></term>
<listitem><para>
Send an ASCII delete character (0x7F).
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>delete-sequence</literal></term>
<listitem><para>
Send the <quote>@7</quote> control sequence.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>tty</literal></term>
<listitem><para>
Send terminal’s <quote>erase</quote> setting.
</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
@ -196,42 +178,24 @@ let
deleteBinding = mkOption { deleteBinding = mkOption {
default = "delete-sequence"; default = "delete-sequence";
type = eraseBinding; type = eraseBinding;
description = '' description = lib.mdDoc ''
Which string the terminal should send to an application when the user Which string the terminal should send to an application when the user
presses the <emphasis>Delete</emphasis> key. presses the *Delete* key.
<variablelist> `auto`
<varlistentry> : Send the `@7` control sequence.
<term><literal>auto</literal></term>
<listitem><para> `ascii-backspace`
Send the <quote>@7</quote> control sequence. : Send an ASCII backspace character (`0x08`).
</para></listitem>
</varlistentry> `ascii-delete`
<varlistentry> : Send an ASCII delete character (`0x7F`).
<term><literal>ascii-backspace</literal></term>
<listitem><para> `delete-sequence`
Send an ASCII backspace character (0x08). : Send the `@7` control sequence.
</para></listitem>
</varlistentry> `tty`
<varlistentry> : Send terminal's "erase" setting.
<term><literal>ascii-delete</literal></term>
<listitem><para>
Send an ASCII delete character (0x7F).
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>delete-sequence</literal></term>
<listitem><para>
Send the <quote>@7</quote> control sequence.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>tty</literal></term>
<listitem><para>
Send terminal’s <quote>erase</quote> setting.
</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };

45
modules/programs/gpg.nix
View File

@ -62,34 +62,27 @@ let
}.${v} }.${v}
else else
v; v;
description = '' description = lib.mdDoc ''
The amount of trust you have in the key ownership and the care the The amount of trust you have in the key ownership and the care the
owner puts into signing other keys. The available levels are owner puts into signing other keys. The available levels are
<variablelist>
<varlistentry> `unknown` or `1`
<term><literal>unknown</literal> or <literal>1</literal></term> : I don't know or won't say.
<listitem><para>I don't know or won't say.</para></listitem>
</varlistentry> `never` or `2`
<varlistentry> : I do **not** trust.
<term><literal>never</literal> or <literal>2</literal></term>
<listitem><para>I do NOT trust.</para></listitem> `marginal` or `3`
</varlistentry> : I trust marginally.
<varlistentry>
<term><literal>marginal</literal> or <literal>3</literal></term> `full` or `4`
<listitem><para>I trust marginally.</para></listitem> : I trust fully.
</varlistentry>
<varlistentry> `ultimate` or `5`
<term><literal>full</literal> or <literal>4</literal></term> : I trust ultimately.
<listitem><para>I trust fully.</para></listitem>
</varlistentry> See the [Key Management chapter](https://www.gnupg.org/gph/en/manual/x334.html)
<varlistentry> of the GNU Privacy Handbook for more.
<term><literal>ultimate</literal> or <literal>5</literal></term>
<listitem><para>I trust ultimately.</para></listitem>
</varlistentry>
</variablelist>
</para><para>
See <link xlink:href="https://www.gnupg.org/gph/en/manual/x334.html"/>
for more.
''; '';
}; };
}; };

94
modules/programs/hexchat.nix
View File

@ -73,48 +73,35 @@ let
loginMethod = mkOption { loginMethod = mkOption {
type = nullOr (enum (attrNames loginMethodMap)); type = nullOr (enum (attrNames loginMethodMap));
default = null; default = null;
description = '' description = lib.mdDoc ''
The login method. The allowed options are: The login method. The allowed options are:
<variablelist>
<varlistentry> `null`
<term><literal>null</literal></term> : Default
<listitem><para>Default</para></listitem>
</varlistentry> `"nickServMsg"`
<varlistentry> : NickServ (`/MSG NickServ` + password)
<term><literal>"nickServMsg"</literal></term>
<listitem><para>NickServ (/MSG NickServ + password)</para></listitem> `"nickServ"`
</varlistentry> : NickServ (`/NICKSERV` + password)
<varlistentry>
<term><literal>"nickServ"</literal></term> `"challengeAuth"`
<listitem><para>NickServ (/NICKSERV + password)</para></listitem> : Challenge Auth (username + password)
</varlistentry>
<varlistentry> `"sasl"`
<term><literal>"challengeAuth"</literal></term> : SASL (username + password)
<listitem><para>Challenge Auth (username + password)</para></listitem>
</varlistentry> `"serverPassword"`
<varlistentry> : Server password (`/PASS` password)
<term><literal>"sasl"</literal></term>
<listitem><para>SASL (username + password)</para></listitem> `"saslExternal"`
</varlistentry> : SASL EXTERNAL (cert)
<varlistentry>
<term><literal>"serverPassword"</literal></term> `"customCommands"`
<listitem><para>Server password (/PASS password)</para></listitem> : Use "commands" field for auth. For example
</varlistentry> ```nix
<varlistentry> commands = [ "/msg NickServ IDENTIFY my_password" ]
<term><literal>"saslExternal"</literal></term> ```
<listitem><para>SASL EXTERNAL (cert)</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>"customCommands"</literal></term>
<listitem>
<para>Use "commands" field for auth. For example
<programlisting language="nix">
commands = [ "/msg NickServ IDENTIFY my_password" ]
</programlisting>
</para>
</listitem>
</varlistentry>
</variablelist>
''; '';
}; };
@ -293,25 +280,20 @@ in {
overwriteConfigFiles = mkOption { overwriteConfigFiles = mkOption {
type = nullOr bool; type = nullOr bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Enables overwriting HexChat configuration files Enables overwriting HexChat configuration files
(<filename>hexchat.conf</filename>, <filename>servlist.conf</filename>). ({file}`hexchat.conf`, {file}`servlist.conf`).
Any existing HexChat configuration will be lost. Certify to back-up any Any existing HexChat configuration will be lost. Make sure to back up
previous configuration before enabling this. any previous configuration before enabling this.
</para><para>
Enabling this setting is recommended, because everytime HexChat Enabling this setting is recommended, because everytime HexChat
application is closed it overwrites Nix/Home Manager provided application is closed it overwrites Nix/Home Manager provided
configuration files, causing: configuration files, causing:
<orderedlist numeration="arabic">
<listitem><para> 1. Nix/Home Manager provided configuration to be out of sync with
Nix/Home Manager provided configuration to be out of sync with actual active HexChat configuration.
actual active HexChat configuration. 2. Nix/Home Manager updates to be blocked until configuration files are
</para></listitem> manually removed.
<listitem><para>
Blocking Nix/Home Manager updates until configuration files are
manually removed.
</para></listitem>
</orderedlist>
''; '';
}; };

156
modules/programs/qutebrowser.nix
View File

@ -133,111 +133,77 @@ in {
keyBindings = mkOption { keyBindings = mkOption {
type = with types; attrsOf (attrsOf (separatedString " ;; ")); type = with types; attrsOf (attrsOf (separatedString " ;; "));
default = { }; default = { };
description = '' description = lib.mdDoc ''
Key bindings mapping keys to commands in different modes. This setting Key bindings mapping keys to commands in different modes. This setting
is a dictionary containing mode names and dictionaries mapping keys to is a dictionary containing mode names and dictionaries mapping keys to
commands: <literal>{mode: {key: command}}</literal> If you want to map commands: `{mode: {key: command}}` If you want to map
a key to another key, check the <literal>keyMappings</literal> setting a key to another key, check the `keyMappings` setting
instead. For modifiers, you can use either <literal>-</literal> or instead. For modifiers, you can use either `-` or
<literal>+</literal> as delimiters, and these names: `+` as delimiters, and these names:
<itemizedlist> Control
<listitem><para> : `Control`, `Ctrl`
Control: <literal>Control</literal>, <literal>Ctrl</literal>
</para></listitem>
<listitem><para>
Meta: <literal>Meta</literal>, <literal>Windows</literal>,
<literal>Mod4</literal>
</para></listitem>
<listitem><para>
Alt: <literal>Alt</literal>, <literal>Mod1</literal>
</para></listitem>
<listitem><para>
Shift: <literal>Shift</literal>
</para></listitem>
</itemizedlist>
For simple keys (no <literal>&lt;&gt;</literal>-signs), a capital Meta
: `Meta`, `Windows`, `Mod4`
Alt
: `Alt`, `Mod1`
Shift
: `Shift`
For simple keys (no `<>`-signs), a capital
letter means the key is pressed with Shift. For special keys (with letter means the key is pressed with Shift. For special keys (with
<literal>&lt;&gt;</literal>-signs), you need to explicitly add `<>`-signs), you need to explicitly add
<literal>Shift-</literal> to match a key pressed with shift. If you `Shift-` to match a key pressed with shift. If you
want a binding to do nothing, bind it to the <literal>nop</literal> want a binding to do nothing, bind it to the `nop`
command. If you want a default binding to be passed through to the command. If you want a default binding to be passed through to the
website, bind it to null. Note that some commands which are only useful website, bind it to null. Note that some commands which are only useful
for bindings (but not used interactively) are hidden from the command for bindings (but not used interactively) are hidden from the command
completion. See <literal>:</literal>help for a full list of available completion. See `:help` for a full list of available
commands. The following modes are available: commands. The following modes are available:
<variablelist> `normal`
<varlistentry> : Default mode, where most commands are invoked.
<term><literal>normal</literal></term>
<listitem><para> `insert`
Default mode, where most commands are invoked. : Entered when an input field is focused on a website, or by
</para></listitem> pressing `i` in normal mode. Passes through almost all keypresses
</varlistentry> to the website, but has some bindings like
<varlistentry> `<Ctrl-e>` to open an external editor.
<term><literal>insert</literal></term> Note that single keys can't be bound in this mode.
<listitem><para>
Entered when an input field is focused on a website, or by `hint`
pressing i in normal mode. Passes through almost all keypresses : Entered when `f` is pressed to select links with the keyboard. Note
to the website, but has some bindings like that single keys can't be bound in this mode.
<literal>&lt;Ctrl-e&gt;</literal> to open an external editor.
Note that single keys can’t be bound in this mode. `passthrough`
</para></listitem> : Similar to insert mode, but passes through all keypresses except
</varlistentry> `<Escape>` to leave the mode. It might be
<varlistentry> useful to bind `<Escape>` to some other
<term><literal>hint</literal></term> key in this mode if you want to be able to send an Escape key to
<listitem><para> the website as well. Note that single keys can't be bound in this
Entered when f is pressed to select links with the keyboard. Note mode.
that single keys can’t be bound in this mode.
</para></listitem> `command`
</varlistentry> : Entered when pressing the `:` key in order to enter a command. Note
<varlistentry> that single keys can't be bound in this mode.
<term><literal>passthrough</literal></term>
<listitem><para> `prompt`
Similar to insert mode, but passes through all keypresses except : Entered when there's a prompt to display, like for download
<literal>&lt;Escape&gt;</literal> to leave the mode. It might be locations or when invoked from JavaScript.
useful to bind <literal>&lt;Escape&gt;</literal> to some other
key in this mode if you want to be able to send an Escape key to `yesno`
the website as well. Note that single keys can’t be bound in this : Entered when there's a yes/no prompt displayed.
mode.
</para></listitem> `caret`
</varlistentry> : Entered when pressing the `v` mode, used to select text using the
<varlistentry> keyboard.
<term><literal>command</literal></term>
<listitem><para> `register`
Entered when pressing the : key in order to enter a command. Note : Entered when qutebrowser is waiting for a register name/key for
that single keys can’t be bound in this mode. commands like `:set-mark`.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>prompt</literal></term>
<listitem><para>
Entered when there’s a prompt to display, like for download
locations or when invoked from JavaScript.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>yesno</literal></term>
<listitem><para>
Entered when there’s a yes/no prompt displayed.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>caret</literal></term>
<listitem><para>
Entered when pressing the v mode, used to select text using the
keyboard.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>register</literal></term>
<listitem><para>
Entered when qutebrowser is waiting for a register name/key for
commands like <literal>:set-mark</literal>.
</para></listitem>
</varlistentry>
</variablelist>
''; '';
example = literalExpression '' example = literalExpression ''
{ {

29
modules/services/udiskie.nix
View File

@ -72,26 +72,19 @@ in {
tray = mkOption { tray = mkOption {
type = types.enum [ "always" "auto" "never" ]; type = types.enum [ "always" "auto" "never" ];
default = "auto"; default = "auto";
description = '' description = lib.mdDoc ''
Whether to display tray icon. Whether to display tray icon.
</para><para>
The options are The options are
<variablelist>
<varlistentry> `always`
<term><literal>always</literal></term> : Always show tray icon.
<listitem><para>Always show tray icon.</para></listitem>
</varlistentry> `auto`
<varlistentry> : Show tray icon only when there is a device available.
<term><literal>auto</literal></term>
<listitem><para> `never`
Show tray icon only when there is a device available. : Never show tray icon.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>never</literal></term>
<listitem><para>Never show tray icon.</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
}; };

16
modules/services/window-managers/i3-sway/sway.nix
View File

@ -363,18 +363,16 @@ in {
type = types.bool; type = types.bool;
default = pkgs.stdenv.isLinux; default = pkgs.stdenv.isLinux;
example = false; example = false;
description = '' description = lib.mdDoc ''
Whether to enable <filename>sway-session.target</filename> on Whether to enable {file}`sway-session.target` on
sway startup. This links to sway startup. This links to
<filename>graphical-session.target</filename>. {file}`graphical-session.target`.
Some important environment variables will be imported to systemd Some important environment variables will be imported to systemd
and dbus user environment before reaching the target, including and dbus user environment before reaching the target, including
<itemizedlist> * {env}`DISPLAY`
<listitem><para><literal>DISPLAY</literal></para></listitem> * {env}`WAYLAND_DISPLAY`
<listitem><para><literal>WAYLAND_DISPLAY</literal></para></listitem> * {env}`SWAYSOCK`
<listitem><para><literal>SWAYSOCK</literal></para></listitem> * {env}`XDG_CURRENT_DESKTOP`
<listitem><para><literal>XDG_CURRENT_DESKTOP</literal></para></listitem>
</itemizedlist>
''; '';
}; };

49
modules/systemd.nix
View File

@ -164,40 +164,29 @@ in {
type = with types; type = with types;
either bool (enum [ "suggest" "legacy" "sd-switch" ]); either bool (enum [ "suggest" "legacy" "sd-switch" ]);
apply = p: if isBool p then if p then "legacy" else "suggest" else p; apply = p: if isBool p then if p then "legacy" else "suggest" else p;
description = '' description = lib.mdDoc ''
Whether new or changed services that are wanted by active targets Whether new or changed services that are wanted by active targets
should be started. Additionally, stop obsolete services from the should be started. Additionally, stop obsolete services from the
previous generation. previous generation.
</para><para>
The alternatives are The alternatives are
<variablelist>
<varlistentry> `suggest` (or `false`)
<term><literal>suggest</literal> (or <literal>false</literal>)</term> : Use a very simple shell script to print suggested
<listitem><para> {command}`systemctl` commands to run. You will have to
Use a very simple shell script to print suggested manually run those commands after the switch.
<command>systemctl</command> commands to run. You will have to
manually run those commands after the switch. `legacy` (or `true`)
</para></listitem> : Use a Ruby script to, in a more robust fashion, determine the
</varlistentry> necessary changes and automatically run the
<varlistentry> {command}`systemctl` commands.
<term><literal>legacy</literal> (or <literal>true</literal>)</term>
<listitem><para> `sd-switch`
Use a Ruby script to, in a more robust fashion, determine the : Use sd-switch, a third party application, to perform the service
necessary changes and automatically run the updates. This tool offers more features while having a small
<command>systemctl</command> commands. closure size. Note, it requires a fully functional user D-Bus
</para></listitem> session. Once tested and deemed sufficiently robust, this will
</varlistentry> become the default.
<varlistentry>
<term><literal>sd-switch</literal></term>
<listitem><para>
Use sd-switch, a third party application, to perform the service
updates. This tool offers more features while having a small
closure size. Note, it requires a fully functional user D-Bus
session. Once tested and deemed sufficiently robust, this will
become the default.
</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };

26
modules/targets/darwin/user-defaults/opts-allhosts.nix
View File

@ -174,23 +174,19 @@ in {
OpenTmuxWindowsIn = mkNullableOption { OpenTmuxWindowsIn = mkNullableOption {
type = types.int; type = types.int;
example = 2; example = 2;
description = '' description = lib.mdDoc ''
Configures how to restore tmux windows when attaching to a session. Configures how to restore tmux windows when attaching to a session.
<variablelist><title>Possible Values</title> **Possible Values**
<varlistentry>
<term><literal>0</literal></term> `0`
<listitem><para>Native windows</para></listitem> : Native windows
</varlistentry>
<varlistentry> `1`
<term><literal>1</literal></term> : Native tabs in a new window
<listitem><para>Native tabs in a new window</para></listitem>
</varlistentry> `2`
<varlistentry> : Tabs in the attaching window
<term><literal>2</literal></term>
<listitem><para>Tabs in the attaching window</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };