summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/s6-socklog.html14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/s6-socklog.html b/doc/s6-socklog.html
index 7feb175..1292fb2 100644
--- a/doc/s6-socklog.html
+++ b/doc/s6-socklog.html
@@ -82,12 +82,12 @@ 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.
If this option is not given, no readiness notification is sent. </li>
- <li> <tt>-u&nbsp;<em>uid</em></tt>&nbsp;: set the process' user ID to <em>uid</em> </li>
- <li> <tt>-g&nbsp;<em>gid</em></tt>&nbsp;: set the process' group ID to <em>gid</em> </li>
- <li> <tt>-G&nbsp;<em>gidlist</em></tt>&nbsp;: set the process' supplementary group list
+ <li> <tt>-u&nbsp;<em>uid</em></tt>&nbsp;: drop user id to <em>uid</em> </li>
+ <li> <tt>-g&nbsp;<em>gid</em></tt>&nbsp;: drop group ID to <em>gid</em> </li>
+ <li> <tt>-G&nbsp;<em>gidlist</em></tt>&nbsp;: set supplementary group list
to <em>gidlist</em>, which must be given as a comma-separated list of numeric GIDs,
without spaces. </li>
- <li> <tt>-U</tt>&nbsp;: set the process' user ID, group ID and supplementary group list
+ <li> <tt>-U</tt>&nbsp;: set user ID, group ID and supplementary group list
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>
@@ -109,7 +109,11 @@ is a combination of <em>ip</em>, which must be an IPv4 or IPv6 address, and
<em>port</em>, which must be an integer. <em>port</em> may be omitted, in which
case it defaults to 514. If <em>port</em> is given, <em>ip</em> and <em>port</em>
must be separated by a <tt>_</tt> character (an underscore). If <em>ip</em> is
-IPv4, a <tt>:</tt> (colon) can be used instead of an underscore. </li>
+IPv4, a <tt>:</tt> (colon) can be used instead of an underscore. When this
+option is used, <tt>s6-socklog</tt> will prepend every log line with
+<tt><em>clientip</em>_<em>clientport</em>: </tt>, <em>clientip</em> and
+<em>clientport</em> being the IP address and port of the client that sent
+the log datagram.</li>
</ul>
<h2> Typical use </h2>