home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / pc / source / pep21.arc / AAREAD.ME < prev    next >
Text File  |  1989-12-29  |  7KB  |  161 lines
  1. RELEASE-NOTES
  2. =============
  3.  
  4. (( This is an english language version of the norwegian file aales.meg ))
  5.  
  6. Name:         pep, ver. 2.1
  7. Author:         Gisle Hannemyr, Brageveien 3A, N-0452 Oslo, Norway.
  8.          EAN:  gisle@nr.uninett
  9.          Inet: gisle@ifi.uio.no
  10.          UUCP: ..!mcvax!ifi!gisle
  11.            and a number of Oslo based BBS's
  12. Purpose:     Detergent for "dirty" files
  13. Language:    K&R C
  14. Environment: Fairly generic (CP/M, MS-DOS, UNIX, VMS)
  15. Files:         PEP21.ARC
  16.          Contents:
  17.         aaread.me    -- this file
  18.         aales.meg    -- norwegian version of aaread.me
  19.         hjelp.txt    -- answer to questions (norwegian)
  20.         pepvms.txt   -- about vms RMS (norwegian)
  21.         header.txt   -- advice about portability of pep
  22.         pep.1l         -- manual page (nroff source)
  23.         pep.doc         -- formatted version of pep.1l
  24.         Makefile     -- commands to make distribution
  25.         Makefile.unx -- commands to make distribution (Unix)
  26.         Makevms.com  -- DCL script to compile and link (VMS)
  27.         ansi.c         -- ansi terminal interpreter
  28.         bdmg.c         -- DUCOS brain damage compensation
  29.         main.c         -- root module
  30.         plain.c         -- standard filter module
  31.         bdmg.h         -- bdmg.c types and functions
  32.         pep.h         -- types and functions for pep
  33.         pep.exe         -- executable (MS-DOS)
  34.         mac2ibm         -- sample conversion table
  35.         ibm2mac         -- sample conversion table
  36.         ebc2ns7         -- conv.-table EBCDIC to NS 4551
  37.         ibm2ro8         -- conv.-table IBM-PC to ROMAN8
  38.         ro82ibm         -- ditto
  39.         ibm2iso         -- conv.-table CP 850 to ISO 8859/1
  40.         iso2ibm         -- ditto
  41.  
  42.  
  43. Description:
  44.    Pep is a general purpose filter and file cleaning program.
  45.    It is named after an excellent Norwegian detergent.    Pep may
  46.    be used to expand/compress tabs; convert to and from several
  47.    character sets; to interprete ANSI escape sequences; and to
  48.    remove unanted line noise from files.  See the file pep.doc
  49.    for a complete description.
  50.  
  51.  
  52. Installation:
  53.    The steps required to install pep are:
  54.  
  55.    1) Print the manual page pep.doc on paper, and read it.
  56.    2) Compile the source file pep.c to a executable file.
  57.    3) Install the executable file.
  58.    4) Install the conversion tables.
  59.    5) Modify your startup profile as required.
  60.  
  61.    In more detail:
  62.  
  63.    1) If you have troff or ptroff, you may want to typeset the manual.
  64.       The troff command is: troff -man pep.1l .
  65.  
  66.    2) One executable file (pep.exe) for MS-DOS systems is included
  67.       in the distribution archive.  If you are able to use this,
  68.       you may skip the compilation.
  69.  
  70.       If you want to install pep on another operating system, you must
  71.       first compile it.     Instructions for compilation on several common
  72.       systems are at the start of the source file. A makefile is
  73.       also supplied.  Pep is fairly generic and should compile with
  74.       almost any C-compiler after very little tweaking.     Read the file
  75.       "header.txt" for advise about what pep expect to find in the
  76.       header files.
  77.  
  78.    3) The executable will be named pep.exe, pep.com, pep.cmd or just
  79.       pep, depending upon which operating system you are using.     See
  80.       operating system notes below for recommended placement.
  81.  
  82.    4) This are the files named mac2ibm, ro82ibm, ibm2ro8, etc.
  83.       You may want to add your conversion tables, which should be
  84.       installed in the same directory as those in the distribution.
  85.       As with executables, see the notes below for hints about where
  86.       tables should be installed on different systems.
  87.  
  88.    5) Pep uses one environment variable: PEP, which should be defined
  89.       in the startup profile if possible.
  90.  
  91.  
  92. Operating system notes:
  93.    Below is some notes on points pertaining to the different operating
  94.    systems:
  95.  
  96.    * CP/M systems:
  97.      Install the executable file and the conversion filters under
  98.      user 0.  CP/M does not have a startup profile or environment
  99.      variables.
  100.  
  101.    * MS-DOS systems:
  102.      Install PEP.EXE in a directory that is defined in your PATH
  103.      environment variable, and define an environment variable PEP
  104.      pointing to the directory where the conversion filters are
  105.      installed.     If this is "c:\usr\lib" your startup profile
  106.      AUTOEXEC.BAT should contain a line like this:
  107.  
  108.     set PEP=c:\usr\lib
  109.  
  110.      Alternatively, you may put the conversion tables in the same
  111.      directory as you put the executables.  If you use this alternative,
  112.      it is not necessary to define the PEP environment variable.
  113.  
  114.    * UNIX systems:
  115.      Install the executable file pep in a directory that is defined
  116.      in your PATH environment variable (a canonical place will be
  117.      /usr/local/bin).  Install the conversion table in a directory of
  118.      your choice (a canonical place will be /usr/local/lib).
  119.      Define an environment variable PEP pointing to the directory where
  120.      the conversion filters are installed.  If this is "/usr/local/lib"
  121.      your startup profile (.login on BSD systems, .profile on SYS-V)
  122.      should contain a line like this:
  123.  
  124.     setenv PEP /usr/local/lib
  125.  
  126.      Also, Unix users may want to install the manpage "pep.1l" in the
  127.      online manual.  The canonical placement is /usr/man/manl.
  128.  
  129.    * VMS systems:
  130.      Pep need to be installed as a "foreign command", and you need
  131.      to define a symbol pointing to the conversion filters.  If both
  132.      the executable file and the filters is placed in directory named
  133.      "disk_daf:<d_progbib.vms>", you need to have the following two
  134.      lines in your startup profile LOGIN.COM.
  135.  
  136.     $ pep :== $disk_daf:<d_progbib.vms>pep
  137.     $ define PEP "disk_daf:<d_progbib.vms>"
  138.  
  139.      Incidently, this is where pep is installed on the University of
  140.      Oslo VMS Vax cluster.  If you have an account on one of the
  141.      machines in this cluster, having the two lines above in your
  142.      LOGIN.COM is all you need to use pep on these machines.
  143.  
  144.      Also note that VMS does not support pipes and redirection, and
  145.      it is therefore awkward to use pep as a filter under VMS.    The
  146.      distributed version does not even try to run as a filter under
  147.      VMS, it has the -o option (write output back on file named as
  148.      input file) permanently enabled.
  149.  
  150.  
  151. Version 2.1, news:
  152.    * The -u option is expanded to allow user's to specify canonical
  153.      line terminator.
  154.    * New option: -v, to make pep generate hard line terminators only
  155.      between paragraphs.
  156.    * New conversion table "ebc2ns7" for EBCDIC and DisplayWrite.
  157.    * Some old conversion tables are expanded.
  158.    * Bugfixes.
  159.  
  160. ..EOF
  161.