git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/doc/bbc.me

   1 .\"     This file is automatically generated.  Do not edit!
   2 .\" @(#)$Id: bbc.rf,v 2.6 1995/12/06 22:48:30 jromine Exp $
   3 .SC BBC 1
   4 .NA
   5 bbc \- check on BBoards
   6 .SY
   7 bbc
   8 \%[bboards\ ...]
   9 \%[\-topics] \%[\-check] \%[\-read]
  10 \%[\-quiet] \%[\-verbose]
  11 \%[\-archive] \%[\-noarchive]
  12 \%[\-protocol] \%[\-noprotocol]
  13 \%[\-mshproc\ program]
  14 \%[switches\ for\ \fImshproc\fR]
  15 \%[\-rcfile rcfile] \%[\-norcfile]
  16 \%[\-file\ BBoardsfile] \%[\-user\ BBoardsuser]
  17 \%[\-help]
  18 .DE
  19 \fIbbc\fR is a BBoard
  20 reading/checking program that interfaces to the BBoard
  21 channel.
  22
  23 The \fIbbc\fR program has three action switches which direct its operation:
  24
  25 The `\-read' switch invokes the \fImsh\fR program on the named
  26 \fIBBoards\fR.  If you also specify
  27 the `\-archive' switch, then  \fIbbc\fR will invoke the \fImsh\fR program on
  28 the archives of the named \fIBBoards\fR.  If no \fIBBoards\fR are given
  29 on the command line, and you specified `\-archive',
  30 \fIbbc\fR will not read your `bboards' profile entry, but will
  31 read the archives of the \*(lqsystem\*(rq \fIBBoard\fR instead.
  32
  33 The `\-check' switch types out status information for the named \fIBBoards\fR.
  34 \fIbbc\fR
  35 can print one of several messages depending on the status of both the
  36 BBoard
  37 and the user's reading habits.
  38 As with each of these messages, the number
  39 given is the item number of the last item placed in the
  40 BBoard.
  41 This number (which is marked in the messages as the \*(lqBBoard\-Id\*(rq) is
  42 ever increasing.  Hence, when \fIbbc\fR
  43 says \*(lqn items\*(rq, it really means that the highest BBoard\-Id is \*(lqn\*(rq.
  44 There may, or may not actually be \*(lqn\*(rq items in the BBoard.
  45 Some common messages are:
  46 .in +1i
  47
  48 .ti -.5i
  49 \fBBBoard \-\- n items unseen\fR
  50 .br
  51 This message tells how many items the user has not yet seen.
  52 When invoked with the `\-quiet' switch,
  53 this is the only informative line that \fIbbc\fR will possibly print out.
  54
  55 .ti -.5i
  56 \fBBBoard \-\- empty\fR
  57 .br
  58 The BBoard is empty.
  59
  60 .ti -.5i
  61 \fBBBoard \-\- n items (none seen)\fR
  62 .br
  63 The BBoard has items in it, but the user hasn't seen any.
  64
  65 .ti -.5i
  66 \fBBBoard \-\- n items (all seen)\fR
  67 .br
  68 The BBoard is non\-empty, and the user has seen everything in it.
  69
  70 .ti -.5i
  71 \fBBBoard \-\- n items seen out of m\fR
  72 .br
  73 The BBoard has at most m\-n items that the user has not seen.
  74 .in -1i
  75
  76 The `\-topics' switch directs \fIbbc\fR to print three items about the named
  77 \fIBBoards\fR:
  78 it's official name,
  79 the number of items present,
  80 and the date and time of the last update.
  81 If no \fIBBoards\fR
  82 are named, then all BBoards
  83 are listed.  If the `\-verbose' switch is given, more information is output.
  84
  85 The `\-quiet' switch specifies that \fIbbc\fR should be silent if no
  86 \fIBBoards\fR are found with new information.
  87 The `\-verbose' switch specifies that \fIbbc\fR is to consider you to be
  88 interested in \fIBBoards\fR that you've already seen everything in.
  89
  90 To override the default \fImshproc\fR and the profile entry,
  91 use the `\-mshproc\ program' switch.
  92 Any arguments not understood by \fIbbc\fR are passed to this program.
  93 The `\-protocol' switch tells \fIbbc\fR that your \fImshproc\fR knows about
  94 the special \fIbbc\fR protocol for reporting back information.
  95 \fImsh\fR\0(1), the default \fImshproc\fR, knows all about this.
  96
  97 The `\-file\ BBoardsfile' switch tells \fIbbc\fR to use a non\-standard
  98 \fIBBoards\fR file when performing its calculations.
  99 Similarly, the `\-user BBoardsuser' switch tells \fIbbc\fR to use a
 100 non\-standard username.
 101 Both of these switches are useful for debugging a new \fIBBoards\fR or
 102 \fIPOP\fR file.
 103
 104 The \fI\&.bbrc\fR file in the
 105 user's \fB$HOME\fR directory
 106 is used to keep track of what messages have been read.
 107 The `\-rcfile\ rcfile' switch overrides the use of \fI\&.bbrc\fR for
 108 this purpose.
 109 If the value given to the switch is not absolute,
 110 (i.e., does not begin with a \fB/\fR\0),
 111 it will be presumed to start from the current working directory.
 112 If this switch is not given (or the `\-norcfile' switch is given),
 113 then \fIbbc\fR consults the envariable \fBMHBBRC\fR,
 114 and honors it similarly.
 115 .Fi
 116 ^$HOME/\&.mh\(ruprofile~^The user profile
 117 ^$HOME/\&.bbrc~^BBoard \*(lqcurrent\*(rq message information
 118 .Pr
 119 ^Path:~^To determine the user's MH directory
 120 .Ps
 121 ^bboards:~^To specify interesting BBoards
 122 .Ps
 123 ^mshproc:~^Program to read a given BBoard
 124 .Sa
 125 bbl(1), bboards(1), msh(1)
 126 .De
 127 `\-read'
 128 .Ds
 129 `\-noarchive'
 130 .Ds
 131 `\-protocol'
 132 .Ds
 133 `bboards' defaults to \*(lqsystem\*(rq
 134 .Ds
 135 `\-file /usr/spool/bboards/BBoards'
 136 .Ds
 137 `\-user bboards'
 138 .Co
 139 None
 140 .Bu
 141 The `\-user' switch takes effect only if followed by the `\-file' switch.
 142 .En