nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

treewide: convert all option docs to Markdown

Browse source 
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
This commit is contained in:
Emily 2023-07-01 00:30:13 +01:00
parent c1d8d2a3d1
commit 36a53d9f26
355 changed files with 3805 additions and 3886 deletions
Download patch file Download diff file Expand all files Collapse all files

154
modules/programs/ssh.nix
View file

@ -26,14 +26,14 @@ let
type = types.str;
default = "localhost";
example = "example.org";
description = "The address where to bind the port.";
description = lib.mdDoc "The address where to bind the port.";
};
port = mkOption {
type = types.nullOr types.port;
default = null;
example = 8080;
description = "Specifies port number to bind on bind address.";
description = lib.mdDoc "Specifies port number to bind on bind address.";
};
};
@ -50,14 +50,14 @@ let
type = types.nullOr types.str;
default = null;
example = "example.org";
description = "The address where to forward the traffic to.";
description = lib.mdDoc "The address where to forward the traffic to.";
};
port = mkOption {
type = types.nullOr types.port;
default = null;
example = 80;
description = "Specifies port number to forward the traffic to.";
description = lib.mdDoc "Specifies port number to forward the traffic to.";
};
};
};
@ -69,16 +69,13 @@ let
type = types.nullOr types.str;
default = null;
example = "*.example.org";
description = ''
<literal>Host</literal> pattern used by this conditional block.
description = lib.mdDoc ''
`Host` pattern used by this conditional block.
See
<citerefentry>
<refentrytitle>ssh_config</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
for <literal>Host</literal> block details.
{manpage}`ssh_config(5)`
for `Host` block details.
This option is ignored if
<option>ssh.matchBlocks.*.match</option>
{option}`ssh.matchBlocks.*.match`
if defined.
'';
};
@ -87,15 +84,12 @@ let
type = types.nullOr types.str;
default = null;
example = "host <hostname> canonical\nhost <hostname> exec \"ping -c1 -q 192.168.17.1\"";
description = ''
<literal>Match</literal> block conditions used by this block. See
<citerefentry>
<refentrytitle>ssh_config</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
for <literal>Match</literal> block details.
description = lib.mdDoc ''
`Match` block conditions used by this block. See
{manpage}`ssh_config(5)`
for `Match` block details.
This option takes precedence over
<option>ssh.matchBlocks.*.host</option>
{option}`ssh.matchBlocks.*.host`
if defined.
'';
};
@ -103,13 +97,13 @@ let
port = mkOption {
type = types.nullOr types.port;
default = null;
description = "Specifies port number to connect on remote host.";
description = lib.mdDoc "Specifies port number to connect on remote host.";
};
forwardAgent = mkOption {
default = null;
type = types.nullOr types.bool;
description = ''
description = lib.mdDoc ''
Whether the connection to the authentication agent (if any)
will be forwarded to the remote machine.
'';
@ -118,16 +112,16 @@ let
forwardX11 = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Specifies whether X11 connections will be automatically redirected
over the secure channel and <envar>DISPLAY</envar> set.
over the secure channel and {env}`DISPLAY` set.
'';
};
forwardX11Trusted = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Specifies whether remote X11 clients will have full access to the
original X11 display.
'';
@ -136,11 +130,11 @@ let
identitiesOnly = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Specifies that ssh should only use the authentication
identity explicitly configured in the
<filename>~/.ssh/config</filename> files or passed on the
ssh command-line, even if <command>ssh-agent</command>
{file}`~/.ssh/config` files or passed on the
ssh command-line, even if {command}`ssh-agent`
offers more identities.
'';
};
@ -152,7 +146,7 @@ let
if p == null then []
else if isString p then [p]
else p;
description = ''
description = lib.mdDoc ''
Specifies files from which the user identity is read.
Identities will be tried in the given order.
'';
@ -161,26 +155,26 @@ let
user = mkOption {
type = types.nullOr types.str;
default = null;
description = "Specifies the user to log in as.";
description = lib.mdDoc "Specifies the user to log in as.";
};
hostname = mkOption {
type = types.nullOr types.str;
default = null;
description = "Specifies the real host name to log into.";
description = lib.mdDoc "Specifies the real host name to log into.";
};
serverAliveInterval = mkOption {
type = types.int;
default = 0;
description =
"Set timeout in seconds after which response will be requested.";
lib.mdDoc "Set timeout in seconds after which response will be requested.";
};
serverAliveCountMax = mkOption {
type = types.ints.positive;
default = 3;
description = ''
description = lib.mdDoc ''
Sets the number of server alive messages which may be sent
without SSH receiving any messages back from the server.
'';
@ -189,7 +183,7 @@ let
sendEnv = mkOption {
type = types.listOf types.str;
default = [];
description = ''
description = lib.mdDoc ''
Environment variables to send from the local host to the
server.
'';
@ -198,7 +192,7 @@ let
setEnv = mkOption {
type = with types; attrsOf (oneOf [ str path int float ]);
default = {};
description = ''
description = lib.mdDoc ''
Environment variables and their value to send to the server.
'';
};
@ -206,31 +200,31 @@ let
compression = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
Specifies whether to use compression. Omitted from the host
block when <literal>null</literal>.
block when `null`.
'';
};
checkHostIP = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Check the host IP address in the
<filename>known_hosts</filename> file.
{file}`known_hosts` file.
'';
};
proxyCommand = mkOption {
type = types.nullOr types.str;
default = null;
description = "The command to use to connect to the server.";
description = lib.mdDoc "The command to use to connect to the server.";
};
proxyJump = mkOption {
type = types.nullOr types.str;
default = null;
description = "The proxy host to use to connect to the server.";
description = lib.mdDoc "The proxy host to use to connect to the server.";
};
certificateFile = mkOption {
@ -240,7 +234,7 @@ let
if p == null then []
else if isString p then [p]
else p;
description = ''
description = lib.mdDoc ''
Specifies files from which the user certificate is read.
'';
};
@ -248,7 +242,7 @@ let
addressFamily = mkOption {
default = null;
type = types.nullOr (types.enum ["any" "inet" "inet6"]);
description = ''
description = lib.mdDoc ''
Specifies which address family to use when connecting.
'';
};
@ -265,12 +259,9 @@ let
}
];
'';
description = ''
description = lib.mdDoc ''
Specify local port forwardings. See
<citerefentry>
<refentrytitle>ssh_config</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for <literal>LocalForward</literal>.
{manpage}`ssh_config(5)` for `LocalForward`.
'';
};
@ -286,12 +277,9 @@ let
}
];
'';
description = ''
description = lib.mdDoc ''
Specify remote port forwardings. See
<citerefentry>
<refentrytitle>ssh_config</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for <literal>RemoteForward</literal>.
{manpage}`ssh_config(5)` for `RemoteForward`.
'';
};
@ -301,19 +289,16 @@ let
example = literalExpression ''
[ { port = 8080; } ];
'';
description = ''
description = lib.mdDoc ''
Specify dynamic port forwardings. See
<citerefentry>
<refentrytitle>ssh_config</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for <literal>DynamicForward</literal>.
{manpage}`ssh_config(5)` for `DynamicForward`.
'';
};
extraOptions = mkOption {
type = types.attrsOf types.str;
default = {};
description = "Extra configuration options for the host.";
description = lib.mdDoc "Extra configuration options for the host.";
};
};
@ -359,7 +344,7 @@ in
meta.maintainers = [ maintainers.rycee ];
options.programs.ssh = {
enable = mkEnableOption "SSH client configuration";
enable = mkEnableOption (lib.mdDoc "SSH client configuration");
package = mkPackageOptionMD pkgs "openssh" {
nullable = true;
@ -370,7 +355,7 @@ in
forwardAgent = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether the connection to the authentication agent (if any)
will be forwarded to the remote machine.
'';
@ -379,13 +364,13 @@ in
compression = mkOption {
default = false;
type = types.bool;
description = "Specifies whether to use compression.";
description = lib.mdDoc "Specifies whether to use compression.";
};
serverAliveInterval = mkOption {
type = types.int;
default = 0;
description = ''
description = lib.mdDoc ''
Set default timeout in seconds after which response will be requested.
'';
};
@ -393,7 +378,7 @@ in
serverAliveCountMax = mkOption {
type = types.ints.positive;
default = 3;
description = ''
description = lib.mdDoc ''
Sets the default number of server alive messages which may be
sent without SSH receiving any messages back from the server.
'';
@ -402,12 +387,9 @@ in
hashKnownHosts = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Indicates that
<citerefentry>
<refentrytitle>ssh</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`ssh(1)`
should hash host names and addresses when they are added to
the known hosts file.
'';
@ -416,17 +398,17 @@ in
userKnownHostsFile = mkOption {
type = types.str;
default = "~/.ssh/known_hosts";
description = ''
description = lib.mdDoc ''
Specifies one or more files to use for the user host key
database, separated by whitespace. The default is
<filename>~/.ssh/known_hosts</filename>.
{file}`~/.ssh/known_hosts`.
'';
};
controlMaster = mkOption {
default = "no";
type = types.enum ["yes" "no" "ask" "auto" "autoask"];
description = ''
description = lib.mdDoc ''
Configure sharing of multiple sessions over a single network connection.
'';
};
@ -434,7 +416,7 @@ in
controlPath = mkOption {
type = types.str;
default = "~/.ssh/master-%r@%n:%p";
description = ''
description = lib.mdDoc ''
Specify path to the control socket used for connection sharing.
'';
};
@ -443,7 +425,7 @@ in
type = types.str;
default = "no";
example = "10m";
description = ''
description = lib.mdDoc ''
Whether control socket should remain open in the background.
'';
};
@ -451,7 +433,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra configuration.
'';
};
@ -459,7 +441,7 @@ in
extraOptionOverrides = mkOption {
type = types.attrsOf types.str;
default = {};
description = ''
description = lib.mdDoc ''
Extra SSH configuration options that take precedence over any
host specific configuration.
'';
@ -468,15 +450,12 @@ in
includes = mkOption {
type = types.listOf types.str;
default = [];
description = ''
description = lib.mdDoc ''
File globs of ssh config files that should be included via the
<literal>Include</literal> directive.
</para><para>
`Include` directive.
See
<citerefentry>
<refentrytitle>ssh_config</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
{manpage}`ssh_config(5)`
for more information.
'';
};
@ -496,16 +475,13 @@ in
};
};
'';
description = ''
description = lib.mdDoc ''
Specify per-host settings. Note, if the order of rules matter
then use the DAG functions to express the dependencies as
shown in the example.
</para><para>
See
<citerefentry>
<refentrytitle>ssh_config</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
{manpage}`ssh_config(5)`
for more information.
'';
};