home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / citadel / ctdl338a.zip / READ.HLP < prev    next >
Text File  |  1990-06-02  |  7KB  |  175 lines

  1.  Advanced Reading Options
  2.  ------------------------
  3.     ^variantname's Advanced Reading commands contain a number of useful
  4. options which can greatly enhance your pleasure if you take just a couple
  5. of minutes to find out what they can do.  Study the following carefully...
  6.  
  7.  Basics
  8.    You should already be familiar with the basic single stroke Message
  9. Reading commands and the general idea of "dot" commands.  The generic
  10. format of the .Read commands for viewing Messages is
  11.  
  12.    <.R>ead [Option ...] [Read Command [date-spec] ] <CR>
  13.  
  14.    Or, in English, ".Read" followed by zero or more "Options" followed by
  15. a single, optional "Read Command" (default is <N>ew messages) and optional
  16. "date-spec".  We'll explain these one at a time, starting with the "Read
  17. Commands" (since you should find them familiar anyways), then the "date-spec",
  18. and finally the "Options".  Don't worry, this WILL make sense ...
  19.   
  20.  Read Commands
  21.    Here are the four basic Read Commands for messages; each should be
  22. ended with a C/R:
  23.   
  24.   <.R>ead <F>orward
  25.     will print all messages in room from beginning.
  26.  
  27.   <.R>ead <N>ew messages
  28.     will print all new messages in room.
  29.  
  30.   <.R>ead <O>ld-reverse
  31.     will print all old msgs in reverse order in room.
  32.  
  33.   <.R>ead <R>everse
  34.     will print all messages in reverse chronological order.
  35.  
  36.    These four should be familiar from the single stroke command set, and
  37. they are exactly the same.  However, as you'll see, they are NOT superfluous.
  38.  
  39.  Date-Spec
  40.    A "date-spec" is simply some date of your choosing, expressed in normal
  41. Citadel format.  For instance, July 4th, 1989 would be 89Jul4 (or 89Jul04).
  42. If the current year was 1989, you could shorten that to Jul4.  In fact, the
  43. month can be shortened even farther if it remains "unique" within the range
  44. of months.  For instance, you can't type "Ju" because ^nodetitle won't know
  45. if you mean July or June.  However, you can type "N4" to mean November 4th,
  46. because there is no other month with the first letter of November.
  47.  
  48.    But what does this have to do with reading?  When you use it with one of
  49. the Read Commands, you are telling ^variantname to either Read only those
  50. messages since or before that date, depending on the exact Read Command you
  51. are using.  For example,
  52.  
  53.   .Read New 88Jan4
  54.  
  55.      will print all the new messages in the room entered SINCE
  56. January 4, 1988, while
  57.  
  58.   .Read Old-reverse 88Jan4
  59.  
  60.      will print all the old messages in the room entered BEFORE
  61. January 4, 1988, and in reverse order.
  62.  
  63.    In general, Read New and Read Forward used with a date-spec will display
  64. messages written since the given date, while Read Reverse and Read Old-reverse
  65. will display messages written before the given date.
  66.  
  67.    The date-spec is completely optional, but it is useful when you have
  68. logged into a system for the first time and only want to read messages entered
  69. since a day a few days before.
  70.  
  71.  Options
  72.    The Options actually fall into three groups, from which you can mix and
  73. match nearly any combination (don't worry, those which don't make sense will
  74. be blindingly obvious).  The groups are Search Options, Transfer Options,
  75. and the Global Option.
  76.  
  77.    You have three Search options:
  78.  o <U>ser.  This lets you search for messages from a particular user, and,
  79. if this is a network system, for messages from a particular system.
  80.  o <P>hrase.  This lets you search for messages containing a given phrase.
  81.  o <L>ocal.  This lets you search for messages originating on ^nodetitle.
  82.  
  83.    Both the User and Phrase options are used in the same way: specify them
  84. while you are typing in the command, and after you hit a carriage return you
  85. will be prompted for each in turn.  Local, on the other hand, doesn't require
  86. any further input, since it only means the system should search for messages
  87. which were written on this system (and thus the command only makes sense in
  88. Shared rooms).
  89.  
  90.    A couple of examples.  Suppose you wanted to find all the New messages
  91. written by Joe Blow.  You'd type (at the room prompt)
  92.  
  93.    .Read User New <CR>
  94.  
  95.    The system would then prompt for a name, to which you'd type "Joe Blow"
  96. (sans quotes), and the system would go searching the New messages for those
  97. written by good old Joe.  Or suppose you wanted to find a message from Joe
  98. when he was writing on a local system named "Mundane" (so the message
  99. header looks like "... Joe Blow @ Mundane ...").  Then, after you typed
  100. .Read User New <CR>, you'd respond to the User prompt with "Joe @ Mundane"
  101. (notice you didn't have to type in the entire name to find "Joe Blow" --
  102. this applies as well to the system name).
  103.  
  104.    Suppose you wanted to find all the messages,
  105. new or not, containing the Phrase "archaeology".  You'd type
  106.  
  107.    .Read Phrase Forward <CR>
  108.  
  109.    The system would then prompt for the phrase, to which you'd type
  110. "archaeology" (case-insensitive search, by the way), and the system would
  111. happily search all the messages in the current room for such messages.
  112.  
  113.    ^variantname also supports transferring messages via several transfer
  114. protocols besides basic ASCII.  Since this is an Option, that's where the
  115. command would go.
  116.  
  117.    You may use any of the three basic transfer protocols
  118. of ^variantname (<X>modem, <Y>modem [but in SINGLE FILE mode only, not
  119. BATCH], and <W>xmodem).  Additionally, ^nodetitle supports the following
  120. protocols via external drivers which you may use to download messages:
  121. ^dlprotocols
  122.  
  123.    A basic example, downloading all the New messages in a room via Xmodem:
  124.  
  125.    .Read Xmodem New
  126.  
  127.    You would then be asked if you were ready, and if you answer Yes, the
  128. system would drop into Xmodem download mode, in which all those New messages
  129. will be transferred as a text file, formatted to your current screen width
  130. setting.  (Answering No aborts the transfer).
  131.  
  132.    Naturally, you can combine any of the transfer protocols with any of the
  133. other options already discussed.  For instance,
  134.  
  135.    .Read Ymodem User New
  136.  
  137.    would result in the system prompting for a User name to search on and
  138. then try to start a Ymodem Single download, resulting in a transfer of all
  139. messages which written by the user you typed in using Ymodem.
  140.  
  141.    Finally, the Global Option.  You may read the entire board in one swell
  142. foop if you wish.  The Global modifier used to do this.  The typical use
  143. for this command would be
  144.  
  145.    .Read Global New <C/R>
  146.  
  147.  which would give you all the new messages and mark all the rooms as being
  148. read by you -- Forward, Old, and Reverse when used with Global do not.
  149. However, the Global modifier may be used in combination with other modifiers.
  150. For instance, if you want to find all the messages accessible to you that
  151. contain the phrase "Todd has chickenpox", you would type
  152.  
  153.    .Read Global Phrase Forward <C/R>
  154.  
  155.  and type that phrase in when prompted.
  156.  
  157.    Don't forget, all of the above can be combined in a number of useful
  158. combinations.  Don't be afraid to do a little experimentation!
  159.  
  160.  Miscellaneous
  161.  -------------
  162.    Finally,
  163.  
  164.      .Read Status
  165.  
  166.    will print the number of messages in system, etc. 
  167.  
  168.  Use .Read ? to get a complete list of read options.
  169.  
  170.  
  171.  %ADVANCED Back to the advanced commands help menu.
  172.  %HELPOPT Get a list of all help files in the system.
  173.  %MAINHELP First level of help system.
  174.  
  175.