* [gentoo-commits] proj/openrc:master commit in: man/
@ 2011-04-08 19:10 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2011-04-08 19:10 UTC (permalink / raw
To: gentoo-commits
commit: 16f7e90c6c4a9198261f9ac8c5d07fc37674b39c
Author: William Hubbs <williamh <AT> gentoo <DOT> org>
AuthorDate: Fri Apr 8 19:08:29 2011 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Apr 8 19:08:29 2011 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=16f7e90c
clarify documentation for -timeout keyword
---
man/runscript.8 | 3 ++-
1 files changed, 2 insertions(+), 1 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index f3c397e..75c54b8 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -148,7 +148,8 @@ have this keyword.
Don't stop this service when changing runlevels, even if not present.
This includes shutting the system down.
.It Dv -timeout
-Do not time out waiting for that service.
+Other services should wait indefinitely for this service to start. Use
+this keyword if your service may take longer than 60 seconds to start.
.It Dv -jail
When in a jail, exclude this service from any dependencies. The service can
still be run directly. Set via
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2011-12-30 15:03 Christian Ruppert
0 siblings, 0 replies; 51+ messages in thread
From: Christian Ruppert @ 2011-12-30 15:03 UTC (permalink / raw
To: gentoo-commits
commit: 191ea10f86d9399d67ab1a483a32167f70ee2bad
Author: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
AuthorDate: Fri Dec 30 14:59:42 2011 +0000
Commit: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
CommitDate: Fri Dec 30 15:03:24 2011 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=191ea10f
Document start_stop_daemon_args
---
man/runscript.8 | 2 ++
1 files changed, 2 insertions(+), 0 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 2889970..6c4bd15 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -100,6 +100,8 @@ the service has already been stopped.
String describing the service.
.It Ar description_$command
String describing the extra command the.
+.It Ar start_stop_daemon_args
+List of arguments passed to start-stop-daemon.
.It Ar command
Daemon to start or stop via
.Nm start-stop-daemon
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2011-12-30 16:41 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2011-12-30 16:41 UTC (permalink / raw
To: gentoo-commits
commit: 810f2e55fb32e8a363d5737649a698f037e92db6
Author: William Hubbs <williamh <AT> gentoo <DOT> org>
AuthorDate: Fri Dec 30 16:35:16 2011 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Dec 30 16:35:16 2011 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=810f2e55
Documentation updates
- Clarify that start_stop_daemon_args is only used when starting a
daemon.
- fix several typos.
---
man/runscript.8 | 8 ++++----
1 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 6c4bd15..9439b76 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -99,9 +99,9 @@ the service has already been stopped.
.It Ar description
String describing the service.
.It Ar description_$command
-String describing the extra command the.
+String describing the extra command.
.It Ar start_stop_daemon_args
-List of arguments passed to start-stop-daemon.
+List of arguments passed to start-stop-daemon when starting the daemon.
.It Ar command
Daemon to start or stop via
.Nm start-stop-daemon
@@ -144,7 +144,7 @@ Tags a service with a keyword. Here's the keywords we currently understand:-
.Bl -tag -width indent
.It Dv -shutdown
Don't stop this service when shutting the system down.
-This normally quite safe as remaining daemons will be sent a SIGTERM just
+This is normally quite safe as remaining daemons will be sent a SIGTERM just
before final shutdown.
Network related services such as the network and dhcpcd init scripts normally
have this keyword.
@@ -226,7 +226,7 @@ seconds until all files exist.
Returns 0 if all files exist, otherwise non zero.
If
.Ar timeout
-is less then 1 then we wait indefinitely.
+is less than 1 then we wait indefinitely.
.It Ic is_newer_than Ar file1 Ar file2 ...
If
.Ar file1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2011-12-31 2:44 Christian Ruppert
0 siblings, 0 replies; 51+ messages in thread
From: Christian Ruppert @ 2011-12-31 2:44 UTC (permalink / raw
To: gentoo-commits
commit: 26edfe369c685f3bec560dd4a968f2468c47a269
Author: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
AuthorDate: Sat Dec 31 02:41:52 2011 +0000
Commit: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
CommitDate: Sat Dec 31 02:43:25 2011 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=26edfe36
Fix the description of --retry in start-stop-daemon(8)
X-Gentoo-Bug: 368615
X-Gentoo-Bug-URL: https://bugs.gentoo.org/368615
Reported-by: Stuart Shelton <srcshelton <AT> gmail.com>
---
man/start-stop-daemon.8 | 3 +--
1 files changed, 1 insertions(+), 2 deletions(-)
diff --git a/man/start-stop-daemon.8 b/man/start-stop-daemon.8
index a35d96c..acdde1a 100644
--- a/man/start-stop-daemon.8
+++ b/man/start-stop-daemon.8
@@ -163,8 +163,7 @@ These options are only used for stopping daemons:
.Bl -tag -width indent
.It Fl R , -retry Ar timeout | Ar signal Ns / Ns Ar timeout
You can either specify a timeout in seconds or a multiple signal/timeout
-pairs as a stopping schedule.
-If not specified then a default value of SIGTERM/5 is assumed.
+(like SIGTERM/5) pairs as a stopping schedule.
.El
.Sh ENVIRONMENT
.Va SSD_NICELEVEL
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2011-12-31 4:25 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2011-12-31 4:25 UTC (permalink / raw
To: gentoo-commits
commit: e873ef2ba7d43346b945e9d9f7bd32667de655a5
Author: William Hubbs <williamh <AT> gentoo <DOT> org>
AuthorDate: Sat Dec 31 03:51:05 2011 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sat Dec 31 04:12:59 2011 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=e873ef2b
Reword retry documentation on runscript man page
---
man/runscript.8 | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 77b2399..08f302e 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -113,8 +113,8 @@ Pidfile to use for the above defined command.
.It Ar name
Display name used for the above defined command.
.It Ar retry
-You can either specify a timeout in seconds or a multiple signal/timeout pairs
-as a stopping schedule. This is only used during stop().
+Retry schedule to use when stopping the daemon. It can either be a
+timeout in seconds or multiple signal/timeout pairs (like SIGTERM/5).
.El
.Sh DEPENDENCIES
You should define a
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2011-12-31 4:25 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2011-12-31 4:25 UTC (permalink / raw
To: gentoo-commits
commit: 1771a83b92e3ff7b05742cf754a67c1e258472d1
Author: William Hubbs <williamh <AT> gentoo <DOT> org>
AuthorDate: Sat Dec 31 04:20:03 2011 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sat Dec 31 04:20:03 2011 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=1771a83b
Reword the documentation for the retry option for start-stop-daemon
---
man/start-stop-daemon.8 | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/man/start-stop-daemon.8 b/man/start-stop-daemon.8
index acdde1a..5467ec2 100644
--- a/man/start-stop-daemon.8
+++ b/man/start-stop-daemon.8
@@ -162,8 +162,8 @@ but with the standard error output.
These options are only used for stopping daemons:
.Bl -tag -width indent
.It Fl R , -retry Ar timeout | Ar signal Ns / Ns Ar timeout
-You can either specify a timeout in seconds or a multiple signal/timeout
-(like SIGTERM/5) pairs as a stopping schedule.
+The retry specification can be either a timeout in seconds or multiple
+signal/timeout pairs (like SIGTERM/5).
.El
.Sh ENVIRONMENT
.Va SSD_NICELEVEL
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-02-19 18:54 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2012-02-19 18:54 UTC (permalink / raw
To: gentoo-commits
commit: f18763bcd8834909222d3ca1388845eca4d6ac13
Author: William Hubbs <williamh <AT> gentoo <DOT> org>
AuthorDate: Sun Feb 19 18:49:53 2012 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sun Feb 19 18:49:53 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=f18763bc
Document the RC_REBOOT variable
---
man/runscript.8 | 8 +++++++-
1 files changed, 7 insertions(+), 1 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 5901f47..1351aea 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -332,7 +332,13 @@ sets the following environment variables for use in the service scripts:
.It Va RC_SVCNAME
Name of the service.
.It Va RC_RUNLEVEL
-Current runlevel that rc is in.
+Current runlevel that rc is in. Note that, in OpenRC, the reboot
+runlevel does not exist. This was done because most services do not need
+to know if a system is shutting down or rebooting. If you are writing a
+service that needs to know the difference, see the RC_REBOOT variable.
+.It Va RC_REBOOT
+This variable contains YES if the system is rebooting. If your service
+needs to know the system is rebooting, you should test this variable.
.It Va RC_BOOTLEVEL
Boot runlevel chosen. Default is boot.
.It Va RC_DEFAULTLEVEL
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-02-19 19:18 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2012-02-19 19:18 UTC (permalink / raw
To: gentoo-commits
commit: 47c3b284599cb4cfc9d1263af6d2039d67906b43
Author: William Hubbs <williamh <AT> gentoo <DOT> org>
AuthorDate: Sun Feb 19 19:11:11 2012 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sun Feb 19 19:11:11 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=47c3b284
Clarify the documentation about the reboot runlevel
The reboot runlevel does exist, but it gets remapped to the shutdown
runlevel internally.
---
man/runscript.8 | 7 ++++---
1 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 1351aea..bab54e2 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -333,9 +333,10 @@ sets the following environment variables for use in the service scripts:
Name of the service.
.It Va RC_RUNLEVEL
Current runlevel that rc is in. Note that, in OpenRC, the reboot
-runlevel does not exist. This was done because most services do not need
-to know if a system is shutting down or rebooting. If you are writing a
-service that needs to know the difference, see the RC_REBOOT variable.
+runlevel is mapped to the shutdown runlevel. This was done because most
+services do not need to know if a system is shutting down or rebooting.
+If you are writing a service that does need to know this, see the
+RC_REBOOT variable.
.It Va RC_REBOOT
This variable contains YES if the system is rebooting. If your service
needs to know the system is rebooting, you should test this variable.
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-03-24 17:40 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2012-03-24 17:40 UTC (permalink / raw
To: gentoo-commits
commit: eb11953dd2bd713e6494db6da85ca87ac7f475e6
Author: William Hubbs <williamh <AT> gentoo <DOT> org>
AuthorDate: Sat Mar 24 17:40:45 2012 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sat Mar 24 17:40:45 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=eb11953d
Document the required_dirs and required_files variables
---
man/runscript.8 | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 64f36b1..6d425e4 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -124,6 +124,10 @@ Display name used for the above defined command.
.It Ar retry
Retry schedule to use when stopping the daemon. It can either be a
timeout in seconds or multiple signal/timeout pairs (like SIGTERM/5).
+.It Ar required_dirs
+A list of directories which must exist for the service to start.
+.It Ar required_files
+A list of files which must exist for the service to start.
.El
.Sh DEPENDENCIES
You should define a
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-09-24 0:37 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2012-09-24 0:37 UTC (permalink / raw
To: gentoo-commits
commit: f007988fbac79460f7733eb9093d2beb537311f8
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Mon Sep 24 00:25:57 2012 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Mon Sep 24 00:25:57 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=f007988f
Clarify how to handle restart processing
The Gentoo developer manual covers how to handle restarts in init
scripts, but this was not officially covered in OpenRc's Documentation.
This commit adds an example to the runscript man page that shows how
this works.
---
man/runscript.8 | 18 ++++++++++++++++--
1 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index d823e33..c4119d9 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -358,8 +358,8 @@ offset. Otherwise it is undefined.
.It Va RC_UNAME
The result of `uname -s`.
.It Va RC_CMD
-Name of the command like start, stop, restart, ...
-RC_CMD is one way to determine whether it's a restart or normal start/stop.
+This contains the name of the command the init script is executing, such
+as start, stop, restart etc.
.El
.Sh FILES
.Pp
@@ -452,8 +452,22 @@ restart_pre() {
...
}
+# This function does any pre-start setup. If it fails, the service will
+# not be started.
+# If you need this function to behave differently for a restart command,
+# you should check the value of RC_CMD for "restart".
+# This also applies to start_post, stop_pre and stop_post.
start_pre()
{
+ if [ "$RC_CMD" = restart ]; then
+ # This block will only execute for a restart command. Use a
+ # structure like this if you need special processing for a
+ # restart which you do not need for a normal start.
+ # The function can also fail from here, which will mean that a
+ # restart can fail.
+ # This logic can also be used in start_post, stop_pre and
+ # stop_post.
+ fi
# Ensure that our dirs are correct
checkpath --dir --owner foo:foo --mode 0664 \\
/var/run/foo /var/cache/foo
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-09-25 17:09 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2012-09-25 17:09 UTC (permalink / raw
To: gentoo-commits
commit: c08b1a6a3205c41bc14e466a6c47c7f309ae6cd2
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Tue Sep 25 17:09:45 2012 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Sep 25 17:09:45 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=c08b1a6a
small runscript man page cleanups
---
man/runscript.8 | 6 +++---
1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 471c0f1..044bef7 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -37,7 +37,7 @@
.Op Ar command ...
.Sh DESCRIPTION
.Nm
-is basically an interpreter for shell scripts which provide an easy interface
+is basically an interpreter for shell scripts which provides an easy interface
to the often complex system commands and daemons.
When a service runs a command it first loads its multiplexed configuration
file, then its master configuration file, then
@@ -156,7 +156,7 @@ We provide this virtual service. For example, named provides dns.
.It Ic config
We should recalculate our dependencies if the listed files have changed.
.It Ic keyword
-Tags a service with a keyword. Here's the keywords we currently understand:-
+Tags a service with a keyword. These are the keywords we currently understand:
.Bl -tag -width indent
.It Dv -shutdown
Don't stop this service when shutting the system down.
@@ -358,7 +358,7 @@ offset. Otherwise it is undefined.
.It Va RC_UNAME
The result of `uname -s`.
.It Va RC_CMD
-This contains the name of the command the init script is executing, such
+This contains the name of the command the service script is executing, such
as start, stop, restart etc.
.El
.Sh FILES
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-10-16 19:00 Christian Ruppert
0 siblings, 0 replies; 51+ messages in thread
From: Christian Ruppert @ 2012-10-16 19:00 UTC (permalink / raw
To: gentoo-commits
commit: c5bb6829d00a4034f7294aa4af79d5d114572ac1
Author: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
AuthorDate: Fri Oct 12 19:07:59 2012 +0000
Commit: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
CommitDate: Fri Oct 12 19:07:59 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=c5bb6829
Prepare for real "restart" support
---
man/runscript.8 | 9 ---------
1 files changed, 0 insertions(+), 9 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 044bef7..4c8c985 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -454,15 +454,6 @@ depend()
# This also applies to start_post, stop_pre and stop_post.
start_pre()
{
- if [ "$RC_CMD" = restart ]; then
- # This block will only execute for a restart command. Use a
- # structure like this if you need special processing for a
- # restart which you do not need for a normal start.
- # The function can also fail from here, which will mean that a
- # restart can fail.
- # This logic can also be used in start_post, stop_pre and
- # stop_post.
- fi
# Ensure that our dirs are correct
checkpath --dir --owner foo:foo --mode 0664 \\
/var/run/foo /var/cache/foo
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-10-16 19:29 Christian Ruppert
0 siblings, 0 replies; 51+ messages in thread
From: Christian Ruppert @ 2012-10-16 19:29 UTC (permalink / raw
To: gentoo-commits
commit: a3ff6cce97d2437438a955c781267df1f4f49bcd
Author: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
AuthorDate: Tue Oct 16 19:28:45 2012 +0000
Commit: Christian Ruppert <idl0r <AT> gentoo <DOT> org>
CommitDate: Tue Oct 16 19:28:45 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=a3ff6cce
Revert "Prepare for real "restart" support"
This reverts commit c5bb6829d00a4034f7294aa4af79d5d114572ac1.
That was meant for my local devel branch :)
---
man/runscript.8 | 9 +++++++++
1 files changed, 9 insertions(+), 0 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 4c8c985..044bef7 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -454,6 +454,15 @@ depend()
# This also applies to start_post, stop_pre and stop_post.
start_pre()
{
+ if [ "$RC_CMD" = restart ]; then
+ # This block will only execute for a restart command. Use a
+ # structure like this if you need special processing for a
+ # restart which you do not need for a normal start.
+ # The function can also fail from here, which will mean that a
+ # restart can fail.
+ # This logic can also be used in start_post, stop_pre and
+ # stop_post.
+ fi
# Ensure that our dirs are correct
checkpath --dir --owner foo:foo --mode 0664 \\
/var/run/foo /var/cache/foo
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2012-10-22 0:53 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2012-10-22 0:53 UTC (permalink / raw
To: gentoo-commits
commit: 06658d1038407a26a2bde381b748e14241b660eb
Author: Andrew Gregory <andrew.gregory.8 <AT> gmail <DOT> com>
AuthorDate: Mon Oct 15 23:25:42 2012 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Mon Oct 22 00:51:09 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=06658d10
fix typo in rc-status.8
Signed-off-by: Andrew Gregory <andrew.gregory.8 <AT> gmail.com>
---
man/rc-status.8 | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/man/rc-status.8 b/man/rc-status.8
index 4b786a6..90f2603 100644
--- a/man/rc-status.8
+++ b/man/rc-status.8
@@ -46,7 +46,7 @@ Show all runlevels and their services.
List all services that have crashed.
.It Fl l , -list
List all defined runlevels.
-.It fl r , -runlevel
+.It Fl r , -runlevel
Print the current runlevel name.
.It Fl s , -servicelist
Show all services.
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2013-03-20 20:45 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2013-03-20 20:45 UTC (permalink / raw
To: gentoo-commits
commit: 879c7f04eca9336ae9dcccc23c818a9125792123
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Wed Mar 20 20:21:03 2013 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Wed Mar 20 20:42:09 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=879c7f04
runscript: update documentation for the provide function
Explain that virtual services take precedence over real services and
recommend that virtual services have different names from real services.
Reported-by: me <AT> 2gw.net
X-Gentoo-Bug: 461818
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=461818
---
man/runscript.8 | 3 +++
1 files changed, 3 insertions(+), 0 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 044bef7..7277546 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -153,6 +153,9 @@ The service will start after these services and stop before these services.
The service will start before these services and stop after these services.
.It Ic provide
We provide this virtual service. For example, named provides dns.
+Virtual services take precedence over real services, so it is highly
+recommended that you do not have a real service that has the same name
+as a virtual service.
.It Ic config
We should recalculate our dependencies if the listed files have changed.
.It Ic keyword
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2013-08-13 17:22 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2013-08-13 17:22 UTC (permalink / raw
To: gentoo-commits
commit: b2f8ac9382d5dad70181ef803a37f43896f5cb91
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Tue Aug 13 17:12:43 2013 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Aug 13 17:12:43 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=b2f8ac93
Clarify the documentation about the restart function
Restart has never been able to be overridden in OpenRc, but there is a
way to make your service script behave differently when restart is being
executed.
X-Gentoo-Bug: 480866
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=480866
---
man/runscript.8 | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 7277546..ddce662 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -60,7 +60,10 @@ First we ensure that any services that depend on us are stopped. If any
services that need us fail to stop then we exit with a suitable error,
otherwise call the supplied stop function if it exists.
.It Ar restart
-Stop and start the service, including dependencies.
+Stop and start the service, including dependencies. This cannot be
+overridden. See the description of the RC_CMD variable below for the
+method to make your service behave differently when restart is being
+executed.
.It Ar status
Show the status of the service. The return code matches the status, with the
exception of "started" returning 0 to match standard command behaviour.
@@ -362,7 +365,8 @@ offset. Otherwise it is undefined.
The result of `uname -s`.
.It Va RC_CMD
This contains the name of the command the service script is executing, such
-as start, stop, restart etc.
+as start, stop, restart etc. One example of using this is to make a
+service script behave differently when restart is being executed.
.El
.Sh FILES
.Pp
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2013-08-15 15:22 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2013-08-15 15:22 UTC (permalink / raw
To: gentoo-commits
commit: 1f5d447eda0ecc62a556cee19cdc1f1929ac2931
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Thu Aug 15 15:14:42 2013 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Thu Aug 15 15:14:42 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=1f5d447e
fix typo on runscript man page
The example code had an invalid checkpath option (--dir instead of
--directory) and a mode that does not make sense for directories (664
instead of 775).
X-Gentoo-Bug: 481034
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=481034
---
man/runscript.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/runscript.8 b/man/runscript.8
index ddce662..1854638 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -471,7 +471,7 @@ start_pre()
# stop_post.
fi
# Ensure that our dirs are correct
- checkpath --dir --owner foo:foo --mode 0664 \\
+ checkpath --directory --owner foo:foo --mode 0775 \\
/var/run/foo /var/cache/foo
}
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2013-08-24 17:05 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2013-08-24 17:05 UTC (permalink / raw
To: gentoo-commits
commit: 7296379f3fcab5d3d6320a21c6da30905155816b
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Sat Aug 24 16:57:22 2013 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sat Aug 24 16:57:22 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=7296379f
man/runscript.8: minor grammar fixes
---
man/runscript.8 | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/man/runscript.8 b/man/runscript.8
index 1854638..7a0b79e 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -60,12 +60,12 @@ First we ensure that any services that depend on us are stopped. If any
services that need us fail to stop then we exit with a suitable error,
otherwise call the supplied stop function if it exists.
.It Ar restart
-Stop and start the service, including dependencies. This cannot be
+Stops and starts the service, including dependencies. This cannot be
overridden. See the description of the RC_CMD variable below for the
method to make your service behave differently when restart is being
executed.
.It Ar status
-Show the status of the service. The return code matches the status, with the
+Shows the status of the service. The return code matches the status, with the
exception of "started" returning 0 to match standard command behaviour.
.It Ar zap
Resets the service state to stopped and removes all saved data about the
@@ -88,8 +88,8 @@ Output from any non OpenRC commands is not affected.
.It Fl v , -verbose
Turns on any extra informational output the service generates.
.It Fl Z , -dry-run
-Shows what services would be stopped and/or started without actually starting
-or stopping them.
+Shows which services would be stopped and/or started without actually stopping
+or starting them.
.El
.Pp
The following variables affect the service script:
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2014-01-08 19:27 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2014-01-08 19:27 UTC (permalink / raw
To: gentoo-commits
commit: e5a94dd3f4570d74b6e5149253e6d17261cf27f9
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Wed Jan 8 19:16:27 2014 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Wed Jan 8 19:16:27 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=e5a94dd3
Add missing documentation for environment variables
Add documentation for the RC_SERVICE, RC_GOINGDOWN, RC_LIBEXECDIR and
RC_NO_UMOUNTS environment variables.
X-Gentoo-Bug: 489344
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=489344
---
man/openrc-run.8 | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 0346241..c330e8c 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -342,6 +342,8 @@ sets the following environment variables for use in the service scripts:
.Bl -tag -width "RC_DEFAULTLEVEL"
.It Va RC_SVCNAME
Name of the service.
+.It Va RC_SERVICE
+Full path to the service.
.It Va RC_RUNLEVEL
Current runlevel that OpenRC is in. Note that, in OpenRC, the reboot
runlevel is mapped to the shutdown runlevel. This was done because most
@@ -367,6 +369,15 @@ The result of `uname -s`.
This contains the name of the command the service script is executing, such
as start, stop, restart etc. One example of using this is to make a
service script behave differently when restart is being executed.
+.It Va RC_GOINGDOWN
+This variable contains YES if the system is going into single user mode
+or shutting down.
+.It Va RC_LIBEXECDIR
+The value of libexecdir which OpenRC was configured with during build
+time.
+.It Va RC_NO_UMOUNTS
+This variable is used by plugins to contain a list of directories which
+should not be unmounted.
.El
.Sh FILES
.Pp
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2014-06-21 7:05 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2014-06-21 7:05 UTC (permalink / raw
To: gentoo-commits
commit: 23cb55d843b165d5508f330287ed329358fc85dc
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Sat Jun 21 06:53:17 2014 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sat Jun 21 06:53:17 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=23cb55d8
man/start-stop-daemon.8: correct argument from --nice to --nicelevel
X-Gentoo-Bug: 510648
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=510648
---
man/start-stop-daemon.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/start-stop-daemon.8 b/man/start-stop-daemon.8
index a805232..b3405d5 100644
--- a/man/start-stop-daemon.8
+++ b/man/start-stop-daemon.8
@@ -139,7 +139,7 @@ option.
Modifies the IO scheduling priority of the daemon.
Class can be 0 for none, 1 for real time, 2 for best effort and 3 for idle.
Data can be from 0 to 7 inclusive.
-.It Fl N , -nice Ar level
+.It Fl N , -nicelevel Ar level
Modifies the scheduling priority of the daemon.
.It Fl 1 , -stdout Ar logfile
Redirect the standard output of the process to logfile when started with
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2014-07-11 21:41 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2014-07-11 21:41 UTC (permalink / raw
To: gentoo-commits
commit: f66f41c4f03d8077bdaa047a7a93f6c92c0a69de
Author: Alexander V Vershilov <qnikst <AT> gentoo <DOT> org>
AuthorDate: Fri Jul 11 21:33:42 2014 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Jul 11 21:36:35 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=f66f41c4
typo fix
---
man/openrc-run.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index c330e8c..0ce1f75 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -321,7 +321,7 @@ Mark the service as inactive.
.Op Fl f , -file
.Op Fl p , -pipe
.Op Fl m , -mode Ar mode
-.Op Fl o , owner Ar owner
+.Op Fl o , -owner Ar owner
.Ar path ...
.Xc
Checks to see if the path exists, is of the right type, owned by the right
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2014-07-13 16:25 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2014-07-13 16:25 UTC (permalink / raw
To: gentoo-commits
commit: d59737afb159d993916836903d9e670a1334c93a
Author: Alexander V Vershilov <qnikst <AT> gentoo <DOT> org>
AuthorDate: Sun Feb 16 00:08:23 2014 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sun Jul 13 13:50:36 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=d59737af
man/openrc.8: update checkpath documentation
X-GENTOO-BUG: 500606
X-GENTOO-BUG-URL: https://bugs.gentoo.org/show_bug.cgi?id=500606
---
man/openrc-run.8 | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 0ce1f75..07f3527 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -322,10 +322,25 @@ Mark the service as inactive.
.Op Fl p , -pipe
.Op Fl m , -mode Ar mode
.Op Fl o , -owner Ar owner
+.Op Fl q , -quiet
.Ar path ...
.Xc
Checks to see if the path exists, is of the right type, owned by the right
people and has the correct access modes. If not, then it corrects the path.
+
+Type.
+File, directory and pipe types are supported, if type is not provided then
+directory is used
+
+Mode.
+Mode should be provided as a three (644) or four digit string (0644). If mode
+is argument is not provided then default value is used: 0644 - for files, and
+0775 for directories.
+
+Truncate variant of options create empty directory or file, or clears contents
+if it exists.
+
+Quiet argument suppress normal output, repeat quiet argument to suppress errors.
.It Ic checkpath
.Op Fl W , -writable
.Ar path
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2014-07-13 16:25 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2014-07-13 16:25 UTC (permalink / raw
To: gentoo-commits
commit: 40141244e349e6e1d2dfb9ebfbcbf62f68d33a9d
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Sun Jul 13 16:15:26 2014 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sun Jul 13 16:23:43 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=40141244
man/openrc-run.8: more updates and clarifications for checkpath
X-Gentoo-Bug: 500606
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=500606
---
man/openrc-run.8 | 39 ++++++++++++++++++++++-----------------
1 file changed, 22 insertions(+), 17 deletions(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 07f3527..3890f76 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -322,30 +322,35 @@ Mark the service as inactive.
.Op Fl p , -pipe
.Op Fl m , -mode Ar mode
.Op Fl o , -owner Ar owner
+.Op Fl W , -writable
.Op Fl q , -quiet
.Ar path ...
.Xc
-Checks to see if the path exists, is of the right type, owned by the right
-people and has the correct access modes. If not, then it corrects the path.
+If -d, -f or -p is specified, checkpath checks to see if the path
+exists, is the right type and has the correct owner and access modes. If
+any of these tests fail, the path is created and set up as specified. If
+more than one of -d, -f or -p are specified, the last one will be used.
-Type.
-File, directory and pipe types are supported, if type is not provided then
-directory is used
+The argument to -m is a three or four digit octal number. If this option
+is not provided, the value defaults to 0644 for files and 0775 for
+directories.
-Mode.
-Mode should be provided as a three (644) or four digit string (0644). If mode
-is argument is not provided then default value is used: 0644 - for files, and
-0775 for directories.
+The argument to -o is a representation of the user and/or group which
+should own the path. The user and group can be represented numerically
+or with names, and are separated by a colon.
-Truncate variant of options create empty directory or file, or clears contents
-if it exists.
+The truncate options (-D and -F) cause the directory or file to be
+cleared of all contents.
-Quiet argument suppress normal output, repeat quiet argument to suppress errors.
-.It Ic checkpath
-.Op Fl W , -writable
-.Ar path
-.Xc
-checks to see if the path is writable.
+If -W is specified, checkpath checks to see if the first path given on
+the command line is writable. This is different from how the test
+command in the shell works, because it also checks to make sure the file
+system is not read only.
+
+Also, the -d, -f or -p options should not be specified along with this option.
+
+The -q option suppresses all informational output. If it is specified
+twice, all error messages are suppressed as well.
.It Ic yesno Ar value
If
.Ar value
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2014-09-19 23:00 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2014-09-19 23:00 UTC (permalink / raw
To: gentoo-commits
commit: 20006625a6d37c5add84dd4c8454649279645604
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Fri Sep 19 22:23:55 2014 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Sep 19 22:23:55 2014 +0000
URL: http://sources.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=20006625
man: Document start_inactive and in_background_fake
---
man/openrc-run.8 | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 3890f76..c8bf24d 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -131,6 +131,12 @@ timeout in seconds or multiple signal/timeout pairs (like SIGTERM/5).
A list of directories which must exist for the service to start.
.It Ar required_files
A list of files which must exist for the service to start.
+.It Ar start_inactive
+Set to yes to have the service marked inactive when it starts. This is
+used along with in_background_fake to support re-entrant services.
+.It Ar in_background_fake
+Space separated list of commands which should always succeed when
+in_background is yes.
.El
.Sh DEPENDENCIES
You should define a
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2014-11-22 18:39 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2014-11-22 18:39 UTC (permalink / raw
To: gentoo-commits
commit: dff6e4a004afeaa64f4ccb07c7d31bb821b043b4
Author: S. Gilles <sgilles <AT> umd <DOT> edu>
AuthorDate: Sat Nov 22 17:41:10 2014 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Sat Nov 22 17:49:46 2014 +0000
URL: http://sources.gentoo.org/gitweb/?p=proj/openrc.git;a=commit;h=dff6e4a0
Fix mdoc warning for empty line in rc-update man page.
X-Gentoo-Bug: 529374
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=529374
---
man/rc-update.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/rc-update.8 b/man/rc-update.8
index dca4b90..113a533 100644
--- a/man/rc-update.8
+++ b/man/rc-update.8
@@ -87,7 +87,7 @@ If the
.Fl s , -stack
option is given then we either add or remove the runlevel from the runlevel.
This allows inheritance of runlevels.
-
+.Pp
If the
.Fl a, -all
option is given, we remove the service from all runlevels. This is
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2015-05-11 20:39 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2015-05-11 20:39 UTC (permalink / raw
To: gentoo-commits
commit: 0f9354becfbd54f9800c93092aa26be859dcf16a
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Mon May 11 20:37:30 2015 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Mon May 11 20:37:30 2015 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=0f9354be
man: Clarify the documentation for command_args
The command_args variable only works if using start-stop-daemon to start
the daemon.
man/openrc-run.8 | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 3308f24..f144152 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -114,7 +114,8 @@ Daemon to start or stop via
.Nm start-stop-daemon
if no start or stop function is defined by the service.
.It Ar command_args
-List of arguments to pass to the daemon when starting.
+List of arguments to pass to the daemon when starting via
+.Nm start-stop-daemon .
.It Ar command_background
Set this to "true", "yes" or "1" (case-insensitive) to force the daemon into
the background. This implies the "--make-pidfile" and "--pidfile" option of
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2015-05-27 19:15 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2015-05-27 19:15 UTC (permalink / raw
To: gentoo-commits
commit: bcb9c44e73ccf332c7c961a6f82520699c6e776d
Author: Mike Gilbert <floppym <AT> gentoo <DOT> org>
AuthorDate: Tue May 19 01:23:11 2015 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Wed May 27 19:09:45 2015 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=bcb9c44e
man: Document the stopsig variable
This variable can be used to set the signal to send if the service is
using start-stop-daemon.
This fixes #56
man/openrc-run.8 | 2 ++
1 file changed, 2 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index f08ad79..4637fd0 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -141,6 +141,8 @@ will chroot into this path before writing the pid file or starting the daemon.
Pidfile to use for the above defined command.
.It Ar name
Display name used for the above defined command.
+.It Ar stopsig
+Signal to send when stopping the daemon.
.It Ar retry
Retry schedule to use when stopping the daemon. It can either be a
timeout in seconds or multiple signal/timeout pairs (like SIGTERM/5).
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2015-12-03 23:45 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2015-12-03 23:45 UTC (permalink / raw
To: gentoo-commits
commit: b810473e4f7218afbb7047890860c15a8c45472b
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Thu Dec 3 23:37:38 2015 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Thu Dec 3 23:37:38 2015 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=b810473e
man/openrc-run.8: Clarify documentation on dependencies and keywords
Provide an example of using the -containers keyword and clarify
documentation on some of the dependency functions.
man/openrc-run.8 | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 5d18fe5..bbb8b50 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -166,23 +166,25 @@ will start and stop it in the right order in relation to other services.
As it's a function it can be very flexible, see the example below.
Here is a list of the functions you can use in a
.Ic depend
-function. You simply pass the names of the services to it to add to that
-dependency type, or prefix it with ! to remove it.
+function. You simply pass the names of the services you want to add to
+that dependency type to the function, or prefix the names with ! to
+remove them from the dependencies.
.Bl -tag -width "RC_DEFAULTLEVEL"
.It Ic need
The service will refuse to start until needed services have started and it
will refuse to stop until any services that need it have stopped.
.It Ic use
-The service will attempt to start any services we use that have been added
+The service will attempt to start any services it uses that have been added
to the runlevel.
.It Ic want
-The service will attempt to start any services we want.
+The service will attempt to start any services it wants, regardless of
+whether they have been added to the runlevel.
.It Ic after
The service will start after these services and stop before these services.
.It Ic before
The service will start before these services and stop after these services.
.It Ic provide
-We provide this virtual service. For example, named provides dns.
+The service provides this virtual service. For example, named provides dns.
Virtual services take precedence over real services, so it is highly
recommended that you do not have a real service that has the same name
as a virtual service.
@@ -471,6 +473,9 @@ rc_net_tap1_provide="!net"
# It's also possible to negate keywords. This is mainly useful for prefix
# users testing OpenRC.
rc_keyword="!-prefix"
+# This can also be used to block a script from runining in all
+# containers except one or two
+rc_keyword="!-containers !-docker"
.Ed
.Sh EXAMPLES
.Pp
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2016-06-23 22:55 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2016-06-23 22:55 UTC (permalink / raw
To: gentoo-commits
commit: 553799400218903ab495d1154a41c6d8890cb752
Author: Mike Gilbert <floppym <AT> gentoo <DOT> org>
AuthorDate: Thu Jun 23 12:40:45 2016 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Thu Jun 23 22:46:11 2016 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=55379940
man: Document the procname variable for openrc-run
X-Gentoo-Bug: 586794
X-Gentoo-Bug-URL: https://bugs.gentoo.org/586794
man/openrc-run.8 | 2 ++
1 file changed, 2 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index be15d59..3d78d98 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -143,6 +143,8 @@ will chroot into this path before writing the pid file or starting the daemon.
Pidfile to use for the above defined command.
.It Ar name
Display name used for the above defined command.
+.It Ar procname
+Process name to match when signaling the daemon.
.It Ar stopsig
Signal to send when stopping the daemon.
.It Ar retry
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2016-09-13 19:09 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2016-09-13 19:09 UTC (permalink / raw
To: gentoo-commits
commit: a4e0d675e13f07bf880da10a4d602983a556264d
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Tue Sep 13 19:02:10 2016 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Sep 13 19:02:10 2016 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=a4e0d675
man/openrc-run.8: update variable documentation
- document command_args_background and command_user.r
- clarify documentation for command_background
This fixes #78.
man/openrc-run.8 | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 3d78d98..6e3b9dc 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -125,15 +125,31 @@ if no start or stop function is defined by the service.
.It Ar command_args
List of arguments to pass to the daemon when starting via
.Nm start-stop-daemon .
+.It Ar command_args_background
+This variable should be used if the daemon you are starting with
+.Xr start-stop-daemon 8
+runs in the foreground by default but has its own command line options
+to request that it background and write a pid file. It should be set to
+those options. It should not be used at the same time as
+command_background, because command_background requests that
+.Xr start-stop-daemon 8
+go into the background before executing the daemon.
.It Ar command_args_foreground
List of arguments to pass to the daemon when starting via
.Nm supervise-daemon .
to force the daemon to stay in the foreground
.It Ar command_background
-Set this to "true", "yes" or "1" (case-insensitive) to force the daemon into
-the background. This implies the "--make-pidfile" and "--pidfile" option of
+Set this to "true", "yes" or "1" (case-insensitive) if you want
+.Xr start-stop-daemon 8
+to force the daemon into the background. This forces the
+"--make-pidfile" and "--pidfile" options, so the pidfile variable must be set.
+.It Ar command_user
+If the daemon does not support changing to a different user id, you can
+use this to change the user id before
.Xr start-stop-daemon 8
-so the pidfile variable must be set.
+or
+.Xr supervise-daemon 8
+launches the daemon
.It Ar chroot
.Xr start-stop-daemon 8
and
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2016-09-21 18:35 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2016-09-21 18:35 UTC (permalink / raw
To: gentoo-commits
commit: 66a9788435e51e658e4ae9d3ce0d0e54ea53e4f9
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Wed Sep 21 18:33:39 2016 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Wed Sep 21 18:33:39 2016 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=66a97884
man/openrc-run.8: Add note about eval usage
This fixes #77.
man/openrc-run.8 | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 5ec8156..d83e1cc 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -180,6 +180,10 @@ used along with in_background_fake to support re-entrant services.
.It Ar in_background_fake
Space separated list of commands which should always succeed when
in_background is yes.
+.Pp
+Keep in mind that eval is used to process chroot, command, command_args_*,
+command_user, pidfile and procname. This may affect how they are
+evvaluated depending on how they are quoted.
.El
.Sh DEPENDENCIES
You should define a
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2016-09-22 15:30 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2016-09-22 15:30 UTC (permalink / raw
To: gentoo-commits
commit: 316903fbf0da6edc067a98327c8c6cb2b3cdcf93
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Thu Sep 22 15:30:41 2016 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Thu Sep 22 15:30:41 2016 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=316903fb
man/openrc-run.8: typo fix
man/openrc-run.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index d83e1cc..3c23bcc 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -183,7 +183,7 @@ in_background is yes.
.Pp
Keep in mind that eval is used to process chroot, command, command_args_*,
command_user, pidfile and procname. This may affect how they are
-evvaluated depending on how they are quoted.
+evaluated depending on how they are quoted.
.El
.Sh DEPENDENCIES
You should define a
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2016-12-02 16:58 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2016-12-02 16:58 UTC (permalink / raw
To: gentoo-commits
commit: 42cb84882918a0c9dd93a89d92b0b4818dfb44b8
Author: AndCycle <andcycle-github <AT> andcycle <DOT> idv <DOT> tw>
AuthorDate: Fri Dec 2 11:22:14 2016 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Dec 2 16:57:10 2016 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=42cb8488
fix manual typo
This fixes #105.
man/openrc-run.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 3c23bcc..25ec5b9 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -97,7 +97,7 @@ String describing the extra command.
.It Ar supervisor
Supervisor to use to monitor this daemon. If this is unset or invalid,
start-stop-daemon will be used.
-Currently, we support s6 from scarnet software, and supervise-daemon
+Currently, we support s6 from skarnet software, and supervise-daemon
which is a light-weight supervisor internal to OpenRC.
To use s6, set
supervisor=s6.
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2016-12-05 18:27 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2016-12-05 18:27 UTC (permalink / raw
To: gentoo-commits
commit: 3552f0ae548d68effd4411ad4080e7b13fe627c5
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Mon Dec 5 18:23:37 2016 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Mon Dec 5 18:25:52 2016 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=3552f0ae
man/start-stop-daemon.8: clarify documentation about --pidfile option
The documentation implied that if you stop a daemon we handle multiple
pids in a pid file. This is not correct. We only handle the first pid.
X-Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=601540
man/start-stop-daemon.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/start-stop-daemon.8 b/man/start-stop-daemon.8
index 112cd5f..1506a1a 100644
--- a/man/start-stop-daemon.8
+++ b/man/start-stop-daemon.8
@@ -55,7 +55,7 @@ is used.
.It Fl p , -pidfile Ar pidfile
When starting, we expect the daemon to create a valid
.Ar pidfile
-within a reasonable amount of time. When stopping we only stop the pid(s)
+within a reasonable amount of time. When stopping we only stop the first pid
listed in the
.Ar pidfile .
.It Fl n , -name Ar name
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-04-14 16:11 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-04-14 16:11 UTC (permalink / raw
To: gentoo-commits
commit: 5fd3747b190887d094225547f23007d25e2d9592
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Fri Apr 14 16:10:56 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Apr 14 16:11:07 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=5fd3747b
reword the bugs section of the openrc-init man page
man/openrc-init.8 | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/man/openrc-init.8 b/man/openrc-init.8
index 93068f10..8cd4d02b 100644
--- a/man/openrc-init.8
+++ b/man/openrc-init.8
@@ -37,9 +37,9 @@ doesn't manage getty's directly, so you will need to manage them another
way. For example, you can use the agetty service script as described in
agetty-guide.md in this distribution.
.Sh BUGS
-OpenRC 0.25 contains the first release of this init process.
-I do not know of any specific issues. However, if you use it, please be
-aware that there may be bugs and report any issues you find.
+This was first released as part of OpenRC 0.25.
+I do not know of any specific issues. However, since this is the first
+release of openrc-init, please test and report any issues you find.
.Sh SEE ALSO
.Xr openrc-shutdown 8 ,
.Sh AUTHORS
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-05-12 3:01 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-05-12 3:01 UTC (permalink / raw
To: gentoo-commits
commit: 78e0042eccaf5a5554b195ad391b3ab0b8974cf6
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Fri May 12 02:53:23 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri May 12 02:55:31 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=78e0042e
man/rc-status: document changes for supervised daemons
rc-status now shows the amount of time a supervised daemon has been
active as well as the number of times it has been respawned during the
current respawn period.
man/rc-status.8 | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/man/rc-status.8 b/man/rc-status.8
index 3b33df4a..6cf69a59 100644
--- a/man/rc-status.8
+++ b/man/rc-status.8
@@ -25,6 +25,12 @@ in different runlevels. The default behavior is to show information
about the current runlevel and any unassigned services that are not stopped,
but any runlevel can be quickly examined.
.Pp
+If an active service is being supervised by
+.Xr supervise-daemon 8,
+the amount of time the daemon has been active along with the number of
+times it has been respawned in the current respawn period will be
+displayed.
+.Pp
The options are as follows:
.Bl -tag -width ".Fl test , test string"
.It Fl a , -all
@@ -57,5 +63,6 @@ dependency order if the dependency tree is available.
.Sh SEE ALSO
.Xr openrc 8 ,
.Xr rc-update 8
+.Xr supervise-daemon 8
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-06-07 16:34 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-06-07 16:34 UTC (permalink / raw
To: gentoo-commits
commit: caacedc0a82285fb2d25c6d3473f154044c7ad66
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Wed Jun 7 16:28:01 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Wed Jun 7 16:28:01 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=caacedc0
man: update openrc-shutdown man page
Add the new wtmp options and fix some cross references.
man/openrc-shutdown.8 | 25 +++++++++++++++++--------
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/man/openrc-shutdown.8 b/man/openrc-shutdown.8
index 5d81c4af..5db21334 100644
--- a/man/openrc-shutdown.8
+++ b/man/openrc-shutdown.8
@@ -16,25 +16,33 @@
.Nd bring the system down
.Sh SYNOPSIS
.Nm
+.Op Fl d , -no-write
+.Op Fl D , -dry-run
.Op Fl H , -halt
.Op Fl k , -kexec
.Op Fl p , -poweroff
.Op Fl R , -reexec
.Op Fl r , -reboot
+.Op Fl s , -single
+.Op Fl w , -write-only
.Sh DESCRIPTION
.Nm
-is the utility that communicates with openrc-init(8) to bring down the
-system or instruct openrc-init to re-execute itself. It supports the
-following options:
+is the utility that communicates with
+.Xr openrc-init 8
+to bring down the system or instruct openrc-init to re-execute itself.
+It supports the following options:
.Bl -tag -width "poweroff"
-.It Fl d , -dry-run
+.It Fl d , -no-write
+Do not write the wtmp boot record.
+.It Fl D , -dry-run
Print the action that would be taken without executing it. This is to
allow testing.
.It Fl H , -halt
Stop all services, kill all remaining processes and halt the system.
.It Fl k , -kexec
Stop all services, kill all processes and boot directly into a new
-kernel loaded via kexec(8).
+kernel loaded via
+.Xr kexec 8 .
.It Fl p , -poweroff
Stop all services, kill all processes and power off the system.
.It Fl R , -reexec
@@ -42,10 +50,11 @@ instruct openrc-init to re-exec itself. This should be used after an
upgrade of OpenRC if you are using openrc-init as your init process.
.It Fl r , -reboot
Stop all services, kill all processes and reboot the system.
+.It Fl s , -single
+Stop all services, kill all processes and move to single user mode.
+.It Fl w , -write-only
+Stop all services, kill all processes and move to single user mode.
.El
-.Pp
-If none of these options are given, the default is to move the system
-into single user mode.
.Sh SEE ALSO
.Xr openrc-init 8 ,
.Xr kexec 8 ,
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-07-08 16:55 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-07-08 16:55 UTC (permalink / raw
To: gentoo-commits
commit: 12f75e4167f84a9a85f69924ebdb28ad36c085cb
Author: Adam Borowski <kilobyte <AT> angband <DOT> pl>
AuthorDate: Fri Jul 7 00:11:00 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Jul 7 22:14:31 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=12f75e41
man: fix an unclosed .Bl/.El warning
This fixes #151.
man/supervise-daemon.8 | 1 +
1 file changed, 1 insertion(+)
diff --git a/man/supervise-daemon.8 b/man/supervise-daemon.8
index 19aa5d44..34a4e936 100644
--- a/man/supervise-daemon.8
+++ b/man/supervise-daemon.8
@@ -130,6 +130,7 @@ The same thing as
.Fl 1 , -stdout
but with the standard error output.
.El
+.El
.Sh ENVIRONMENT
.Va SSD_NICELEVEL
can also set the scheduling priority of the daemon, but the command line
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-07-08 16:55 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-07-08 16:55 UTC (permalink / raw
To: gentoo-commits
commit: 260368e0103e95625c29760f2c2ec89143e5a233
Author: Adam Borowski <kilobyte <AT> angband <DOT> pl>
AuthorDate: Fri Jul 7 00:06:34 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Jul 7 22:13:40 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=260368e0
man: fix missing .Pp warnings
This fixes #151.
man/openrc-run.8 | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index f627004d..278aa0e1 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -412,25 +412,25 @@ If -d, -f or -p is specified, checkpath checks to see if the path
exists, is the right type and has the correct owner and access modes. If
any of these tests fail, the path is created and set up as specified. If
more than one of -d, -f or -p are specified, the last one will be used.
-
+.Pp
The argument to -m is a three or four digit octal number. If this option
is not provided, the value defaults to 0644 for files and 0775 for
directories.
-
+.Pp
The argument to -o is a representation of the user and/or group which
should own the path. The user and group can be represented numerically
or with names, and are separated by a colon.
-
+.Pp
The truncate options (-D and -F) cause the directory or file to be
cleared of all contents.
-
+.Pp
If -W is specified, checkpath checks to see if the first path given on
the command line is writable. This is different from how the test
command in the shell works, because it also checks to make sure the file
system is not read only.
-
+.Pp
Also, the -d, -f or -p options should not be specified along with this option.
-
+.Pp
The -q option suppresses all informational output. If it is specified
twice, all error messages are suppressed as well.
.It Ic yesno Ar value
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-07-25 18:57 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-07-25 18:57 UTC (permalink / raw
To: gentoo-commits
commit: f48d9c33a5c708c871d6657a39485d1c0c735548
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Tue Jul 25 18:54:12 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Jul 25 18:54:12 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=f48d9c33
man/openrc-run.8: document _pre and _post functions
Fixes https://github.com/openrc/openrc/issues/155.
man/openrc-run.8 | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 278aa0e1..3fb5a5b3 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -284,6 +284,18 @@ system.
To see how to influence dependencies in configuration files, see the
.Sx FILES
section below.
+.Sh _pre AND _post FUNCTIONS
+Any command defined in extra_commands, extra_started_commands or
+extra_stopped_commands can have _pre and _post functions in the service
+script. If the command function is called foo, the_pre and _post
+functions for it should be called foo_pre and foo_post.
+.Pp
+These functions should be used to perform preparation before the
+command is run and cleanup after the command completes. In order for
+.Nm
+to record the command as being run successfully, the _pre
+function, command function itself and the _post function should all exit
+with a zero return code.
.Sh BUILTINS
.Nm
defines some builtin functions that you can use inside your service scripts:
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-07-26 16:32 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-07-26 16:32 UTC (permalink / raw
To: gentoo-commits
commit: c2d256bafb9d1dfafbfd0846c035c5d26f7449c8
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Wed Jul 26 16:29:10 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Wed Jul 26 16:31:34 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=c2d256ba
man/openrc-run.8: document fstabinfo and mountinfo
X-Gentoo-Bug: 592374
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=592374
man/openrc-run.8 | 36 ++++++++++++++++++++++++++++++++++++
1 file changed, 36 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 3fb5a5b3..2e3ec728 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -445,6 +445,42 @@ Also, the -d, -f or -p options should not be specified along with this option.
.Pp
The -q option suppresses all informational output. If it is specified
twice, all error messages are suppressed as well.
+.Ic fstabinfo
+.Op Fl M , -mount
+.Op Fl R , -remount
+.Op Fl b , -blockdevice
+.Op Fl m , -mountargs
+.Op Fl o , -options
+.Op Fl p , -passno Ar passno
+.Op Fl t , -type Ar fstype
+.Ar path
+.Xc
+If -b, -m, -o, -p or -t is specified,the appropriate information is
+extracted from fstab. If -M or -R are given, file systems are mounted or
+remounted.
+.Pp
+The -q option suppresses all informational output. If it is specified
+twice, all error messages are suppressed as well.
+.Ic mountinfo
+.Op Fl f, -fstype-regex Ar regex
+.Op Fl F, -skip-fstype-regex Ar regex
+.Op Fl n, -node-regex Ar regex
+.Op Fl N, -skip-node-regex Ar regex
+.Op Fl o, -options-regex Ar regex
+.Op Fl O, -skip-options-regex Ar regex
+.Op Fl p, -point-regex Ar regex
+.Op Fl P, -skip-point-regex Ar regex
+.Op Fl e, -netdev
+.Op Fl E, -nonetdev
+.Op Fl i, -options
+.Op Fl s, -fstype
+.Op Fl t, -node
+ .Ar mount1 mount2 ...
+.Xc
+The f, F, n, N, o, O, p, P, e and E options specify what you want to
+search for or skip in the mounted file systems. The i, s and t options
+specify what you want to display. If no mount points are given, all
+mount points will be considered.
.It Ic yesno Ar value
If
.Ar value
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-09-22 22:25 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-09-22 22:25 UTC (permalink / raw
To: gentoo-commits
commit: c46adf14343df3a74aef7e4ae5be175ae5fa7a01
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Fri Sep 22 21:20:41 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Fri Sep 22 21:24:20 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=c46adf14
man/openrc-run.8: Clarify the explanation of the need dependency
man/openrc-run.8 | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 2e3ec728..471f63e5 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -217,8 +217,10 @@ that dependency type to the function, or prefix the names with ! to
remove them from the dependencies.
.Bl -tag -width "RC_DEFAULTLEVEL"
.It Ic need
-The service will refuse to start until needed services have started and it
-will refuse to stop until any services that need it have stopped.
+The service will attempt to start any services it needs regardless of
+whether they have been added to the runlevel. It will refuse to start
+until all services it needs have started, and it will refuse to stop until all
+services that need it have stopped.
.It Ic use
The service will attempt to start any services it uses that have been added
to the runlevel.
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-10-12 23:55 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-10-12 23:55 UTC (permalink / raw
To: gentoo-commits
commit: 2b6eeea01d1c64d58929788f4bfa0758393885bf
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Thu Oct 12 23:47:36 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Thu Oct 12 23:47:36 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=2b6eeea0
man: remove service(8) man page
man/Makefile | 2 +-
man/service.8 | 1 -
2 files changed, 1 insertion(+), 2 deletions(-)
diff --git a/man/Makefile b/man/Makefile
index a72b7e72..006c8d16 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -6,7 +6,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 openrc-run.8 \
- service.8 start-stop-daemon.8 supervise-daemon.8
+ start-stop-daemon.8 supervise-daemon.8
ifeq (${OS},Linux)
MAN8 += rc-sstat.8 openrc-init.8 openrc-shutdown.8
diff --git a/man/service.8 b/man/service.8
deleted file mode 100644
index cd9dfa88..00000000
--- a/man/service.8
+++ /dev/null
@@ -1 +0,0 @@
-.so rc-service.8
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-11-29 21:12 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-11-29 21:12 UTC (permalink / raw
To: gentoo-commits
commit: f0129307759f1a5eb34b72589e8d48790c92b2db
Author: Julien Reichardt <mi <AT> jrei <DOT> ch>
AuthorDate: Wed Nov 29 21:01:32 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Wed Nov 29 21:06:06 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=f0129307
man/openrc-run.8: remove white space
This is for #184.
man/openrc-run.8 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index e1db58bd..3325139f 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -142,12 +142,12 @@ List of arguments to pass to the daemon when starting via
.Nm supervise-daemon .
to force the daemon to stay in the foreground
.It Ar command_background
-Set this to "true", "yes" or "1" (case-insensitive) if you want
+Set this to "true", "yes" or "1" (case-insensitive) if you want
.Xr start-stop-daemon 8
to force the daemon into the background. This forces the
"--make-pidfile" and "--pidfile" options, so the pidfile variable must be set.
.It Ar command_progress
-Set this to "true", "yes" or "1" (case-insensitive) if you want
+Set this to "true", "yes" or "1" (case-insensitive) if you want
.Xr start-stop-daemon 8
to display a progress meter when waiting for a daemon to stop.
.It Ar command_user
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2017-11-30 22:04 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2017-11-30 22:04 UTC (permalink / raw
To: gentoo-commits
commit: 0feadd2922484ec181c2ab86a5f7f8d6d37c5c77
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Thu Nov 30 22:00:42 2017 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Thu Nov 30 22:00:42 2017 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=0feadd29
man/openrc-run.8: update documentation for command_user
man/openrc-run.8 | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 3325139f..5f9c86dd 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -8,7 +8,7 @@
.\" This file may not be copied, modified, propagated, or distributed
.\" except according to the terms contained in the LICENSE file.
.\"
-.Dd December 31, 2011
+.Dd November 30, 2017
.Dt openrc-run 8 SMM
.Os OpenRC
.Sh NAME
@@ -152,11 +152,11 @@ Set this to "true", "yes" or "1" (case-insensitive) if you want
to display a progress meter when waiting for a daemon to stop.
.It Ar command_user
If the daemon does not support changing to a different user id, you can
-use this to change the user id before
+use this to change the user id, and optionally group id, before
.Xr start-stop-daemon 8
or
.Xr supervise-daemon 8
-launches the daemon
+launches the daemon.
.It Ar output_log
This is the path to a file or named pipe where the standard output from
the service will be redirected. If you are starting this service with
@@ -731,6 +731,8 @@ Users are encouraged to use the is_newer_than function which returns correctly.
.Xr rc_plugin_hook 3 ,
.Xr sh 1p ,
.Xr start-stop-daemon 8 ,
+.Xr supervise-daemon 8 ,
.Xr uname 1
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
+.An William Hubbs <w.d.hubbs@gmail.com>
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2018-02-10 20:52 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2018-02-10 20:52 UTC (permalink / raw
To: gentoo-commits
commit: 4c517bdb2b69eac36f004ae41bb9cbb212fe0a51
Author: Michael Orlitzky <michael <AT> orlitzky <DOT> com>
AuthorDate: Thu Jan 25 16:27:16 2018 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Feb 6 19:52:36 2018 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=4c517bdb
man/openrc-run.8: add missing "Xo" tags for fstabinfo and mountinfo.
The BUILTINS are all surrounded by Xo...Xc tags, but the opening "Xo"
was missing from the two commands fstabinfo and mountinfo. This commit
adds them, and thereby fixes the spacing when viewed by man.
This is for #204.
man/openrc-run.8 | 2 ++
1 file changed, 2 insertions(+)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 5f9c86dd..9078ff95 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -470,6 +470,7 @@ Also, the -d, -f or -p options should not be specified along with this option.
.Pp
The -q option suppresses all informational output. If it is specified
twice, all error messages are suppressed as well.
+.It Xo
.Ic fstabinfo
.Op Fl M , -mount
.Op Fl R , -remount
@@ -486,6 +487,7 @@ remounted.
.Pp
The -q option suppresses all informational output. If it is specified
twice, all error messages are suppressed as well.
+.It Xo
.Ic mountinfo
.Op Fl f, -fstype-regex Ar regex
.Op Fl F, -skip-fstype-regex Ar regex
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2018-02-10 20:52 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2018-02-10 20:52 UTC (permalink / raw
To: gentoo-commits
commit: c1ffe4d9f2e10b6853464cc298d1922c81ae92f4
Author: Michael Orlitzky <michael <AT> orlitzky <DOT> com>
AuthorDate: Thu Jan 25 16:28:39 2018 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Feb 6 19:53:11 2018 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=c1ffe4d9
man/openrc-run.8: fix mountinfo args.
The "Ar" tag for the mountinfo command contained a typo (leading
space) that resulted in the tag being output verbatim; that is,
mountinfo ... .Ar mount1 mount2
rather than e.g.
mountinfo ... <mount1> <mount2>
This commit deletes the leading space to fix the output.
This fixes #204.
man/openrc-run.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 9078ff95..426afdcc 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -502,7 +502,7 @@ twice, all error messages are suppressed as well.
.Op Fl i, -options
.Op Fl s, -fstype
.Op Fl t, -node
- .Ar mount1 mount2 ...
+.Ar mount1 mount2 ...
.Xc
The f, F, n, N, o, O, p, P, e and E options specify what you want to
search for or skip in the mounted file systems. The i, s and t options
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2018-03-12 23:23 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2018-03-12 23:23 UTC (permalink / raw
To: gentoo-commits
commit: 122768d339175c925a1a228792f4725b7c802f46
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Mon Mar 12 23:22:05 2018 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Mon Mar 12 23:22:40 2018 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=122768d3
man: document default retry specification for supervise-daemon
man/supervise-daemon.8 | 1 +
1 file changed, 1 insertion(+)
diff --git a/man/supervise-daemon.8 b/man/supervise-daemon.8
index 0d34a249..af06ee31 100644
--- a/man/supervise-daemon.8
+++ b/man/supervise-daemon.8
@@ -120,6 +120,7 @@ description of --respawn-max for more information.
.It Fl R , -retry Ar timeout | Ar signal Ns / Ns Ar timeout
The retry specification can be either a timeout in seconds or multiple
signal/timeout pairs (like SIGTERM/5).
+If this option is not given, the default is SIGTERM/5.
.It Fl r , -chroot Ar path
chroot to this directory before starting the daemon. All other paths, such
as the path to the daemon, chdir and pidfile, should be relative to the chroot.
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2018-03-12 23:23 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2018-03-12 23:23 UTC (permalink / raw
To: gentoo-commits
commit: fa3c60c0d8fd2267be5c1b156530b136a2503088
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Mon Mar 12 23:15:06 2018 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Mon Mar 12 23:15:06 2018 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=fa3c60c0
man: document default retry sppecification for start-stop-daemon
man/start-stop-daemon.8 | 1 +
1 file changed, 1 insertion(+)
diff --git a/man/start-stop-daemon.8 b/man/start-stop-daemon.8
index 1506a1a5..706a12ed 100644
--- a/man/start-stop-daemon.8
+++ b/man/start-stop-daemon.8
@@ -151,6 +151,7 @@ These options are only used for stopping daemons:
.It Fl R , -retry Ar timeout | Ar signal Ns / Ns Ar timeout
The retry specification can be either a timeout in seconds or multiple
signal/timeout pairs (like SIGTERM/5).
+If this option is not given, the default is SIGTERM/5.
.El
.Sh ENVIRONMENT
.Va SSD_IONICELEVEL
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2018-05-07 23:21 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2018-05-07 23:21 UTC (permalink / raw
To: gentoo-commits
commit: 49a90f27a848ba02a363fc0c844d6284728bdd73
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Tue Apr 24 15:40:57 2018 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Apr 24 15:40:57 2018 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=49a90f27
typo fix
man/openrc-run.8 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 426afdcc..f9109ef3 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -594,7 +594,7 @@ rc_net_tap1_provide="!net"
# It's also possible to negate keywords. This is mainly useful for prefix
# users testing OpenRC.
rc_keyword="!-prefix"
-# This can also be used to block a script from runining in all
+# This can also be used to block a script from running in all
# containers except one or two
rc_keyword="!-containers !-docker"
.Ed
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [gentoo-commits] proj/openrc:master commit in: man/
@ 2018-05-15 22:11 William Hubbs
0 siblings, 0 replies; 51+ messages in thread
From: William Hubbs @ 2018-05-15 22:11 UTC (permalink / raw
To: gentoo-commits
commit: 56870d0db18209396f8276bdc05d413fe4dd7a88
Author: William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Tue May 15 22:09:56 2018 +0000
Commit: William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue May 15 22:09:56 2018 +0000
URL: https://gitweb.gentoo.org/proj/openrc.git/commit/?id=56870d0d
Man: rc-service man page cleanups
man/rc-service.8 | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/man/rc-service.8 b/man/rc-service.8
index 3613f8b8..2834f361 100644
--- a/man/rc-service.8
+++ b/man/rc-service.8
@@ -44,7 +44,8 @@
.Ar service
.Nm
.Fl Z , -dry-run
-.Ar service
+.Ar service cmd
+.Op Ar ...
.Nm
.Fl l , -list
.Nm
@@ -87,7 +88,7 @@ sets -x when running the service script(s).
ignores dependencies when running the service.
.Pp
.Fl Z , -dry-run
-prints out the commands it would execute rather than executing them.
+displays commands rather than executing them.
.Sh SEE ALSO
.Xr openrc 8 ,
.Xr stdout 3
^ permalink raw reply related [flat|nested] 51+ messages in thread
end of thread, other threads:[~2018-05-15 22:11 UTC | newest]
Thread overview: 51+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-11-29 21:12 [gentoo-commits] proj/openrc:master commit in: man/ William Hubbs
-- strict thread matches above, loose matches on Subject: below --
2018-05-15 22:11 William Hubbs
2018-05-07 23:21 William Hubbs
2018-03-12 23:23 William Hubbs
2018-03-12 23:23 William Hubbs
2018-02-10 20:52 William Hubbs
2018-02-10 20:52 William Hubbs
2017-11-30 22:04 William Hubbs
2017-10-12 23:55 William Hubbs
2017-09-22 22:25 William Hubbs
2017-07-26 16:32 William Hubbs
2017-07-25 18:57 William Hubbs
2017-07-08 16:55 William Hubbs
2017-07-08 16:55 William Hubbs
2017-06-07 16:34 William Hubbs
2017-05-12 3:01 William Hubbs
2017-04-14 16:11 William Hubbs
2016-12-05 18:27 William Hubbs
2016-12-02 16:58 William Hubbs
2016-09-22 15:30 William Hubbs
2016-09-21 18:35 William Hubbs
2016-09-13 19:09 William Hubbs
2016-06-23 22:55 William Hubbs
2015-12-03 23:45 William Hubbs
2015-05-27 19:15 William Hubbs
2015-05-11 20:39 William Hubbs
2014-11-22 18:39 William Hubbs
2014-09-19 23:00 William Hubbs
2014-07-13 16:25 William Hubbs
2014-07-13 16:25 William Hubbs
2014-07-11 21:41 William Hubbs
2014-06-21 7:05 William Hubbs
2014-01-08 19:27 William Hubbs
2013-08-24 17:05 William Hubbs
2013-08-15 15:22 William Hubbs
2013-08-13 17:22 William Hubbs
2013-03-20 20:45 William Hubbs
2012-10-22 0:53 William Hubbs
2012-10-16 19:29 Christian Ruppert
2012-10-16 19:00 Christian Ruppert
2012-09-25 17:09 William Hubbs
2012-09-24 0:37 William Hubbs
2012-03-24 17:40 William Hubbs
2012-02-19 19:18 William Hubbs
2012-02-19 18:54 William Hubbs
2011-12-31 4:25 William Hubbs
2011-12-31 4:25 William Hubbs
2011-12-31 2:44 Christian Ruppert
2011-12-30 16:41 William Hubbs
2011-12-30 15:03 Christian Ruppert
2011-04-08 19:10 William Hubbs
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox