chiark / gitweb /
option for no inotify; manpage fix
[innduct.git] / doc / man / controlchan.8
1 .\" $Revision: 5909 $
2 .TH CONTROLCHAN 8
3 .SH NAME
4 controlchan \- channel\-fed control message handler
5 .SH SYNOPSIS
6 .B controlchan
7 .SH DESCRIPTION
8 .I Controlchan
9 removes the responsibility for handling control messages
10 (except cancels) from
11 .IR innd (8)
12 and instead processes them from a channel or file feed.
13 To reduce load,
14 .I controlchan
15 keeps a copy of
16 .I control.ctl
17 in memory and checks permissions (including any required PGP headers) before any
18 scripts are called.  Also, the default (``bad message'') case is handled
19 internally.  The ``drop'' case is handled with far less fuss.
20 .PP
21 Normally,
22 .I controlchan
23 is invoked by
24 .IR innd (8)
25 as configured in
26 .IR newsfeeds .
27 An example entry is below.  Make sure that you've created the newsgroup
28 control.cancel so that
29 .I controlchan
30 doesn't have to scan through cancels, which it won't process anyway.
31 .sp 1
32 .in +0.5i
33 .nf
34 controlchan!\\
35    :!*,control,control.*,!control.cancel\\
36    :Tc,Wnsm\\ 
37    :<pathbin in inn.conf>/controlchan
38 .fi
39 .in -0.5i
40 .sp 1
41 Note that in the (very, very unlikely) event that you need to process
42 ihave/sendme control messages, be sure that
43 .I logipaddr
44 is set to false in
45 .IR inn.conf ,
46 because in this case controlchan needs a site name, not an IP address.
47 .sp 1
48 .I Controlchan
49 tries to report all log messages through
50 .IR syslog (3),
51 unless connected to an interactive terminal.  To enable
52 .IR syslog (3)'ing
53 for versions of Perl prior to 5.6.0,
54 you will need to have run ``h2ph'' on your
55 system include files at some point (this is required to
56 make ``Sys::Syslog'' work).  If you have not done so, do this:
57 .sp 1
58 .nf
59 .in +0.5i
60 cd /usr/include
61 h2ph * sys/*
62 .in -0.5i
63 .fi
64 .sp 1
65 If you run FreeBSD, you will need to run the following in addition:
66 .sp 1
67 .nf
68 .in +0.5i
69 h2ph machine/*
70 .in -0.5i
71 .fi
72 .SH HISTORY
73 Written by Katsuhiro Kondou <kondou@nec.co.jp> for InterNetNews.
74 .de R$
75 This is revision \\$3, dated \\$4.
76 ..
77 .R$ $Id: controlchan.8 5909 2002-12-03 05:17:18Z vinocur $
78 .SH "SEE ALSO"
79 control.ctl(5),
80 inn.conf(5).