summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2021-10-31 00:16:44 +0200
committerLudovic Courtès <ludo@gnu.org>2021-10-31 00:51:06 +0200
commit7711a6c3f41b0791f9fac60d31954f5ce478b7b8 (patch)
tree56c5293d444b23b7e2086ca8d120091d4edc0649 /doc
parent6f4ca78761471602e3af37ee1a33de446114039f (diff)
downloadguix-7711a6c3f41b0791f9fac60d31954f5ce478b7b8.tar.gz
doc: Mention "guix home import" upfront.
* doc/guix.texi (Declaring the Home Environment): Mention "guix home
import".
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi27
1 files changed, 21 insertions, 6 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 066971b995..c78dbdc451 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -35853,12 +35853,27 @@ still in an experimental stage, though.
 @section Declaring the Home Environment
 The home environment is configured by providing a
 @code{home-environment} declaration in a file that can be passed to the
-@command{guix home} command (@pxref{Invoking guix home}).  A simple
-setup can include Bash and a custom text configuration, like in the
-example below.  Don't be afraid to declare home environment parts, which
-overlaps with your current dotfiles, before installing any configuration
-files, Guix Home will back up existing config files to a separate place
-in the home folder.
+@command{guix home} command (@pxref{Invoking guix home}).  The easiest
+way to get started is by generating an initial configuration with
+@command{guix home import}:
+
+@example
+guix home import ~/src/guix-config
+@end example
+
+The @command{guix home import} command reads some of the ``dot files''
+such as @file{~/.bashrc} found in your home directory and copies them to
+the given directory, @file{~/src/guix-config} in this case; it also
+reads the contents of your profile, @file{~/.guix-profile}, and, based
+on that, it outputs a Home configuration that resembles your current
+configuration.  You can dump that configuration to a file and you're
+ready to go!
+
+A simple setup can include Bash and a custom text configuration, like in
+the example below.  Don't be afraid to declare home environment parts,
+which overlaps with your current dot files: before installing any
+configuration files, Guix Home will back up existing config files to a
+separate place in the home directory.
 
 @quotation Note
 It is highly recommended that you manage your shell or shells with Guix