home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / os20 / man-1.9.lha / Man / Man.doc < prev    next >
Text File  |  1994-01-31  |  7KB  |  281 lines
  1.  
  2.  MAN, written by Kai Iske July 27. 1993
  3.       This is PUBLIC DOMAIN; you may do with it whatever you like
  4.  
  5.  
  6. If you change/republish/delete/sell the program or do anything similar, please
  7. be so kind to keep my name within the program and all the other files.
  8.  
  9. MAN  was  written  because  of  the fact that MRMan (by Mark Rinfret) had some
  10. severe  problems  under  OS 2.x (or was it 3.x).  Anyway, I wrote this tool in
  11. order not to have to keep in mind the locations of all the various man pages I
  12. spread across the subdirectories of my MAN:  directory.
  13.  
  14. MAN was written using SAS 6.3 / 6.50....
  15.  
  16. !!! Man requires OS 2.x and up to run !!!
  17.  
  18.  
  19. -----------------
  20. What does MAN ???
  21. -----------------
  22.  
  23.  
  24. Well, it is a MAN command similar to the one found on any UNIX System.  Simply
  25. type  "man dummy" and the manual pages (documentation) for a file called dummy
  26. will  be searched for.  If man was successful in finding the appropriate file,
  27. a textviewer will be used to display the documentation.
  28.  
  29. You may configure MAN in order to tell the program where to find the man pages
  30. and  what  text  viewers  to  use.   Wait a minute.  Textviewers ???  Yep, MAN
  31. recognizes the following suffixes as to be part of man pages:
  32.  
  33.   .doc   - Simple ASCII text file
  34.   .man   - Simple ASCII text file
  35.   .guide - Got it, AmigaGuide compatible guide file.
  36.  
  37. So now you know why there are different textviewers.
  38.  
  39.    For example...
  40.  
  41.       You have the documentation for a program called "KCommodity" somewhere
  42.       within your docs directory. The doc file is called "KCommodity.Man". In
  43.       order to get the documentation loaded by man, simply type:
  44.  
  45.           MAN KCommodity
  46.  
  47.       ...and the ASCII textviewer will be used. If your filename ends up with
  48.       .guide ("KCommodity.guide"), MAN assumes it to be a GUIDE file and will
  49.       use the GUIDE Viewer instead...
  50.  
  51.       See, no suffixes needed. MAN will take the first file matching a
  52.       suffix mentioned above.
  53.  
  54.  
  55. You may even add features to MAN using environment variables. Read on...
  56.  
  57.  
  58. ----------------------
  59. How to install MAN ???
  60. ----------------------
  61.  
  62. Copy the main program to a directory within your search paths (i.e. C:).
  63.  
  64. Simply an environment variable, so that MAN knows what to do.
  65. The template for this variable (MANOPT) is as follows:
  66.  
  67.    MANPATHS/K/A,MANVIEW/K/A,MANVIEWAG/K/A,MANNRMEXT/K,MANAGEXT/K,MANNOVIEW/K,
  68.    MANGETFILE/S
  69.  
  70.  
  71.   *REMEMBER* to enclose parameters containing spaces by quotes. If you don`t
  72. want to write a file MANOPT to your ENVARC: directory but like to use SetEnv
  73. from within your S:User-StartUp file, use something like this :
  74.  
  75.  
  76.   SetEnv MANOPT "... MANVIEWAG=*"SYS:Utilities/AmigaGuide PUBSCREEN 'Dummy'*""
  77.  
  78. The ellipsis "..." is only meant to shorten the example, of course you have
  79. to add the other (needed) parameters as well. You see, if you want to set a
  80. variable to a string which contains spaces you have to use the special
  81. escape charater *" to force quotes.
  82.  
  83.  
  84.                              --------------------
  85.  
  86.  
  87. The meaning of the keywords :
  88.  
  89.    MANPATHS  - This option tells man where to look for man pages.
  90.  
  91.    For example...
  92.  
  93.       MANPATHS=MAN:,MAN:CSHDOC|MAN:HPDOCS,MAN:AUTODOCS
  94.  
  95.    You see, you may either use "," or the "|" as seperators between
  96.    directory names.
  97.  
  98.  
  99.  
  100.  
  101.    MANVIEW   - This one is the path (including filename) for the
  102.                textviewer you wish to use for displaying normal
  103.                ASCII files.
  104.  
  105.    For example...
  106.  
  107.       MANVIEW=SYS:Utilities/More
  108.  
  109.    REMEMBER: Complete path and filename
  110.  
  111.  
  112.  
  113.  
  114.  
  115.    MANVIEWAG - This one is used to set the path (and filename) for
  116.                the AmigaGuide GUIDE-Viewer.
  117.  
  118.    For example...
  119.  
  120.       MANVIEWAG=SYS:Utilities/AmigaGuide
  121.  
  122.    REMEMBER : Complete path and filename
  123.  
  124.  
  125.  
  126.  
  127. Additionally there are three more keywords you may use to add
  128. extensions and functions to man. These are :
  129.  
  130.    MANNRMEXT - You may use this option to add extensions to the already
  131.                known, which should be treated (shown) as plain ASCII files.
  132.  
  133.    For example...
  134.  
  135.       MANNRMEXT=.txt|.asc|.dok
  136.  
  137.    Will add these extensions to known ASCII files
  138.  
  139.  
  140.  
  141.  
  142.    MANAGEXT  - Using this option you may add extensions for AmigaGuide
  143.                files
  144.  
  145.    For example
  146.  
  147.       MANAGEXT=.bla|.blo|.blu
  148.  
  149.    Will add these extensions to known AmigaGuide compatible files
  150.  
  151.  
  152.  
  153.  
  154.    MANNOVIEW - If a file doesn`t end up with an extension (starting with a
  155.                dot), MAN will use the predefined ASCII viewer to display
  156.                such a file. You may change the viewer for such files using
  157.                this option. Additionally this option may be turned off,
  158.                when you issue "NONE".
  159.  
  160.    For example
  161.  
  162.       MANNOVIEW=SYS:Utilities/AmigaGuide
  163.  
  164.    Will tell MAN to display files, without extension, using AmigaGuide
  165.  
  166.  
  167.  
  168.    MANGETFILE- If MAN didn`t succeed in finding the required man page
  169.                it will pop up a FileRequester asking for a file to
  170.                be loaded.
  171.  
  172.                Simply add this option to your MANOPT environment var,
  173.                if you want MAN to pop up a FileRequester.
  174.  
  175.  
  176.  
  177. A more complete example
  178.  
  179.  
  180.    SetEnv MANOPT "MANPATHS=docs:|guide: MANVIEW=More MANVIEWAG=AmigaGuide"
  181.  
  182.  
  183.  
  184. It is best to place this line within your S:User-StartUp file.
  185.  
  186.  
  187.                              --------------------
  188.  
  189.  
  190.  
  191. -----------
  192. Version 1.0
  193. -----------
  194.   - initial release
  195.  
  196.  
  197. -----------
  198. Version 1.1
  199. -----------
  200.   - Accidentially called Exit() instead of exit(), which
  201.     prevented the program to pass the cleanup code of SAS.
  202.     So a lock to the directory was kept and the shell could
  203.     never been left.............
  204.  
  205.  
  206. -----------
  207. Version 1.2
  208. -----------
  209.   - Used MAN as a keyword for the template which prevented MAN
  210.     to accept inputs like "man man".
  211.  
  212.  
  213. -----------
  214. Version 1.3
  215. -----------
  216.   - Added CTRL-C checking
  217.   - Recompiled using SAS 6.50
  218.   - Reduced stack usage
  219.   - Reduced executable size
  220.  
  221.  
  222. -----------
  223. Version 1.4
  224. -----------
  225.   - DOS-Library wasn`t closed
  226.  
  227.  
  228. -----------
  229. Version 1.5
  230. -----------
  231.   - Referenced free memory area
  232.  
  233.  
  234. -----------
  235. Version 1.6
  236. -----------
  237.   - Added MANRMEXT, MANAGEXT and MANNOVIEW options,
  238.     which may be used for extensibility of MAN
  239.     (Somehow suggested by : Michael 'Mick' Hohmann)
  240.  
  241.  
  242. -----------
  243. Version 1.7
  244. -----------
  245.   - All config variables have been moved to a single one,
  246.     which will be parsed just like a CommandLine
  247.     (Suggested by : Michael 'Mick' Hohmann)
  248.  
  249.  
  250. -----------
  251. Version 1.8
  252. -----------
  253.   - Man now correctly handles multi-assigns, since ExAll
  254.     doesn`t....;)
  255.     (Reported by : Jan Hoeydahl)
  256.  
  257.  
  258. -----------
  259. Version 1.9
  260. -----------
  261.   - Recompiled using SAS/C 6.51
  262.   - Added MANGETFILE parameter
  263.     (Requested by : Bill Hogsett)
  264.  
  265. Hope you like it, if not, delete it......
  266.  
  267.  
  268.  
  269. So long,
  270.  
  271.      Kai
  272.  
  273.  
  274.  
  275.  
  276.  --- Kai Iske
  277.  Brucknerstrasse 18, 63452 Hanau, Germany, Tel.: +49-(0)6181-850181
  278.  Z-Net    : KAI@SWEET.ZER            usenet : kai@iske.adsp.sub.org
  279.  internet : iske@informatik.uni-frankfurt.de              IRC:kiske
  280.  ---- Life sucks ----
  281.