Elaborated the --footer option
[enscript.git] / docs / enscript.man
index 8097a4fbb09d2d1bf70389bcc57b97d0cd0f953f..473d7efd19e70abc591f4d857f05403b1e17c8bd 100644 (file)
@@ -4,22 +4,20 @@
 .\" Author: Markku Rossi <mtr@iki.fi>
 .\"
 .\"
-.\" This file is part of GNU enscript.
+.\" This file is part of GNU Enscript.
 .\"
-.\" This program is free software; you can redistribute it and/or modify
+.\" Enscript is free software: you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
-.\" the Free Software Foundation; either version 2, or (at your option)
-.\" any later version.
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
 .\"
-.\" This program is distributed in the hope that it will be useful,
+.\" Enscript is distributed in the hope that it will be useful,
 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\" GNU General Public License for more details.
 .\"
 .\" You should have received a copy of the GNU General Public License
-.\" along with this program; see the file COPYING.  If not, write to
-.\" the Free Software Foundation, 51 Franklin Street, Fifth Floor,
-.\" Boston, MA 02110-1301, USA.
+.\" along with Enscript.  If not, see <http://www.gnu.org/licenses/>.
 .\"
 .TH ENSCRIPT 1 "Mar 12, 1999" "ENSCRIPT" "ENSCRIPT"
 
@@ -60,7 +58,7 @@ overstrikes
 [\f3\-T \f2tabsize\f1]
 [\f3\-u\f1[\f2text\f1]]
 [\f3\-U \f2num\f1]
-[\f3\-W \f2language\f1]
+[\f3\-w \f2language\f1]
 [\f3\-X \f2encoding\f1]
 [\f2filename\f1 ...]
 
@@ -118,7 +116,7 @@ modification time.
 The header string \f2header\f1 can contain the same formatting escapes
 which can be specified for the \f3%Format\f1 directives in the user
 defined fancy headers.  For example, the following option prints the
-file name, current data and page numbers:
+file name, current date and page numbers:
 
 \f3enscript \-\-header='$n %W Page $% of $=' *.c\f1
 
@@ -159,7 +157,7 @@ For example, the command
 
 prints file foo.txt in duplex (two side) mode.
 
-Page device operators are implementation dependant but they are
+Page device operators are implementation dependent but they are
 standardized.  See section \f3PAGE DEVICE OPTIONS\f1 for the details.
 .TP 8
 .B \-e\f1[\f2char\f1]\f3, \-\-escapes\f1[\f3=\f2char\f1]\f3
@@ -179,7 +177,7 @@ languages and file formats with the command:
 .B enscript \-\-help\-highlight
 
 The highlighting rules are defined in the
-`@DATADIR@/enscript/st/*.st' files which can be edited to create
+`@DATADIR@/enscript/hl/*.st' files which can be edited to create
 highlighting definitions for new languages.
 
 \f3Note!\f1 You can not use your own input filters with this option.
@@ -194,6 +192,10 @@ font and its size in PostScript points.  For example,
 "\f3Times\-Roman12\f1" selects the "Times\-Roman" font with size
 12pt.
 
+The name of the font must appear in @DATADIR@/enscript/font.map and
+have a corresponding AFM file. See section \f3USING NEW FONTS\f1 for
+information on adding a font beyond the defaults.
+
 The font specification \f2name\f1 can also be given in format
 `\f2name\f1@\f2ptsize\f1', where the name of the font and its point
 size are separated by a `@' character.  This allows \f3enscript\f1 to use
@@ -338,7 +340,7 @@ size + baselineskip\f1) points down.  The default baseline skip is 1.
 Pass a statusdict definition to the generated PostScript output.  If
 no value is given, the key \f2key\f1 is removed from the definitions.
 
-The statusdict operators are implementation dependant; see the
+The statusdict operators are implementation dependent; see the
 printer's documentation for the details.
 
 For example, the command
@@ -375,7 +377,7 @@ Tell what \f3enscript\f1 is doing.
 .B \-V, \-\-version
 Print \f3enscript\f1 version information and exit.
 .TP 8
-.B \-W \f1[\f2lang\f1]\f3, \-\-language\f1[\f3=\f2lang\f1]\f3
+.B \-w \f1[\f2lang\f1]\f3, \-\-language\f1[\f3=\f2lang\f1]\f3
 Generate output for the language \f2lang\f1.  The possible values for
 \f2lang\f1 are:
 .RS 8
@@ -396,6 +398,9 @@ generate RTF (Rich Text Format)
 generate ANSI terminal control codes
 .RE
 .TP 8
+.B \-W \f2app\f1,\f2option\f3, \-\-language\f3=\f2app\f1,\f2option\f3
+pass the option \f2option\f3 to helper application \f2app\f3.
+.TP 8
 .B \-X \f2name\f3, \-\-encoding=\f2name\f3
 Use the input encoding \f2name\f1.  Currently \f3enscript\f1 supports
 the following encodings:
@@ -425,6 +430,9 @@ ISO\-8859\-9 (ISO Latin5)
 .B 885910, latin6
 ISO\-8859\-10 (ISO Latin6)
 .TP 8
+.B 885915, latin9
+ISO\-8859\-15 (ISO Latin9)
+.TP 8
 .B ascii
 7\-bit ascii
 .TP 8
@@ -490,7 +498,9 @@ value is an empty string ("") but some programs require that the
 .TP 8
 .B \-\-footer=\f2footer\f3
 Use the text \f2footer\f1 as a page footer.  Otherwise the option
-works like the \f3\-\-header\f1 option
+works like the \f3\-\-header\f1 option. As a default, the page has no footer.
+Setting this option does not necessary shows any footer strings in the output.
+It depends on the selected fancy header ('.hdr' file) whether it supports footer strings or not.
 .TP 8
 .B \-\-h\-column\-height=\f2height\f3
 Set the horizontal column height to be \f2height\f1 PostScript
@@ -595,7 +605,7 @@ from 1.
 .TP 8
 .B \-\-style=\f2style\f3
 Set the highlighting style to \f2style\f1.  The possible values are:
-\f3a2ps\f1, \f3emacs\f1, \f3emacs-verbose\f1, \f3ifh\f1, and
+\f3a2ps\f1, \f3emacs\f1, \f3emacs_verbose\f1, \f3ifh\f1, and
 \f3msvc\f1.
 .TP 8
 .B \-\-swap\-even\-page\-margins
@@ -623,10 +633,10 @@ default gray value is .8.
 Set the underlay text's starting position according to the
 \f2position_spec\f1.  The position specification must be given in
 format: `\f2sign\f1 \f2xpos\f1 \f2sign\f1 \f2ypos\f1', where the
-\f2sign\f1 must be `+' or `-'.  The positive dimensions are measured
+\f2sign\f1 must be `+' or `\-'.  The positive dimensions are measured
 from the lower left corner and the negative dimensions from the upper
-right corner.  For example, the specification `+0-0' specifies the
-upper left corner and `-0+0' specifies the lower right corner.
+right corner.  For example, the specification `+0\-0' specifies the
+upper left corner and `\-0+0' specifies the lower right corner.
 .TP 8
 .B \-\-ul\-style=\f2style\f3
 Set the underlay text's style to \f2style\f1.  The possible values for
@@ -739,7 +749,7 @@ various resources.  The default path is:
 the user's home directory.
 .TP 8
 .B MarkWrappedLines: \f2style\f3
-Mark wraped lines in the output with the style \f2style\f1.  The
+Mark wrapped lines in the output with the style \f2style\f1.  The
 possible values for the \f2format\f1 are the same which can be given
 for the \f3\-\-mark\-wrapped\-lines\f1 option.
 .TP 8
@@ -1327,13 +1337,13 @@ Print file \f3foo.txt\f1 to two columns.
 Print file to two columns and rotate output 90 degrees (landscape).
 .TP 8
 .B enscript \-DDuplex:true foo.txt
-Print file in duplex (two side) mode (printer dependant).
+Print file in duplex (two side) mode (printer dependent).
 .TP 8
 .B enscript \-G2rE \-U2 foo.c
 My default code printing command: gaudy header, two columns,
 landscape, code highlighting, 2-up printing.
 .TP 8
-\f3enscript \-E \-\-color \-Whtml \-\-toc -pfoo.html *.h *.c\f1
+\f3enscript \-E \-\-color \-whtml \-\-toc \-pfoo.html *.h *.c\f1
 A nice HTML report of your project's C source files.
 
 .SH ENVIRONMENT VARIABLES
@@ -1389,6 +1399,17 @@ some characters were unprintable
 ~/.enscript/                           personal resource directory
 .fi
 
+.SH USING NEW FONTS
+
+If you instruct enscript to use a font whose name does not appear in the
+font map, it will give the warning "couldn't open AFM file for font".
+
+To create an AFM file for a TrueType font, you can use \f3ttf2pt1\f1.
+
+Once you create the AFM file, you must add it to the font map.
+
+To generate a new font map automatically, use \f3mkafmmap\f1.
+
 .SH SEE ALSO
 diffpp(1), ghostview(1), gs(1), lpq(1), lpr(1), lprm(1), states(1)