home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / uqwk18.zip / uqwk.cat < prev    next >
Text File  |  1994-02-11  |  19KB  |  528 lines
  1.  
  2.  
  3.  
  4.    uqwk version 1.8                                                   UQWK(1)
  5.  
  6.  
  7.  
  8.    NAME
  9.      uqwk - Collect news and mail into packet for offline reading
  10.  
  11.    SYNOPSIS
  12.      uqwk [options]
  13.  
  14.    DESCRIPTION
  15.      uqwk is a program which collects all a user's unread mail or news and
  16.      formats it into a packet for offline reading, saving telephone and con-
  17.      nect charges.  QWK, Simple Offline Usenet Packet (SOUP), and ZipNews
  18.      formats are supported.
  19.  
  20.      uqwk also accepts reply packets, so replies can be mailed or posted,
  21.      depending whether the message is marked private (email) or public
  22.      (news).
  23.  
  24.      uqwk also supports a small offline command language, so the contents of
  25.      the user's .newsrc file can be viewed and manipulated offline.
  26.  
  27.    OPTIONS
  28.  
  29.      +m   Do mail.  uqwk will process all mail in the user's mail spool file
  30.           and convert it into an offline packet.  This is the default.
  31.  
  32.      -m   Don't do mail.
  33.  
  34.      +n   Do news.  Using the user's .newsrc file and the news system's
  35.           active file, uqwk will collect all unread news articles in all sub-
  36.           scribed newsgroups into the packet.  This can generate a large
  37.           number of messages and large packet files.
  38.  
  39.      -n   Don't do news.  This is the default.
  40.  
  41.      +h   Include headers.  Since the QWK specification places limits on the
  42.           sizes of certain header fields such as To:, From:, and Subject:,
  43.           uqwk can include all message and article headers in the body of the
  44.           message so all fields are visible.  This is the default.  (This
  45.           switch only applies to the QWK packet format.)
  46.  
  47.      -h   Do not include headers in messages.  (QWK only.)
  48.  
  49.      +e   Include an entry for every subscribed newsgroup in the CONTROL.DAT
  50.           file.  (QWK only).
  51.  
  52.      -e   Do not include an entry in CONTROL.DAT for empty newsgroups.  This
  53.           is the default.  (QWK only.)
  54.  
  55.      -p   Print options.  uqwk will examine all appropriate environment vari-
  56.           ables and command line options, print the values of all run-time
  57.           options, then exit.  This is useful to see what uqwk thinks it is
  58.           going to do before you actually run it.
  59.  
  60.      +r   Read only.  Normally, uqwk will empty the user's mail spool file
  61.  
  62.  
  63.                                                                             1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.    UQWK(1)                                                   uqwk version 1.8
  71.  
  72.  
  73.           and update the user's .newsrc file to reflect the fact that mail
  74.           and news have been read.  If this switch is specified, uqwk will
  75.           not touch these files.  This is useful for testing.
  76.  
  77.      -r   Do not execute in read-only mode.  This is the default.
  78.  
  79.      +L   Operate in SOUP (also known as HDPF or SLNP) mode.  The files
  80.           comprising a Simple Offline Usenet Packet (SOUP), specifically,
  81.           AREAS and *.MSG, will be created instead of a QWK packet.  The
  82.           reply file, if any, will be interpreted as an SOUP "replies" file
  83.           instead of a QWK reply packet.
  84.  
  85.      -L   Do not operate in SOUP mode.  This is the default.
  86.  
  87.      +z   Operate in ZipNews mode.  The files comprising a ZipNews news
  88.           packet, specifically, "user.JN", "user.NWS", and "user.IDX", will
  89.           be created instead of a QWK packet.
  90.  
  91.      -z   Do not operate in ZipNews mode.  This is the default.
  92.  
  93.      +x   Honor Xref header lines in news articles.  When this switch is in
  94.           effect, uqwk will only pack a crossposted article in the first
  95.           newsgroup in which it is encountered.  This can reduce the size of
  96.           the packet but may introduce unexpected behavior on the part of the
  97.           offline reader.
  98.  
  99.      -x   Do not honor Xref lines.  This is the default.
  100.  
  101.      +W   Activate the Blue Wave kludge.  The Blue Wave QWK reader does not
  102.           like the personal.ndx file that uqwk creates by default.  If this
  103.           switch is specified uqwk will create a regular ???.ndx file that
  104.           Blue Wave likes.  (QWK only.)
  105.  
  106.      -W   Do not activate the Blue Wave kludge.  This is the default.
  107.  
  108.      +X   Operate in expert QWK mode.  The QWK header is ignored and all
  109.           header lines are taken from the body of the message.  In the hands
  110.           of an expert, this permits the creation of RFC822 compliant mail
  111.           messages and RFC1036 compliant news articles using QWK readers,
  112.           which is difficult or impossible otherwise in many cases.  This is
  113.           intended for people who really know what they're doing.  (QWK
  114.           only.)
  115.  
  116.      -X   Do not operate in expert QWK mode.  This is the default.
  117.  
  118.      -M_m_a_i_l_d_i_r
  119.           Look in the directory _m_a_i_l_d_i_r for the mail spool file.  The default
  120.           is /usr/spool/mail.
  121.  
  122.      -f_m_a_i_l_f_i_l_e
  123.           Look for mail in the file _m_a_i_l_f_i_l_e.  The default is a file with the
  124.           same name as the user's login name in _m_a_i_l_d_i_r.  This switch over-
  125.           rides the -M switch.
  126.  
  127.  
  128.  
  129.    2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.    uqwk version 1.8                                                   UQWK(1)
  137.  
  138.  
  139.      -u_u_s_e_r_n_a_m_e
  140.           By default uqwk uses the getpwuid() system call to determine the
  141.           proper user name to use.  This switch overrides the results of that
  142.           call.
  143.  
  144.      -H_h_o_m_e_d_i_r
  145.           By default, uqwk uses the getpwuid() system call to determine the
  146.           user's home directory.  The home directory is where the files
  147.           comprising the offline packet will be created.  It is also where
  148.           uqwk looks for the .newsrc file.  This switch may be used to over-
  149.           ride the results of the getpwuid() call.
  150.  
  151.      -b_b_b_s_n_a_m_e
  152.           Specify the BBS Name to be entered into the QWK packet.  The
  153.           default is "unknown BBS".  (QWK only.)
  154.  
  155.      -c_c_i_t_y
  156.           Specify the BBS City to be entered into the QWK packet.  The
  157.           default is "Anytown, USA".  (QWK only.)
  158.  
  159.      -P_p_h_o_n_e
  160.           Specify the BBS Phone Number to be entered into the QWK packet.
  161.           The default is "555-1212".  (QWK only.)
  162.  
  163.      -s_s_y_s_o_p
  164.           Specify the BBS Sysop Name to be entered into the QWK packet.  The
  165.           default is "Joe Sysop".  (QWK only.)
  166.  
  167.      -i_b_b_s_i_d
  168.           Specify the BBS ID to be entered into the QWK packet.  The BBS ID
  169.           is important since it will be checked against the BBS ID string in
  170.           any incoming reply packets.  If the two do not match, the reply
  171.           packet will not be processed.  The BBS ID consists of an integer, a
  172.           comma, and a string of less than nine characters, with no spaces.
  173.           The default is "0,SOMEBBS".  (QWK only.)
  174.  
  175.      -a_a_c_t_i_v_e_f_i_l_e
  176.           Use _a_c_t_i_v_e_f_i_l_e for the list of all available newsgroups and article
  177.           numbers.  The default is /usr/lib/news/active.  This option is
  178.           ignored if articles are being obtained from a news server using
  179.           NNTP.
  180.  
  181.      -N_n_e_w_s_r_c_f_i_l_e
  182.           Use _n_e_w_s_r_c_f_i_l_e for the list of all newsgroups to which the user is
  183.           subscribed and the list of article numbers which have been read.
  184.           The default is a file called ".newsrc" in the user's home direc-
  185.           tory.
  186.  
  187.      +w   Interpret the _n_e_w_s_r_c_f_i_l_e as a Waffle "join" file instead of a regu-
  188.           lar Unix .newsrc.
  189.  
  190.      -w   Do not interpret the _n_e_w_s_r_c_f_i_l_e as a Waffle "join" file.  This is
  191.           the default.
  192.  
  193.  
  194.  
  195.                                                                             3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.    UQWK(1)                                                   uqwk version 1.8
  203.  
  204.  
  205.      -D_n_g_f_i_l_e
  206.           Process newsgroups in the order specified in _n_g_f_i_l_e.  _n_g_f_i_l_e is
  207.           expected to contain one newsgroup name per line.
  208.  
  209.      -S_n_e_w_s_d_i_r
  210.           Look for news articles in the directory _n_e_w_s_d_i_r.  The default is
  211.           /usr/spool/news.  This option is ignored if articles are being
  212.           obtained from a news server using NNTP.
  213.  
  214.      -B_m_a_x_b_l_o_c_k_s
  215.           Stop processing news articles if the size of the offline packet
  216.           exceeds _m_a_x_b_l_o_c_k_s 128-byte blocks.  This is useful since large
  217.           amounts of unread news can create large packets.  Use a _m_a_x_b_l_o_c_k_s
  218.           value of zero to suppress this check.  The default is 4000 blocks
  219.           (half a megabyte).
  220.  
  221.      -t_t_a_b_l_e_f_i_l_e
  222.           Translate newsgroup names as specified in _t_a_b_l_e_f_i_l_e.  Each line in
  223.           _t_a_b_l_e_f_i_l_e is expected to have two fields separated by white space:
  224.           The old name of the newsgroup and the name to which it will be
  225.           translated.  (QWK only.)
  226.  
  227.      -l_l_e_n
  228.           Truncate the names of newsgroups to _l_e_n characters.  Some offline
  229.           readers cannot handle long newsgroup names.  Newsgroup names are
  230.           truncated after having been translated.  The default is 15 charac-
  231.           ters.  Specify a value of zero for unlimited newsgroup name
  232.           lengths.  (QWK only.)
  233.  
  234.      -R_r_e_p_l_y_f_i_l_e
  235.           Process _r_e_p_l_y_f_i_l_e as a reply packet.  Messages and articles created
  236.           by the offline reader must be uploaded as a reply packet and then
  237.           processed by this switch to be mailed or posted.  If operating in
  238.           SOUP mode, this file should be the REPLIES file.  uqwk will remove
  239.           _r_e_p_l_y_f_i_l_e when it has been processed unless it is running in read-
  240.           only mode.  If operating in ZipNews mode, this switch should
  241.           specify the directory in which the ZipNews reply files reside.
  242.  
  243.      -d_h_o_s_t_n_a_m_e
  244.           Use the specified _h_o_s_t_n_a_m_e when processing ZipNews reply packets.
  245.           This should be the fully-qualified domain name of the Unix host.
  246.           The default is "nowhere".
  247.  
  248.      -U_s_u_m_f_i_l_e
  249.           Operate in "summary" mode.  Instead of packing articles, uqwk
  250.           creates a summary file, _s_u_m_f_i_l_e, which consists of the newsgroup
  251.           name, article number, and subject line of each unread article.  All
  252.           summarized articles are marked as read.
  253.  
  254.      -E_s_e_l_f_i_l_e
  255.           Operate in "selection" mode.  Instead of using the .newsrc file to
  256.           determine which articles to pack, uqwk reads _s_e_l_f_i_l_e, a file in the
  257.           same format as the summary file.  (The actual subjects are optional
  258.           in _s_e_l_f_i_l_e.)  The idea is that a summary may be created by using
  259.  
  260.  
  261.    4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.    uqwk version 1.8                                                   UQWK(1)
  269.  
  270.  
  271.           -U, downloaded, edited or processed by additional software to
  272.           select desired articles, uploaded, and fed to the -E switch for
  273.           offline article selection.
  274.  
  275.      Most of the run-time options can also be controlled by environment vari-
  276.      ables.  If an option is specified by both an environment variable and a
  277.      command-line option, the command-line option is honored.
  278.  
  279.      UQ_DO_MAIL
  280.           Determines whether or not to process mail.  Should be set to "1"
  281.           (do mail) or "0" (don't do mail).
  282.  
  283.      UQ_DO_NEWS
  284.           Determines whether or not to process news.  Should be set to "1"
  285.           (do news) or "0" (don't do news).
  286.  
  287.      UQ_INC_HDRS
  288.           Determines whether or not to include headers in messages.  Should
  289.           be set to "1" (include headers) or "0" (don't include headers).
  290.  
  291.      UQ_EVERY_MODE
  292.           Determines whether or not to include an entry in CONTROL.DAT for
  293.           empty newsgroups.  Should be set to "1" (include empty groups) or
  294.           "0" (don't include empty groups).
  295.  
  296.      UQ_PRT_OPTS
  297.           Determines whether or not to just print the values of run-time
  298.           options and stop.  Should be set to "1" (print options) or "0"
  299.           (don't print options).
  300.  
  301.      UQ_READ_ONLY
  302.           Determines whether or not to run in read-only mode.  Should be set
  303.           to "1" (read-only) or "0" (not read-only).
  304.  
  305.      UQ_WAF_MODE
  306.           Determines whether the .newsrc file should be interpreted as a Waf-
  307.           fle "join" file.  Should be set to "0" (normal) or "1" (Waffle
  308.           mode).
  309.  
  310.      UQ_SOUP_MODE
  311.           Determines whether or not to run in SOUP mode.  Should be set to
  312.           "0" (don't run in SOUP mode) or "1" (run in SOUP mode).
  313.  
  314.      UQ_ZIP_MODE
  315.           Determines whether or not to run in ZipNews mode.  Should be set to
  316.           "0" (don't run in ZipNews mode) or "1" (run in ZipNews mode).
  317.  
  318.      UQ_XRF_MODE
  319.           Determines whether or not to honor Xref lines.  Should be set to
  320.           "0" (do not honor Xref lines) or "1" (honor Xref lines).
  321.  
  322.      UQ_BW_KLUDGE
  323.           Determines whether or not to activate the Blue Wave kludge.  Should
  324.           be set to "0" (do not activate the Blue Wave kludge) or "1"
  325.  
  326.  
  327.                                                                             5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.    UQWK(1)                                                   uqwk version 1.8
  335.  
  336.  
  337.           (activate the Blue Wave kludge).
  338.  
  339.      UQ_XPRT_MODE
  340.           Determines whether or not to operate in QWK expert mode.  Should be
  341.           set to "0" (do not run in expert mode) or "1" (run in expert mode).
  342.  
  343.      UQ_MAIL_DIR
  344.           Specifies the directory where the mail spool file resides.
  345.  
  346.      UQ_MAIL_FILE
  347.           Specifies the mail spool file.
  348.  
  349.      UQ_USER_NAME
  350.           Specifies the username of the person running uqwk.
  351.  
  352.      UQ_HOME_DIR
  353.           Specifies the home directory, where the packet files will be
  354.           created, and where uqwk expects to find the .newsrc file.
  355.  
  356.      UQ_BBS_NAME
  357.           Specifies the BBS name to be entered into the QWK packet.
  358.  
  359.      UQ_BBS_CITY
  360.           Specifies the BBS city to be entered into the QWK packet.
  361.  
  362.      UQ_BBS_PHONE
  363.           Specifies the BBS phone number to be entered into the QWK packet.
  364.  
  365.      UQ_BBS_SYSOP
  366.           Specifies the BBS sysop name to be entered into the QWK packet.
  367.  
  368.      UQ_BBS_ID
  369.           Specifies the BBS ID to be entered into the QWK packet.
  370.  
  371.      UQ_ACT_FILE
  372.           Specifies the name of the news system's active file.
  373.  
  374.      UQ_NRC_FILE
  375.           Specifies the name of the user's .newsrc file.
  376.  
  377.      UQ_NG_FILE
  378.           Specifies the name of the desired newsgroups file.
  379.  
  380.      UQ_MAX_BLKS
  381.           Specifies the maximum size of the offline packet in 128-byte
  382.           blocks.
  383.  
  384.      UQ_TRN_FILE
  385.           Specifies the name of the newsgroup name translation table.
  386.  
  387.      UQ_GRP_LEN
  388.           Specifies the maximum length of newsgroup names.
  389.  
  390.      UQ_REP_FILE
  391.  
  392.  
  393.    6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.    uqwk version 1.8                                                   UQWK(1)
  401.  
  402.  
  403.           Specifies the name of the reply packet, if any.
  404.  
  405.      UQ_HOST_NAME
  406.           Specifies the host name for ZipNews replies.
  407.  
  408.      UQ_SUM_FILE
  409.           Specifies the name of the summary file, if any.  Also causes uqwk
  410.           to execute in summary mode.
  411.  
  412.      UQ_SEL_FILE
  413.           Specifies the name of the selection file, if any.  Also causes uqwk
  414.           to execute in selection mode.
  415.  
  416.    COMMAND LANGUAGE
  417.      If, while processing a reply packet, uqwk encounters a message to the
  418.      username "UQWK", the body of the message will be interpreted as a small
  419.      command language, used to display newsgroup names and subscribe or
  420.      unsubscribe to newsgroups.  The results of the execution of the commands
  421.      will be mailed back to the originating user.
  422.  
  423.      This is what the command language looks like:
  424.  
  425.      HELP List all the available commands.
  426.  
  427.      SUBSCRIBE newsgroup
  428.           Subscribe to the named newsgroup.
  429.  
  430.      UNSUBSCRIBE newsgroup
  431.           Unsubscribe from the named newsgroup.  UNSUBSCRIBE ALL may be used
  432.           to unsubscribe from all newsgroups.  UNSUBSCRIBE ALL is also the
  433.           only way to create a new .newsrc if it does not already exist.
  434.  
  435.      CATCHUP newsgroup
  436.           Mark all articles in the named newsgroup as read.
  437.  
  438.      GROUPS
  439.           List all newsgroups to which the user is currently subscribed.
  440.  
  441.      ALLGROUPS
  442.           List all the available newsgroups and the number of articles in
  443.           each one.
  444.  
  445.      SHELL command
  446.           Execute the specified shell command.  Anything written to standard
  447.           output will be mailed back to the originating user.
  448.  
  449.    NOTES
  450.      In QWK mode, it is possible to send mail to long email addresses by
  451.      including, as the first thing in the body of the message, a line of the
  452.      form:
  453.  
  454.                                 To: user@site.com
  455.  
  456.  
  457.  
  458.  
  459.                                                                             7
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.    UQWK(1)                                                   uqwk version 1.8
  467.  
  468.  
  469.      (The space after the colon is important.)
  470.  
  471.    BUGS
  472.  
  473.      The handling of MMDF mail files is kludgy and should be fixed.
  474.  
  475.      In QWK mode, if the .newsrc file is modified significantly between the
  476.      time a packet is created and the time replies to that packet are pro-
  477.      cessed, it is possible that articles may be posted to the wrong news-
  478.      group.  If you use uqwk along with a conventional online newsreader, it
  479.      may be wise to maintain a separate .newsrc file strictly for uqwk.
  480.  
  481.      uqwk does not do mail locking.  If new mail arrives while uqwk is pack-
  482.      ing mail, the new message may be lost.  If you're worried about this,
  483.      either make a copy of your mail spool before running uqwk, or run uqwk
  484.      in read-only mode and erase your mail spool manually when you think it
  485.      is safe.
  486.  
  487.      uqwk does not support the ZipNews offline commands.  To perform offline
  488.      configuration using uqwk, send mail to the username "UQWK" in the format
  489.      described in the COMMAND LANGUAGE section above.
  490.  
  491.    SEE ALSO
  492.      mail(1), inews(8)
  493.  
  494.    ACKNOWLEDGEMENTS
  495.  
  496.      uqwk was inspired by a conversation with Harry Lockwood
  497.      (lockwood@world.std.com).
  498.  
  499.      QWK format was designed by Mark "Sparky" Herring
  500.      (mark.herring@nashville.com).  The creator of SOUP is Rhys Weatherley
  501.      (rhys@cs.uq.oz.au).  The creator of ZipNews is Jack Kilday
  502.      (jkilday@nlbbs.com).
  503.  
  504.      Thanks to Patrick Y. Lee (patlee@panix.com) for the QWK documentation.
  505.      Many thanks also to the beta-testers:  Karl J. Vesterling
  506.      (kjv@exucom.com) and Brian J. Coan (brian@igc.apc.org).
  507.  
  508.      Many thanks to Ken Whedbee (kcw@grumpy.ksc.nasa.gov) for the NNTP modif-
  509.      ications.
  510.  
  511.      Many other people, too numerous to list here, contributed bug fixes and
  512.      suggestions for improvement.
  513.  
  514.    AUTHOR
  515.      steve belczyk, steve1@genesis.nred.ma.us, seb3@gte.com.
  516.  
  517.      Copyright (C) 1993-1994 by steve belczyk.  Permission to use, copy,
  518.      modify and distribute this software and its documentation for any pur-
  519.      pose and without fee is hereby granted, provided that the above copy-
  520.      right notice appear in all copies and that both that copyright notice
  521.      and this permission notice appear in supporting documentation.  This
  522.      software is provided "as is" without expressed or implied warranty.
  523.  
  524.  
  525.    8
  526.  
  527.