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