doc: Add home reference.
home.md unknown status 1
| 1 | + | Using the Home Manager | |
| 2 | + | ====================== | |
| 3 | + | ||
| 4 | + | Installing a new Configuration | |
| 5 | + | ------------------------------ | |
| 6 | + | ||
| 7 | + | You should create a file that contains your home configuration. This file can | |
| 8 | + | easily be kept in version control with git for instance. The file looks | |
| 9 | + | like this: | |
| 10 | + | ||
| 11 | + | ```scm | |
| 12 | + | (use-modules (home)) | |
| 13 | + | ||
| 14 | + | (home "/data/alice" '()) | |
| 15 | + | ``` | |
| 16 | + | ||
| 17 | + | Home Reference | |
| 18 | + | -------------- | |
| 19 | + | ||
| 20 | + | **Scheme Procedure**: (use-home-modules module-name ...) | |
| 21 | + | ||
| 22 | + | Import home modules with name _module-name_. For instance, | |
| 23 | + | ||
| 24 | + | ```scm | |
| 25 | + | (use-home-modules openbox hexchat) | |
| 26 | + | ``` | |
| 27 | + | ||
| 28 | + | is equivalent to: | |
| 29 | + | ||
| 30 | + | ```scm | |
| 31 | + | (use-modules (home openbox) | |
| 32 | + | (home hexchat)) | |
| 33 | + | ``` | |
| 34 | + | ||
| 35 | + | **Scheme Procedure**: (home basedir inputs #:guix-symlink #:guix-config-symlink #:local-symlink #:cache-symlink)) | |
| 36 | + | ||
| 37 | + | Create a package that can then be installed with `guix package -f` from _inputs_ | |
| 38 | + | and essential configuration. _inputs_ must be a list of inputs, namely a list | |
| 39 | + | of file-like objects. The resulting package is a union of all the inputs, with | |
| 40 | + | the addition of a few essential symlinks. | |
| 41 | + | ||
| 42 | + | By default, when no input is given, and no keyword argument is used, these | |
| 43 | + | symlinks are created: | |
| 44 | + | ||
| 45 | + | * `~/.guix-profile` ??? `${basedir}/.guix-profile` | |
| 46 | + | * `~/.config/guix` ??? `${basedir}/.config/guix` | |
| 47 | + | * `~/.local` ??? `${basedir}/.local` | |
| 48 | + | * `~/.cache` ??? `${basedir}/.cache` | |
| 49 | + | ||
| 50 | + | When the corresponding keyword argument is used, the associated path is used as | |
| 51 | + | the target of the symbolic link. | |
| 51 | < | ||
| 0 | 52 | < | \ No newline at end of file |