rc-config manpage contains bugs. The errors are: 1) There are some spelling errors: deleted to instead of deleted from orderd instead of ordered 2) There are no mention of rc-update and rc-status. 3) DESCRIPTION is not descriptive 4) The man page is not in section 5 but in section 1. 5) Synopsis tells about eselect rc instead of rc-config (I know that rc-config is a script that uses eselect) I propose the following changes to rc-config manpage: .TH "rc-config" "1" "April 2005" "Gentoo Linux" "rc-config" .SH "NAME" rc-config \- handling init scripts that control services .SH "SYNOPSIS" .BI "rc-config [" action "] [" script " [" runlevel "] ]" .br \fBrc-config\fR [\fBhelp\fR|\fBusage\fR] .br \fBrc-config\fR \fBadd\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] .br \fBrc-config\fR \fBdelete\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] .br \fBrc-config\fR \fBlist\fR [\fIrunlevel\fR] .br \fBrc-config\fR \fBpause\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] .br \fBrc-config\fR \fBrestart\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] .br \fBrc-config\fR \fBshow\fR .br \fBrc-config\fR \fBstart\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] .br \fBrc-config\fR \fBstop\fR \fIscript\fR [\fIscript\fR [\fIscript\fR ...]] .SH "DESCRIPTION" Use \fBrc-config\fR to manage init scripts at a specified runlevel. All scripts specified with this utility must reside in the \fI/etc/init.d\fR directory. They must also conform to the Gentoo runscript standard. .SH "ACTION: add" \fBrc-config add\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] .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. phi ~ # rc-config add local default nonetwork notexisting .br Adding local to following runlevels default [done] nonetwork [skipped] notexisting [invalid] The result\-tags are as following .TP \fB[done]\fR .br \fIscript\fR succesfully added to \fIrunlevel\fR .TP \fB[failed]\fR \fIscript\fR could not be added to \fIrunlevel\fR .TP \fB[skipped]\fR \fIscript\fR already part of \fIrunlevel\fR .TP \fB[invalid]\fR \fIrunlevel\fR is not existing .SH "ACTION: delete" \fBrc-config delete\fR \fIscript\fR [\fIrunlevel\fR [\fIrunlevel\fR ...]] .br Delete \fIscript\fR to given \fIrunlevels\fR. If no \fIrunlevel\fR is given, this action will delete \fIscript\fR from the \fBdefault\fR runlevel. phi ~ # rc-config delete local nonetwork notexisting .br Adding local to following runlevels nonetwork [done] notexisting [invalid] The result\-tags are as following .TP \fB[done]\fR .br \fIscript\fR succesfully deleted from \fIrunlevel\fR .TP \fB[failed]\fR \fIscript\fR could not be deleted from \fIrunlevel\fR .TP \fB[skipped]\fR \fIscript\fR not part of \fIrunlevel\fR .TP \fB[invalid]\fR \fIrunlevel\fR is not existing .SH "ACTION: list" \fBrc-config list\fR [\fIrunlevel\fR] .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/. phi / # rc-config list default Init scripts to be started by runlevel default cupsd local metalog net.eth0 netmount powernowd sshd vixie\-cron xdm xfs .SH "ACTION: pause" \fBrc-config pause\fR \fIscript\fR [\fIscript\fR ...] .br Pauses the given set of init scripts. phi / # rc-config pause net.eth0 .br * Stopping eth0 * Bringing down eth0 * Shutting down eth0 ... .SH "ACTION: restart" \fBrc-config restart\fR \fIscript\fR [\fIscript\fR ...] .br Restarts the given set of init scripts. phi / # rc-config restart sshd .br Restarting init script * ERROR: "local" has not yet been started. * Stopping sshd ... [ ok ] .SH "ACTION: show" \fBrc-config show\fR .br Shows the current runlevel's init script and lists them together with their status. phi / # rc-config show .br Status of init scripts in runlevel default cupsd [started] local [started] metalog [started] net.eth0 [started] netmount [started] powernowd [started] sshd [stopped] vixie\-cron [started] xdm [started] The status flags are as following .TP \fB[started]\fR \fIscript\fR has been successfully run. .TP \fB[stopping]\fR \fIscript\fR stop has been ordered, but it has not ceased yet. .TP \fB[stopped]\fR \fIscript\fR has manually been stopped. .TP \fB[failed]\fR One or more commands in \fIscript\fR have not succeeded. .TP \fB[broken]\fR \fIscript\fR has a syntax error. .SH "ACTION: start" \fBrc-config start\fR \fIscript\fR [\fIscript\fR ...] .br Starts the given set of init scripts manually, regardless of the current runlevel. phi / # rc-config start local sshd .br Restarting init script * Starting local ... [ ok ] * WARNING: "sshd" has already been started. .SH "ACTION: stop" \fBrc-config restart\fR \fIscript\fR [\fIscript\fR ...] .br Restarts the given set of init scripts. phi / # rc-config restart sshd .br Restarting init script * ERROR: "local" has not yet been started. * Stopping sshd ... [ ok ] .SH "SEE ALSO" .BR rc-update (8), rc-status (8) .SH "AUTHOR" Danny van Dyk <kugelfang@gentoo.org> .SH "REVISION" $Id: rc.eselect.5 267 2006-04-14 16:18:40Z kugelfang $
Please, reopen with a unified diff, attached (not pasted inline) to this bug. Thanks.
Created attachment 94947 [details, diff] unified diff
Need to reopen the bug after providing requested info.
(In reply to comment #0) > rc-config manpage contains bugs. > The errors are: > 1) There are some spelling errors: > deleted to instead of deleted from > orderd instead of ordered ACK. > 2) There are no mention of rc-update and rc-status. Why should there by any? rc-update and rc-status aren't related to eselect nor rc.eselect module. > 3) DESCRIPTION is not descriptive DESCRIPTION refers to the main eselect script. If you change this, you got to change it for all manpages provided by eselect. I might do that one day. > 4) The man page is not in section 5 but in section 1. rc.eselect is a file and rc.eselect.5 is the correct manpage and correct section for a file. See http://www.december.com/unix/ref/mansec.html > 5) Synopsis tells about eselect rc instead of rc-config (I know that rc-config > is a script that uses eselect) rc-config is no script, it's a symlink to eselect. > I propose the following changes to rc-config manpage: Please keep in mind to only post diffs on bugs.g.o _unless asked otherwise_, just as Jakub told you. Thanks for your efforts here, but as you can guess by my answers above, the attached patch won't make it in. I might fix the remaining issues 1) and 3) later on, but it's not top priority...
1) fixed in SVN 3) WONTFIX
Fixed as of eselect-1.0.6.
