File: socklog-conf.8

package info (click to toggle)
socklog 2.1.0%2Brepack-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 1,128 kB
  • sloc: ansic: 3,422; sh: 362; makefile: 323
file content (246 lines) | stat: -rw-r--r-- 4,579 bytes parent folder | download
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
.TH socklog-conf 8
.SH NAME
socklog-conf \- sets up a socklog(8) service.
.SH SYNOPSIS
.B socklog-conf
unix|inet|klog|ucspi-tcp
.I acct
.I logacct
.br
.B socklog-conf
notify
.I acct
.I grp
.SH DESCRIPTION
.B socklog-conf
creates
.I /etc/sv
if necessary and a subdirectory that runs the
.BR unix ,
.BR inet ,
.B ucspi-tcp
or
.B notify
service (see below for each service).
Except for the notify service,
.B socklog-conf
also creates a log directory with subdirectories.
.LP
.IR acct ,
.I logacct
and
.I grp
must not contain any special characters.
.SH UNIX SERVICE
.B socklog-conf
unix
.I acct
.I logacct
.LP
Running
.B socklog-conf
with the 1st argument
.IR unix ,
.B socklog-conf
creates the service directory
.I /etc/sv/socklog-unix
and the log directory
.IR /var/log/socklog .
.LP
.B socklog-conf
arranges for
.BR socklog (8)
to run under the uid and gid of
.I acct
and to listen for syslog messages on
.IR /dev/log .
.LP
It also creates automatically rotated log directories in
.IR /var/log/socklog .
The logs are owned by
.IR logacct .
The corresponding
.BR svlogd (8)
process runs under the uid and gid of
.IR logacct .
.LP
You can add the service to system-wide service supervision through the
.BR update-service (8)
program:
.LP
update-service \--add /etc/sv/socklog-unix
.LP
.SH INET SERVICE
.B socklog-conf
inet
.I acct
.I logacct
.LP
Running
.B socklog-conf
with the 1st argument
.IR inet ,
.B socklog-conf
creates the service directory
.I /etc/sv/socklog-inet
and the log directory
.IR /var/log/socklog-inet .
.LP
.B socklog-conf
arranges for
.BR socklog (8)
to run under the uid and gid of
.I acct
and to listen for syslog messages on the UDP socket
.IR 0.0.0.0:514 .
.LP
It also creates automatically rotated log directories in
.IR /var/log/socklog-inet .
The logs are owned by
.IR logacct .
The corresponding
.BR svlogd (8)
process runs under the uid and gid of
.IR logacct .
.LP
You can add the service to system-wide service supervision through the
.BR update-service (8)
program:
.LP
update-service \--add /etc/sv/socklog-inet
.LP
.SH KLOG SERVICE
.B socklog-conf
klog
.I acct
.I logacct
.LP
Running
.B socklog-conf
with the 1st argument
.IR klog ,
.B socklog-conf
creates the service directory
.I /etc/sv/socklog-klog
and the log directory
.IR /var/log/socklog-klog .
.LP
.B socklog-conf
arranges for
.BR socklog (8)
to run under the uid and gid of
.I acct
and to read kernel messages from
.I /proc/kmsg
on Linux, or
.I /dev/socklog-klog
on BSD.
.LP
It also creates automatically rotated log directories in
.IR /var/log/socklog-klog .
The logs are owned by
.IR logacct .
The corresponding
.BR svlogd (8)
process runs under the uid and gid of
.IR logacct .
.LP
You can add the service to system-wide service supervision through the
.BR update-service (8)
program:
.LP
update-service \--add /etc/sv/socklog-klog
.LP
.SH UCSPI-TCP SERVICE
.B socklog-conf
ucspi-tcp
.I acct
.I logacct
.LP
Running
.B socklog-conf
with the 1st argument
.IR ucspi-tcp ,
.B socklog-conf
creates the service directory
.I /etc/sv/socklog-ucspi-tcp
and the log directory
.IR /var/log/socklog-ucspi-tcp .
.LP
.B socklog-conf
arranges for
.BR tcpsvd (1)
to run
.BR socklog (8)
under the uid and gid of
.I acct
and to listen on the TCP socket
.IR 0.0.0.0:10116 .
.LP
It also creates automatically rotated log directories in
.IR /var/log/socklog-ucspi-tcp .
The logs are owned by
.IR logacct .
The corresponding
.BR svlogd (8)
process runs under the uid and gid of
.IR logacct .
.LP
You can add the service to system-wide service supervision through the
.BR update-service (8)
program:
.LP
update-service \--add /etc/sv/socklog-ucspi-tcp
.LP
.SH NOTIFY SERVICE
.B socklog-conf
notify
.I acct
.I grp
.LP
Running
.B socklog-conf
with the 1st argument
.IR notify ,
.B socklog-conf
creates the service directory
.IR /etc/sv/socklog-notify .
.LP
.B socklog-conf
arranges for
.BR uncat (1)
to run under the uid and gid of
.I acct
and to listen on the named pipe
.IR /var/log/socklog/.notify .
The named pipe will have mode 0620, the uid of
.I acct
and the gid of
.IR grp .
.LP
All uids running a log service that is configured to push log events to the
socklog-notify service must be member of the group
.IR grp .
.LP
You can add the service to system-wide service supervision through the
.BR update-service (8)
program:
.LP
update-service \--add /etc/sv/socklog-notify
.LP
.SH SEE ALSO
socklog(8),
svlogd(8),
nc(1),
tryto(1),
uncat(1),
socklog-check(8),
tcpsvd(8),
sv(8),
runsv(8),
runsvdir(8)
.LP
 http://smarden.org/socklog/
 http://smarden.org/runit/
.SH AUTHOR
Gerrit Pape <pape@smarden.org>