home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / yrn2_090.zip / ENGLISH.DOC < prev    next >
Text File  |  1996-02-10  |  42KB  |  1,236 lines

  1.  
  2.  
  3. PC Yarn User Manual - version 0.90                                            
  4.  
  5.  
  6.               PC Yarn - offline news storage and reading system
  7.  
  8.      Copyright 1995 by Chin Huang
  9.  
  10.      Permission to copy and distribute this material for any purpose and
  11.      without fee is hereby granted, provided that the above copyright notice
  12.      and this permission notice appear in all copies.  The author makes no
  13.      representations about the accuracy or suitability of this material for
  14.      any purpose.  It is provided "as is", without any express or implied
  15.      warranties.  The author will assume no liability for damages either from
  16.      the direct use of this product or as a consequence of the use of this
  17.      product.
  18.  
  19.  
  20.                                  INTRODUCTION
  21.  
  22.      PC Yarn is a suite of programs for your personal computer, used to store
  23.      and read USENET news and mail downloaded from a USENET host.
  24.  
  25. FEATURES
  26.  
  27.      -  An import program inserts USENET articles into a "news base" from
  28.         Simple Offline USENET Packet (SOUP) format.  For each newsgroup, you
  29.         specify the number of days to keep articles, after which, an expire
  30.         program deletes them.  However, articles containing an Expires: header
  31.         are deleted on the date specified in the header.
  32.  
  33.      -  A mail filter moves incoming mail to specific folders or deletes
  34.         incoming mail based on user defined rules.
  35.  
  36.      -  The Yarn news reader presents articles in threads arranged by
  37.         Message-ID and References headers.  The reader program generates SOUP
  38.         reply packets.
  39.  
  40.      -  Score files contain rules to score articles based on matching text
  41.         found in the article.  The reader can be set up to not show articles
  42.         having scores below a certain threshold.
  43.  
  44.      -  Multiple users are supported by storing separate configuration files
  45.         for each user.
  46.  
  47. SYSTEM REQUIREMENTS
  48.  
  49.      -  MS-DOS 3.0 or higher
  50.  
  51.      -  compression software such as PKZIP and PKUNZIP
  52.  
  53.      -  80186 compatible CPU or better.  An 80386 compatible CPU or better is
  54.         required to run the 32-bit DOS extender programs.
  55.  
  56.      -  a lot of hard disk storage, depending on how much news you want to
  57.         keep.  For example, the author subscribes to 180 newsgroups and keeps
  58.         most articles for 7 days.  The amount of disk space used is 40
  59.         megabytes.
  60.  
  61.  
  62.  
  63.  
  64.                                                                              1
  65.  
  66.  
  67.  
  68. PC Yarn User Manual - version 0.90                                            
  69.  
  70.  
  71.                                  INSTALLATION
  72.  
  73. INSTALL YARN DIRECTORY
  74.  
  75.      Unpack the files from the Yarn distribution into a directory.  Run the
  76.      command
  77.  
  78.           english [drive:]directory
  79.  
  80.      where [drive:]directory specifies where to install the Yarn data
  81.      directory.  This directory is created if it doesn't already exist.
  82.      Choose a disk drive with a lot of free space because the news base will
  83.      be stored here.  In this document, this directory will be called the
  84.      %YARN% directory.
  85.  
  86. SET UP USER DIRECTORY
  87.  
  88.      To set up a user directory where Yarn will store your user information,
  89.      run the command
  90.  
  91.           adduser
  92.  
  93.      A form appears in which you fill in the required user information.
  94.  
  95.      + Add User ------------------------------------------------------------+
  96.      |                                                                      |
  97.      |    Home directory: C:\JIM                                            |
  98.      |                                                                      |
  99.      |           User ID: jsmith                                            |
  100.      |                                                                      |
  101.      |       Host system: netcom.com                                        |
  102.      |                                                                      |
  103.      |  User's full name: Jim Smith                                         |
  104.      |                                                                      |
  105.      |    Editor program: edit                                              |
  106.      |                                                                      |
  107.      | Reply packet file: C:\UPLOAD\IOXR.ZIP                                |
  108.      |                                                                      |
  109.      +----------------------------------------------------------------------+
  110.  
  111.      Home directory
  112.           Specify the directory where Yarn will store your user information.
  113.           This directory is created if it doesn't already exist.  In this
  114.           document, this directory will be called the %HOME% directory.
  115.  
  116.      User ID
  117.           Set this to your login name on the host from which you download and
  118.           upload USENET news.
  119.  
  120.      Host system
  121.           Set this to the full domain name of your host.
  122.  
  123.      User's full name
  124.           Set this to your full name.  This is the name that appears in
  125.           parentheses on the From: header in messages you send.
  126.  
  127.  
  128.  
  129.                                                                              2
  130.  
  131.  
  132.  
  133. PC Yarn User Manual - version 0.90                                            
  134.  
  135.  
  136.      Editor program
  137.           Set the name of the editor program to run when you send messages.
  138.  
  139.      Reply packet file
  140.           Specify the full path of the SOUP reply packet file where your
  141.           outgoing messages are stored.  If the reply packet file does not
  142.           exist, it is created when you post an article or send a mail message
  143.           from the reader program.  When you exit the reader program, the
  144.           reply packet is ready to upload to your host.
  145.  
  146.      The program writes the user information to a configuration file named
  147.      %HOME%\yarn\config.  This document refers to other configuration settings
  148.      also stored in this file.  If you want to change those settings, you have
  149.      to edit the configuration file with a text editor.
  150.  
  151. SET TIME ZONE
  152.  
  153.      Set the environment variable TZ to your time zone.  The format of the TZ
  154.      string is
  155.  
  156.           zzz[+/-]h[h][ddd]
  157.  
  158.      zzz is a three character field representing the name of the time zone.
  159.  
  160.      [+/-]h[h] is an optionally signed number representing the local time
  161.      zone's difference from Greenwich Mean Time (GMT) in hours.  Positive
  162.      numbers adjust westward from GMT.  Negative numbers adjust eastward from
  163.      GMT.
  164.  
  165.      ddd is an optional three character field that represents the name of the
  166.      local time zone's daylight saving time.
  167.  
  168.      If no TZ environment variable is set, a default TZ=EST5EDT is assumed.
  169.  
  170. UPDATE SYSTEM FILES
  171.  
  172.      Ensure the FILES setting in the CONFIG.SYS file is set to
  173.  
  174.           FILES=20
  175.  
  176.      or higher.  If there is no FILES setting, then add it.
  177.  
  178.      Put these SET commands in the AUTOEXEC.BAT file to ensure the environment
  179.      settings persist after the next time you reboot your system.  (If you are
  180.      installing Yarn for OS/2, put the SET commands in the CONFIG.SYS file
  181.      instead.)  Use the settings determined above for the values appearing to
  182.      the right of the equal signs.
  183.  
  184.           SET YARN=C:\YARN
  185.           SET HOME=C:\JIM
  186.           SET TZ=EST5EDT
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                                                              3
  195.  
  196.  
  197.  
  198. PC Yarn User Manual - version 0.90                                            
  199.  
  200.  
  201. SET UP OTHER USERS
  202.  
  203.      To set up another user, run the adduser command, and specify a different
  204.      home directory.  To run Yarn as that user, set the HOME environment
  205.      variable to the user's home directory.
  206.  
  207. ENVIRONMENT
  208.  
  209.      These enviroment variables modify the behaviour of Yarn if they are set.
  210.  
  211.      EDITOR    Specifies the external editor program, overriding the editor
  212.                specified in the configuration file.
  213.  
  214.      LOGDIR    Sets the user's home directory.  If LOGDIR is not set, the home
  215.                directory is set from the HOME environment variable.
  216.  
  217.      TMP       Specifies a directory where temporary working files are stored.
  218.                The default is %YARN%\temp.
  219.  
  220.      YARNRC    Specifies an alternate configuration file to read instead of
  221.                the default %HOME%\yarn\config.
  222.  
  223. HOW TO ADD MIME SUPPORT
  224.  
  225.      Yarn supports the decoding of Multimedia Internet Mail Extension (MIME)
  226.      messages by running an external MIME processing program.  One such
  227.      program is metamail.  A DOS port of metamail is available from
  228.  
  229.           ftp://thumper.bellcore.com/pub/nsb/
  230.  
  231.      An OS/2 port of metamail is available from
  232.  
  233.           ftp://ftp-os2.nmsu.edu/os2/unix/
  234.  
  235.      Put this setting in the Yarn configuration file, assuming you installed
  236.      the metamail executable in a directory in your PATH:
  237.  
  238.           decode-mime=metamail %f
  239.  
  240.  
  241. HOW TO ADD PGP SUPPORT
  242.  
  243.      Yarn contains hooks to external cryptographic programs.  The standard
  244.      Yarn distribution is set up to run Pretty Good Privacy (PGP).  Ensure
  245.      that the PGP executable is in the execution PATH.  Uncomment the "secret-
  246.      sign", "encrypt", "decrypt" and "decrypt-view" lines in the Yarn
  247.      configuration file.  Yarn is now configured to use the PGP privacy and
  248.      authentication functions.
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.                                                                              4
  260.  
  261.  
  262.  
  263. PC Yarn User Manual - version 0.90                                            
  264.  
  265.  
  266.                                   OPERATION
  267.  
  268. IMPORT NEWS AND MAIL
  269.  
  270.      To import messages from SOUP format, run
  271.  
  272.           import <file>
  273.  
  274.      where <file> is the path of the SOUP file.  The import program takes
  275.      these options.
  276.  
  277.      -n        Do not delete the packet file.
  278.  
  279.      -q        Operate in quiet mode.  Do not list the imported newsgroup
  280.                names.
  281.  
  282.      -r        Import rnews batch or UNIX mailbox files instead of SOUP files.
  283.  
  284.      -u [directory]
  285.                Assume the files from a SOUP packet have already been unpacked
  286.                into the current directory and import messages from those
  287.                files.  If the optional directory is specified, then import
  288.                from the files in that directory.
  289.  
  290. SET EXPIRY OF NEWSGROUPS
  291.  
  292.      Two settings are associated with each newsgroup.  One is the number of
  293.      days that articles in the newsgroup will be kept before the expire
  294.      program deletes them.  The other is the absolute maximum number of days
  295.      that articles with an Expires: header will be kept.  The Expires: header
  296.      may contain a date far in the future, but the article will be kept only
  297.      for the specified number of days.
  298.  
  299.      When the import program finds a newsgroup in the packet that is not
  300.      already in the news base, it adds the newsgroup with keep days and
  301.      maximum keep days settings specified from the configuration file.  The
  302.      "keep" and "max-keep" settings specify the keep days and maximum keep
  303.      days respectively.  For example, if the configuration file contains the
  304.      settings
  305.  
  306.           keep=7
  307.           max-keep=30
  308.  
  309.      then articles are normally kept in the newsgroup for 7 days and
  310.      absolutely not more than 30 days.
  311.  
  312.      You can set the keep days of individual newsgroups.  Run the command
  313.  
  314.           newgroup <name> <keepDays> [<maxDays>]
  315.  
  316.      where <name> is the newsgroup name and <keepDays> is the number of days
  317.      that articles in the newsgroup will be kept before the expire program
  318.      deletes them.  The optional parameter <maxDays> is the absolute maximum
  319.      number of days that articles containing an Expires: header will be kept.
  320.  
  321.  
  322.  
  323.  
  324.                                                                              5
  325.  
  326.  
  327.  
  328. PC Yarn User Manual - version 0.90                                            
  329.  
  330.  
  331.      Instead of naming a newsgroup on the command line, you can specify a text
  332.      file containing a list of newsgroup names.  Every newsgroup listed in the
  333.      file is assigned the keep days value.
  334.  
  335.           newgroup @<file> <keepDays> [<maxDays>]
  336.  
  337.  
  338. EXPIRE NEWS
  339.  
  340.      Periodically run the expire program to delete old articles from the news
  341.      base.  To expire old articles from all newsgroups, run the command
  342.  
  343.           expire -o
  344.  
  345.      To expire old articles from specific newsgroups, list the newsgroups on
  346.      the command line.  For example:
  347.  
  348.           expire -o comp.answers news.answers
  349.  
  350.      To delete all read articles in all newsgroups, run
  351.  
  352.           expire -r
  353.  
  354.      To delete read articles from specific newsgroups, run expire with the -r
  355.      option and list the newsgroups on the command line.  For example:
  356.  
  357.           expire -r comp.answers news.answers
  358.  
  359.      The program may expire newsgroups in addition to the newsgroups you
  360.      specified if an expired article was crossposted to multiple newsgroups.
  361.  
  362.      You can specify a text file containing a list of newsgroups to expire.
  363.      Run expire with the argument
  364.  
  365.           @<file>
  366.  
  367.      on the command line, where <file> is the file path.
  368.  
  369.      The expire program accepts these options:
  370.  
  371.      -d <n>    Assume it is <n> days in the future.  Use this option to expire
  372.                articles before they normally would have been expired.
  373.  
  374.      -n        Do not actually delete any articles.  Used for testing.
  375.  
  376.      -o        Delete old articles.
  377.  
  378.      -q        Operate in quiet mode.  Display fewer messages than usual.
  379.  
  380.      -r        Delete read articles.
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.                                                                              6
  390.  
  391.  
  392.  
  393. PC Yarn User Manual - version 0.90                                            
  394.  
  395.  
  396. REMOVE NEWSGROUP
  397.  
  398.      To remove a newsgroup from the news base, run the command
  399.  
  400.           rmgroup <name>
  401.  
  402.      where <name> is the newsgroup name.
  403.  
  404. USING THE MAIL FILTER
  405.  
  406.      The mail filter looks at incoming mail messages and processes the
  407.      messages based on a set of rules you define.  You can set up a rule that
  408.      automatically moves messages you receive from a mailing list to a
  409.      specific folder.  Or, you can automatically delete messages from a
  410.      specific user so that you don't even see messages from that user.
  411.  
  412.      Run the filter program to set up the filter rules.  A list of filter
  413.      rules appears.  To add a filter rule, press the [Ins] key.  The mail rule
  414.      form appears.
  415.  
  416.      + Mail Rule ----------------------------------------------------------+
  417.      |                                                                     |
  418.      | Rule name: Yarn Mailing List                                        |
  419.      |                                                                     |
  420.      | Search in: ( ) From          Search for: yarn-list                  |
  421.      |            (*) To            Match case: No                         |
  422.      |            ( ) Subject                                              |
  423.      |            ( ) Header                                               |
  424.      |            ( ) Body                                                 |
  425.      |            ( ) Header and body                                      |
  426.      |                                                                     |
  427.      |    Action: (*) Move to folder/newsgroup: list.yarn                  |
  428.      |            ( ) Delete                                               |
  429.      |                                                                     |
  430.      +---------------------------------------------------------------------+
  431.  
  432.      Rule name
  433.           Enter a name for the rule.  Filter rules are processed in sorted
  434.           order by rule name.  Each rule is checked in turn until a match is
  435.           found.  If no rules match, the message is moved to the INBOX folder.
  436.  
  437.      Search in
  438.           Select where to search.  If you select "To", then the To: and Cc:
  439.           headers are searched.
  440.  
  441.      Search for
  442.           Enter the string to search for in the selected header.
  443.  
  444.      Match case
  445.           Set the field to Yes if you want the search to be case sensitive.
  446.  
  447.      Action
  448.           Select "Move to folder/newsgroup" if you want to move the message to
  449.           a specific folder or newsgroup.  If the specified name is a
  450.           newsgroup in the news base, the message is moved to the newsgroup,
  451.           otherwise the message is moved to the named folder.  Select "Delete"
  452.  
  453.  
  454.                                                                              7
  455.  
  456.  
  457.  
  458. PC Yarn User Manual - version 0.90                                            
  459.  
  460.  
  461.           if you want to automatically delete the message.
  462.  
  463.      The mail filter allows you to automatically transfer messages from a
  464.      mailing list into a newsgroup.  You can also set up Yarn to send any
  465.      posts you make to that newsgroup back to the mailing list.  For example,
  466.      suppose you want to filter messages from the Yarn mailing list into a
  467.      newsgroup.  Run the command
  468.  
  469.           newgroup list.yarn 7 30 yarn-list@lists.colorado.edu
  470.  
  471.      to create a newsgroup named list.yarn.  Set up a mail filter rule to move
  472.      messages from the mailing list into the newsgroup.  Now when you post a
  473.      message to the list.yarn newsgroup, it is mailed to the list address
  474.      yarn-list@lists.colorado.edu.
  475.  
  476. READ NEWS
  477.  
  478.      Run the yarn program to read news and mail.  The yarnx program uses a DOS
  479.      extender, which uses the CPU's memory management functions to give the
  480.      program access to much more memory than conventional DOS programs.  It
  481.      requires an 80386 compatible CPU or better.  With more available memory,
  482.      the program can list much more articles in a newsgroup.
  483.  
  484.      The reader program operates in several modes -- the newsgroup selection
  485.      level, the article selection level, and the article reading level.
  486.  
  487.      In the newsgroup selection level, yarn displays a window listing the
  488.      newsgroups you are subscribed to along with the number of unread articles
  489.      in each newsgroup.  You can subscribe, unsubscribe or rearrange the order
  490.      of newsgroups in this list.  Press the [Ins] key to subscribe to a
  491.      newsgroup.  This brings up a list of unsubscribed newsgroups.  To make a
  492.      selection, use the arrow keys to move the highlight to the newsgroup, and
  493.      then press the [Enter] key.  The selected newsgroup is inserted into the
  494.      subscribed newsgroup list.  Press the [Del] key to unsubscribe from the
  495.      highlighted newsgroup.  To move a newsgroup in the list, press the [Del]
  496.      key to remove it, position the highlight to the desired location, then
  497.      press the [Ins] key and reinsert the newsgroup.
  498.  
  499.      By selecting a newsgroup, you go to the article selection level, where
  500.      yarn presents a list of the subjects of each article.  A subject
  501.      beginning with the greater than (>) symbol indicates an article belonging
  502.      to the thread above it in the list, but the author of the article changed
  503.      the subject.  You can select an article to read from this list, taking
  504.      you to the article reading level.
  505.  
  506. USING SCORE FILES
  507.  
  508.      Score files contain rules used to automatically calculate a numeric rank,
  509.      called a score, for news articles.  You can set up the reader so it
  510.      doesn't show articles having scores less than a threshold score.  A
  511.      global score file contains rules applied in all newsgroups.  Each
  512.      newsgroup can have a separate score file containing rules that are also
  513.      applied in that newsgroup.
  514.  
  515.  
  516.  
  517.  
  518.  
  519.                                                                              8
  520.  
  521.  
  522.  
  523. PC Yarn User Manual - version 0.90                                            
  524.  
  525.  
  526.      A rule in a score file has the format
  527.  
  528.           <points> <where> <string>
  529.  
  530.      where
  531.  
  532.      <points>
  533.           is the number of points added or subtracted if the rule matches the
  534.           article.  It is a positive or negative number.  An article's score
  535.           is the total points of all matching rules in the global score file
  536.           and the newsgroup score file.
  537.  
  538.      <where>
  539.           names an article header to search, such as "From:", "Subject:" or
  540.           "Message-ID:".  You can name any header that might appear in an
  541.           article header.  You can also specify two special options.  The
  542.           "Header" option searches the entire article header.  The "Body"
  543.           option searches the article body.  Searching the "From:", "Subject:"
  544.           and "Message-ID:" fields is significantly faster than the other
  545.           search options.
  546.  
  547.      <string>
  548.           is the string to search for.  All searches are case-insensitive.  If
  549.           the optional keyword "pattern" appears between <points> and <where>,
  550.           the string is interpreted as a regular expression.
  551.  
  552.      A score file entry in the form
  553.  
  554.           killthreshold <n>
  555.  
  556.      sets the kill threshold to <n> points.  The default kill threshold is 0.
  557.      Articles having scores less that this threshold are marked as already
  558.      read, and you normally will not see them.
  559.  
  560.      Blank lines and lines beginning with the # character are ignored.
  561.  
  562.      Here is an example score file that the author uses for the
  563.      alt.usenet.offline-reader newsgroup.
  564.  
  565.           # I have little interest in Forte Agent.
  566.           -1 Subject: Agent
  567.           -1 Subject: Forte
  568.           -1 pattern Subject: \bFA\b
  569.  
  570.           # But I am interested in Yarn and SOUP.
  571.           10 Subject: Yarn
  572.           5 Subject: SOUP
  573.  
  574.      Press [Shift-E] at the newsgroup selection level to edit the global score
  575.      file.  This starts your configured editor program on the global score
  576.      file.  Press [Shift-E] while inside a newsgroup to edit the score file
  577.      specific to the newsgroup.
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.                                                                              9
  585.  
  586.  
  587.  
  588. PC Yarn User Manual - version 0.90                                            
  589.  
  590.  
  591. NEWSGROUP SELECTION LEVEL
  592.  
  593.      These commands are available in the newsgroup selection level.
  594.  
  595.      Down Arrow, Ctrl-N
  596.           Move to the next newsgroup.
  597.  
  598.      Up Arrow, Ctrl-P
  599.           Move to the previous newsgroup.
  600.  
  601.      Tab, N
  602.           Move to the next newsgroup that contains unread articles.
  603.  
  604.      Shift-Tab, P
  605.           Move to the previous newsgroup that contains unread articles.
  606.  
  607.      Home Move to first newsgroup.
  608.  
  609.      End  Move to last newsgroup.
  610.  
  611.      /    Search forward for newsgroup name containing matching text.
  612.  
  613.      ?    Search backward for newsgroup name containing matching text.
  614.  
  615.      ;    Continue forward search.
  616.  
  617.      :    Continue backward search.
  618.  
  619.      Space, Right Arrow
  620.           Go to the article selection level, listing only unread articles.
  621.  
  622.      Enter
  623.           Go to the article selection level, listing all articles.
  624.  
  625.      Ins, +
  626.           Subscribe to a newsgroup and insert the newsgroup at the current
  627.           position.
  628.  
  629.      Del, -
  630.           Unsubscribe from the highlighted newsgroup.
  631.  
  632.      A    Post an article to the highlighted newsgroup.
  633.  
  634.      M    Send mail message.
  635.  
  636.      C    Mark all articles in the highlighted newsgroup as read.
  637.  
  638.      E    Edit the global score file.
  639.  
  640.      O    Save unread articles in the highlighted newsgroup to a folder.
  641.  
  642.      S    Save unread articles in the highlighted newsgroup to a file.  The
  643.           program prompts for a file name.  If you don't give a full path
  644.           name, the file is stored in the directory %HOME%\news.
  645.  
  646.  
  647.  
  648.  
  649.                                                                             10
  650.  
  651.  
  652.  
  653. PC Yarn User Manual - version 0.90                                            
  654.  
  655.  
  656.      W    Same as the 'S' command, except omit the article headers.
  657.  
  658.      !    Run command shell.  Type "exit" to return to Yarn.
  659.  
  660.      F2, Ctrl-L
  661.           List address book.
  662.  
  663.      Esc  Exit program
  664.  
  665. ARTICLE SELECTION LEVEL
  666.  
  667.      These commands are available in the article selection level.
  668.  
  669.      Down Arrow, Ctrl-N
  670.           Move to the next article.
  671.  
  672.      Up Arrow, Ctrl-P
  673.           Move to the previous article.
  674.  
  675.      Tab, N
  676.           Move to the first article of the next thread.
  677.  
  678.      Shift-Tab, P
  679.           Move backwards to the previous article beginning a thread.
  680.  
  681.      Home Move to first article.
  682.  
  683.      End  Move to last article.
  684.  
  685.      /    Search forward for article containing matching text.
  686.  
  687.      ?    Search backward for article containing matching text.
  688.  
  689.      ;    Continue forward search.
  690.  
  691.      :    Continue backward search.
  692.  
  693.      Space, Right Arrow
  694.           Read the article.
  695.  
  696.      Del, -
  697.           Mark the article as read and go to the next unread article.
  698.  
  699.      Ins, +
  700.           Mark the article as unread.
  701.  
  702.      O    Save the current article through to the last article in the thread
  703.           to a folder.
  704.  
  705.      S    Save the current article through to the last article in the thread
  706.           to a file.  The program prompts for a file name.  If you don't give
  707.           a full path name, the file is stored in the directory %HOME%\news.
  708.  
  709.      W    Same as the 'S' command, except omit the article headers.
  710.  
  711.  
  712.  
  713.  
  714.                                                                             11
  715.  
  716.  
  717.  
  718. PC Yarn User Manual - version 0.90                                            
  719.  
  720.  
  721.      B    Extract uuencoded file from the current article.
  722.  
  723.      K    Mark the current article through to the last article in the thread
  724.           as read.
  725.  
  726.      U    Mark the current article through to the last article in the thread
  727.           as unread.
  728.  
  729.      C    Mark all articles in the newsgroup as read.
  730.  
  731.      E    Edit the newsgroup score file.
  732.  
  733.      A    Post an article to the newsgroup.
  734.  
  735.      M    Send mail message.
  736.  
  737.      L    Toggle short, medium or long subject list.
  738.  
  739.      T    Sort articles by arrival, subject or score order.
  740.  
  741.      V    Toggle listing of all articles or unread articles.
  742.  
  743.      !    Run command shell.  Type "exit" to return to Yarn.
  744.  
  745.      |    Run a program, piping the article into the program's standard input.
  746.           If you put %f on the command line, it is replaced with the name of a
  747.           temporary file containing the article, and the article will not be
  748.           piped into the standard input.
  749.  
  750.      F2, Ctrl-L
  751.           List address book.
  752.  
  753.      F3, Ctrl-A
  754.           Add the author of the current message to the address book.
  755.  
  756.      Esc, Left Arrow
  757.           Return to the newsgroup selection level.
  758.  
  759. ARTICLE READING LEVEL
  760.  
  761.      These commands are available in the article reading level.
  762.  
  763.      Down Arrow, Enter
  764.           Scroll one line down.
  765.  
  766.      Up Arrow
  767.           Scroll one line up.
  768.  
  769.      PgDn Show next page.
  770.  
  771.      Space
  772.           Show next page.  If at the end of an article, go to the next unread
  773.           article.
  774.  
  775.  
  776.  
  777.  
  778.  
  779.                                                                             12
  780.  
  781.  
  782.  
  783. PC Yarn User Manual - version 0.90                                            
  784.  
  785.  
  786.      PgUp, b
  787.           Show previous page.
  788.  
  789.      Home Go to top of article.
  790.  
  791.      g    Search article for matching text.
  792.  
  793.      G    Continue search in article.
  794.  
  795.      Ctrl-G
  796.           Search for the next line beginning with "Subject:".  You can use
  797.           this command to search for the next message in a message digest.
  798.  
  799.      /    Search forward for article containing matching text.
  800.  
  801.      ?    Search backward for article containing matching text.
  802.  
  803.      ;    Continue forward search.
  804.  
  805.      :    Continue backward search.
  806.  
  807.      n, Right Arrow
  808.           Mark the article as read and show the next unread article.
  809.  
  810.      N    Show next article.
  811.  
  812.      p    Show previous unread article.
  813.  
  814.      P    Show previous article.
  815.  
  816.      a, A Post an article to the newsgroup.
  817.  
  818.      f    Post a followup article.
  819.  
  820.      F    Post a followup article, quoting the original article.
  821.  
  822.      r    Mail a reply to the author of the article.
  823.  
  824.      R    Mail a reply, quoting the original article.
  825.  
  826.      m    Mail (forward) the article to someone.
  827.  
  828.      M    Compose a mail message.
  829.  
  830.      o    Save the article to a folder.
  831.  
  832.      s    Save the article to a file.  The program prompts for a file name.
  833.           If you don't give a full path name, the file is stored in the
  834.           directory %HOME%\news.
  835.  
  836.      w    Same as the 's' command, except omit article headers.
  837.  
  838.      B    Extract uuencoded file from the article.
  839.  
  840.  
  841.  
  842.  
  843.  
  844.                                                                             13
  845.  
  846.  
  847.  
  848. PC Yarn User Manual - version 0.90                                            
  849.  
  850.  
  851.      x    ROT13 decrypt the article.
  852.  
  853.      X    Decrypt the article by running the external cryptography program
  854.           specified in the Yarn configuration.
  855.  
  856.      k, Del
  857.           Mark the article as read.
  858.  
  859.      K    Mark this article and the rest of the articles in the thread as
  860.           read.
  861.  
  862.      u, Ins
  863.           Mark the article as unread.
  864.  
  865.      U    Mark this article and the rest of the articles in the thread as
  866.           unread.
  867.  
  868.      C    Mark all the articles in the newsgroup as read.
  869.  
  870.      E    Edit the newsgroup score file.
  871.  
  872.      v    Toggle verbose headers.
  873.  
  874.      c    Cancel the article.  You must be the author to be able to cancel the
  875.           article.
  876.  
  877.      z    Supersede the article.  You must be the author to be able to
  878.           supersede the article.
  879.  
  880.      Z    Same as the 'z' command, except you start with a copy of the
  881.           original article in the editor.
  882.  
  883.      !    Run command shell.  Type "exit" to return to Yarn.
  884.  
  885.      |    Run a program, piping the article into the program's standard input.
  886.           If you put %f on the command line, it is replaced with the name of a
  887.           temporary file containing the article, and the article will not be
  888.           piped into the standard input.
  889.  
  890.      F2, Ctrl-L
  891.           List address book.
  892.  
  893.      F3, Ctrl-A
  894.           Add the author of the current message to the address book.
  895.  
  896.      Esc, Left Arrow
  897.           Return to the article selection level.
  898.  
  899.      q    Return to the newsgroup selection level.
  900.  
  901.  
  902.  
  903.  
  904.  
  905.  
  906.  
  907.  
  908.  
  909.                                                                             14
  910.  
  911.  
  912.  
  913. PC Yarn User Manual - version 0.90                                            
  914.  
  915.  
  916. READ MAIL
  917.  
  918.      To list your incoming mail messages, press [Shift-I] at the newsgroup
  919.      selection level.
  920.  
  921.      You can send new mail by pressing [Shift-M].  A form pops up, asking you
  922.      to enter the destination mail address and subject for the message you
  923.      want to send.  If you press the [F2] key while the cursor is in the mail
  924.      address field, the address book pops up.  You can select an entry from
  925.      the address book by moving the highlight with the arrow keys and pressing
  926.      the [Enter] key.
  927.  
  928.      Press [Shift-F] at the newsgroup selection level to bring up a list of
  929.      folders.  You can select a folder to read from this list.
  930.  
  931.      If you start yarn with the -m option, you go directly to reading your
  932.      received mail and skip reading news.  If you start yarn with the -f
  933.      option, you go directly to the folder list and skip reading news.
  934.  
  935. EDIT REPLIES
  936.  
  937.      The Yarn reader allows you to edit the messages in the reply packet.  At
  938.      the newsgroup selection level, press [Shift-R] to display a list of
  939.      folders in the reply packet.  The reply packet may contain up to two
  940.      folders, ``mail'' which holds outgoing mail messages, and ``news'' which
  941.      holds outgoing USENET articles.
  942.  
  943.      By selecting a folder, you go to the message selection level, where the
  944.      program lists the messages in the folder.  Press the [Del] key to delete
  945.      the currently highlighted message.  Press [Shift-E] to edit the message.
  946.  
  947.      To view a message, select it from the message selection level.  While a
  948.      message is displayed, pressing the 'd' key deletes the message.  Press
  949.      the 'e' key to edit the message.
  950.  
  951.      If you start yarn with the -r option, you go directly to the replies list
  952.      and skip reading news.
  953.  
  954. USING THE ADDRESS BOOK
  955.  
  956.      The address book is used to conveniently retrieve mail addresses.  An
  957.      address book entry consists of an alias and an address.  An alias is a
  958.      word representing a address or a list of addresses.  If an alias appears
  959.      in a To:, Cc:, or Bcc: header, it is replaced with the corresponding
  960.      address(es) when the message is sent.
  961.  
  962.      To list the address book, press [F2] at the newsgroup selection level.
  963.      To add an address book entry, press the [Ins] key.  A form appears in
  964.      which you enter the alias and address.  To specify a list of addresses,
  965.      enter the addresses in the Address: field, separating them with a comma.
  966.  
  967.      While you are reading a message, you can capture the mail address of the
  968.      message author and add it to the address book by pressing the [F3] key.
  969.  
  970.  
  971.  
  972.  
  973.  
  974.                                                                             15
  975.  
  976.  
  977.  
  978. PC Yarn User Manual - version 0.90                                            
  979.  
  980.  
  981. YARN OPTION SUMMARY
  982.  
  983.      The yarn program accepts these options:
  984.  
  985.      -b   Output to the display using BIOS calls instead of direct screen
  986.           writes.
  987.  
  988.      -f   List folders.  Do not read news.
  989.  
  990.      -m   List mail.  Do not read news.
  991.  
  992.      -r   List replies.  Do not read news.
  993.  
  994.      -s   Disable the '!' run shell command.
  995.  
  996. REGULAR EXPRESSIONS
  997.  
  998.      The search functions use regular expressions to specify the pattern to
  999.      match.
  1000.  
  1001.      A \b matches a word boundary.
  1002.  
  1003.      A ^ matches the beginning of the buffer.
  1004.  
  1005.      A $ matches the end of the buffer.
  1006.  
  1007.      A . matches any character.
  1008.  
  1009.      A single character with no special meaning matches that character.
  1010.  
  1011.      A string enclosed in brackets [] matches any single character in that
  1012.      string. Ranges of ASCII character codes may be abbreviated as 'a-z0-9'.
  1013.      A left bracket ] may occur only as the first character of the string.  A
  1014.      literal - must be placed where it can't be mistaken as a range indicator.
  1015.      If the first character is the caret ^ then any character not in the
  1016.      string will match.
  1017.  
  1018.      A regular expression followed by * matches a sequence of 0 or more
  1019.      matches of the regular expression.
  1020.  
  1021.      A regular expression followed by + matches a sequence of 1 or more
  1022.      matches of the regular expression.
  1023.  
  1024.      A regular expression followed by ? matches a sequence of 0 or 1 matches
  1025.      of the regular expression.
  1026.  
  1027.      Two adjacent (concatenated) regular expressions match a match of the
  1028.      first followed by a match of the second.
  1029.  
  1030.      Two regular expressions separated by | match either a match for the first
  1031.      or a match for the second.
  1032.  
  1033.      A regular expression enclosed in parentheses matches a match for the
  1034.      regular expression.
  1035.  
  1036.  
  1037.  
  1038.  
  1039.                                                                             16
  1040.  
  1041.  
  1042.  
  1043. PC Yarn User Manual - version 0.90                                            
  1044.  
  1045.  
  1046.      The order of precedence of operators at the same parenthesis level is []
  1047.      then *+? then concatenation then |.
  1048.  
  1049. QUESTIONS AND ANSWERS
  1050.  
  1051. ------------------------------
  1052.  
  1053. Subject: How do I create SOUP files on my UNIX host?
  1054.  
  1055.      The uqwk program creates and processes SOUP files on your UNIX host.  It
  1056.      is available by anonymous FTP from ftp.gte.com in the /pub/uqwk
  1057.      directory.
  1058.  
  1059.      To create a SOUP download packet, named "down.zip" in this example, run
  1060.      these commands on your UNIX host:
  1061.  
  1062.           uqwk +n +x +L
  1063.           zip -m down.zip AREAS *.MSG
  1064.  
  1065.      Download the down.zip file to your PC.  Run this command on your PC to
  1066.      insert the messages into the Yarn news base:
  1067.  
  1068.           import down.zip
  1069.  
  1070.      When you send mail or post articles, the Yarn reader creates a SOUP reply
  1071.      packet, named "up.zip" in this example.  Upload the up.zip file to your
  1072.      UNIX host.  Run these commands on your UNIX host to send the messages in
  1073.      the reply packet:
  1074.  
  1075.           unzip -U up.zip
  1076.           uqwk -m -n +L -RREPLIES
  1077.  
  1078.  
  1079. ------------------------------
  1080.  
  1081. Subject: The newsgroup selection list showed a number of the unread articles
  1082.      in a newsgroup.  When I selected the newsgroup by pressing the space bar,
  1083.      the article selection list had less articles than that number.
  1084.  
  1085.      When you read an article that was cross-posted to multiple newsgroups,
  1086.      that article is marked as read in all the newsgroups to which it was
  1087.      cross-posted.  The newsgroup you selected contains cross-posted articles
  1088.      that you already read in another newsgroup.  The program counts the true
  1089.      number of unread articles when you select the newsgroup.
  1090.  
  1091. ------------------------------
  1092.  
  1093. Subject: What is the junk newsgroup?
  1094.  
  1095.      When the import program finds an article that doesn't belong to any of
  1096.      the newsgroups in the news base, it tosses the article into the junk
  1097.      newsgroup.  This usually shouldn't happen with properly configured
  1098.      software.
  1099.  
  1100.  
  1101.  
  1102.  
  1103.  
  1104.                                                                             17
  1105.  
  1106.  
  1107.  
  1108. PC Yarn User Manual - version 0.90                                            
  1109.  
  1110.  
  1111. ------------------------------
  1112.  
  1113. Subject: How do I configure Yarn for OS/2 to run the MS-DOS version of PKZIP
  1114.      and PKUNZIP?
  1115.  
  1116.      Put these settings in your configuration file, adjusting the drive and
  1117.      path appropriately.
  1118.  
  1119.           compress=cmd.exe /c c:\path\pkzip -m %f %d\*.*
  1120.           uncompress=cmd.exe /c c:\path\pkunzip -o %f %d
  1121.  
  1122.  
  1123. ------------------------------
  1124.  
  1125. Subject: How do I configure Yarn to use InfoZip's zip and unzip programs?
  1126.  
  1127.      Put these settings in the configuration file.
  1128.  
  1129.           compress=zip -kjm %f %d/*
  1130.           uncompress=unzip -o %f
  1131.  
  1132.  
  1133. ------------------------------
  1134.  
  1135. Subject: How do I print an article from the reader program?
  1136.  
  1137.      Use the save to file command.  When prompted for a file name, enter the
  1138.      name
  1139.  
  1140.           prn
  1141.  
  1142.  
  1143. ------------------------------
  1144.  
  1145. Subject: How do I cross-post an article to more than one newsgroup?
  1146.  
  1147.      While you are editing the article, add the newsgroups where you want to
  1148.      cross-post to the Newsgroups: line.  Separate the newsgroups with commas.
  1149.      Do not put any spaces between the newsgroups.
  1150.  
  1151. ------------------------------
  1152.  
  1153. Subject: The program aborted with the error message "history file is corrupt".
  1154.  
  1155.      The history file is an critical part of the news base.  It contains the
  1156.      location where each article is stored.  If the history file becomes
  1157.      corrupted, some articles may become inaccessible.
  1158.  
  1159.      The rebuild program is a utility that rebuilds the history file by
  1160.      scanning all the articles in the news base.  If the files containing the
  1161.      articles are intact, rebuild should restore the links to every article in
  1162.      the news base.  To repair the history file, first run the chkdsk command
  1163.      to fix any file system errors, then run the command
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.                                                                             18
  1170.  
  1171.  
  1172.  
  1173. PC Yarn User Manual - version 0.90                                            
  1174.  
  1175.  
  1176.           rebuild -h
  1177.  
  1178.  
  1179. ------------------------------
  1180.  
  1181. Subject: The program aborted with the error message "dbm file is corrupt:
  1182.      %YARN%\supersed" or "dbm file is corrupt: %HOME%\yarn\readart".
  1183.  
  1184.      These files aren't so critical and can be deleted if they become
  1185.      corrupted.  First run the chkdsk command to fix any file system errors,
  1186.      then delete the supersed.* files in the %YARN% directory or delete the
  1187.      readart.* files in the %HOME%\yarn directory respectively.
  1188.  
  1189. ------------------------------
  1190.  
  1191. Subject: Is there a Yarn mailing list?
  1192.  
  1193.      Yes, to subscribe to the mailing list, mail a message to
  1194.      listproc@lists.colorado.edu.  The body of the message should be the line
  1195.  
  1196.           subscribe yarn-list Your Full Name
  1197.  
  1198.      assuming Your Full Name is your full name.  If it isn't, substitute your
  1199.      own name.
  1200.  
  1201. FILES
  1202.  
  1203.      %HOME%\mail                Folder directory
  1204.      %HOME%\news                Default save directory
  1205.      %HOME%\replies             Reply work directory
  1206.      %HOME%\yarn                User configuration directory
  1207.      %HOME%\yarn\scores         Score file directory
  1208.      %HOME%\yarn\scores\global  Global score file
  1209.      %HOME%\yarn\addrbook       Address book file
  1210.      %HOME%\yarn\config         User configuration file
  1211.      %HOME%\yarn\filter         Mail filter configuration file
  1212.      %HOME%\yarn\newsrc         Newsgroup subscription file
  1213.      %HOME%\yarn\readart.*      Read cross-posted article lookup table
  1214.  
  1215.      %YARN%\active              Active newsgroup file
  1216.      %YARN%\global              System-wide configuration file
  1217.      %YARN%\history.*           Article history lookup table
  1218.      %YARN%\supersed.*          Superseded article lookup table
  1219.      %YARN%\news.dat            Article spool file
  1220.      %YARN%\overview            Article overview directory
  1221.  
  1222.  
  1223.                                ACKNOWLEDGEMENTS
  1224.  
  1225.      The MS-DOS yarn.exe program uses the SPAWNO routines by Ralf Brown to
  1226.      minimize memory use while shelling to DOS and running other programs.
  1227.  
  1228.      The MS-DOS yarnx.exe program uses PMODE for Watcom C/C++, a DOS extender
  1229.      written by Charles Scheffold and Thomas Pytel.
  1230.  
  1231.  
  1232.  
  1233.  
  1234.                                                                             19
  1235.  
  1236.