diff --git a/options.xhtml b/options.xhtml index 79ea8780f..6d8009748 100644 --- a/options.xhtml +++ b/options.xhtml @@ -39755,6 +39755,290 @@ null or string

+
+ + programs.sftpman.enable + + +
+
+

Whether to enable sftpman, an application that handles sshfs/sftp file systems mounting.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.package + + +
+
+

The sftpman package to use.

+ +

Type: +package

+ +

Default: +pkgs.sftpman

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.defaultSshKey + + +
+
+

Path to the SSH key to be used by default. Can be overridden per host.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts + + +
+
+

The sshfs mount configurations written to +$XDG_CONFIG_HOME/sftpman/mounts/.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.authType + + +
+
+

The authentication method to use.

+ +

Type: +one of “password”, “publickey”, “hostbased”, “keyboard-interactive”, “gssapi-with-mic”

+ +

Default: +"publickey"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.beforeMount + + +
+
+

Command to run before mounting.

+ +

Type: +string

+ +

Default: +"true"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.host + + +
+
+

The host to connect to.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.mountOptions + + +
+
+

Options to pass to sshfs.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.mountPoint + + +
+
+

The remote path to mount.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.port + + +
+
+

The port to connect to.

+ +

Type: +16 bit unsigned integer; between 0 and 65535 (both inclusive)

+ +

Default: +22

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.sshKey + + +
+
+

Path to the SSH key to use for authentication. +Only applies if authMethod is publickey.

+ +

Type: +null or string

+ +

Default: +config.programs.sftpman.defaultSshKey

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
+
+ + programs.sftpman.mounts.<name>.user + + +
+
+

The username to authenticate with.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/sftpman.nix> + +
+
programs.sioyek.enable