home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / utils / trn / readme.os2 < prev    next >
Text File  |  1993-04-26  |  14KB  |  322 lines

  1. TRN for OS/2 is based the Unix-Version 2.2. Is was
  2. ported using the EMX 0.8f (GCC) 32-bit-C-Compiler.
  3.  
  4. The program requires at least OS/2 2.0, it will not run
  5. together with the EMX-extender for DOS (although this
  6. was not explicitely tested). It was designed to run
  7. together with the UUPC-Package by Drew Derbyshire.
  8.  
  9. Because UUPC does not have real News-Support until version 1.11q,
  10. we included an Rnews-program from a later version of
  11. UUPC (version x). If you have another package that produces
  12. Unix-compatible News-Database, it may run together with TRN.
  13.  
  14. If you have UUPC 1.11v (or later) installed, you have to
  15. replace the orignial rnews.exe and expire.exe with the ones
  16. in this package. If you have a later UUPC-version than
  17. 1.11x, the programs out of that package may work for TRN, 
  18. so please check this in the documentation of UUPC.
  19.  
  20. It is important, that the rnews.exe and expire.exe porgrams of
  21. that version use long HPFS names, and do not convert long directory
  22. names to the 8.3 convention. There is also a problem with the
  23. active file, the programs out of the UUPC package write this 
  24. file to the config-directory and not to the news directory, so
  25. that TRN would not be able to find it.
  26.  
  27. **REMARK**:  You need a hpfs-partition, where the news
  28.      will be stored, where your personal file will
  29.      be located (your home-directory) and where temporary
  30.      files can be created (the uupc-temp-directory).
  31.      The reason are the long filenames, that are
  32.      hardcoded in the TRN-Source. Also TRN will use
  33.      a completely unix-compatible filestructure to
  34.      store the news. So there will be directory-names
  35.      like 'c:/usr/uupc/news/alt/cyberpunk' or even longer
  36.      ones. If there is enough desire for a FAT-version,
  37.      we will perhaps do that later.
  38.  
  39.  
  40. This package includes:
  41.   TRN        --  the newsreader
  42.   MThreads   --  it generates the thread-database
  43.   TmpThread  --  this program is called by TRN for temporary thread files
  44.   ActTimes   --  this program generates and updates the active.times file
  45.  
  46.   Rnews      --  this replaces original Rnews of UUPC
  47.   Expire     --  removes old news articles
  48.   compress   --  decompresses newsbatches, called from within rnews
  49.  
  50.   unshar     --  utility to extract shar'ed files out of news articles
  51.  
  52.  
  53. Installation:
  54.  
  55.  - Put the executables into a directory listed in your path.
  56.    The full name of the directory (including drive) must be
  57.    listed in the TRN-rc-file. The best thing seams to be
  58.    your UUPC-binaries-directory. The rnews.exe of UUPC may
  59.    be replaced by the one provided in this package, if you
  60.    have already installed an expire-program, you may also
  61.    replace it with the one in this package (see notes above).
  62.  
  63.  - Put the emx*.dll files into a directory listed in your LIBPATH.
  64.    If you already have emx*.dll-Files, check if yours are newer
  65.    that the ones included in this package. If your's are newer, don't
  66.    replace then, TRN should work with them. At least emx 0.8f is needed.
  67.  
  68.  - The directory, where the TRN-executables are located and
  69.    the one, where the UUPC-execs can be found MUST be in
  70.    to PATH-variable, so that they can be found by TRN.
  71.    Also the external editor MUST be in everybodies path.
  72.  
  73.  - Edit your config.sys and add the following setting:
  74.          UUPCTRNRC
  75.    The setting must include the whole path to the file, like
  76.    UUPCSYSRC or UUPCUSRRC  (e.g.: SET UUPCTRNRC=C:/USR/UUPC/CONFIG/TRN.RC)
  77.    You may use either "/" or "\" in this path.
  78.  
  79.  - Look through your UUPC-rc-files, and check if the information
  80.    is complete and correct. The following settings are required
  81.    (they are NOT optional):
  82.    UUPCSYSRC:
  83.        MailServ, NodeName, NewsDir, Domain, TempDir, MailDir
  84.    UUPCUSRRC:
  85.        Mailbox, Signature, Name, Home, Organization, Editor
  86.    UUPCTRNRC:
  87.        Newsadmin, TrnLib, LocalDist, OrganizationDist, CityDist,
  88.        StateDist, Countrydist, ContinentDist
  89.  
  90.    Don't forget, these settings are required, not optional!
  91.  
  92.    Path-names in this settings may either use '/' or '\' as
  93.    directory separators. This didn't work in the previous version
  94.    of the OS/2 port (version 1.0) but this is (hopefully) fixed now.
  95.  
  96.    UUPCTRNRC: The variable Newsadmin ist the name of the mailbox
  97.               of the person which does sysadmin on the machine,
  98.               this may be the same as the variable Mailbox in the
  99.               UUPCUSRRC-file.
  100.  
  101.               TrnLib is the directory, where the executables
  102.               are located (TRN looks for the file newsnews there
  103.               and also stores some configuration files there).
  104.  
  105.               The other 6 settings are the values for the
  106.               distributions you want to use for postings.
  107.  
  108.    If you use the environment-variable HOME, it will overwrite
  109.    the setting Home in the UUPCUSRRC.
  110.  
  111.  - copy the file TERMCAP.DAT to one of your directories
  112.    for example the config-directory of UUPC.
  113.  
  114.  - set another environmentvariable: TERMCAP. This is the value
  115.    for the terminal-definition-file you want to use. The setting
  116.    must include the whole path to the TERMCAT.DAT-file
  117.    (SET TERMCAP=C:/USR/UUPC/CONFIG/TERMCAP.DAT).
  118.    You may use either "/" or "\" in this path.
  119.  
  120.  - Now with your TERMCAP.DAT installed, you must set the
  121.    TERM-variable. (e.g. SET TERM=ansi or SET TERM=window).
  122.  
  123. IMPORTANT:
  124. ~~~~~~~~~~
  125.  - Now you have to generate an  active  file in the news directory.
  126.    I'm sorry, but rnews does not write the names of new newsgroups
  127.    automatically to the active file, you have maintain that yourself.
  128.    For the layout of the active file please look for the sample "active"
  129.    that is included in this package.
  130.  
  131.  
  132.  
  133. Now you can get some news-batches with UUPC. If your settings
  134. are correct, and you're using the rnews provided with TRN,
  135. the news will be delivered to the directory listed in the
  136. NewsDir-Variable in your UUPCSYSRC. Rnews will also create
  137. and maintain the active-file. Now you must create the active.times
  138. file. This is done simply by typing acttimes to the command line.
  139. The active.times file should be located in the same directory
  140. as the active file.
  141.  
  142. Now you can either start TRN or first create thread files
  143. for specific newsgroups. This can be done by using
  144.    mthreads news.group     to thread a specific group, or
  145.    mthreads all            to thread every group.
  146.  
  147. For more information on the programs please refer to
  148. the original documentation.
  149.  
  150.  
  151. Remarks:
  152.  
  153.   -  I compiled the sources of rnews and expire out of the
  154.      UUPC 1.1x package. The executables are included in this
  155.      package. I tried to contact Drew Derbishire, but he
  156.      didn't answer. First I didn't want to include the
  157.      programs without asking him, but there's no choice,
  158.      because TRN 1.1 for OS/2 has to be released now. So I want
  159.      to thank Drew now for his work on the whole UUPC package,
  160.      and hope that I can get in contact with him soon.
  161.  
  162.   -  I included the program "compress" into the package
  163.      which is needed to uncompress news-batches and is
  164.      called from within the rnews-program. I received this
  165.      program without any documentation, just the exe-file
  166.      was included. So I don't know who wrote this program
  167.      and I was not able to ask if I'm allowed to include
  168.      this program into this package. If you have a compress
  169.      which also uses the "-d" switch (decode) you can just
  170.      try to use yours, you must not use the one included
  171.      in this package. 
  172.  
  173.  
  174.   -  TRN can not only save but also extract articles directly
  175.      by using the e-command when displaying the article. TRN
  176.      will try to determine the type of the file. It will
  177.      recognize uuendoded or shiped (zip-archiver) articles and
  178.      also SHAR'ed files. TRN will use it's own routines to
  179.      uudecode and unship articles. This will also work if
  180.      the archive consists of multiple articles (just type 'e /dirname'
  181.      on the first part and then only 'e' on the following ones).
  182.      If a shell-archive is detected, TRN will call the external
  183.      programs 'tail' and 'unshar' to extract the archive.
  184.  
  185.      You must ensure that you have the Unix-Tools 'tail' and
  186.      'unshar' installed and in the path. Tail will be used to strip 
  187.      off the header so that only the article-body is saved. tail is 
  188.      a unix-tool which was ported by Kai-Uwe Rommel and can be found 
  189.      in the "gnututil.zoo", the GNU Text Utilities on ftp-os2. Also 
  190.      the program "unshar" can be found on ftp-os2.
  191.  
  192.  
  193.   -  If you have the environmentvariable "deldir" set, which
  194.      can be very useful of course, expire gets VERY slow. This
  195.      can be avoided using the batch-file expirenews (or somthing
  196.      similar) to temporarily disable the deldir-setting. This
  197.      batch file is also included in this package (see expirenews.cmd).
  198.  
  199.  
  200.  
  201. *******************************************************************
  202. Thanks:
  203.     
  204.     Thanks to Eberhard Mattes for his excellent work on
  205.     the port of GNU GCC for OS/2. Porting TRN would have been
  206.     impossible to do without his GCC, because of lots of
  207.     unix-specific functions.
  208.     
  209.     Thanks also to Kai-Uwe Rommel for his betatest and
  210.     the resulting improvements. A lot of suggestions
  211.     he made will be in the next release.
  212.     
  213.     Thanks also to the others who tested TRN.
  214.     
  215. ********************************************************************
  216.  
  217. Please send your suggestions, remarks or bug reports to
  218.  
  219. Herbert Neugebauer      haen@veces.stgt.sub.org
  220.  
  221. or
  222.  
  223. Thilo Schuster          term@godot.stgt.sub.org
  224.  
  225. ********************************************************************
  226. Remarks and ToDos:
  227.  
  228.  - When chasing xrefs on threaded groups, trn compains about
  229.    corrupt xref-lines. (Rnews has to be rewritten)
  230.    *** done, thanks to Drew Derbishire and Kai-Uwe Rommel ***
  231.  
  232.  - When saving an article in mailbox-format, the generation
  233.    of the From-line does not work correctly. Default values
  234.    are used for the from-line. The filexp-function seams
  235.    not to work correctly.
  236.    *** should work now ***
  237.       
  238.  - On some groups (unthreaded ones) trn calls tmpthread
  239.    an then displays the thread selector, although you
  240.    didn't tell trn to do so. (You can display the thread
  241.    selector on unthreaded groups by pressing 't').
  242.    If this happens, you can try to edit manually the 
  243.    active2-file (in the trnlib-directory). Threaded groups
  244.    are marked with a small 'y', 'n' or 'm' unthreaded ones
  245.    with capital 'Y', 'N' 'M'. 
  246.    *** This problem never happened for half a year now, although  ***
  247.    *** nothing has been fixed. So PLEASE send us an email if you  ***
  248.    *** experience the problem.                      ***
  249.  
  250.  - currently the commands s S w and W for saving articles
  251.    do the same, there is no difference between them.
  252.    We don't save via a shell, we do it directly on our own
  253.    and this will not be fixed, so there will be no difference
  254.    between s and S (btw. w and W) in future.
  255.    But the stripping of the header (w and W) will be included
  256.    later.
  257.    ******* partly fixed at 08/15/92, now the stripping of
  258.       the header with the w-command is working. But there is still
  259.       no difference between s and S and between w and W. *****
  260.  
  261.  - The kill-file does not work at the moment. The reason ist
  262.    mainly, that we need working fseek and ftell functions
  263.    to read the article header for writing the kill-commands
  264.    to the file. But this commands does not work for text files
  265.    in emx 0.8d. This will probably be fixed in emx 0.8e.
  266.    There is another problem with the kill-files, but this
  267.    will only be fixed, if the ftell and fseek functions
  268.    work correctly, so don't try create edit killfiles on
  269.    your own, because if one is found, TRN will try to read
  270.    it, and then it cannot be opened correctly. You will
  271.    get an error-message, that the killfile cannot be created
  272.    (although it exists).
  273.    ********* fixed by using binary mode to open articles. 07/28/92 *******
  274.  
  275.  - NNTP-Support is not included, and it is very unlikely, that
  276.    this will be done in the future. TRN for OS/2 is intended
  277.    to work together with UUPC at the moment. If somebody
  278.    would like to do the NNTP support for TRN, I will send
  279.    the sources. I can't do that, because I don't have access
  280.    to TCP/IP, to check if it would be possible.
  281.    
  282.  - Server-mode for acttimes and mthreads is not supported.
  283.    The reason is that we need forks and execs to do this.
  284.    Perhaps this will be fixed later, but the programs work
  285.    together with UUPC, and so this seams not to be very
  286.    important. Also this would require NNTP, see also the note above...
  287.  
  288.  - We had some problems with the OS/2 filesystems. Or better
  289.    with the Un*x-filesystem. There are no file links under
  290.    OS/2. We avoided them using the DosCopy API-function.
  291.    In most cases this may be suitable, but this may cause
  292.    problems under certain circumstances.
  293.    *** such problems were never experience ...  ***
  294.  
  295.  - There was also a Problem when a file was opened two times
  296.    simultaneously. This is not possible with the fopen
  297.    command in EMX. We fixed this temporarily by copying the
  298.    file first and then opening the copied one only for reading.
  299.    There is another way by using API-calls and fdopen, so
  300.    this may be fixed later.
  301.    *** this should work now, because the fopen in EMX now allows  ***
  302.    *** shared opening of files. Be sure not to have TRN running   ***
  303.    *** while rnews is executed. This may cause error messages.    *** 
  304.  
  305.  - You can only post arcticles from within TRN. Under Unix
  306.    there is a shell-script Pnews, which can also handle this
  307.    without starting TRN. The posting routine is implemented
  308.    in C and included into TRN. You can post your articles
  309.    now by using the followup-command 'f' (not 'F'). If you
  310.    are at article-level, you will be asked if you want to
  311.    start an unrelated article. This did also work in the
  312.    original Unix-TRN.
  313.  
  314.  - At the moment articles will not be posted locally, so
  315.    you cannot read them with TRN on your own machine. But
  316.    the articles are saved to an outgoing article-mailbox.
  317.    *********** fixed at 08/15/92: local posting should work now *******
  318.  
  319.  - saving via pipe (s|... , w|... , e dir | ...) does not
  320.    work currently.
  321.    ****** fixed at 08/15/92: use another PIPESAVER-string *******
  322.