aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorWilliam Hubbs <w.d.hubbs@gmail.com>2013-12-21 14:51:11 -0600
committerWilliam Hubbs <w.d.hubbs@gmail.com>2013-12-29 22:57:31 -0600
commit3470eda3f5cea437a6de132b1ead3f27effd3902 (patch)
treed360366f33bad25da13ff204c5ade7ce29098255 /man
parentc096ad63caba72684010f446ecee87751da78e65 (diff)
Rename runscript to openrc-run
This was requested by Debian, because the minicom software, which is available on Debian and other distros, has a binary named runscript. We are keeping a backward compatibility symlink for now, but this allows Debian or any other distro to safely remove the symlink. X-Gentoo-Bug: 494220 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=494220
Diffstat (limited to 'man')
-rw-r--r--man/Makefile2
-rw-r--r--man/openrc-run.8 (renamed from man/runscript.8)8
-rw-r--r--man/rc-update.84
-rw-r--r--man/rc_deptree.32
-rw-r--r--man/rc_plugin_hook.32
-rw-r--r--man/rc_service.32
6 files changed, 11 insertions, 9 deletions
diff --git a/man/Makefile b/man/Makefile
index 04862da2..436f647d 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -1,7 +1,7 @@
MAN3= einfo.3 \
rc_config.3 rc_deptree.3 rc_find_pids.3 rc_plugin_hook.3 \
rc_runlevel.3 rc_service.3 rc_stringlist.3
-MAN8= rc-service.8 rc-status.8 rc-update.8 openrc.8 runscript.8 \
+MAN8= rc-service.8 rc-status.8 rc-update.8 openrc.8 openrc-run.8 \
service.8 start-stop-daemon.8
# Handy macro to create symlinks
diff --git a/man/runscript.8 b/man/openrc-run.8
index e0d7cf02..03462414 100644
--- a/man/runscript.8
+++ b/man/openrc-run.8
@@ -22,10 +22,10 @@
.\" SUCH DAMAGE.
.\"
.Dd December 31, 2011
-.Dt RUNSCRIPT 8 SMM
+.Dt openrc-run 8 SMM
.Os OpenRC
.Sh NAME
-.Nm runscript
+.Nm openrc-run
.Nd a means of hooking shell commands into a service
.Sh SYNOPSIS
.Nm
@@ -47,7 +47,7 @@ and finally the script itself. At this point
then runs the command given.
.Pp
Commands are defined as shell functions within the script. Here is a list of
-some functions that all runscripts have by default:
+some functions that all scripts have by default:
.Bl -tag -width "RC_DEFAULTLEVEL"
.It Ar describe
Describes what the service does and each command the service defines.
@@ -411,7 +411,7 @@ rc_keyword="!-prefix"
.Pp
An example service script for foo.
.Bd -literal -offset indent
-#!/sbin/runscript
+#!/sbin/openrc-run
command=/usr/bin/foo
command_args="${foo_args} --bar"
pidfile=/var/run/foo.pid
diff --git a/man/rc-update.8 b/man/rc-update.8
index 459f0693..3fa97a4e 100644
--- a/man/rc-update.8
+++ b/man/rc-update.8
@@ -53,7 +53,8 @@ All services must reside in the
or
.Pa /usr/local/etc/init.d
directories.
-They must also conform to the OpenRC runscript standard.
+They must also be standard OpenRC scripts, meaning they must use
+openrc-run.
.Pp
.Bl -tag -width "Fl a , -delete service"
.It Ar add Ar service
@@ -87,6 +88,7 @@ option is given then we either add or remove the runlevel from the runlevel.
This allows inheritance of runlevels.
.Sh SEE ALSO
.Xr openrc 8 ,
+.Xr openrc-run 8 ,
.Xr rc-status 8
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
diff --git a/man/rc_deptree.3 b/man/rc_deptree.3
index e9805343..64fcf602 100644
--- a/man/rc_deptree.3
+++ b/man/rc_deptree.3
@@ -107,6 +107,6 @@ when done.
.Xr malloc 3 ,
.Xr free 3 ,
.Xr rc_stringlist_free 3 ,
-.Xr runscript 8
+.Xr openrc-run 8
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
diff --git a/man/rc_plugin_hook.3 b/man/rc_plugin_hook.3
index 22a1c589..955ecb8c 100644
--- a/man/rc_plugin_hook.3
+++ b/man/rc_plugin_hook.3
@@ -45,6 +45,6 @@ Plugins can affect the parent environment by writing NULL separated strings to
.Va rc_environ_fd .
.Sh SEE ALSO
.Xr openrc 8 ,
-.Xr runscript 8
+.Xr openrc-run 8
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
diff --git a/man/rc_service.3 b/man/rc_service.3
index 4c1ee011..aba1636b 100644
--- a/man/rc_service.3
+++ b/man/rc_service.3
@@ -141,7 +141,7 @@ is lost.
returns a list of extra commands the
.Fa service
supports beyond the default ones. See
-.Nm runscript
+.Nm openrc-run
for default commands.
.Pp
.Fn rc_service_plugable