[arch-projects] [INITSCRIPTS][PATCH] Add rc.d manual page

[Elvis Stansvik]

And thanks to you guys for finishing it off. I kind of dropped the
ball on this one. I blame school.

Cheers,
Elvis

2011/10/1 Sebastien Luttringer <seblu at seblu.net>:
> Thanks to Elvis Stansvik <elvstone at gmail.com> for its template.
>
> Fix bug: FS#25269
>
> Signed-off-by: Sebastien Luttringer <seblu at seblu.net>
> ---
>  Makefile   |   15 +++++++--
>  PKGBUILD   |    1 +
>  rc.d.8.txt |  103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 116 insertions(+), 3 deletions(-)
>  create mode 100644 rc.d.8.txt
>
> diff --git a/Makefile b/Makefile
> index a6262e2..c7eaa5f 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -12,14 +12,17 @@ DIRS := \
>        /usr/lib/sysctl.d \
>        /usr/lib/initscripts \
>        /etc/bash_completion.d \
> -       /usr/share/zsh/site-functions
> +       /usr/share/zsh/site-functions \
> +       /usr/share/man/man8
> +
> +all: minilogd doc
>
>  minilogd: minilogd.o
>
>  installdirs:
>        install -dm755 $(foreach DIR, $(DIRS), $(DESTDIR)$(DIR))
>
> -install: minilogd installdirs
> +install: minilogd installdirs doc
>        install -m644 -t $(DESTDIR)/etc inittab rc.conf
>        install -m755 -t $(DESTDIR)/etc rc.local rc.local.shutdown rc.multi rc.shutdown rc.single rc.sysinit
>        install -m644 -t $(DESTDIR)/etc/logrotate.d bootlog
> @@ -27,13 +30,19 @@ install: minilogd installdirs
>        install -m755 -t $(DESTDIR)/etc/rc.d hwclock network netfs
>        install -m755 -t $(DESTDIR)/etc/profile.d locale.sh
>        install -m755 -t $(DESTDIR)/usr/sbin minilogd rc.d
> +       install -m644 -t ${DESTDIR}/usr/share/man/man8 rc.d.8
>        install -m755 -t $(DESTDIR)/usr/lib/initscripts arch-tmpfiles arch-sysctl
>        install -m644 tmpfiles.conf $(DESTDIR)/usr/lib/tmpfiles.d/arch.conf
>        install -m644 -T bash-completion $(DESTDIR)/etc/bash_completion.d/rc.d
>        install -m644 -T zsh-completion $(DESTDIR)/usr/share/zsh/site-functions/_rc.d
>
> +rc.d.8: rc.d.8.txt
> +       a2x -d manpage -f manpage rc.d.8.txt
> +
> +doc: rc.d.8
> +
>  clean:
> -       rm -f minilogd minilogd.o
> +       rm -f minilogd minilogd.o rc.d.8
>
>  release:
>        git archive HEAD --prefix=initscripts-$(VER)/ | xz > initscripts-$(VER).tar.xz
> diff --git a/PKGBUILD b/PKGBUILD
> index d8b4717..8b4472d 100644
> --- a/PKGBUILD
> +++ b/PKGBUILD
> @@ -9,6 +9,7 @@ groups=('base')
>  conflicts=('initscripts')
>  provides=('initscripts=9999')
>  backup=(etc/inittab etc/rc.conf etc/rc.local etc/rc.local.shutdown)
> +makedepends=('asciidoc')
>  depends=('glibc' 'bash' 'grep' 'coreutils' 'udev>=139-1' 'iproute2'
>          'ncurses' 'kbd' 'findutils' 'sysvinit')
>  optdepends=('net-tools: legacy networking support'
> diff --git a/rc.d.8.txt b/rc.d.8.txt
> new file mode 100644
> index 0000000..d0bbcce
> --- /dev/null
> +++ b/rc.d.8.txt
> @@ -0,0 +1,103 @@
> +/////
> +vim:set ts=4 sw=4 syntax=asciidoc noet:
> +/////
> +rc.d(8)
> +=======
> +
> +Name
> +----
> +rc.d - Initscripts power tool
> +
> +Synopsis
> +--------
> +*rc.d <action> [options] [rc [rc] ...]*
> +
> +Description
> +-----------
> +The *rc.d* program controls and lists rc scripts on the system. An action may be
> +invoked on one or more scripts using *rc.d action rc1 rc2...*. See <<A,Actions>>
> +below for more information.
> +Use *rc.d list* to get the list of all rc scripts on the system.
> +
> +Actions[[A]]
> +------------
> +The actions supported by a rc scripts may be different from script to script, but
> +commonly supported actions include:
> +
> +*start*::
> +       Starts the script if it's not already running.
> +
> +*stop*::
> +       Stops a running script.
> +
> +*restart*::
> +       Restarts a running script.
> +
> +More uncommon actions are:
> +
> +*reload*::
> +       Signals the script to reload its configuration.
> +
> +*status*::
> +       Shows the status of the script.
> +
> +Options[[O]]
> +------------
> +*-s, --started*::
> +       Filter to started scripts.
> +
> +*-S, --stopped*::
> +       Filter to stopped scripts.
> +
> +*-a, --auto*::
> +       Filter to auto started scripts.
> +
> +*-A, --noauto*::
> +       Filter to manually started scripts.
> +
> +Examples[[E]]
> +-------------
> +*rc.d list*::
> +       List all scripts.
> +
> +*rc.d list sshd gpm*::
> +       List only *sshd* and *gpm* scripts.
> +
> +*rc.d list --started gpm*::
> +       List *gpm* script only if started.
> +
> +*rc.d list --started --auto*::
> +       List all auto started scripts.
> +
> +*rc.d start sshd gpm*::
> +       Starts *sshd* and *gpm* scripts.
> +
> +*rc.d start --auto --stopped*::
> +       Starts all stopped scripts which are started at startup.
> +
> +*rc.d stop crond*::
> +       Stops the *crond* script.
> +
> +*rc.d stop --noauto*::
> +       Stop all script which are not runned at startup
> +
> +*rc.d restart crond*::
> +       Restarts the *crond* script.
> +
> +*rc.d restart --stopped crond*::
> +       Restarts the *crond* script only if stopped.
> +
> +*rc.d help*::
> +       Display help.
> +
> +Directories[[D]]
> +----------------
> +'/etc/rc.d'::
> +       Directory containing available daemons on the system.
> +
> +'/usr/lib/initscripts'::
> +       Directory containing available initscripts plugins.
> +
> +Authors
> +-------
> +       Written by Sebastien Luttringer and Dave Reisner.
> --
> Sebastien "Seblu" Luttringer
>
>