diff options
author | Laurent Bercot <ska-skaware@skarnet.org> | 2021-09-25 09:45:27 +0000 |
---|---|---|
committer | Laurent Bercot <ska@appnovation.com> | 2021-09-25 09:45:27 +0000 |
commit | 0ba5fd00ec4e1e25bb868b2b5a7b98d24b56197e (patch) | |
tree | 56c3b8747bbea36d433c5108e0d326bd48450914 /doc | |
parent | 394619babd409dfede6bdce61699981b893183ba (diff) | |
download | s6-0ba5fd00ec4e1e25bb868b2b5a7b98d24b56197e.tar.xz |
Doc fixes, s6-socklog min linelen -> 76, s6-ioconnect fixes
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/s6-socklog.html | 6 | ||||
-rw-r--r-- | doc/s6-svlink.html | 4 | ||||
-rw-r--r-- | doc/s6-svunlink.html | 8 |
3 files changed, 9 insertions, 9 deletions
diff --git a/doc/s6-socklog.html b/doc/s6-socklog.html index 3f66cdc..d10a517 100644 --- a/doc/s6-socklog.html +++ b/doc/s6-socklog.html @@ -45,7 +45,7 @@ with a few more features. <ul> <li> Messages are truncated to 1024 characters </li> <li> Trailing nulls or newlines are removed </li> - <li> Embedded nulls or newlines are converted to <tt>~</tt> characters (tildas) </li> + <li> Embedded nulls or newlines are converted to <tt>~</tt> characters (tildes) </li> <li> A <tt><syslogcode></tt> at the beginning of the line is converted to <tt>facility.priority: </tt> </li> </ul> </li> <li> It prints the log line to its stdout, terminated by a newline. </li> @@ -80,7 +80,7 @@ will not be converted to facility/priority names. </li> (actually bound to its socket), write a newline to file descriptor <em>notif</em> then close it. This allows <tt>s6-socklog</tt> to use the <a href="notifywhenup.html">s6 -mechanism to notify readiness</a>. <em>notif</em> cannot be lesser than 3. +mechanism to notify readiness</a>. <em>notif</em> cannot be less than 3. If this option is not given, no readiness notification is sent. </li> <li> <tt>-u <em>uid</em></tt> : drop user id to <em>uid</em> </li> <li> <tt>-g <em>gid</em></tt> : drop group id to <em>gid</em> </li> @@ -92,7 +92,7 @@ to the values of the UID, GID and GIDLIST environment variables. If a <tt>-u</tt <tt>-g</tt> or <tt>-G</tt> option is given after <tt>-U</tt>, the command line value overrides the environment variable. </li> <li> <tt>-l</tt> <em>linelen</em> : Set the maximum datagram size to -<em>linelen</em>. Default is 1024. It cannot be set to less than 80 or more than +<em>linelen</em>. Default is 1024. It cannot be set to less than 76 or more than 1048576. If a datagram is bigger than <em>linelen</em>, it will be truncated to <em>linelen</em> characters, and the logged line will end with a <tt>...</tt> ellipsis to show the truncation. </li> diff --git a/doc/s6-svlink.html b/doc/s6-svlink.html index c1b9e94..5135ee4 100644 --- a/doc/s6-svlink.html +++ b/doc/s6-svlink.html @@ -48,7 +48,7 @@ is named <em>name</em>; if no <em>name</em> argument has been given, the name gi to the symbolic link is the basename of <em>servicedir</em>. </li> <li> It sends a command to <a href="s6-svscan.html">s6-svscan</a> to signal it that a new service is available. </li> - <li> It waits for a <a href="s6-supervise.html">s6-supervise</a> process to be + <li> It waits for an <a href="s6-supervise.html">s6-supervise</a> process to be spawned on <em>servicedir</em>. </li> <li> It exits 0. </li> </ul> @@ -105,7 +105,7 @@ supervisors one at a time, can be used instead. </li> <li> If <em>servicedir</em> is logged, i.e. <em>servicedir</em><tt>/log</tt> is also a valid service directory, then <tt>s6-svlink</tt> will wait until supervisors have been spawned for both the service and its logger. </li> - <li> <tt>s6-svlink</tt> sends a <a href="s6-svscanctl.html">s6-svscanctl -a</a> + <li> <tt>s6-svlink</tt> sends an <a href="s6-svscanctl.html">s6-svscanctl -a</a> command to <em>scandir</em>, which means that the system's view of services will be refreshed. Depending on what links exist in <em>scandir</em>, other services than <em>servicedir</em> may also appear. </li> diff --git a/doc/s6-svunlink.html b/doc/s6-svunlink.html index 371f5bd..5a4bf1b 100644 --- a/doc/s6-svunlink.html +++ b/doc/s6-svunlink.html @@ -65,14 +65,14 @@ managing the service directory to exit. </li> <li> <tt>-X</tt> : don't wait. <tt>s6-svunlink</tt> will exit right away, without waiting for the supervisor to exit first. </li> <li> <tt>-t <em>timeout</em></tt> : if the supervisor has not exited -after <em>timeout</em> milliseconds, <tt>s6-svlink</tt> will still exit. -The default is 0, meaning no time limit.. </li> +after <em>timeout</em> milliseconds, <tt>s6-svunlink</tt> will still exit. +The default is 0, meaning no time limit. </li> </ul> <h2> Notes </h2> <ul> - <li> Using <tt>s6-svlink</tt> to stop services is a suboptimal pattern: + <li> Using <tt>s6-svunlink</tt> to stop services is a suboptimal pattern: starting and stopping supervisors is a heavier operation than just stopping services. The simpler, more efficient pattern is to simply perform <a href="s6-svc.html">s6-svc -dwD <em>scandir</em><tt>/</tt><em>name</em></a>, @@ -84,7 +84,7 @@ situations that are nominal failures. For instance, it returns 0 even if its timeout expires; the rationale is that there is no sensible action for the user to do if this error is reported. <tt>s6-svunlink</tt> only reports errors when they uncover a deeper problem in the system. </li> - <li> <tt>s6-svunlink</tt> sends a <a href="s6-svscanctl.html">s6-svscanctl -an</a> + <li> <tt>s6-svunlink</tt> sends an <a href="s6-svscanctl.html">s6-svscanctl -an</a> command to <em>scandir</em>, which means that the system's view of services will be refreshed and inactive services will be killed and unsupervised. Depending on what links exist in <em>scandir</em>, new |