chiark / gitweb /
option for no inotify; manpage fix
[innduct.git] / doc / man / rc.news.8
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "RC.NEWS 8"
132 .TH RC.NEWS 8 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 rc.news \- Start or stop INN daemons
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBrc.news\fR [start | stop]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 \&\fBrc.news\fR can be used to start or stop \fBinnd\fR and supporting programs.
141 It checks to make sure \s-1INN\s0 is not already running, handles cases of
142 unclean shutdown, finishes up tasks which might have been interrupted by
143 the preceeding shutdown, emails certain boot-time warnings to
144 \&\fInewsmaster\fR (as set in \fIinn.conf\fR), and is generally safer and easier
145 than starting and stopping everything directly.  It needs to be run as the
146 news user so that files in \fIpathrun\fR are created with the right ownership
147 (though this is less important for \f(CW\*(C`rc.news stop\*(C'\fR), and therefore
148 requires that \fIinndstart\fR be setuid root, see \fIinndstart\fR\|(8) for
149 discussion.
150 .PP
151 Programs run and stopped by this script include:
152 .IP "\(bu" 4
153 Always:  \fBinndstart\fR is run, and \fBinnd\fR is stopped.
154 .IP "\(bu" 4
155 If \fIdoinnwatch\fR is true in \fIinn.conf\fR:  \fBinnwatch\fR is started and
156 stopped.
157 .IP "\(bu" 4
158 If \fIdocnfsstat\fR is true in \fIinn.conf\fR:  \fBovdb_init\fR is run;
159 \&\fBovdb_server\fR and \fBovdb_monitor\fR are stopped.
160 .IP "\(bu" 4
161 If \fIrc.news.local\fR exists in \fIpathbin\fR:  \fBrc.news.local\fR is run with
162 argument \f(CW\*(C`start\*(C'\fR or \f(CW\*(C`stop\*(C'\fR (to perform site-specific startup or shutdown
163 tasks).
164 .SH "OPTIONS"
165 .IX Header "OPTIONS"
166 .ie n .IP """start""" 4
167 .el .IP "\f(CWstart\fR" 4
168 .IX Item "start"
169 If the first argument is \f(CW\*(C`start\*(C'\fR, or no first argument is given,
170 \&\fBrc.news\fR initiates \s-1INN\s0 startup.
171 .ie n .IP """stop""" 4
172 .el .IP "\f(CWstop\fR" 4
173 .IX Item "stop"
174 If the first argument is \f(CW\*(C`stop\*(C'\fR, \fBrc.news\fR initiates \s-1INN\s0 shutdown.  It
175 is recommended to throttle the server first as described in \fIctlinnd\fR\|(8).
176 .SH "EXAMPLES"
177 .IX Header "EXAMPLES"
178 To start \s-1INN\s0 and leave certain error messages going to the terminal:
179 .PP
180 .Vb 1
181 \&       su \- news \-c ~news/bin/rc.news
182 .Ve
183 .PP
184 To run \s-1INN\s0 at startup time from appropriate system boot scripts:
185 .PP
186 .Vb 1
187 \&       su \- news \-c ~news/bin/rc.news >/dev/console
188 .Ve
189 .PP
190 To stop \s-1INN\s0 (throttling first):
191 .PP
192 .Vb 2
193 \&       ~news/bin/ctlinnd throttle reason
194 \&       su \- news \-c '~news/bin/rc.news stop'
195 .Ve
196 .SH "BUGS"
197 .IX Header "BUGS"
198 Running \f(CW\*(C`rc.news start\*(C'\fR as root is never the right thing to do, so we
199 should at minimum check for this and error, or perhaps change effective
200 user \s-1ID\s0.
201 .SH "HISTORY"
202 .IX Header "HISTORY"
203 // \s-1FIXME:\s0  any attribution for rc.news itself?
204 .PP
205 This manual page written by Jeffrey M. Vinocur <jeff@litech.org> for
206 InterNetNews.
207 .PP
208 $Id: rc.news.8 7880 2008-06-16 20:37:13Z iulius $
209 .SH "SEE ALSO"
210 .IX Header "SEE ALSO"
211 \&\fIctlinnd\fR\|(8),
212 \&\fIcnfsstat\fR\|(8),
213 \&\fIinn.conf\fR\|(5),
214 \&\fIinndstart\fR\|(8),
215 \&\fIinnwatch\fR\|(8),
216 \&\fIovdb\fR\|(5).