aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDanny van Dyk <kugelfang@gentoo.org>2005-06-08 20:04:17 +0000
committerDanny van Dyk <kugelfang@gentoo.org>2005-06-08 20:04:17 +0000
commit3e4ae335e087a85ebb7ee3f1e1d3ec9b5e85e62f (patch)
tree62304eee36371682f9f8f076578777c473735ac6 /doc
parentMoved to Gentoo infrastructure and renamed project to 'eselect'. (diff)
downloadeselect-3e4ae335e087a85ebb7ee3f1e1d3ec9b5e85e62f.tar.gz
eselect-3e4ae335e087a85ebb7ee3f1e1d3ec9b5e85e62f.tar.bz2
eselect-3e4ae335e087a85ebb7ee3f1e1d3ec9b5e85e62f.zip
2005-06-08 Danny van Dyk <kugelfang@gentoo.org>
* bin/eselect.in: Added handling of global options in main code. * libs/core.bash.in: Removed COLOUR_* vars. * libs/output.bash.in: Added function colours() which replaces all ${COLOURS_*} uses and respects the --no-colour option. * docs/{developer,user}-guide.txt: Added reference to global options and --no-colour. diffstat: bin/eselect.in | 20 ++++++++++++--- doc/developer-guide.txt | 6 ++-- doc/user-guide.txt | 11 ++++++-- libs/core.bash.in | 9 ------ libs/output.bash.in | 64 ++++++++++++++++++++++++++++++++++-------------- 5 files changed, 73 insertions(+), 37 deletions(-) svn path=/trunk/; revision=118
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-guide.txt6
-rw-r--r--doc/user-guide.txt11
2 files changed, 11 insertions, 6 deletions
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 968939c..9971401 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -18,9 +18,9 @@ How eselect Works
------------------
eselect provides a script named ``eselect``. This script is invoked as
-``eselect <module> <action> <parameters>``. eselect will try to find the
-module requested, and then call the relevant action function in that module.
-Additional handling is available for help parameters and listing available
+``eselect [<global-options>] <module> <action> <parameters>``. eselect will try
+to find the module requested, and then call the relevant action function in that
+module. Additional handling is available for help parameters and listing available
modules.
eselect consists of several components:
diff --git a/doc/user-guide.txt b/doc/user-guide.txt
index 0c830e1..6ea22e3 100644
--- a/doc/user-guide.txt
+++ b/doc/user-guide.txt
@@ -23,10 +23,15 @@ Usage
eselect should be called as: ::
- eselect <module> <action> <options>
+ eselect [<global-options>] <module> <action> <options>
-eselect features consistently named actions among most of its modules. The
-following are standard action names -- each module may provide a subset of these
+eselect features consistently named actions among most of its modules. There
+is currently only one global option:
+
+--no-colour
+ Don't use colourization throughout all of eselect's modules.
+
+The following are standard action names -- each module may provide a subset of these
actions:
help