diff options
author | 2009-04-22 22:18:41 +0000 | |
---|---|---|
committer | 2009-04-22 22:18:41 +0000 | |
commit | fce33b7c1f536c78a007d25ddc1b360c7d4041d6 (patch) | |
tree | 75756502d5170bff38d2fa92b571c8399cd2a108 /man | |
parent | Slighly change option parsing. (diff) | |
download | eselect-fce33b7c1f536c78a007d25ddc1b360c7d4041d6.tar.gz eselect-fce33b7c1f536c78a007d25ddc1b360c7d4041d6.tar.bz2 eselect-fce33b7c1f536c78a007d25ddc1b360c7d4041d6.zip |
Various small changes to man pages.
svn path=/trunk/; revision=492
Diffstat (limited to 'man')
-rw-r--r-- | man/bashcomp.eselect.5 | 81 | ||||
-rw-r--r-- | man/editor.eselect.5 | 2 | ||||
-rw-r--r-- | man/env.eselect.5 | 46 | ||||
-rw-r--r-- | man/eselect.1 | 84 | ||||
-rw-r--r-- | man/kernel.eselect.5 | 63 | ||||
-rw-r--r-- | man/pager.eselect.5 | 2 | ||||
-rw-r--r-- | man/rc.eselect.5 | 255 | ||||
-rw-r--r-- | man/visual.eselect.5 | 2 |
8 files changed, 334 insertions, 201 deletions
diff --git a/man/bashcomp.eselect.5 b/man/bashcomp.eselect.5 index b6b527b..e18ed36 100644 --- a/man/bashcomp.eselect.5 +++ b/man/bashcomp.eselect.5 @@ -1,44 +1,69 @@ -.TH "ESELECT" "5" "June 2005" "Gentoo Linux" "eselect" -.SH "NAME" -bashcomp\.eselect \- Manage contributed bash-completion scripts -.SH "SYNOPSIS" -\fBeselect bashcomp\fR [\fBhelp\fR|\fBusage\fR] +.\" Copyright 2005-2009 Gentoo Foundation +.\" Distributed under the terms of the GNU General Public License v2 +.\" $Id$ +.\" +.TH bashcomp.eselect 5 "April 2009" "Gentoo Linux" eselect +.SH NAME +bashcomp.eselect \- Manage contributed bash-completion scripts +.SH SYNOPSIS +.B eselect bashcomp +.RB [ help | usage | version ] .br -\fBeselect bashcomp\fR \fBlist\fR [\fB\-\-global\fR] +.B eselect bashcomp list +.RB [ \-\-global ] .br -\fBeselect bashcomp\fR \fBenable\fR [\fB\-\-global\fR] \fIbashcomp1 bashcomp2\fR +.B eselect bashcomp enable +.RB [ \-\-global ] +.RI [ bashcomp ...] .br -\fBeselect bashcomp\fR \fBdisable\fR [\fB\-\-global\fR] \fIbashcomp1 bashcomp2\fR - -.SH "DESCRIPTION" -\fBeselect\fR is Gentoo's configuration and management tool. It features -modules that care for individual administrative tasks. -.SH "ACTION: LIST" -\fBeselect bashcomp list\fR [\fB\-\-global\fR] +.B eselect bashcomp disable +.RB [ \-\-global ] +.RI [ bashcomp ...] +.SH DESCRIPTION +.B eselect +is Gentoo's configuration and management tool. It features modules +that care for individual administrative tasks. +.SH ACTION: LIST +.B eselect bashcomp list +.RB [ \-\-global ] .br -Displays a list of available contributed bash-completion scripts. Enabled -bash-completions are marked with a '*'. If the \fB\-\-global\fR option is -specified, list globally enabled completions. +Display a list of available contributed bash-completion scripts. +Enabled bash-completions are marked with a '*'. If the +.B \-\-global +option is specified, list globally enabled completions. $ eselect bashcomp list .br Available completions: [1] bitkeeper [2] cowsay * -.SH "ACTION: ENABLE" -\fBeselect bashcomp enable\fR [\fB\-\-global\fR] \fIbashcomp1 bashcomp2\fR -.br +.SH ACTION: ENABLE +.B eselect bashcomp enable +.RB [ \-\-global ] +.RI [ bashcomp ...] .br -Enable the specified completion(s). Arguments may be a completion name or -a corresponding number produced by \fBeselect bashcomp list\fR. If the \fB\-\-global\fR +Enable the specified completion(s). Arguments may be a completion +name or a corresponding number produced by +.B eselect bashcomp +.BR list . +If the +.B \-\-global option is specified, enable globally (for all users). -.SH "ACTION: DISABLE" -\fBeselect bashcomp disable\fR [\fB\-\-global\fR] \fIbashcomp1 bashcomp2\fR +.SH ACTION: DISABLE +.B eselect bashcomp disable +.RB [ \-\-global ] +.RI [ bashcomp ...] .br -Disable the specified completion(s). Arguments may be a completion name or -a corresponding number produced by \fBeselect bashcomp list\fR. If the \fB\-\-global\fR +Disable the specified completion(s). Arguments may be a completion +name or a corresponding number produced by +.B eselect bashcomp +.BR list . +If the +.B \-\-global option is specified, disable globally (for all users). -.SH "AUTHORS" +.SH AUTHOR Aaron Walker <ka0ttic@gentoo.org> -.SH "REVISION" +.SH SEE ALSO +.BR eselect (1) +.SH REVISION $Id$ diff --git a/man/editor.eselect.5 b/man/editor.eselect.5 index 228e121..5230301 100644 --- a/man/editor.eselect.5 +++ b/man/editor.eselect.5 @@ -2,7 +2,7 @@ .\" Distributed under the terms of the GNU General Public License v2 .\" $Id$ .\" -.TH ESELECT 5 "April 2009" "Gentoo Linux" eselect +.TH editor.eselect 5 "April 2009" "Gentoo Linux" eselect .SH NAME editor.eselect \- The EDITOR management module for Gentoo's eselect .SH SYNOPSIS diff --git a/man/env.eselect.5 b/man/env.eselect.5 index 8163630..73e159d 100644 --- a/man/env.eselect.5 +++ b/man/env.eselect.5 @@ -1,22 +1,38 @@ -.TH "ESELECT" "5" "April 2005" "Gentoo Linux" "eselect" -.SH "NAME" -env.eselect \- The environment and ld.so.cache management module for Gentoo's eselect -.SH "SYNOPSIS" -\fBeselect env\fR [\fBhelp\fR|\fBusage\fR] +.\" Copyright 2005-2009 Gentoo Foundation +.\" Distributed under the terms of the GNU General Public License v2 +.\" $Id$ +.\" +.TH env.eselect 5 "April 2009" "Gentoo Linux" eselect +.SH NAME +env.eselect \- The environment and ld.so.cache management module for +Gentoo's eselect +.SH SYNOPSIS +.B eselect env +.RB [ help | usage | version ] .br -\fBeselect env\fR \fBupdate\fR -.SH "DESCRIPTION" -\fBeselect\fR is Gentoo's configuration and management tool. It features -modules that care for the individual administrative tasks. -.SH "ACTION: UPDATE" -\fBeselect env update\fR [\fImakelinks\fR] +.B eselect env update +.RB [ makelinks | noldconfig ] +.SH DESCRIPTION +.B eselect +is Gentoo's configuration and management tool. It features modules +that care for the individual administrative tasks. +.SH ACTION: UPDATE +.B eselect env update +.RB [ makelinks | noldconfig ] .br -Parses all files in /etc/env.d/ for their environment variables and assembles them to one file (/etc/profile.{env,csh}). Further, it creates ld.so.conf/ld\-elf.so.hints and prelink.conf based on the collected vars. +Parses all files in /etc/env.d/ for their environment variables and +assembles them to one file (/etc/profile.{env,csh}). +Further, it creates ld.so.conf/ld\-elf.so.hints and prelink.conf based +on the collected vars, unless option +.B noldconfig +is specified. -phi / # eselect env update +# eselect env update .br Regenerating /etc/ld.so.cache... -.SH "AUTHOR" +.SH AUTHOR Danny van Dyk <kugelfang@gentoo.org> -.SH "REVISION" +.SH SEE ALSO +.BR eselect (1) +.SH REVISION $Id$ diff --git a/man/eselect.1 b/man/eselect.1 index 5e8f013..7f86d39 100644 --- a/man/eselect.1 +++ b/man/eselect.1 @@ -1,61 +1,55 @@ -.TH "ESELECT" "1" "April 2005" "Gentoo Linux" "eselect" -.SH "NAME" -\fBeselect\fR \- Gentoo's multi\-purpose configuration and managment tool -.SH "SYNOPSIS" -\fBeselect\fR <\fIglobal options\fR> <\fImodule\fR> <\fImodule options\fR> -.SH "DESCRIPTION" -\fBeselect\fR is Gentoo's configuration and management tool. It features -modules that care for individual administrative tasks. -.SH "OPTIONS" -.B "\-\-no-color, \-\-no-colour" +.\" Copyright 2005-2009 Gentoo Foundation +.\" Distributed under the terms of the GNU General Public License v2 +.\" $Id$ +.\" +.TH ESELECT 1 "April 2009" "Gentoo Linux" eselect +.SH NAME +eselect \- Gentoo's multi\-purpose configuration and management tool +.SH SYNOPSIS +.B eselect +.RI [ "global options" ] +.I module +.RI [ action ] +.SH DESCRIPTION +.B eselect +is Gentoo's configuration and management tool. It features modules +that care for individual administrative tasks. +.SH OPTIONS +.TP +.BR \-\-no-color ", " \-\-no-colour Disable coloured output. -.SH "BUILT-INS" +.SH BUILT-INS .TP -\fIhelp\fR +.B help Displays a help screen listing all built\-ins and the installed modules. .TP -\fIlist\-modules\fR -Lists only the installed modules. -.TP -\fIusage\fR +.B usage Displays a minimal help screen. .TP -\fIversion\fR +.B version Prints eselect's version tag. -.SH "MODULES" +.SH MODULES You can view a list of installed modules using -.ad -.hy -.ad l -.hy 0 -.HP 14 -\fBeselect\fR \fIlist\-modules\fR -.ad -.hy -.ad l -.hy 0 -.HP 14 +.IP +.B eselect modules list +.PP For individual help on each module, please run -.ad -.hy -.ad l -.hy 0 -.HP 14 -\fBeselect\fR \fImodule\fR -.ad -.hy -.ad l -.hy 0 -.HP 14 -or refer to the manpage \fImodule\fR.eselect(5) -.SH "FULL DOCUMENTATION" +.IP +.B eselect +.I module +.B help +.PP +or refer to the manpage +.IB module .eselect +(5) +.SH FULL DOCUMENTATION Full user and developer documentation is included in Restructured Text (RST) -format. The 'html' Make target can be used to generate HTML versions. -.SH "AUTHORS" +format. The 'html' Make target can be used to generate HTML versions. +.SH AUTHORS Danny van Dyk <kugelfang@gentoo.org> .br Ciaran McCreesh <ciaranm@gentoo.org> .br Aaron Walker <ka0ttic@gentoo.org> -.SH "CVS HEADER" +.SH REVISION $Id$ diff --git a/man/kernel.eselect.5 b/man/kernel.eselect.5 index 5887cc7..298da7d 100644 --- a/man/kernel.eselect.5 +++ b/man/kernel.eselect.5 @@ -1,23 +1,29 @@ -.TH "ESELECT" "5" "October 2005", "Gentoo Linux" "eselect" -.SH "NAME" -kernel\.eselect \- The kernel symlink management module for Gentoo's eselect -.SH "SYNOPSIS" -\fBeselect kernel\fR [\fBhelp\fR|\fBusage\fR] +.\" Copyright 2005-2009 Gentoo Foundation +.\" Distributed under the terms of the GNU General Public License v2 +.\" $Id$ +.\" +.TH kernel.eselect 5 "April 2009" "Gentoo Linux" eselect +.SH NAME +kernel.eselect \- The kernel symlink management module for Gentoo's eselect +.SH SYNOPSIS +.B eselect kernel +.RB [ help | usage | version ] .br -\fBeselect kernel\fR \fBlist\fR +.B eselect kernel list .br -\fBeselect kernel\fR \fBset\fR \fItarget\fR +.B eselect kernel set +.I target .br -\fBeselect kernel\fR \fBshow\fR - -.SH "DESCRIPTION" -\fBeselect\fR is Gentoo's configuration and management tool. It features -modules that care for the individual administrative tasks. -.SH "ACTION: LIST" -\fBeselect kernel list\fR +.B eselect kernel show +.SH DESCRIPTION +.B eselect +is Gentoo's configuration and management tool. It features modules +that care for the individual administrative tasks. +.SH ACTION: LIST +.B select kernel list .br -Displays an ordered list of available kernels. An asterisk next to one of -the list elements denotes the currently selected kernel. +Display an ordered list of available kernels. An asterisk next to one +of the list elements denotes the currently selected kernel. # eselect kernel list .br @@ -25,17 +31,24 @@ Available kernel symlink targets: [1] linux-2.6.11.11 [2] linux-2.6.12.5 * [3] linux-2.6.13-rc6 -.SH "ACTION: SET" -\fBeselect kernel set\fR \fItarget\fR +.SH ACTION: SET +.B eselect kernel set +.I target .br -Set /usr/src/linux symlink to point to the specified kernel name, \fItarget\fR. -The \fItarget\fR argument may be a kernel name or it's associated number (displayed -in \fBeselect kernel list\fR output). -.SH "ACTION: SHOW" -\fBeselect kernel show\fR +Set /usr/src/linux symlink to point to the specified kernel name, +.IR target . +The +.I target +argument may be a kernel name or it's associated number (displayed in +.B eselect kernel list +output). +.SH ACTION: SHOW +.B eselect kernel show .br Show the currently selected kernel. -.SH "AUTHORS" +.SH AUTHOR Aaron Walker <ka0ttic@gentoo.org> -.SH "REVISION" +.SH SEE ALSO +.BR eselect (1) +.SH REVISION $Id$ diff --git a/man/pager.eselect.5 b/man/pager.eselect.5 index 54335b8..7a24467 100644 --- a/man/pager.eselect.5 +++ b/man/pager.eselect.5 @@ -2,7 +2,7 @@ .\" Distributed under the terms of the GNU General Public License v2 .\" $Id$ .\" -.TH ESELECT 5 "April 2009" "Gentoo Linux" eselect +.TH pager.eselect 5 "April 2009" "Gentoo Linux" eselect .SH NAME pager.eselect \- The PAGER management module for Gentoo's eselect .SH SYNOPSIS diff --git a/man/rc.eselect.5 b/man/rc.eselect.5 index 63dbe74..0cfae42 100644 --- a/man/rc.eselect.5 +++ b/man/rc.eselect.5 @@ -1,34 +1,65 @@ -.TH "ESELECT" "5" "April 2005" "Gentoo Linux" "eselect" -.SH "NAME" +.\" Copyright 2005-2009 Gentoo Foundation +.\" Distributed under the terms of the GNU General Public License v2 +.\" $Id$ +.\" +.TH rc.eselect 5 "April 2009" "Gentoo Linux" eselect +.SH NAME rc.eselect \- Runlevel configuration module -.SH "SYNOPSIS" -\fBeselect rc\fR [\fBhelp\fR|\fBusage\fR] +.SH SYNOPSIS +.B eselect rc +.RB [ help | usage | version ] .br -\fBeselect rc\fR \fBadd\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] +.B eselect rc add +.I script +.RI [ runlevel ...] .br -\fBeselect rc\fR \fBdelete\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] +.B eselect rc delete +.I script +.RI [ runlevel ...] .br -\fBeselect rc\fR \fBlist\fR [\fIrunlevel\fR] +.B eselect rc list +.RI [ runlevel ] .br -\fBeselect rc\fR \fBpause\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] +.B eselect rc pause +.I script +.RI [ script ...] .br -\fBeselect rc\fR \fBrestart\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] +.B eselect rc restart +.I script +.RI [ script ...] .br -\fBeselect rc\fR \fBshow\fR +.B eselect rc show +.RI [ runlevel ...] .br -\fBeselect rc\fR \fBstart\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] +.B eselect rc start +.I script +.RI [ script ...] .br -\fBeselect rc\fR \fBstop\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] -.SH "DESCRIPTION" -\fBeselect\fR is Gentoo's configuration and management tool. It features -modules that care for the individual administrative tasks. -.SH "ACTION: ADD" -\fBeselect rc add\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] +.B eselect rc stop +.I script +.RI [ script ...] +.SH DESCRIPTION +.B eselect +is Gentoo's configuration and management tool. It features modules +that care for the individual administrative tasks. +.SH ACTION: ADD +.B eselect rc add +.I script +.RI [ runlevel ...] .br -Add \fIscript\fR to given \fIrunlevels\fR. If no \fIrunlevel\fR is given, -this action will add \fIscript\fR to the \fBdefault\fR runlevel. +Add +.I script +to given +.IR runlevels . +If no +.I runlevel +is given, this action will add +.I script +to the +.B default +runlevel. -phi ~ # eselect rc add local default nonetwork notexisting +# eselect rc add local default nonetwork notexisting .br Adding local to following runlevels default [done] @@ -37,25 +68,42 @@ Adding local to following runlevels The result\-tags are as following .TP -\fB[done]\fR -.br -\fIscript\fR succesfully added to \fIrunlevel\fR +.B [done] +.I script +successfully added to +.IR runlevel . .TP -\fB[failed]\fR -\fIscript\fR couldnot be added to \fIrunlevel\fR +.B [failed] +.I script +could not be added to +.IR runlevel . .TP -\fB[skipped]\fR -\fIscript\fR already part of \fIrunlevel\fR +.B [skipped] +.I script +already part of +.IR runlevel . .TP -\fB[invalid]\fR -\fIrunlevel\fR is not existing -.SH "ACTION: DELETE" -\fBeselect rc delete\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] +.B [invalid] +.I runlevel +is not existing. +.SH ACTION: DELETE +.B eselect rc delete +.I script +.RI [ runlevel ...] .br -Delete \fIscript\fR from given \fIrunlevels\fR. If no \fIrunlevel\fR is given, -this action will delete \fIscript\fR from the \fBdefault\fR runlevel. +Delete +.I script +from given +.IR runlevels . +If no +.I runlevel +is given, this action will delete +.I script +from the +.B default +runlevel. -phi ~ # eselect rc delete local nonetwork notexisting +# eselect rc delete local nonetwork notexisting .br Deleting local from following runlevels nonetwork [done] @@ -63,25 +111,36 @@ Deleting local from following runlevels The result\-tags are as following .TP -\fB[done]\fR -.br -\fIscript\fR succesfully deleted from \fIrunlevel\fR +.B [done] +.I script +successfully deleted from +.I runlevel .TP -\fB[failed]\fR -\fIscript\fR could not be deleted from \fIrunlevel\fR +.B [failed] +.I script +could not be deleted from +.IR runlevel . .TP -\fB[skipped]\fR -\fIscript\fR not part of \fIrunlevel\fR +.B [skipped] +.I script +not part of +.IR runlevel . .TP -\fB[invalid]\fR -\fIrunlevel\fR is not existing -.SH "ACTION: LIST" -\fBeselect rc list\fR [\fIrunlevel\fR] +.B [invalid] +.I runlevel +is not existing. +.SH ACTION: LIST +.B eselect rc list +.RI [ runlevel ] .br -Displays an ordered list of init scripts that belong to \fIrunlevel\fR. In case that -\fIrunlevel\fR is given, this action will list all scripts from /etc/init.d/. +Display an ordered list of init scripts that belong to +.IR runlevel . +In case that no +.I runlevel +is given, this action will list all scripts from /etc/init.d/. -phi / # eselect rc list default +# eselect rc list default +.br Init scripts to be started by runlevel default cupsd local @@ -93,34 +152,46 @@ Init scripts to be started by runlevel default vixie\-cron xdm xfs -.SH "ACTION: PAUSE" -\fBeselect rc pause\fR \fIscript\fR [\fIscript\fR ...] +.SH ACTION: PAUSE +.B eselect rc pause +.I script +.RI [ script ...] .br -Pauses the given set of init scripts. +Pause the given set of init scripts. -phi / # eselect rc pause net.eth0 +# eselect rc pause net.eth0 .br * Stopping eth0 * Bringing down eth0 * Shutting down eth0 ... -.SH "ACTION: RESTART" -\fBeselect rc restart\fR \fIscript\fR [\fIscript\fR ...] +.SH ACTION: RESTART +.B eselect rc restart +.I script +.RI [ script ...] .br -Restarts the given set of init scripts. +Restart the given set of init scripts. -phi / # eselect rc restart sshd +# eselect rc restart sshd .br Restarting init script * ERROR: "local" has not yet been started. - * Stopping sshd ... [ ok ] -.SH "ACTION: SHOW" -\fBeselect rc show\fR + * Stopping sshd ... [ ok ] +.SH ACTION: SHOW +.B eselect rc show +.RI [ runlevel ...] .br -Shows the current runlevel's init script and lists them together with their status. +Show init scripts that belong to +.I runlevel +and list them together with their status. If no +.I runlevel +is given, list the scripts from the current runlevel. +With option +.B --all +the scripts of all runlevels are shown. -phi / # eselect rc show +# eselect rc show .br -Status of init scripts in runlevel default +Status of init scripts in runlevel "default" cupsd [started] local [started] metalog [started] @@ -132,44 +203,58 @@ Status of init scripts in runlevel default xdm [started] The status flags are as following - .TP -\fB[started]\fR -\fIscript\fR has been successfully run. +.B [started] +.I script +has been successfully run. .TP -\fB[stopping]\fR -\fIscript\fR stop has been ordered, but it has not ceased yet. +.B [stopped] +.I script +has manually been stopped. .TP -\fB[stopped]\fR -\fIscript\fR has manually been stopped. +.B [starting] +.I script +is starting. .TP -\fB[failed]\fR -One or more commands in \fIscript\fR have not succeeded. +.B [stopping] +.I script +stop has been ordered, but it has not ceased yet. .TP -\fB[broken]\fR -\fIscript\fR has a syntax error. - -.SH "ACTION: START" -\fBeselect rc start\fR \fIscript\fR [\fIscript\fR ...] +.B [inactive] +.I script +has started, but is inactive. +.B [unknown] +.I script is part of +.IR runlevel , +but its status is not known. +.SH ACTION: START +.B eselect rc start +.I script +.RI [ script ...] .br -Starts the given set of init scripts manually, regardless of the current runlevel. +Starts the given set of init scripts manually, regardless of the +current runlevel. -phi / # eselect rc start local sshd +# eselect rc start local sshd .br Restarting init script - * Starting local ... [ ok ] + * Starting local ... [ ok ] * WARNING: "sshd" has already been started. -.SH "ACTION: STOP" -\fBeselect rc restart\fR \fIscript\fR [\fIscript\fR ...] +.SH ACTION: STOP +.B eselect rc restart +.I script +.RI [ script ...] .br Restarts the given set of init scripts. -phi / # eselect rc restart sshd +# eselect rc restart sshd .br Restarting init script * ERROR: "local" has not yet been started. - * Stopping sshd ... [ ok ] -.SH "AUTHOR" + * Stopping sshd ... [ ok ] +.SH AUTHOR Danny van Dyk <kugelfang@gentoo.org> -.SH "REVISION" +.SH SEE ALSO +.BR eselect (1) +.SH REVISION $Id$ diff --git a/man/visual.eselect.5 b/man/visual.eselect.5 index 394cd1e..393ffce 100644 --- a/man/visual.eselect.5 +++ b/man/visual.eselect.5 @@ -2,7 +2,7 @@ .\" Distributed under the terms of the GNU General Public License v2 .\" $Id$ .\" -.TH ESELECT 5 "April 2009" "Gentoo Linux" eselect +.TH visual.eselect 5 "April 2009" "Gentoo Linux" eselect .SH NAME visual.eselect \- The VISUAL management module for Gentoo's eselect .SH SYNOPSIS |