aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2022-01-08 12:42:39 +0100
committerUlrich Müller <ulm@gentoo.org>2022-01-08 12:56:11 +0100
commit285b2c59ed8234d1480012ca3020cbd4368a9d16 (patch)
tree90408c2540ea228f54317ce2408ad63a164d9057 /doc
parentFix canonicalise call in profile module (diff)
downloadeselect-285b2c59ed8234d1480012ca3020cbd4368a9d16.tar.gz
eselect-285b2c59ed8234d1480012ca3020cbd4368a9d16.tar.bz2
eselect-285b2c59ed8234d1480012ca3020cbd4368a9d16.zip
New global option --root
* bin/eselect.in: New global option --root. (es_do_help): Document it. * doc/user-guide.txt: * man/eselect.1: Document the --root option. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/user-guide.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/user-guide.txt b/doc/user-guide.txt
index 8ec35c4..16c2629 100644
--- a/doc/user-guide.txt
+++ b/doc/user-guide.txt
@@ -91,10 +91,14 @@ eselect should be called as shown below: ::
eselect [<global-options>] <module> <action> <options>
eselect features consistently named actions among most of its modules.
-There are only two global options as of now; --brief, which makes
+There are only three global options as of now; --brief, which makes
eselect's output shorter (e.g., to use it as input for other programs);
-and --colour, which controls coloured output. The following are standard
-action names -- each module may provide a subset of these actions:
+--colour, which controls coloured output; and --root, which specifies
+the path that eselect should use as the target root filesystem for its
+operations.
+
+The following are standard action names -- each module may provide a
+subset of these actions:
help
Print the module's help screen.