doc/pod/rc.news.pod

   1 =head1 NAME
   2
   3 rc.news - Start or stop INN daemons
   4
   5 =head1 SYNOPSIS
   6
   7 B<rc.news> [start | stop]
   8
   9 =head1 DESCRIPTION
  10
  11 B<rc.news> can be used to start or stop B<innd> and supporting programs.
  12 It checks to make sure INN is not already running, handles cases of
  13 unclean shutdown, finishes up tasks which might have been interrupted by
  14 the preceeding shutdown, emails certain boot-time warnings to
  15 I<newsmaster> (as set in F<inn.conf>), and is generally safer and easier
  16 than starting and stopping everything directly.  It needs to be run as the
  17 news user so that files in I<pathrun> are created with the right ownership
  18 (though this is less important for C<rc.news stop>), and therefore
  19 requires that F<inndstart> be setuid root, see inndstart(8) for
  20 discussion.
  21
  22 Programs run and stopped by this script include:
  23
  24 =over 4
  25
  26 =item *
  27
  28 Always:  B<inndstart> is run, and B<innd> is stopped.
  29
  30 =item *
  31
  32 If I<doinnwatch> is true in F<inn.conf>:  B<innwatch> is started and
  33 stopped.
  34
  35 =item *
  36
  37 If I<docnfsstat> is true in F<inn.conf>:  B<ovdb_init> is run;
  38 B<ovdb_server> and B<ovdb_monitor> are stopped.
  39
  40 =item *
  41
  42 If F<rc.news.local> exists in I<pathbin>:  B<rc.news.local> is run with
  43 argument C<start> or C<stop> (to perform site-specific startup or shutdown
  44 tasks).
  45
  46 =back
  47
  48 =head1 OPTIONS
  49
  50 =over 4
  51
  52 =item C<start>
  53
  54 If the first argument is C<start>, or no first argument is given,
  55 B<rc.news> initiates INN startup.
  56
  57 =item C<stop>
  58
  59 If the first argument is C<stop>, B<rc.news> initiates INN shutdown.  It
  60 is recommended to throttle the server first as described in ctlinnd(8).
  61
  62 =back
  63
  64 =head1 EXAMPLES
  65
  66 To start INN and leave certain error messages going to the terminal:
  67
  68        su - news -c ~news/bin/rc.news
  69
  70 To run INN at startup time from appropriate system boot scripts:
  71
  72        su - news -c ~news/bin/rc.news >/dev/console
  73
  74 To stop INN (throttling first):
  75
  76        ~news/bin/ctlinnd throttle reason
  77        su - news -c '~news/bin/rc.news stop'
  78
  79 =head1 BUGS
  80
  81 Running C<rc.news start> as root is never the right thing to do, so we
  82 should at minimum check for this and error, or perhaps change effective
  83 user ID.
  84
  85 =head1 HISTORY
  86
  87 // FIXME:  any attribution for rc.news itself?
  88
  89 This manual page written by Jeffrey M. Vinocur <jeff@litech.org> for
  90 InterNetNews.
  91
  92 $Id: rc.news.pod 5908 2002-12-03 04:41:36Z vinocur $
  93
  94 =head1 SEE ALSO
  95
  96 ctlinnd(8),
  97 cnfsstat(8),
  98 inn.conf(5),
  99 inndstart(8),
 100 innwatch(8),
 101 ovdb(5).
 102
 103 =cut
 104