home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d824 / pager.lha / Pager / Pager.doc < prev    next >
Text File  |  2001-02-25  |  6KB  |  205 lines
  1.  
  2.  
  3.  
  4.                         Documentation
  5.  
  6.  
  7.  
  8.                       Pager Version 1.0
  9.  
  10.  
  11.  
  12.  
  13.                 ® 1992/93 by H.P.G FreeWare
  14.  
  15.  
  16.  
  17.  
  18.  
  19. Index:
  20.  
  21.  
  22.  
  23.         Overview
  24.         System Requirements
  25.         Legal Stuff
  26.         Cli-Parameters
  27.         Examples
  28.         Technical
  29.         Address
  30.         List Of File
  31.  
  32.  
  33.  
  34.  
  35.  
  36. Overview:
  37.  
  38.  
  39.         Pager is a little helpful utility that brings you the ability to add
  40.         line numbers and page numbers to texts, documents and any other kind
  41.         of files.
  42.  
  43.         Its a cli tool that has a lot of commandline options which enables
  44.         you to control the form of the output in a very easy way.
  45.  
  46.         Most formattings can be done with specifying format strings in a
  47.         printf style. You may use a format string like "%-3ld" for line
  48.         numbering or "%s Page No %3ld" for page numberings.
  49.  
  50.         You are able to specify the number of lines per page.
  51.  
  52.         To use Pager in batch scripts is also usable with the supported Quit
  53.         option.
  54.  
  55.  
  56.  
  57. System Requirements:
  58.  
  59.         To run Pager you will need OS 2.04 or higher. Previous versions
  60.         doesn`t function.
  61.  
  62.  
  63. Legal Stuff:
  64.  
  65.  
  66.         This  program  and  all files come with it, also the docfiles, are
  67.         released as FREEWARE.
  68.  
  69.         this means:
  70.  
  71.             everybody may use Pager,
  72.  
  73.             everybody may copy Pager, if:
  74.  
  75.                 1. You copy all included files, see list at the end of the
  76.                    doc file.
  77.                 2. No changes are made,  this  means  the  program and all
  78.                    included files must stay in the original form.
  79.                    Exception: you  may  archive  it; but in this case you
  80.                               must also archive the whole package.
  81.                 3. If  you  decompile  it, you have to include a notice to
  82.                    the original author. If you also want to (re)distribute
  83.                    in any new form you have to send me a copy.
  84.                 4. You may not sell Pager.
  85.                    Execption: you`re  allowed  to  take  a  small copy fee
  86.                               which should not extend 5US$.
  87.                 5. If you want to include Pager or one of the  included files
  88.                    as a part of a commercial package, you must have written
  89.                    permission from the author (address see below).
  90.  
  91.  
  92.         I take no warranty or guaranty for the function of this program.
  93.         The whole risk of using Pager stays only by the user.
  94.  
  95.  
  96.  
  97. Cli-Parameters
  98.  
  99.  
  100.     Pager understands the following cli options:
  101.  
  102.         Syntax: Pager <File/M/A><TO/A> [Numbers=N/K][PLen=P/K/N]
  103.                       [LnForm=L/K][Quiet=Q/S]
  104.  
  105.     with
  106.  
  107.  
  108.         File    = This is the source file you want to process. This argument
  109.                   have to be given. You may also specify multiples sources,
  110.                   but in this case you must take care not to forget to specify
  111.                   a destination file, otherwise the last source file will be
  112.                   used as destination and will be overwritten !!!
  113.  
  114.         To      = This is the output file. Dependent to the other settings
  115.                   this contains the line and/or page numbers.
  116.                   The source and destination file cannot be the same.
  117.  
  118.         Numbers = This is the format string which should be used to add the
  119.                   line numbers to the source(s). This format string must
  120.                   contain a "%ld" anywhere. But you may also use "%#ld" or
  121.                   "%-#ld", where # is the number of chars which should be
  122.                   used and a leading `-` sign represents the filling direction.
  123.                   Please refer also to the printf, scanf conventions.
  124.  
  125.         PLen    = This number represents the number of lines per page. This
  126.                   option is importent for the page numbering. If this options
  127.                   is omitted a default number of 65 lines per page will be
  128.                   used.
  129.  
  130.         LnForm  = This is the format string which should be used for the page
  131.                   numberings. You may include a "%s" with the commandline but
  132.                   you have to specify a "%ld" anywhere. If you want to use
  133.                   the "%s", it must be appear in the format string before the
  134.                   "%ld" string.
  135.  
  136.         Quiet   = If this switch is given, no information to output will be
  137.                   sent.
  138.  
  139.  
  140.  
  141. Examples
  142.  
  143.     Here followes some examples how to change the behaviour of Pager
  144.  
  145.         1. Add line numbers to a text file with the name MyText.asc.
  146.            The text contains ca. 500 lines, so we use a 3 digit page
  147.            numbering format string.
  148.  
  149.            SHELL 1.>  Pager MyText.asc to Ram:MyText.numbers.asc N "%3ld"
  150.  
  151.         2. Add line numbers to a c source file and add also page numbers
  152.            after each 55 lines. The line numbers should include leading
  153.            0`s and 5 digits length.
  154.  
  155.            SHELL 1.>  Pager Source.c To Source.asc N "%05ld   : " P 55
  156.                             L "%s Now at page Number %ld"
  157.  
  158.         3. Add line numbers to three header files and add page numbers.
  159.            The output should be Header.sample.list and no messages should
  160.            be sent to output.
  161.  
  162.            SHELL 1.>  Pager Header1.h Header2.h Header3.h To
  163.                             Header.sample.list N "%3ld :" P "25"
  164.                             L "File: %s Page: %3ld" QUIET
  165.  
  166.  
  167.         After formatting a file with Pager you can easily print it out to
  168.         the printer. You may also specify "PRT:" for output, in which case
  169.         the formatted output will be immediately sent to the printer.
  170.  
  171.  
  172. Technical
  173.  
  174.         Pager is written in C with the Manx Aztec 5.2a Compiler System.
  175.  
  176.         I used the format string directly in those formatting function like
  177.         Printf etc.
  178.  
  179.  
  180. Address
  181.  
  182.         For all kind of suggestions, gifts, money etc. write to the
  183.         following  address:
  184.  
  185.                 Hans-Peter Günther
  186.                 Grüner Weg 5
  187.                 W-3501 Fuldatal 2
  188.                 GERMANY
  189.  
  190.  
  191. List Of File
  192.  
  193.         This package should contain the following files. IF you miss
  194.         something please le me know.
  195.  
  196.         Pager            :  the binary
  197.         Pager.info       :
  198.         Pager.doc        :  english documentation
  199.         Pager.doc.info   :
  200.         Pager.dok        :  german documentation
  201.         Pager.dok.info   :
  202.  
  203.  
  204.  
  205.