home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / uqwk18.zip / README < prev    next >
Text File  |  1994-09-11  |  3KB  |  99 lines
  1. UQWK
  2.  
  3. Copyright 1993-1994, steve belczyk
  4.  
  5. uqwk is a program which collects all a user's unread mail or news
  6. and formats it into a packet for offline reading.  QWK, Simple
  7. Offline Usenet Packet (SOUP), and ZipNews packet formats are supported.
  8.  
  9. Uqwk also accepts reply packets, so replies can be mailed or posted,
  10. depending whether the message is marked private (email) or public (news).
  11.  
  12. Uqwk also supports a small offline command language, so the contents
  13. of the user's .newsrc file can be viewed and manipulated offline.
  14.  
  15. INSTALLATION
  16.  
  17. 1.  Create a directory for the uqwk source code.
  18.  
  19.     mkdir /usr/local/src/uqwk
  20.  
  21. 2.  Move the uqwk tar file to that directory.
  22.  
  23.     mv uqwk.tar.Z /usr/local/src/uqwk
  24.  
  25. 3.  Change to that directory, and unpack the tar file.
  26.  
  27.     cd /usr/local/src/uqwk; zcat uqwk.tar | tar xvf -
  28.  
  29. 4.  Compile the software.
  30.  
  31.     make
  32.  
  33.     If you're going to be getting news from a server using NNTP,
  34.     you must use the NNTP version of the Makefile:
  35.  
  36.     make -f Makefile.nntp
  37.  
  38.     If this doesn't work you may have to twiddle with the Makefile,
  39.     or, heaven forbid, the actual source code.
  40.  
  41. 5.  Move the binary and man pages to some public place.
  42.  
  43.     mv uqwk /usr/local/bin
  44.     mv uqwk.man /usr/man/man1/uqwk.1
  45.     mv uqwk.cat /usr/man/cat1/uqwk.1
  46.  
  47. 6.  The QWK specification allows for the name, location, etc., of
  48.     the BBS from which messages are being downloaded.  If you plan
  49.     to use the QWK format, you should configure this information.
  50.     The best way is probably to use environment variables.  If you
  51.     are using a Bourne shell, you should add something like this to
  52.     /etc/profile or .profile:
  53.  
  54.         UQ_BBS_NAME="My Super BBS"
  55.     UQ_BBS_CITY="Somewhere, PA"
  56.     UQ_BBS_PHONE="+1 215 555 1212"
  57.     UQ_BBS_SYSOP="Joe Shmoe"
  58.     UQ_BBS_ID="0,MYBBS"
  59.     export UQ_BBS_NAME UQ_BBS_CITY UQ_BBS_PHONE
  60.     export UQ_BBS_SYSOP UQ_BBS_ID
  61.  
  62.     If you use a C type shell, try something like this in your
  63.     .cshrc or .login:
  64.  
  65.         setenv UQ_BBS_NAME "My Super BBS"
  66.     setenv UQ_BBS_CITY "Somewhere, PA"
  67.     setenv UQ_BBS_PHONE "+1 215 555 1212"
  68.     setenv UQ_BBS_SYSOP "Joe Shmoe"
  69.     setenv UQ_BBS_ID "0,MYBBS"
  70.  
  71.     In both cases, the last entry, the "BBS ID", is the most important.
  72.     It always consists of an integer, a comma, and a string less than
  73.     nine characters, with no intervening spaces.  The string will be
  74.     used to identify reply packets.
  75.  
  76. 7.  Now you can try it.  Log in as a normal user who has some mail,
  77.     and issue:
  78.  
  79.     uqwk +r
  80.  
  81.     (The "+r" stops uqwk from clearing the user's mail spool file.)
  82.     This should create three new files in the current directory named
  83.     messages.dat, control.dat, and personal.ndx.  These are the files
  84.     which the offline reader will need.  (Not all readers need the
  85.     *.ndx files.  Also, some readers expect these files to have been
  86.     archived using an archiver like zip, lharc, or arj.  You may need
  87.     to obtain Unix versions of these archivers.)
  88.  
  89. 8.  Now it would be a good idea to read the man page ("more uqwk.cat")
  90.     and the Frequently Asked Questions list ("more FAQ").
  91.  
  92. Please inform me of any problems you run into:
  93.  
  94.     steve belczyk
  95.     steve1@genesis.nred.ma.us
  96.     seb3@gte.com
  97.     BBS: +1 508 664 0149
  98.  
  99.