diff --git a/index.html b/index.html index cbc4d9432..58ee35358 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual

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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 20.09
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.03
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 19.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual


Preface

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

diff --git a/options.html b/options.html index 91eea302a..352b75fed 100644 --- a/options.html +++ b/options.html @@ -12429,6 +12429,90 @@ must be set. "~/.local/share"

Declared by:

<home-manager/modules/misc/xdg.nix> +
xdg.desktopEntries

Desktop Entries allow applications to be shown in your desktop environment's app launcher.

+You can define entries for programs without entries or override existing entries.

+See https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys for more information on options. +

Type: attribute set of submodules

Default: + + { + + } + +

Example:

{
+  firefox = {
+    name = "Firefox";
+    genericName = "Web Browser";
+    exec = "firefox %U";
+    terminal = false;
+    categories = [ "Application" "Network" "WebBrowser" ];
+    mimeType = [ "text/html" "text/xml" ];
+  };
+}
+

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.categories

Categories in which the entry should be shown in a menu.

Type: null or list of strings

Default: + null +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.comment

Tooltip for the entry.

Type: null or string

Default: + null +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.exec

Program to execute, possibly with arguments.

Type: string

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.extraConfig

Extra configuration. Will be appended to the end of the file and +may thus contain extra sections. +

Type: strings concatenated with "\n"

Default: + "" +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.fileValidation

Whether to validate the generated desktop file.

Type: boolean

Default: + true +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.genericName

Generic name of the application.

Type: null or string

Default: + null +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.icon

Icon to display in file manager, menus, etc.

Type: null or string

Default: + null +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.mimeType

The MIME type(s) supported by this application.

Type: null or list of strings

Default: + null +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.name

Specific name of the application.

Type: string

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.settings

Extra key-value pairs to add to the [Desktop Entry] section. +This may override other values. +

Type: attribute set of Concatenated strings

Default: + + { + + } + +

Example:

{
+  Keywords = "calc;math";
+  DBusActivatable = "false";
+}
+

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.startupNotify

If true, it is KNOWN that the application will send a "remove" +message when started with the DESKTOP_STARTUP_ID +environment variable set. If false, it is KNOWN that the application +does not work with startup notification at all.

Type: null or boolean

Default: + null +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.terminal

Whether the program runs in a terminal window.

Type: boolean

Default: + false +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix> +
xdg.desktopEntries.<name>.type

The type of the desktop entry.

Type: one of "Application", "Link", "Directory"

Default: + "Application" +

Declared by:

+ <home-manager/modules/misc/xdg-desktop-entries.nix>
xdg.mime.enable

Whether to install programs and files to support the XDG Shared MIME-info specification and XDG MIME Applications specification at diff --git a/tools.html b/tools.html index c1f0129f4..cf41ab985 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

home-manager { build | @@ -74,7 +74,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.

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

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -234,15 +234,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)

\ No newline at end of file