Annotation of 43BSD/contrib/mh/doc/bbc.me, revision 1.1.1.1

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

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.