Return to bbl.me CVS log

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

Annotation of 43BSD/contrib/mh/doc/bbl.me, revision 1.1

1.1     ! root        1: .\"    This file is automatically generated.  Do not edit!
        !             2: .TH BBL 1 "April 22, 1986" MH [mh.6]
        !             3: .UC 6
        !             4: .SH NAME
        !             5: bbl \- manage a BBoard
        !             6: .SH SYNOPSIS
        !             7: .in +.5i
        !             8: .ti -.5i
        !             9: bbl
        !            10: \%[+folder] 
        !            11: \%[\-shell\ program]
        !            12: \%[\-verbose] \%[\-noverbose]
        !            13: bboard
        !            14: \%[\-help]
        !            15: .in -.5i
        !            16: .SH DESCRIPTION
        !            17: \fIbbl\fR allows a \fIBBleader\fR to manage a BBoard.
        !            18: The process is relatively simple:  a \fIBBleader\fR
        !            19: invokes the \fIbbl\fR program to set\-up an environment in which the messages
        !            20: contained in the BBoard
        !            21: may be accessed as if they were messages in an \fIMH\fR folder.
        !            22: 
        !            23: To do this, \fIbbl\fR, \fIincs\fR the \fIBBoard\fR
        !            24: to the folder \*(lq+bbl\*(rq, and \fIincs\fR the archives for the \fIBBoard\fR
        !            25: to the folder \*(lq+bbl/arc\*(rq.  The \fIBBleader\fR
        !            26: then gets a new shell in which \fIMH\fR
        !            27: commands (among others) may be executed.  When the \fIBBleader\fR
        !            28: is done, CTRL\-D is typed, which terminates the shell.  \fIbbl\fR then
        !            29: asks the \fIBBleader\fR
        !            30: as to how the BBoard
        !            31: should be reconstructed.
        !            32: Usually, this results in zeroing the existing \fIBBoard\fR
        !            33: file, and  \fIpack\fRing the \*(lq+bbl\*(rq folder into the \fIBBoard\fR
        !            34: file.  Similar actions are taken for the archive.
        !            35: 
        !            36: The `\-shell' switch specifies what process that \fIbbl\fR should invoke
        !            37: as your command interpreter.  This need not be a rooted filename.
        !            38: If this switch is not specified,
        !            39: \fIbbl\fR looks at the envariable \fB$SHELL\fR for a value.
        !            40: If this envariable is not set, then \fIbbl\fR uses your login shell.
        !            41: 
        !            42: The `\-verbose' switch directs \fIbbl\fR to type the shell commands that it
        !            43: executes to get the job done (e.g., \fIchmod\fR\0s, \fIinc\fR\0s, etc.)
        !            44: 
        !            45: As \fIbbl\fR processing is most likely not intuitively obvious to most
        !            46: prospective BBoard\-leaders, a short diatribe is in order.  As pointed out in
        !            47: \fIBBleader\fR(1),
        !            48: a BBoard\-leader (of the fictitious BBoard \*(lqhacks\*(rq)
        !            49: has three primary maintenance functions: 
        !            50: .in +.5i
        !            51: 
        !            52: .ti -.5i
        !            53: \fBRead the BBoard\fR
        !            54: .br
        !            55: You don't need \fIbbl\fR
        !            56: to do this, use \fIbbc\fR instead.
        !            57: 
        !            58: .ti -.5i
        !            59: \fBRemove inappropriate material\fR
        !            60: .br
        !            61: Do this by running \fIbbl\fR.
        !            62: An example of this might be:
        !            63: .sp
        !            64: .nf
        !            65: \01 % bbl hacks
        !            66: \02 [ Working folder is +bbl, Archive folder is +bbl/arc ]
        !            67: \03 [ Type CTRL\-D to finish ]
        !            68: \04 % scan
        !            69: .ta \w'\05  'u +\w'20 'u +\w'10/14 'u +\w'1345-PDT 'u +\w'Reasonable Person 'u
        !            70: \05    20      10/14   1345-PDT        Silly User      Nonsensical message
        !            71: \06    21      10/14   1707-PDT        Silly User      Another one
        !            72: \07    22      10/14   2144-PDT        Reasonable Person       Legit message
        !            73: .re
        !            74: \09 % rmm 20 21
        !            75: \10 % \^D
        !            76: \11 Incorporate changes? y
        !            77: \12 Remove +bbl? y
        !            78: \13 Update archives? n
        !            79: \14 Remove +bbl/arc? y
        !            80: \15 [+inbox now current]
        !            81: \16 %
        !            82: .fi
        !            83: .sp
        !            84: In item 1, the BBoard\-Leader invokes \fIbbl\fR
        !            85: on the BBoard called \*(lqhacks\*(rq.  The \fIbbl\fR
        !            86: program responds by typing items 2 and 3 which tell the user what \fIMH\fR
        !            87: folders are being used and that a sub\-shell is now in use (respectively).
        !            88: The user does a scan of the +bbl folder
        !            89: (\fIbbl\fR sets the current\-folder to be the one with the BBoard in it.)
        !            90: and finds two messages that should be removed (numbers 20 and 21).
        !            91: The user then removes these using the \fIrmm\fR
        !            92: program (item 9) and then types a CTRL\-D to return to
        !            93: \fIbbl\fR (item 10).
        !            94: At this point,
        !            95: \fIbbl\fR
        !            96: asks how the BBoard should be reconstructed.  Item 11 asks if the contents of
        !            97: the +bbl folder should OVERWRITE the contents of the BBoard.  The user 
        !            98: responds `yes',
        !            99: that it should (hence the two \fIrmm\fR'd messages disappear).
        !           100: Next on item 12,
        !           101: the user is asked if the +bbl folder should be killed, since the BBoards
        !           102: have been successfully updated, the user answers `yes'.
        !           103: On item 13, the user is
        !           104: asked if the archives should be updated.  Since the user made no changes, the
        !           105: answer `no' is made.  (The user could have answered `yes' with no disastrous 
        !           106: effects, but knew that nothing had been updated).  Finally, on item 14, the
        !           107: user indicates that the +bbl/arc subfolder should be killed, by answering
        !           108: `yes'.
        !           109: 
        !           110: .ti -.5i
        !           111: \fBArchive non\-recent material\fR
        !           112: .br
        !           113: Do this by running \fIbbl\fR.
        !           114: An example of this might be:
        !           115: .sp
        !           116: .nf
        !           117: \01 % bbl hacks
        !           118: \02 [ Working folder is +bbl, Archive folder is +bbl/arc ]
        !           119: \03 [ Type CTRL\-D to finish ]
        !           120: \04 % scan
        !           121: .ta \w'\05  'u +\w'20 'u +\w'10/14 'u +\w'1345-PDT 'u +\w'GFISHER@UCI-20B 'u
        !           122: \05    11      10/12   1905-PST        Marshall Rose   New MMail/BBck
        !           123: \06    12      10/12   1916-PST        Stephen Willson PATH, nfinger, and ls
        !           124: \07    13      10/12   2329-PDT        G@UCI-20A       833-5122 hours
        !           125: \08    14      10/13   1045-PDT        MELLON@UCI-20B  Reporting line
        !           126: \09    15      10/13   1112-PST        Tim Shimeall    Re: 833-5122 hours
        !           127: \10    16      10/13   1045-PDT        MELLON@UCI-20B  Reporting line
        !           128: \11    17      10/13   2042-PST        Dana Roode      Ucifinger
        !           129: \12    18      10/13   2045-PST        Dana Roode      Files in /usr/restores
        !           130: \13    19      10/14   1028-PDT        WILLSON@UCI-20B Re: term no pause
        !           131: \14    20      10/14   1345-PDT        Martin Katz     Re: term no pause
        !           132: \15    21      10/14   1707-PDT        SCRIBE@UCI-20A  Scribe Use
        !           133: \16    22      10/14   2144-PDT        GFISHER@UCI-20B New Twemacs
        !           134: \17    23      10/15   1227-PDT        Rob Rittenhouse Re: New Twemacs
        !           135: .re
        !           136: \18 % file +bbl/arc \-src +bbl 11\-12 17\-20 21
        !           137: \19 % ^D
        !           138: \20 Incorporate changes? y
        !           139: \21 Remove +bbl? y
        !           140: \22 Update archives? y
        !           141: \23 Remove +bbl/arc? y
        !           142: \24 [+inbox now current]
        !           143: \25 %
        !           144: .fi
        !           145: .sp
        !           146: The important command given is in item 18, in which the user \fIfiles\fR
        !           147: some messages from +bbl into +bbl/arc.  When CTRL\-D is typed, the user
        !           148: directs \fIbbl\fR
        !           149: to update both the BBoard and its archives, which does the proper action.
        !           150: As an alternate to this scenario,
        !           151: some creative \fIBBleaders\fR might use the \fIpick\fR command to do all of
        !           152: the work:
        !           153: 
        !           154: .in +.5i
        !           155: .nf
        !           156: pick \-sequence select \-before \-12 \-datefield BB-Posted \-zero
        !           157: pick \-sequence select \-before \-20 \-nozero
        !           158: scan select
        !           159: refile select +bbl/arc
        !           160: .fi
        !           161: .in -.5i
        !           162: 
        !           163: In order to facilitate the use of automation shell scripts,
        !           164: if the standard input for \fIbbl\fR is \fInot\fR a tty,
        !           165: then \fIbbl\fR will not ask any questions and will proceed as if
        !           166: the user's answer was \*(lqyes\*(rq for all questions.
        !           167: Hence, \fIbbl\fR may be run under \fIcron\fR\0(8) to provide for
        !           168: automatic archiving.
        !           169: .in -.5i
        !           170: .Fi
        !           171: ^$HOME/\&.mh\(ruprofile~^The user profile
        !           172: .Pr
        !           173: ^Path:~^To determine the user's MH directory
        !           174: .Ps
        !           175: ^incproc:~^Program to incorporate a mail drop into a folder
        !           176: .Ps
        !           177: ^packproc:~^Program to pack a folder into a msgbox
        !           178: .Ps
        !           179: ^rmfproc:~^Program to remove a folder
        !           180: .Sa
        !           181: bbc(1), bbleader(1), bboards(1)
        !           182: .De
        !           183: `+folder' defaults to \*(lqbbl\*(rq
        !           184: .Ds
        !           185: `\-nofile'
        !           186: .Ds
        !           187: `\-shell' defaults to \fB$SHELL\fR or your login shell
        !           188: .Co
        !           189: None
        !           190: .Hi
        !           191: In the early days of the UCI BBoards facility,
        !           192: \fIBBleaders\fR actually used to run this program by hand.
        !           193: Now, this \fIbbl\fR is often run automatically by the system to perform
        !           194: automatic archiving.
        !           195: .Bu
        !           196: Note that \fIbbl\fR executes a lot of \fIMH\fR 
        !           197: commands, and as such, each of these commands can and will read
        !           198: your \fI\&.mh\(ruprofile\fR for defaults.
        !           199: Please read the \fBBUGS\fR section of \fImh\-profile\fR\0(5)
        !           200: for some hints to help you avoid many silly problems.
        !           201: 
        !           202: Also, \fIbbl\fR is unforgiving in doing exactly what it is told,
        !           203: so take special care in answering \fIbbl\fR's questions.
        !           204: .En

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