guix-home-manager/home.md

home.md

Using the Home Manager

Installing a new Configuration

You should create a file that contains your home configuration. This file can easily be kept in version control with git for instance. The file looks like this:

(use-modules (home))

(home "/data/alice" '())

Home Reference

Scheme Procedure: (use-home-modules module-name ...)

Import home modules with name module-name. For instance,

(use-home-modules openbox hexchat)

is equivalent to:

(use-modules (home openbox)
             (home hexchat))

Scheme Procedure: (home basedir inputs #:guix-symlink #:guix-config-symlink #:local-symlink #:cache-symlink))

Create a package that can then be installed with guix package -f from inputs and essential configuration. inputs must be a list of inputs, namely a list of file-like objects. The resulting package is a union of all the inputs, with the addition of a few essential symlinks.

By default, when no input is given, and no keyword argument is used, these symlinks are created:

When the corresponding keyword argument is used, the associated path is used as the target of the symbolic link.