File: socklog.8.html

package info (click to toggle)
socklog 2.1.0%2Brepack-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,128 kB
  • sloc: ansic: 3,422; sh: 362; makefile: 323
file content (105 lines) | stat: -rw-r--r-- 4,340 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105



<html>
<head>
<title>socklog(8) manual page</title>
</head>
<body bgcolor='white'>
<a href='http://smarden.org/pape/'>G. Pape</a><br><a href='index.html'>socklog</A><hr><p>

<h2><a name='sect0'>Name</a></h2>
socklog - small and secure syslogd replacement for use with runit 
<h2><a name='sect1'>Synopsis</a></h2>
<b>socklog</b>
[-rRU] [unix] [<i>path]</i> <br>
<b>socklog</b> [-rR] inet [<i>ip]</i> [<i>port]</i> <br>
<b>socklog</b> [-rR] ucspi [<i>args]</i> 
<h2><a name='sect2'>Description</a></h2>
<b>socklog</b> is run under runit&rsquo;s <i><b>runsv</b>(8)</i>,
writing syslog messages it receives from unix domain socket <i>path</i> or an
inet udp socket <i>ip:<i>port</i></i> through a pipe provided by <i><b>runsv</b>(8)</i> to a <i><b>svlogd</b>(8)</i>
process. <p>
<b>socklog</b> can be run as an ucspi application to listen to an unix
domain stream socket and for more flexible distributed logging. <p>
If the environment
variables $UID and/or $GID are present, <b>socklog</b> drops permissions to those
ids after creating and binding the socket (not in <i>ucspi</i> mode). <p>
<b>socklog</b> converts
syslog facility and priority information to names (<i>facility</i>.<i>priority</i>:) as
found in <i>/usr/include/syslog.h</i> at compile time if present. <p>
On solaris <b>socklog</b>
also accepts <i>sun_stream</i> as first argument. Please see the web page for details.

<h2><a name='sect3'>UNIX Socket</a></h2>
<b>socklog</b> [ unix ] [ <i>path</i> ] <p>
Starting <b>socklog</b> with the 1st argument
<i>unix</i>, <b>socklog</b> will listen to the unix domain socket <i>path</i>. If <i>path</i> is omitted,
the default <i>/dev/log</i> is used. <p>
The 1st argument may be omitted, default is
<i>unix</i>. 
<h2><a name='sect4'>Inet Socket</a></h2>
<b>socklog</b> inet [ <i>ip</i> ] [ <i>port</i> ] <p>
Starting <b>socklog</b> with the
1st argument <i>inet</i>, <b>socklog</b> will listen to the inet udp socket <i>ip:<i>port</i>.</i> <p>
If
<i>ip</i> starts with 0, <b>socklog</b> will bind to all local interfaces. <p>
If <i>port</i> is
less or equal 1024, <b>socklog</b> must be run by root. <p>
<i>port</i> may be omitted, default
is 514. <i>ip</i> may be omitted, default is 0. <p>
<b>socklog</b> prepends <i>a.b.c.d:</i> to each syslog
message it receives, where <i>a.b.c.d</i> is the ip address of the connecting system.

<h2><a name='sect5'>Ucspi Mode</a></h2>
<b>socklog</b> ucspi [ <i>args</i> ] <p>
Starting <b>socklog</b> with the 1st argument
<i>ucspi</i>, <b>socklog</b> will run as an ucspi application. Normally <b>socklog</b> will only
be started in <i>ucspi</i> mode by an ucspi server tool, such as <i><b>tcpsvd</b>(8)</i>, <i><b>tcpserver</b>(1)</i>
or <b>unixserver</b>. <p>
For each <i>arg</i>, <b>socklog</b> will prepend $<i>arg</i>: to each syslog message,
if the environment variable $<i>arg</i> is present (maximum is 8). 
<h2><a name='sect6'>Options</a></h2>

<dl>

<dt><b>-r</b> </dt>
<dd>raw.
Write the raw syslog messages (no conversion of facility and priority)
to the pipe, additionally to the log messages with syslog facility and
priority converted to names. </dd>

<dt><b>-R</b> </dt>
<dd>raw only. Same as -r above, but write the raw
syslog messages only. </dd>

<dt><b>-U</b> </dt>
<dd>respect umask. Don&rsquo;t set umask to 0 before creating
a unix domain socket, but respect the current setting of <i><b>umask</b>(2)</i>. This
option only takes effect in unix mode. </dd>
</dl>

<h2><a name='sect7'>See Also</a></h2>
<i>sv(8)</i>, <i>runsvdir(8)</i>, <i>runsv(8)</i>,
<i>svlogd(8)</i>, <i>tryto(1)</i>, <i>uncat(1)</i>, <i>socklog-check(8)</i>, <i>tcpsvd(8)</i>, <i>nc(1)</i> <p>
 <i>http://smarden.org/socklog/</i><br>
  <i>http://smarden.org/runit/</i><br>
 
<h2><a name='sect8'>Author</a></h2>
Gerrit Pape &lt;pape@smarden.org&gt; <p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Description</a></li>
<li><a name='toc3' href='#sect3'>UNIX Socket</a></li>
<li><a name='toc4' href='#sect4'>Inet Socket</a></li>
<li><a name='toc5' href='#sect5'>Ucspi Mode</a></li>
<li><a name='toc6' href='#sect6'>Options</a></li>
<li><a name='toc7' href='#sect7'>See Also</a></li>
<li><a name='toc8' href='#sect8'>Author</a></li>
</ul>
</body>
</html>