From ee55bcf040b36670575121b2f306e153b81993c9 Mon Sep 17 00:00:00 2001 From: rycee Date: Sun, 18 Jul 2021 20:13:06 +0000 Subject: [PATCH] deploy: 5f433eb164832fc507c3e1ba2a798f8c00578316 --- index.html | 4 +- options.html | 240 ++++++++++++++++++++++++++++++++++++++++++++- release-notes.html | 22 ++++- tools.html | 14 +-- 4 files changed, 267 insertions(+), 13 deletions(-) diff --git a/index.html b/index.html index 8dd8b9c7d..c126d37cd 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 18.09

Preface

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

diff --git a/options.html b/options.html index 539a9c2d4..53111f923 100644 --- a/options.html +++ b/options.html @@ -12173,6 +12173,244 @@ for the exact format.

Declared by:

<home-manager/modules/misc/tmpfiles.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. +

+

Type: attribute set of attribute set of anythingss

Default: + + { + + } + +

Example: + + { + com.apple.desktopservices = + { + DSDontWriteNetworkStores = true; DSDontWriteUSBStores = true; + } + ; + } + +

Declared by:

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

Sets the language to use in the preferred order.

Type: null or list of strings

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> +
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> +
targets.darwin.defaults.com.apple.Safari.com.apple.Safari.ContentPageGroupIdentifier.WebKit2DeveloperExtrasEnabled

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> +
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> +
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

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> +
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> +
targets.darwin.keybindings

This will configure the default keybindings for text fields in macOS +applications. See +Apple's documentation +for more details. + +

Warning

+ Existing keybinding configuration will be wiped when using this + option. +

+

Type: attribute set of anythings

Default: + + { + + } + +

Example: + + { + ^u = "deleteToBeginningOfLine:"; ^w = "deleteWordBackward:"; + } + +

Declared by:

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

Default search engine.

Type: null or one of "Bing", "DuckDuckGo", "Ecosia", "Google", "Yahoo"

Default: + null +

Declared by:

+ <home-manager/modules/targets/darwin/search.nix>
targets.genericLinux.enable

Whether to enable settings that make Home Manager work better on GNU/Linux distributions other than NixOS.

Type: boolean

Default: @@ -13230,7 +13468,7 @@ and https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html, respectively.

Type: boolean

Default: - true + true if host platform is Linux, false otherwise

Declared by:

<home-manager/modules/misc/xdg-mime.nix>
xdg.mimeApps.enable

Whether to manage $XDG_CONFIG_HOME/mimeapps.list. diff --git a/release-notes.html b/release-notes.html index e1c367a16..43f55bd8a 100644 --- a/release-notes.html +++ b/release-notes.html @@ -1,8 +1,24 @@ Appendix E. Release Notes

Appendix E. Release Notes
Prev   

Release Notes

E.1. Release 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 18.09

This section lists the release notes for stable versions of Home Manager and the current unstable version.

E.1. Release 21.11

This is the current unstable branch and the information in this -section is therefore not final.

E.1.1. Highlights

This release has the following notable changes:

  • -Nothing has happened. -

E.1.2. State Version Changes

The state version in this release includes the changes below. These +section is therefore not final.

E.1.1. Highlights

This release has the following notable changes:

  • +All Home Manager modules are now loaded on all platforms. With this +change you will get a more descriptive error message if you attempt to +enable a module that is incompatible with the host platform. +

    Previously, modules that were platform specific would only be loaded +on that particular platform. For example, a module defining a +systemd service would only be loaded when the +host platform was Linux. This reduced evaluation times, simplified the +generated documentation, and made it impossible to accidentally use +modules that do not support the host platform.

    While the above benefits are quite nice, avoiding module loads also +brings a few problems. For example, the +public documentation +will only show the options available for Linux hosts and the +documentation cannot make references to options within modules that +are unavailable on some hosts. Finally, users who wish to use the same +configuration file for different platforms cannot do so, even if the +platform incompatible options are unused.

    Ultimately, the benefits of loading all modules won and the behavior +has now changed. For associated discussion see +issue #1906.

E.1.2. State Version Changes

The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "21.11" or later.

  • Nothing has happened. diff --git a/tools.html b/tools.html index ccd6956b8..ae288dfe3 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 | @@ -78,7 +78,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.

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

-

Options

+

Options

The tool accepts the options

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

Activates verbose output. -

Files

+

Files

~/.local/share/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