README
1README for man2html 3.0.1
2
3 A Unix manpage-to-HTML converter.
4
5---------------------------------------------------------------------------
6 Copyright (C) 1995-1997 Earl Hood, ehood@medusa.acs.uci.edu
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., 59 Temple Place - Suite 330, Boston, MA
21 02111-1307, USA
22
23---------------------------------------------------------------------------
24FILE LIST
25
26CHANGES History of changes
27MANIFEST List of files to install (used by install.me)
28README The file you are reading
29doc/ Documentation
30install.me Installation program
31man2html* Perl program
32man.cgi* A CGI program for viewing man pages. See source for
33 usage and configuration information.
34
35---------------------------------------------------------------------------
36RELEASE NOTES
37
38 This is the v3 release. The reason for the increment of the
39 major version number (from v2) is that man2html will run only
40 under Perl 5. man2html is no longer compatible with Perl 4.
41 Along with the change to Perl 5, several enhancments have been
42 made. See the CHANGES file for a summary.
43
44---------------------------------------------------------------------------
45INSTALLATION
46
47 To install man2html, type the following command:
48
49 % perl install.me
50
51 The installation process will ask you a series of questions on
52 where the Perl executable is and where to put man2html. Just hit
53 <CR> to accept the default values listed in ()'s.
54
55 Notes on installation process:
56
57 o The '#!' line in the installed man2html program is set
58 to point to the Perl executable specified in the
59 installation process.
60
61 o If you specify paths that do not exist, the install.me
62 program will create the path.
63
64 o man.cgi must be installed manually into you HTTP server's
65 cgi-bin directory. Read the start of man.cgi for any
66 site specific changes that may be required for proper
67 execution.
68
69---------------------------------------------------------------------------
70DOCUMENTATION
71
72 A manpage for man2html gets installed as part of the installation
73 process. The HTML, test, and PostScript versions of the
74 documentation (dervied from the manpage) are also provided in the
75 doc directory, but are not automatically installed by "install.me".
76
77---------------------------------------------------------------------------
78BUGS/COMMENTS/SUGGESTIONS?
79
80 If you have any bugs/comments/suggestions about man2html, feel
81 free to drop me an e-mail message at ehood@medusa.acs.uci.edu.
82
83 If it is a bug you are reporting, please include the following
84 in your message:
85
86 o Version of Perl (can be retrievied by "perl -v").
87 o Version of the program in question.
88 o The exact command-line used to invoke the program.
89 o Error/diagnostic message from the program.
90 o Any other information that might prove useful.
91
92
93 If you have questions on what man2html can, or cannot do, please
94 read the documentation first. If the docs do not answer your
95 question(s), feel free to e-mail me.
96
97---------------------------------------------------------------------------
98Earl Hood, ehood@medusa.acs.uci.edu
9997/08/12 13:18:15
100