mirror of
https://github.com/NixOS/nixpkgs.git
synced 2026-07-06 17:13:24 -05:00
various: add {file} tags for nixos option descriptions
This commit is contained in:
h7x4
parent
c96a499421
commit
b36f8e0b79
31 changed files with 56 additions and 56 deletions
|
|
@ -464,7 +464,7 @@ let
|
|||
Whether to enable or disable lingering for this user. Without
|
||||
lingering, user units will not be started until the user logs in,
|
||||
and may be stopped on logout depending on the settings in
|
||||
`logind.conf`.
|
||||
{file}`logind.conf`.
|
||||
|
||||
By default, NixOS will not manage lingering, new users will default
|
||||
to not lingering, and lingering can be configured imperatively using
|
||||
|
|
|
|||
|
|
@ -91,8 +91,8 @@ in
|
|||
Sets which portal backend should be used to provide the implementation
|
||||
for the requested interface. For details check {manpage}`portals.conf(5)`.
|
||||
|
||||
Configs will be linked to `/etc/xdg/xdg-desktop-portal/` with the name `$desktop-portals.conf`
|
||||
for `xdg.portal.config.$desktop` and `portals.conf` for `xdg.portal.config.common`
|
||||
Configs will be linked to {file}`/etc/xdg/xdg-desktop-portal/` with the name {file}`$desktop-portals.conf`
|
||||
for {file}`xdg.portal.config.$desktop` and {file}`portals.conf` for {file}`xdg.portal.config.common`
|
||||
as an exception.
|
||||
'';
|
||||
};
|
||||
|
|
@ -103,7 +103,7 @@ in
|
|||
example = lib.literalExpression "[ pkgs.gnome-session ]";
|
||||
description = ''
|
||||
List of packages that provide XDG desktop portal configuration, usually in
|
||||
the form of `share/xdg-desktop-portal/$desktop-portals.conf`.
|
||||
the form of {file}`share/xdg-desktop-portal/$desktop-portals.conf`.
|
||||
|
||||
Note that configs in `xdg.portal.config` will be preferred if set.
|
||||
'';
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ in
|
|||
inherit (settingsFormat) type;
|
||||
default = { };
|
||||
description = ''
|
||||
Configuration included in `starship.toml`.
|
||||
Configuration included in {file}`starship.toml`.
|
||||
|
||||
See <https://starship.rs/config/#prompt> for documentation.
|
||||
'';
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ in
|
|||
description = ''
|
||||
Configuration options in RabbitMQ's new config file format,
|
||||
which is a simple key-value format that can not express nested
|
||||
data structures. This is known as the `rabbitmq.conf` file,
|
||||
data structures. This is known as the {file}`rabbitmq.conf` file,
|
||||
although outside NixOS that filename may have Erlang syntax, particularly
|
||||
prior to RabbitMQ 3.7.0.
|
||||
|
||||
|
|
@ -119,7 +119,7 @@ in
|
|||
type = lib.types.str;
|
||||
description = ''
|
||||
Verbatim advanced configuration file contents using the Erlang syntax.
|
||||
This is also known as the `advanced.config` file or the old config format.
|
||||
This is also known as the {file}`advanced.config` file or the old config format.
|
||||
|
||||
`configItems` is preferred whenever possible. However, nested
|
||||
data structures can only be expressed properly using the `config` option.
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ in
|
|||
type = lib.types.lines;
|
||||
default = "";
|
||||
description = ''
|
||||
Extra configuration for `slurmdbd.conf` See also:
|
||||
Extra configuration for {file}`slurmdbd.conf` See also:
|
||||
{manpage}`slurmdbd.conf(8)`.
|
||||
'';
|
||||
};
|
||||
|
|
@ -196,7 +196,7 @@ in
|
|||
type = lib.types.bool;
|
||||
default = false;
|
||||
description = ''
|
||||
Whether to provide a slurm.conf file.
|
||||
Whether to provide a {file}`slurm.conf` file.
|
||||
Enable this option if you do not run a slurm daemon on this host
|
||||
(i.e. `server.enable` and `client.enable` are `false`)
|
||||
but you still want to run slurm commands from this host.
|
||||
|
|
@ -332,7 +332,7 @@ in
|
|||
default = "";
|
||||
type = lib.types.lines;
|
||||
description = ''
|
||||
Extra configuration for that will be added to `mpi.conf`.
|
||||
Extra configuration for that will be added to {file}`mpi.conf`.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
@ -341,7 +341,7 @@ in
|
|||
default = "";
|
||||
type = lib.types.lines;
|
||||
description = ''
|
||||
Extra configuration that will be added to the end of `plugstack.conf`.
|
||||
Extra configuration that will be added to the end of {file}`plugstack.conf`.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -349,7 +349,7 @@ in
|
|||
default = "";
|
||||
type = lib.types.lines;
|
||||
description = ''
|
||||
Extra configuration for `cgroup.conf`. This file is
|
||||
Extra configuration for {file}`cgroup.conf`. This file is
|
||||
used when `procTrackType=proctrack/cgroup`.
|
||||
'';
|
||||
};
|
||||
|
|
@ -359,9 +359,9 @@ in
|
|||
default = [ ];
|
||||
description = ''
|
||||
Slurm expects config files for plugins in the same path
|
||||
as `slurm.conf`. Add extra nix store
|
||||
as {file}`slurm.conf`. Add extra nix store
|
||||
paths that should be merged into same directory as
|
||||
`slurm.conf`.
|
||||
{file}`slurm.conf`.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ in
|
|||
package = mkPackageOption pkgs "hercules-ci-agent" { };
|
||||
settings = mkOption {
|
||||
description = ''
|
||||
These settings are written to the `agent.toml` file.
|
||||
These settings are written to the {file}`agent.toml` file.
|
||||
|
||||
Not all settings are listed as options, can be set nonetheless.
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ in
|
|||
|
||||
settings = mkOption {
|
||||
description = ''
|
||||
Free-form settings written directly to the `lldap_config.toml` file.
|
||||
Free-form settings written directly to the {file}`lldap_config.toml` file.
|
||||
Refer to <https://github.com/lldap/lldap/blob/main/lldap_config.docker_template.toml> for supported values.
|
||||
'';
|
||||
|
||||
|
|
|
|||
|
|
@ -570,7 +570,7 @@ in
|
|||
description = ''
|
||||
PostgreSQL configuration. Refer to
|
||||
<https://www.postgresql.org/docs/current/config-setting.html#CONFIG-SETTING-CONFIGURATION-FILE>
|
||||
for an overview of `postgresql.conf`.
|
||||
for an overview of {file}`postgresql.conf`.
|
||||
|
||||
::: {.note}
|
||||
String values will automatically be enclosed in single quotes. Single quotes will be
|
||||
|
|
|
|||
|
|
@ -200,7 +200,7 @@ in
|
|||
default = { };
|
||||
|
||||
description = ''
|
||||
Configuration for MCHPRS via `Config.toml`.
|
||||
Configuration for MCHPRS via {file}`Config.toml`.
|
||||
See <https://github.com/MCHPR/MCHPRS/blob/master/README.md> for documentation.
|
||||
'';
|
||||
};
|
||||
|
|
@ -210,7 +210,7 @@ in
|
|||
type = lib.types.bool;
|
||||
default = false;
|
||||
description = ''
|
||||
Whether or not the whitelist (in `whitelist.json`) shoud be enabled.
|
||||
Whether or not the whitelist (in {file}`whitelist.json`) shoud be enabled.
|
||||
Only has effect when {option}`services.mchprs.declarativeSettings` is `true`.
|
||||
'';
|
||||
};
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ in
|
|||
};
|
||||
settings = lib.mkOption {
|
||||
description = ''
|
||||
Generates the `aria2.conf` file. Refer to [the documentation][0] for
|
||||
Generates the {file}`aria2.conf` file. Refer to [the documentation][0] for
|
||||
all possible settings.
|
||||
|
||||
[0]: <https://aria2.github.io/manual/en/html/aria2c.html#synopsis>
|
||||
|
|
|
|||
|
|
@ -78,7 +78,7 @@ in
|
|||
'';
|
||||
description = ''
|
||||
Extra configuration options appended to the default
|
||||
`asterisk.conf` file.
|
||||
{file}`asterisk.conf` file.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -134,7 +134,7 @@ in
|
|||
Sets the content of config files (typically ending with
|
||||
`.conf`) in the Asterisk configuration directory.
|
||||
|
||||
Note that if you want to change `asterisk.conf`, it
|
||||
Note that if you want to change {file}`asterisk.conf`, it
|
||||
is preferable to use the {option}`services.asterisk.extraConfig`
|
||||
option over this option. If `"asterisk.conf"` is
|
||||
specified with the {option}`confFiles` option (not recommended),
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ in
|
|||
default = atalkdConfFile;
|
||||
defaultText = "/nix/store/xxx-atalkd.conf";
|
||||
description = ''
|
||||
Optional path to a custom `atalkd.conf` file. When set, this overrides the generated
|
||||
Optional path to a custom {file}`atalkd.conf` file. When set, this overrides the generated
|
||||
configuration from `services.atalkd.interfaces`.
|
||||
'';
|
||||
};
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ in
|
|||
'';
|
||||
description = ''
|
||||
Commands to execute before the config file check. The file to be checked will be
|
||||
available as `bird.conf` in the current directory.
|
||||
available as {file}`bird.conf` in the current directory.
|
||||
|
||||
Files created with this option will not be available at service runtime, only during
|
||||
build time checking.
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ in
|
|||
}
|
||||
'';
|
||||
description = ''
|
||||
Contents of the `config.yaml` config file.
|
||||
Contents of the {file}`config.yaml` config file.
|
||||
The `--config-path` argument will only be passed if this set is not empty.
|
||||
|
||||
See <https://github.com/AdguardTeam/dnsproxy/blob/master/config.yaml.dist>.
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ in
|
|||
type = lib.types.lines;
|
||||
default = "";
|
||||
description = ''
|
||||
Additional options that will be copied verbatim in `gnunet.conf`.
|
||||
Additional options that will be copied verbatim in {file}`gnunet.conf`.
|
||||
See {manpage}`gnunet.conf(5)` for details.
|
||||
'';
|
||||
};
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ in
|
|||
config = lib.mkOption {
|
||||
type = lib.types.lines;
|
||||
description = ''
|
||||
Verbatim `inspircd.conf` file.
|
||||
Verbatim {file}`inspircd.conf` file.
|
||||
For a list of options, consult the
|
||||
[InspIRCd documentation](https://docs.inspircd.org/3/configuration/), the
|
||||
[Module documentation](https://docs.inspircd.org/3/modules/)
|
||||
|
|
|
|||
|
|
@ -361,7 +361,7 @@ in
|
|||
'';
|
||||
description = ''
|
||||
Additional configuration that exists before the first start and
|
||||
later overrides the existing values in `config.json`.
|
||||
later overrides the existing values in {file}`config.json`.
|
||||
|
||||
It is mostly helpful to manage configuration ignored/not yet implemented
|
||||
outside of `netbird up` invocation.
|
||||
|
|
@ -369,9 +369,9 @@ in
|
|||
WARNING: this is not an upstream feature, it could break in the future
|
||||
(by having lower priority) after upstream implements an equivalent.
|
||||
|
||||
It is implemented as a `preStart` script which overrides `config.json`
|
||||
with content of `/etc/${client.dir.baseName}/config.d/*.json` files.
|
||||
This option manages specifically `50-nixos.json` file.
|
||||
It is implemented as a `preStart` script which overrides {file}`config.json`
|
||||
with content of {file}`/etc/${client.dir.baseName}/config.d/*.json` files.
|
||||
This option manages specifically {file}`50-nixos.json` file.
|
||||
|
||||
Consult [the source code](https://github.com/netbirdio/netbird/blob/88747e3e0191abc64f1e8c7ecc65e5e50a1527fd/client/internal/config.go#L49-L82)
|
||||
or inspect existing file for a complete list of available configurations.
|
||||
|
|
@ -396,7 +396,7 @@ in
|
|||
type = path;
|
||||
default = "/var/lib/${client.dir.baseName}";
|
||||
description = ''
|
||||
A state directory used by NetBird client to store `config.json`, `state.json` & `resolv.conf`.
|
||||
A state directory used by NetBird client to store {file}`config.json`, {file}`state.json` & {file}`resolv.conf`.
|
||||
'';
|
||||
};
|
||||
dir.runtime = mkOption {
|
||||
|
|
@ -471,8 +471,8 @@ in
|
|||
2. run as a `netbird-<name>.service`,
|
||||
3. listen for incoming remote connections on the port `51820` (`openFirewall` by default),
|
||||
4. manage the `netbird-<name>` wireguard interface,
|
||||
5. use the `/var/lib/netbird-<name>/config.json` configuration file,
|
||||
6. override `/var/lib/netbird-<name>/config.json` with values from `/etc/netbird-<name>/config.d/*.json`,
|
||||
5. use the {file}`/var/lib/netbird-<name>/config.json` configuration file,
|
||||
6. override {file}`/var/lib/netbird-<name>/config.json` with values from {file}`/etc/netbird-<name>/config.d/*.json`,
|
||||
7. (`hardened`) be locally manageable by `netbird-<name>` system group,
|
||||
|
||||
With following caveats:
|
||||
|
|
|
|||
|
|
@ -346,7 +346,7 @@ in
|
|||
];
|
||||
default = "default";
|
||||
description = ''
|
||||
Set the DNS (`resolv.conf`) processing mode.
|
||||
Set the DNS ({file}`resolv.conf`) processing mode.
|
||||
|
||||
A description of these modes can be found in the main section of
|
||||
[
|
||||
|
|
|
|||
|
|
@ -164,7 +164,7 @@ in
|
|||
default = "";
|
||||
description = ''
|
||||
Extra configuration directives that should be added to
|
||||
`chrony.conf`
|
||||
{file}`chrony.conf`
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ in
|
|||
inherit (format) type;
|
||||
default = { };
|
||||
description = ''
|
||||
Additional attributes to be merged with the configuration options and written to Pangolin's `config.yml` file.
|
||||
Additional attributes to be merged with the configuration options and written to Pangolin's {file}`config.yml` file.
|
||||
'';
|
||||
example = {
|
||||
app = {
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ in
|
|||
default = "";
|
||||
description = ''
|
||||
Global configuration that should be added to the global directory
|
||||
of `pdnsd.conf`.
|
||||
of {file}`pdnsd.conf`.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -51,7 +51,7 @@ in
|
|||
default = "";
|
||||
description = ''
|
||||
Server configuration that should be added to the server directory
|
||||
of `pdnsd.conf`.
|
||||
of {file}`pdnsd.conf`.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ in
|
|||
default = "";
|
||||
description = ''
|
||||
Extra configuration directives that should be added to
|
||||
`pdnsd.conf`.
|
||||
{file}`pdnsd.conf`.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ in
|
|||
type = types.str;
|
||||
default = "";
|
||||
description = ''
|
||||
Contents of the `strongswan.conf` file.
|
||||
Contents of the {file}`strongswan.conf` file.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -482,7 +482,7 @@ in
|
|||
`ike:` prefix are configured any signature scheme
|
||||
constraint (without `ike:` prefix) will also apply to
|
||||
IKEv2 authentication, unless this is disabled in
|
||||
`strongswan.conf`. To use RSASSA-PSS signatures use
|
||||
{file}`strongswan.conf`. To use RSASSA-PSS signatures use
|
||||
`rsa/pss` instead of `pubkey` or
|
||||
`rsa` as in e.g.
|
||||
`ike:rsa/pss-sha256`. If `pubkey` or
|
||||
|
|
@ -628,7 +628,7 @@ in
|
|||
`pubkey-sha256-sha512`,
|
||||
`rsa-2048-sha256-sha384-sha512` or
|
||||
`rsa-2048-sha256-ecdsa-256-sha256-sha384`).
|
||||
Unless disabled in `strongswan.conf`, or explicit IKEv2
|
||||
Unless disabled in {file}`strongswan.conf`, or explicit IKEv2
|
||||
signature constraints are configured (refer to the description of the
|
||||
{option}`local` section's {option}`auth` keyword for
|
||||
details), such key types and hash algorithms are also applied as
|
||||
|
|
|
|||
|
|
@ -110,7 +110,7 @@ in
|
|||
default = null;
|
||||
example = literalExpression "/etc/wpa_supplicant.conf";
|
||||
description = ''
|
||||
External `wpa_supplicant.conf` configuration file.
|
||||
External {file}`wpa_supplicant.conf` configuration file.
|
||||
The configuration options defined declaratively within `networking.supplicant` have
|
||||
precedence over options defined in `configFile`.
|
||||
'';
|
||||
|
|
@ -145,7 +145,7 @@ in
|
|||
model_number=2015
|
||||
'';
|
||||
description = ''
|
||||
Configuration options for `wpa_supplicant.conf`.
|
||||
Configuration options for {file}`wpa_supplicant.conf`.
|
||||
Options defined here have precedence over options in `configFile`.
|
||||
NOTE: Do not write sensitive data into `extraConf` as it will
|
||||
be world-readable in the `nix-store`. For sensitive information
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ in
|
|||
}
|
||||
'';
|
||||
description = ''
|
||||
Contents of the `teleport.yaml` config file.
|
||||
Contents of the {file}`teleport.yaml` config file.
|
||||
The `--config` arguments will only be passed if this set is not empty.
|
||||
|
||||
See <https://goteleport.com/docs/setup/reference/config/>.
|
||||
|
|
|
|||
|
|
@ -127,7 +127,7 @@ in
|
|||
"log"
|
||||
];
|
||||
description = ''
|
||||
A list of modules to include in the `znc.conf` file.
|
||||
A list of modules to include in the {file}`znc.conf` file.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -144,7 +144,7 @@ in
|
|||
"push"
|
||||
];
|
||||
description = ''
|
||||
A list of user modules to include in the `znc.conf` file.
|
||||
A list of user modules to include in the {file}`znc.conf` file.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -233,7 +233,7 @@ in
|
|||
default = "";
|
||||
type = types.lines;
|
||||
description = ''
|
||||
Extra config to `znc.conf` file.
|
||||
Extra config to {file}`znc.conf` file.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ let
|
|||
"https://github.com/hashicorp/consul-template/blob/main/docs/configuration.md#configuration-file";
|
||||
in
|
||||
''
|
||||
Free-form settings written directly to the `config.json` file.
|
||||
Free-form settings written directly to the {file}`config.json` file.
|
||||
Refer to <${upstreamDocs}> for supported values.
|
||||
|
||||
::: {.note}
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ in
|
|||
freeformType = attrsOf (attrsOf anything);
|
||||
};
|
||||
description = ''
|
||||
Free-form settings mapped to the `qBittorrent.conf` file in the profile.
|
||||
Free-form settings mapped to the {file}`qBittorrent.conf` file in the profile.
|
||||
Refer to [Explanation-of-Options-in-qBittorrent](https://github.com/qbittorrent/qBittorrent/wiki/Explanation-of-Options-in-qBittorrent).
|
||||
The Password_PBKDF2 format is oddly unique, you will likely want to use [this tool](https://codeberg.org/feathecutie/qbittorrent_password) to generate the format.
|
||||
Alternatively you can run qBittorrent independently first and use its webUI to generate the format.
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ in
|
|||
settings = lib.mkOption {
|
||||
default = { };
|
||||
description = ''
|
||||
Settings serialized into `config.yml` before build.
|
||||
Settings serialized into {file}`config.yml` before build.
|
||||
If left empty, the default configuration shipped with the package will be used instead.
|
||||
For more information, see the [official documentation](https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -32,10 +32,10 @@ in
|
|||
Example config can be generated by `ocis init --config-path fileName --admin-password "adminPass"`.
|
||||
Add `--insecure true` if SSL certificates are generated and managed externally (e.g. using oCIS behind reverse proxy).
|
||||
|
||||
Note: This directory must contain at least a `ocis.yaml`. Ensure
|
||||
Note: This directory must contain at least a {file}`ocis.yaml`. Ensure
|
||||
[user](#opt-services.ocis.user) has read/write access to it. In some
|
||||
circumstances you may need to add additional oCIS configuration files (e.g.,
|
||||
`proxy.yaml`) to this directory.
|
||||
{file}`proxy.yaml`) to this directory.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ in
|
|||
The set of NTP servers from which to synchronise.
|
||||
|
||||
Setting this option to an empty list will write `NTP=` to the
|
||||
`timesyncd.conf` file as opposed to setting this option to null which
|
||||
{file}`timesyncd.conf` file as opposed to setting this option to null which
|
||||
will remove `NTP=` entirely.
|
||||
|
||||
See {manpage}`timesyncd.conf(5)` for details.
|
||||
|
|
@ -39,7 +39,7 @@ in
|
|||
The set of fallback NTP servers from which to synchronise.
|
||||
|
||||
Setting this option to an empty list will write `FallbackNTP=` to the
|
||||
`timesyncd.conf` file as opposed to setting this option to null which
|
||||
{file}`timesyncd.conf` file as opposed to setting this option to null which
|
||||
will remove `FallbackNTP=` entirely.
|
||||
|
||||
See {manpage}`timesyncd.conf(5)` for details.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue