home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Internet / WWW / Perl_WWW_Utilities / man2html / README < prev    next >
Encoding:
Text File  |  1995-12-20  |  3.1 KB  |  80 lines
  1. README for man2html
  2.  
  3.     A Unix manpage-to-HTML converter.
  4.  
  5. ---------------------------------------------------------------------------
  6.     Copyright (C) 1995  Earl Hood, ehood@convex.com
  7.  
  8.     This program is free software; you can redistribute it and/or modify
  9.     it under the terms of the GNU General Public License as published by
  10.     the Free Software Foundation; either version 2 of the License, or
  11.     (at your option) any later version.
  12.  
  13.     This program is distributed in the hope that it will be useful,
  14.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.     GNU General Public License for more details.
  17.  
  18.     You should have received a copy of the GNU General Public License
  19.     along with this program; if not, write to the Free Software
  20.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21. ---------------------------------------------------------------------------
  22. ---------------------------------------------------------------------------
  23. CONTENTS of distribution:
  24.  
  25. ACKNOWLEDGEMENTS  Thanks to people
  26. CHANGES          History of changes
  27. README          The file you are reading
  28. RELEASE_NOTES      Release notes for man2html (please read)
  29. doc/          Documentation
  30. examples/      Sample CGI programs that utilize man2html
  31. install.me      Installation program
  32. man2html*      Perl program
  33. man.cgi*      A CGI program for viewing man pages.  See source for
  34.           usage and configuration information.
  35. ---------------------------------------------------------------------------
  36. * Before running man2html, please read the RELEASE_NOTES file.
  37. ---------------------------------------------------------------------------
  38. INSTALLATION
  39.  
  40. To install man2html, type the following command:
  41.  
  42.     % perl install.me
  43.  
  44. The installation process will ask you a series of questions on where
  45. the Perl executable is and where to put man2html.  Just hit <CR>
  46. to accept the default values listed in ()'s.
  47.  
  48. Notes on installation process:
  49.  
  50.     o The '#!' line in the installed man2html program is set to point to
  51.       the Perl executable specified in the installation process.
  52.  
  53.     o If you specify paths that do not exist, the install.me program
  54.       will create the path.
  55.  
  56.     o man.cgi must be installed manually.
  57.  
  58. ---------------------------------------------------------------------------
  59. BUGS/COMMENTS/SUGGESTIONS?
  60.  
  61.     If you have any bugs/comments/suggestions about man2html, feel free
  62.     to drop me an e-mail message at ehood@convex.com.
  63.  
  64.     If it is a bug you are reporting, please include the following in
  65.     your message:
  66.  
  67.         o  Version of Perl (can be retrievied by "perl -v").
  68.         o  Version of the program in question.
  69.         o  The exact command-line used to invoke the program.
  70.         o  Error/diagnostic message from the program.
  71.         o  Any other information that might prove useful.
  72.  
  73.  
  74.     If you have questions on what man2html can, or cannot do, please
  75.     read the documnetation first.  If the docs do not answer your
  76.     question(s), feel free to e-mail me.
  77.  
  78. ---------------------------------------------------------------------------
  79. Earl Hood, ehood@convex.com
  80.