From 30288109a6b81e5a150595542c73459f2d7f8802 Mon Sep 17 00:00:00 2001 From: rycee Date: Sun, 24 Jul 2022 13:31:28 +0000 Subject: [PATCH] deploy: 572f348a10826b2207caaf394e9ad2e9ffc6ffa7 --- index.html | 4 +- options.html | 155 ++++++++++++++++++++++++++++++--------------------- tools.html | 14 ++--- 3 files changed, 101 insertions(+), 72 deletions(-) diff --git a/index.html b/index.html index 3b665d912..868f34d2f 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual
Home Manager Manual
   Next

Home Manager Manual

Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager - — reconfigure a user environment
E. Release Notes
E.1. Release 22.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual
   Next

Home Manager Manual

Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager + — reconfigure a user environment
E. Release Notes
E.1. Release 22.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 18.09

Preface

This manual will eventually describe how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index eb1bc1ea2..ec5214ad7 100644 --- a/options.html +++ b/options.html @@ -10695,12 +10695,42 @@ for the exact format. ]

Declared by:

<home-manager/modules/misc/tmpfiles.nix> +
targets.darwin.currentHostDefaults

Set macOS user defaults. Unlike targets.darwin.defaults, +the preferences will only be applied to the currently logged-in host. This +distinction is important for networked accounts. + +Values set to null are ignored. + +

Warning

+ Some settings might require a re-login to take effect. +

+

Type: attribute set of attribute set of anything

Default: + { + + } +

Example: + { + com.apple.controlcenter = + { + BatteryShowPercentage = true; + } + ; + } +

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults> +
targets.darwin.currentHostDefaults.com.apple.controlcenter.BatteryShowPercentage

Whether to show battery percentage in the menu bar. +

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-currenthost.nix>
targets.darwin.defaults

Set macOS user defaults. Values set to null are ignored.

Warning

Some settings might require a re-login to take effect.

+

Warning

+ Some settings are only read from + targets.darwin.currentHostDefaults. +

Type: attribute set of attribute set of anything

Default: { @@ -10713,100 +10743,99 @@ ignored. } ; } -

Declared by:

- <home-manager/modules/targets/darwin> +

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults>
targets.darwin.defaults.NSGlobalDomain.AppleLanguages

Sets the language to use in the preferred order.

Type: null or list of string

Default: null

Example: [ "en" ] -

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.AppleLocale

Configures the user locale.

Type: null or string

Default: null

Example: "en_US"

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.AppleMeasurementUnits

Sets the measurement unit.

Type: null or one of "Centimeters", "Inches"

Default: null

Example: "Centimeters"

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.AppleMetricUnits

Whether to enable the metric system.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.AppleTemperatureUnit

Sets the temperature unit.

Type: null or one of "Celsius", "Fahrenheit"

Default: null

Example: "Celsius"

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.NSAutomaticCapitalizationEnabled

Whether to enable automatic captilization.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.NSAutomaticDashSubstitutionEnabled

Whether to enable smart dashes.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.NSAutomaticPeriodSubstitutionEnabled

Whether to enable period with double space.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.NSAutomaticQuoteSubstitutionEnabled

Whether to enable smart quotes.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.NSGlobalDomain.NSAutomaticSpellingCorrectionEnabled

Whether to enable spelling correction.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.Safari.AutoFillCreditCardData

Whether to enable autofill of credit card numbers.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.Safari.AutoFillPasswords

Whether to enable autofill of usernames and passwords.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.Safari.AutoOpenSafeDownloads

Whether to enable opening of downloaded files.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.Safari.IncludeDevelopMenu

Whether to enable "Develop" menu in the menu bar.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.Safari.ShowOverlayStatusBar

Whether to enable status bar.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> +

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.AppleLocale

Configures the user locale.

Type: null or string

Default: null

Example: "en_US"

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.AppleMeasurementUnits

Sets the measurement unit.

Type: null or one of "Centimeters", "Inches"

Default: null

Example: "Centimeters"

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.AppleMetricUnits

Whether to enable the metric system.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.AppleTemperatureUnit

Sets the temperature unit.

Type: null or one of "Celsius", "Fahrenheit"

Default: null

Example: "Celsius"

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.NSAutomaticCapitalizationEnabled

Whether to enable automatic captilization.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.NSAutomaticDashSubstitutionEnabled

Whether to enable smart dashes.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.NSAutomaticPeriodSubstitutionEnabled

Whether to enable period with double space.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.NSAutomaticQuoteSubstitutionEnabled

Whether to enable smart quotes.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.NSGlobalDomain.NSAutomaticSpellingCorrectionEnabled

Whether to enable spelling correction.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.Safari.AutoFillCreditCardData

Whether to enable autofill of credit card numbers.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.Safari.AutoFillPasswords

Whether to enable autofill of usernames and passwords.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.Safari.AutoOpenSafeDownloads

Whether to enable opening of downloaded files.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.Safari.IncludeDevelopMenu

Whether to enable "Develop" menu in the menu bar.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.Safari.ShowOverlayStatusBar

Whether to enable status bar.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.defaults.com.apple.Safari.WebKitDeveloperExtrasEnabledPreferenceKey

Configures the web inspector.

Warning

Instead of setting this option directly, set IncludeDevelopMenu instead.

-

Type: null or boolean

Default: null

Declared by:

- <home-manager/modules/targets/darwin/options.nix> +

Type: null or boolean

Default: null

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.defaults.com.apple.Safari.WebKitPreferences.developerExtrasEnabled

Configures the web inspector.

Warning

Instead of setting this option directly, set IncludeDevelopMenu instead.

-

Type: null or boolean

Default: null

Declared by:

- <home-manager/modules/targets/darwin/options.nix> +

Type: null or boolean

Default: null

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.defaults.com.apple.Safari.SandboxBroker.ShowDevelopMenu

Show the "Develop" menu in Safari's menubar.

Warning

Instead of setting this option directly, set "com.apple.Safari".IncludeDevelopMenu instead.

-

Type: null or boolean

Default: null

Declared by:

- <home-manager/modules/targets/darwin/options.nix> +

Type: null or boolean

Default: null

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.defaults.com.apple.desktopservices.DSDontWriteNetworkStores

Disable use of .DS_Store files on network shares. See the official article for more info. -

Type: null or boolean

Default: null

Example: false

Declared by:

- <home-manager/modules/targets/darwin/options.nix> +

Type: null or boolean

Default: null

Example: false

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.defaults.com.apple.desktopservices.DSDontWriteUSBStores

Disable use of .DS_Store files on thumb drives. -

Type: null or boolean

Default: null

Example: false

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.dock.expose-group-apps

Whether to enable grouping of windows by application in Mission Control.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.dock.size-immutable

Whether to enable locking of the dock size.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.dock.tilesize

Sets the size of the dock.

Type: null or signed integer

Default: null

Example: 64

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.apple.menuextra.battery.ShowPercent

This option no longer works on macOS 11 and later. Instead, open System -Preferences, go to "Dock & Menu Bar", select "Battery", and toggle -the checkbox labeled "Show Percentage." +

Type: null or boolean

Default: null

Example: false

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.dock.expose-group-apps

Whether to enable grouping of windows by application in Mission Control.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.dock.size-immutable

Whether to enable locking of the dock size.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.dock.tilesize

Sets the size of the dock.

Type: null or signed integer

Default: null

Example: 64

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.apple.menuextra.battery.ShowPercent

This option no longer works on macOS 11 and later. Instead, use +targets.darwin.currentHostDefaults.\"com.apple.controlcenter\".BatteryShowPercentage. Whether to show battery percentage in the menu bar. -

Type: null or one of "YES", "NO"

Default: null

Example: "NO"

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.googlecode.iterm2.AddNewTabAtEndOfTabs

Whether to enable placement of new tabs at the end of the tab bar.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.googlecode.iterm2.AlternateMouseScroll

Whether to enable arrow keys when scrolling in alternate screen mode.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.googlecode.iterm2.CopySelection

Whether to enable copy to clipboard upon selecting text.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> -
targets.darwin.defaults.com.googlecode.iterm2.ExperimentalKeyHandling

Whether to enable experimental key handling for AquaSKK compatibility.

Type: null or boolean

Default: null

Example: true

Declared by:

- <home-manager/modules/targets/darwin/options.nix> +

Type: null or one of "YES", "NO"

Default: null

Example: "NO"

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.googlecode.iterm2.AddNewTabAtEndOfTabs

Whether to enable placement of new tabs at the end of the tab bar.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.googlecode.iterm2.AlternateMouseScroll

Whether to enable arrow keys when scrolling in alternate screen mode.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.googlecode.iterm2.CopySelection

Whether to enable copy to clipboard upon selecting text.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> +
targets.darwin.defaults.com.googlecode.iterm2.ExperimentalKeyHandling

Whether to enable experimental key handling for AquaSKK compatibility.

Type: null or boolean

Default: null

Example: true

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.defaults.com.googlecode.iterm2.OpenTmuxWindowsIn

Configures how to restore tmux windows when attaching to a session.

Possible Values

0

Native windows

1

Native tabs in a new window

2

Tabs in the attaching window

-

Type: null or signed integer

Default: null

Example: 2

Declared by:

- <home-manager/modules/targets/darwin/options.nix> +

Type: null or signed integer

Default: null

Example: 2

Declared by:

+ <home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.keybindings

This will configure the default keybindings for text fields in macOS applications. See Apple's documentation diff --git a/tools.html b/tools.html index 3ad48fc51..466c9291c 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

home-manager { build | @@ -84,7 +84,7 @@ | --verbose } - ]

Description

+ ]

Description

This command updates the user environment so that it corresponds to the configuration specified in ~/.config/nixpkgs/home.nix or ~/.config/nixpkgs/flake.nix.

@@ -153,7 +153,7 @@ available for immediate garbage collection.

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -265,15 +265,15 @@ --verbose

Activates verbose output. -

Files

+

Files

$XDG_DATA_HOME/home-manager/news-read-ids

Identifiers of news items that have been shown. Can be deleted to reset the read news indicator. -

Bugs

+

Bugs

Please report any bugs on the project issue tracker. -

See also

+

See also

home-configuration.nix(5)

Prev   Next
Appendix C. nix-darwin Module Options Home Appendix E. Release Notes
\ No newline at end of file