updated option documentation to reflect recent structure changes
This commit is contained in:
@@ -1,235 +1,225 @@
|
|||||||
# Home-Manager Options
|
# Home-Manager Options
|
||||||
|
|
||||||
## homeFiles.enable
|
- **movOpts**
|
||||||
- Enables my declared files
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/files/neofetch.nix'
|
|
||||||
|
|
||||||
## hyprlandConfig.enable
|
- **homeFiles**
|
||||||
- Enables my custom hyprland configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my declared files.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/hyprland.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/files.nix`
|
||||||
|
|
||||||
## autojumpConfig.enable
|
---
|
||||||
- Enables my autojump options
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/programs/autojump.nix'
|
|
||||||
|
|
||||||
## stylixHomeConfig.enable
|
- **envConfig**
|
||||||
- Enables my stylix home-manager options
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/environment/stylix.nix'
|
|
||||||
|
|
||||||
## waybarConfig.enable
|
- **hyprlandConfig**
|
||||||
- Enables my custom waybar configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my custom Hyprland configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/waybar.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/hyprland.nix`
|
||||||
|
- **monitorNames**
|
||||||
|
- List of monitor names for my Hyprland configuration.
|
||||||
|
- *Type*: List of Strings
|
||||||
|
- *Default*: `[]`
|
||||||
|
- *Defined in*: `modules/home/environment/hyprland.nix`
|
||||||
|
- **workspaceLayout**
|
||||||
|
- Workspace layout for Hyprland (e.g., dual monitor setups).
|
||||||
|
- *Type*: String
|
||||||
|
- *Default*: `"dualmonitor"`
|
||||||
|
- *Defined in*: `modules/home/environment/hyprland.nix`
|
||||||
|
|
||||||
## gtkConfig.enable
|
- **userPkgs**
|
||||||
- Enables my gtk configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my default user packages.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/gtk.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/userpkgs.nix`
|
||||||
|
|
||||||
## spicetifyConfig.enable
|
- **stylixHomeConfig**
|
||||||
- Enables my spicetify configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Stylix Home-Manager options.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/spicetify.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/stylix.nix`
|
||||||
|
|
||||||
## starshipConfig.enable
|
- **waybarConfig**
|
||||||
- Enables my starship configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my custom Waybar configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/starship.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/waybar.nix`
|
||||||
|
|
||||||
## btopConfig.enable
|
- **gtkConfig**
|
||||||
- Enables my btop configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my GTK configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/btop.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/gtk.nix`
|
||||||
|
|
||||||
## swayncConfig.enable
|
- **spicetifyConfig**
|
||||||
- Enables my swaync configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Spicetify configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/swaync.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/spicetify.nix`
|
||||||
|
|
||||||
## userPkgs.enable
|
- **starshipConfig**
|
||||||
- Enables my default user packages
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Starship prompt configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/userpkgs.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/starship.nix`
|
||||||
|
|
||||||
## cavaConfig.enable
|
- **swayncConfig**
|
||||||
- Enables my cava configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my SwayNC configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/cava.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/swaync.nix`
|
||||||
|
|
||||||
## ezaConfig.enable
|
- **zshConfig**
|
||||||
- Enables my eza configuration
|
- **shellAliases**
|
||||||
- Type: Boolean
|
- **enable**
|
||||||
- Default: true
|
- Enables custom shell aliases.
|
||||||
- Defined in 'modules/home/programs/eza.nix'
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/zsh/aliases.nix`
|
||||||
|
- **envVariables**
|
||||||
|
- **enable**
|
||||||
|
- Enables custom environment variables for Zsh.
|
||||||
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/zsh/env.nix`
|
||||||
|
- **shellOptions**
|
||||||
|
- **enable**
|
||||||
|
- Enables custom shell options for Zsh.
|
||||||
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/zsh/options.nix`
|
||||||
|
- **extraConfig**
|
||||||
|
- **enable**
|
||||||
|
- Enables extra custom configuration for Zsh.
|
||||||
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/environment/zsh/extraconfig.nix`
|
||||||
|
|
||||||
## firefoxConfig.enable
|
---
|
||||||
- Enables my firefox configuration
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/programs/firefox.nix'
|
|
||||||
|
|
||||||
## fuzzelConfig.enable
|
- **programConfigs**
|
||||||
- Enables my fuzzel configuration
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/programs/fuzzel.nix'
|
|
||||||
|
|
||||||
## fzfConfig.enable
|
- **autojumpConfig**
|
||||||
- Enables my fzf configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Autojump options.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/fzf.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/autojump.nix`
|
||||||
|
|
||||||
## gitConfig.enable
|
- **btopConfig**
|
||||||
- Enables my git configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Btop configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/git.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/btop.nix`
|
||||||
|
|
||||||
## kittyConfig.enable
|
- **cavaConfig**
|
||||||
- Enables my kitty configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Cava configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/kitty.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/cava.nix`
|
||||||
|
|
||||||
## yaziConfig.enable
|
- **ezaConfig**
|
||||||
- Enables my yazi configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Eza configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/yazi.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/eza.nix`
|
||||||
|
|
||||||
## zshConfig.enable
|
- **firefoxConfig**
|
||||||
- Enables my zsh configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Firefox configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/environment/zshell.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/firefox.nix`
|
||||||
|
|
||||||
## passConfig.enable
|
- **fuzzelConfig**
|
||||||
- Enables my password-store configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Fuzzel configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/password-store.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/fuzzel.nix`
|
||||||
|
|
||||||
## batConfig.enable
|
- **fzfConfig**
|
||||||
- Enables my bat configuration
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my FZF configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/programs/bat.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/fzf.nix`
|
||||||
|
|
||||||
## movScripts.enable
|
- **gitConfig**
|
||||||
- Enables my custom script binaries
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Git configuration.
|
||||||
- Default: true
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/programs/git.nix`
|
||||||
|
|
||||||
## movScripts.commandScripts
|
- **kittyConfig**
|
||||||
### enable
|
- **enable**
|
||||||
- Enables my custom command scripts
|
- Enables my Kitty configuration.
|
||||||
- Type: Boolean
|
- *Type*: Boolean
|
||||||
- Default: true
|
- *Default*: `true`
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
- *Defined in*: `modules/home/programs/kitty.nix`
|
||||||
### invoke.enable
|
|
||||||
- Enables the invoke command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### runbg.enable
|
|
||||||
- Enables the runbg command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### splash.enable
|
|
||||||
- Enables the splash command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### toolbelt.enable
|
|
||||||
- Enables the toolbelt command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### viconf.enable
|
|
||||||
- Enables the viconf command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
|
|
||||||
## movScripts.hyprlandControls
|
- **yaziConfig**
|
||||||
### enable
|
- **enable**
|
||||||
- Enables my hyprland control shortcut scripts
|
- Enables my Yazi configuration.
|
||||||
- Type: Boolean
|
- *Type*: Boolean
|
||||||
- Default: true
|
- *Default*: `true`
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
- *Defined in*: `modules/home/programs/yazi.nix`
|
||||||
### chpaper.enable
|
|
||||||
- Enables the chpaper command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### scheck.enable
|
|
||||||
- Enables the scheck command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### chscheme.enable
|
|
||||||
- Enables the chscheme command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### keyring.enable
|
|
||||||
- Enables the keyring command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### moveonscreen.enable
|
|
||||||
- Enables the moveonscreen command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### switchmon.enable
|
|
||||||
- Enables the switchmon command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### mkscreenshots.enable
|
|
||||||
- Enables the mkscreenshots command
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
|
|
||||||
## movScripts.nixShortcuts
|
- **passConfig**
|
||||||
### enable
|
- **enable**
|
||||||
- Enables my NixOS aliases
|
- Enables my Password-Store configuration.
|
||||||
- Type: Boolean
|
- *Type*: Boolean
|
||||||
- Default: true
|
- *Default*: `true`
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
- *Defined in*: `modules/home/programs/password-store.nix`
|
||||||
### garbage-collect.enable
|
|
||||||
- Enables the garbage-collect command
|
- **batConfig**
|
||||||
- Type: Boolean
|
- **enable**
|
||||||
- Default: true
|
- Enables my Bat configuration.
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
- *Type*: Boolean
|
||||||
### nsp.enable
|
- *Default*: `true`
|
||||||
- Enables the nsp command
|
- *Defined in*: `modules/home/programs/bat.nix`
|
||||||
- Type: Boolean
|
|
||||||
- Default: true
|
---
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
|
||||||
### rebuild.enable
|
- **movScripts**
|
||||||
- Enables the rebuild command
|
|
||||||
- Type: Boolean
|
- **enable**
|
||||||
- Default: true
|
- Enables all custom script binaries.
|
||||||
- Defined in 'modules/home/scripts/default.nix'
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/scripts/default.nix`
|
||||||
|
|
||||||
|
- **commandScripts**
|
||||||
|
- **enable**
|
||||||
|
- Enables my custom command scripts.
|
||||||
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/scripts/default.nix`
|
||||||
|
|
||||||
|
- **hyprlandControls**
|
||||||
|
- **enable**
|
||||||
|
- Enables my Hyprland control shortcut scripts.
|
||||||
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/scripts/default.nix`
|
||||||
|
|
||||||
|
- **nixShortcuts**
|
||||||
|
- **enable**
|
||||||
|
- Enables my NixOS alias scripts.
|
||||||
|
- *Type*: Boolean
|
||||||
|
- *Default*: `true`
|
||||||
|
- *Defined in*: `modules/home/scripts/default.nix`
|
||||||
|
|||||||
@@ -1,79 +1,92 @@
|
|||||||
# System Options
|
# System Options
|
||||||
|
|
||||||
## networkModule.enable
|
- **sysEnv**
|
||||||
- Enables my network configuration
|
- **issue**
|
||||||
- Type: Boolean
|
- **enable**
|
||||||
- Default: false
|
- Enables my custom `/etc/issue` TTY splash screen.
|
||||||
- Defined in 'modules/sys/hardware/network.nix'
|
- *Type*: Boolean
|
||||||
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/environment/issue.nix`
|
||||||
|
|
||||||
## nixSettings.enable
|
- **sddmConfig**
|
||||||
- Enables my NixOS settings
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Catppuccin-SDDM configuration.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/environment/nix.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/environment/sddm.nix`
|
||||||
|
|
||||||
## bootLoader.enable
|
- **stylixConfig**
|
||||||
- Enables my bootloader settings
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables Stylix for system theming.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/hardware/bootloader.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/environment/stylix.nix`
|
||||||
|
|
||||||
## issue.enable
|
- **nixSettings**
|
||||||
- Enables my custom /etc/issue tty splash screen
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my NixOS settings.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/environment/issue.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/environment/nix.nix`
|
||||||
|
|
||||||
## sddmConfig.enable
|
---
|
||||||
- Enables my catppuccin-sddm configuration
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: false
|
|
||||||
- Defined in 'modules/sys/environment/sddm.nix'
|
|
||||||
|
|
||||||
## stylixConfig.enable
|
- **hardwareCfg**
|
||||||
- Enables stylix for system theming
|
- **networkModule**
|
||||||
- Type: Boolean
|
- **enable**
|
||||||
- Default: false
|
- Enables my network configuration.
|
||||||
- Defined in 'modules/sys/environment/stylix.nix'
|
- *Type*: Boolean
|
||||||
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/hardware/network.nix`
|
||||||
|
|
||||||
## gamingPkgs.enable
|
- **bootLoader**
|
||||||
- Enables gaming-related packages
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my bootloader settings.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/software/gaming/gaming_pkgs.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/hardware/bootloader.nix`
|
||||||
|
|
||||||
## steamConfig.enable
|
---
|
||||||
- Enables my Steam configuration
|
|
||||||
- Type: Boolean
|
|
||||||
- Default: false
|
|
||||||
- Defined in 'modules/sys/software/gaming/steam.nix'
|
|
||||||
|
|
||||||
## sysPkgs.enable
|
- **softwareCfg**
|
||||||
- Installs my default system packages
|
- **gamingPkgs**
|
||||||
- Type: Boolean
|
- **enable**
|
||||||
- Default: false
|
- Enables gaming-related packages.
|
||||||
- Defined in 'modules/sys/software/packages.nix'
|
- *Type*: Boolean
|
||||||
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/software/gaming/gaming_pkgs.nix`
|
||||||
|
|
||||||
## sysProgs.enable
|
- **steamConfig**
|
||||||
- Enables
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my Steam configuration.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/software/programs.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/software/gaming/steam.nix`
|
||||||
|
|
||||||
## sysServices.enable
|
- **sysPkgs**
|
||||||
- Description
|
- **enable**
|
||||||
- Type: Boolean
|
- Installs my default system packages.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/software/services.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/software/packages.nix`
|
||||||
|
|
||||||
## virtConfig.enable
|
- **sysProgs**
|
||||||
- Description
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables my system programs.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/software/virtualization.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/software/programs.nix`
|
||||||
|
|
||||||
## powerProfiles.enable
|
- **sysServices**
|
||||||
- Description
|
- **enable**
|
||||||
- Type: Boolean
|
- Enables system services.
|
||||||
- Default: false
|
- *Type*: Boolean
|
||||||
- Defined in 'modules/sys/hardware/powerprofiles.nix'
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/software/services.nix`
|
||||||
|
|
||||||
|
- **virtConfig**
|
||||||
|
- **enable**
|
||||||
|
- Enables virtualization-related configuration.
|
||||||
|
- *Type*: Boolean
|
||||||
|
- *Default*: `false`
|
||||||
|
- *Defined in*: `modules/sys/software/virtualization.nix`
|
||||||
|
|||||||
Reference in New Issue
Block a user