Return to bbc.rf CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / mh / conf / doc

Annotation of 43BSD/contrib/mh/conf/doc/bbc.rf, revision 1.1

1.1     ! root        1: .\"    @(MHWARNING)
        !             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: @BEGIN: BPOP
        !            20: \%[\-host\ host]
        !            21: \%[\-rpop] \%[\-norpop]
        !            22: @END: BPOP
        !            23: \%[\-help]
        !            24: .in -.5i
        !            25: .SH DESCRIPTION
        !            26: \fIbbc\fR is a BBoard
        !            27: reading/checking program that interfaces to the BBoard
        !            28: channel.
        !            29: 
        !            30: The \fIbbc\fR program has three action switches which direct its operation:
        !            31: 
        !            32: The `\-read' switch invokes the \fImsh\fR program on the named
        !            33: \fIBBoards\fR.  If you also specify
        !            34: the `\-archive' switch, then  \fIbbc\fR will invoke the \fImsh\fR program on
        !            35: the archives of the named \fIBBoards\fR.  If no \fIBBoards\fR are given
        !            36: on the command line, and you specified `\-archive',
        !            37: \fIbbc\fR will not read your `bboards' profile entry, but will
        !            38: read the archives of the \*(lqsystem\*(rq \fIBBoard\fR instead.
        !            39: 
        !            40: The `\-check' switch types out status information for the named \fIBBoards\fR.
        !            41: \fIbbc\fR
        !            42: can print one of several messages depending on the status of both the 
        !            43: BBoard
        !            44: and the user's reading habits.  
        !            45: As with each of these messages, the number
        !            46: given is the item number of the last item placed in the 
        !            47: BBoard.
        !            48: This number (which is marked in the messages as the \*(lqBBoard\-Id\*(rq) is
        !            49: ever increasing.  Hence, when \fIbbc\fR
        !            50: says \*(lqn items\*(rq, it really means that the highest BBoard\-Id is \*(lqn\*(rq.
        !            51: There may, or may not actually be \*(lqn\*(rq items in the BBoard.
        !            52: Some common messages are:
        !            53: .in +1i
        !            54: 
        !            55: .ti -.5i
        !            56: \fBBBoard \-\- n items unseen\fR
        !            57: .br
        !            58: This message tells how many items the user has not yet seen.  
        !            59: When invoked with the `\-quiet' switch,
        !            60: this is the only informative line that \fIbbc\fR will possibly print out.
        !            61: 
        !            62: .ti -.5i
        !            63: \fBBBoard \-\- empty\fR
        !            64: .br
        !            65: The BBoard is empty.
        !            66: 
        !            67: .ti -.5i
        !            68: \fBBBoard \-\- n items (none seen)\fR
        !            69: .br
        !            70: The BBoard has items in it, but the user hasn't seen any.
        !            71: 
        !            72: .ti -.5i
        !            73: \fBBBoard \-\- n items (all seen)\fR
        !            74: .br
        !            75: The BBoard is non\-empty, and the user has seen everything in it.
        !            76: 
        !            77: .ti -.5i
        !            78: \fBBBoard \-\- n items seen out of m\fR
        !            79: .br
        !            80: The BBoard has at most m\-n items that the user has not seen.
        !            81: .in -1i
        !            82: 
        !            83: The `\-topics' switch directs \fIbbc\fR to print three items about the named
        !            84: \fIBBoards\fR:
        !            85: it's official name,
        !            86: the number of items present,
        !            87: and the date and time of the last update.
        !            88: If no \fIBBoards\fR
        !            89: are named, then all BBoards
        !            90: are listed.  If the `\-verbose' switch is given, more information is output.
        !            91: 
        !            92: The `\-quiet' switch specifies that \fIbbc\fR should be silent if no
        !            93: \fIBBoards\fR are found with new information.
        !            94: The `\-verbose' switch specifies that \fIbbc\fR is to consider you to be 
        !            95: interested in \fIBBoards\fR that you've already seen everything in.
        !            96: 
        !            97: To override the default \fImshproc\fR and the profile entry,
        !            98: use the `\-mshproc\ program' switch.
        !            99: Any arguments not understood by \fIbbc\fR are passed to this program.
        !           100: The `\-protocol' switch tells \fIbbc\fR that your \fImshproc\fR knows about
        !           101: the special \fIbbc\fR protocol for reporting back information.
        !           102: \fImsh\fR\0(1), the default \fImshproc\fR, knows all about this.
        !           103: 
        !           104: The `\-file\ BBoardsfile' switch tells \fIbbc\fR to use a non\-standard
        !           105: \fIBBoards\fR file when performing its calculations.
        !           106: Similarly, the `\-user BBoardsuser' switch tells \fIbbc\fR to use a
        !           107: non\-standard username.
        !           108: Both of these switches are useful for debugging a new \fIBBoards\fR or
        !           109: \fIPOP\fR file.
        !           110: @BEGIN: BPOP
        !           111: 
        !           112: If the local host is configured as a POP BBoards client,
        !           113: or if the `\-host\ host' switch is given,
        !           114: then \fIbbc\fR will query the POP service host as to the status of the BBoards.
        !           115: The `\-user\ user' switch then takes on a new meaning:
        !           116: it refers to the name of the guest account for BBoards on the service host.
        !           117: The `\-rpop' switch uses the UNIX \fIrPOP\fR
        !           118: (authentication done via trusted connections).
        !           119: In contrast, the `\-norpop' switch uses the ARPA \fIPOP\fR
        !           120: (in which case \fIbbc\fR will prompt for a password,
        !           121: unless the \-user specifies the guest account).
        !           122: @END: BPOP
        !           123: 
        !           124: The `\-rcfile\ rcfile' switch overrides the use of \fI\&.bbrc\fR for
        !           125: user\-specific BBoards information.
        !           126: If the value given to the switch is not absolute,
        !           127: (i.e., does not begin with a \fB/\fR\0),
        !           128: it will be presumed to start from the current working directory.
        !           129: If this switch is not given (or the `\-norcfile' switch is given),
        !           130: then \fIbbc\fR consults the envariable \fB$MHBBRC\fR,
        !           131: and honors it similarly.
        !           132: If this envariable is not set,
        !           133: then the file \fI\&.bbrc\fR in the user's \fB$HOME\fR directory is used.
        !           134: .Fi
        !           135: ^$HOME/\&.mh\(ruprofile~^The user profile
        !           136: ^$HOME/\&.bbrc~^BBoard information
        !           137: .Pr
        !           138: ^Path:~^To determine the user's MH directory
        !           139: .Ps
        !           140: ^bboards:~^To specify interesting BBoards
        !           141: .Ps
        !           142: ^mshproc:~^Program to read a given BBoard
        !           143: .Sa
        !           144: bbl(1), bboards(1), msh(1)
        !           145: .De
        !           146: `\-read'
        !           147: .Ds
        !           148: `\-noarchive'
        !           149: .Ds
        !           150: `\-protocol'
        !           151: .Ds
        !           152: `bboards' defaults to \*(lqsystem\*(rq
        !           153: .Ds
        !           154: `\-file @(BBHOME)/BBoards'
        !           155: .Ds
        !           156: `\-user bboards'
        !           157: @BEGIN: BPOP
        !           158: `\-rpop' unless the guest account for BBoards is used
        !           159: @END: BPOP
        !           160: .Co
        !           161: None
        !           162: .Bu
        !           163: The `\-user' switch takes effect only if followed by the `\-file' switch.
        !           164: .En

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