diff --git a/options.xhtml b/options.xhtml index 29597d015..ebbaa8831 100644 --- a/options.xhtml +++ b/options.xhtml @@ -51917,6 +51917,406 @@ null or (attribute set of (string or signed integer or boolean or list of string +
+ + programs.smug.enable + + +
+
+

Whether to enable Smug session manager.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

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

The smug package to use.

+ +

Type: +null or package

+ +

Default: +pkgs.smug

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects + + +
+
+

Attribute set with project configurations.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.beforeStart + + +
+
+

Commands to execute before the tmux-session starts.

+ +

Type: +null or (list of string)

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.env + + +
+
+

Environment Variables to set in session.

+ +

Type: +null or (attribute set of string)

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.root + + +
+
+

Root path in filesystem of the smug project. This is where tmux +changes its directory to.

Application defaults to $HOME.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.stop + + +
+
+

Commands to execute after the tmux-session is destroyed.

+ +

Type: +null or (list of string)

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows + + +
+
+

Windows to create in the project session

+ +

Type: +list of (submodule)

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.commands + + +
+
+

Commands to execute when window starts.

+ +

Type: +null or (list of string)

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.layout + + +
+
+

Layout of window when opening panes.

+ +

Type: +one of “main-horizontal”, “main-vertical”, “even-vertical”, “even-horizontal”, “tiled”

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.manual + + +
+
+

Start window only manually, using the -w arg

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.name + + +
+
+

Name of the tmux window;

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.panes + + +
+
+

Panes to open in a window.

+ +

Type: +null or (list of (submodule))

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.panes.*.commands + + +
+
+

Commands to execute when pane starts.

+ +

Type: +null or (list of string)

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.panes.*.root + + +
+
+

Root path of pane. This is relative to the path of the smug project.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.panes.*.type + + +
+
+

Type of pane.

+ +

Type: +one of “horizontal”, “vertical”

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
+
+ + programs.smug.projects.<name>.windows.*.root + + +
+
+

Root path of window. This is relative to the path of the smug project.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/smug.nix> + +
+
programs.spotify-player.enable