source: pst/ps/enscript.xml

trunk
Last change on this file was 6b33b5b, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Finish tagging for chapters 46-50.
  • Property mode set to 100644
File size: 8.6 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!-- Keeping this URL as this is the actual maintainer's site
8 <!ENTITY enscript-download-http "http://www.iki.fi/mtr/genscript/enscript-&enscript-version;.tar.gz">
9 -->
10
11 <!ENTITY enscript-download-http "&gnu-http;/enscript/enscript-&enscript-version;.tar.gz">
12 <!ENTITY enscript-download-ftp " ">
13 <!ENTITY enscript-md5sum "3acc242b829adacabcaf28533f049afd">
14 <!ENTITY enscript-size "1.3 MB">
15 <!ENTITY enscript-buildsize "14 MB">
16 <!ENTITY enscript-time "0.1 SBU">
17]>
18
19<sect1 id="enscript" xreflabel="Enscript-&enscript-version;">
20 <?dbhtml filename="enscript.html"?>
21
22
23 <title>Enscript-&enscript-version;</title>
24
25 <indexterm zone="enscript">
26 <primary sortas="a-Enscript">Enscript</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Enscript</title>
31
32 <para>
33 <application>Enscript</application> converts ASCII text files
34 to PostScript, HTML, RTF, ANSI and overstrikes.
35 </para>
36
37 &lfs121_checked;
38
39 <caution>
40 <para>
41 <application>Enscript</application> cannot convert UTF-8 encoded
42 text to PostScript. The issue is discussed in detail in the
43 <xref linkend="locale-not-valid-option"/> section of the
44 <xref linkend="locale-issues"/> page.
45 The solution is to use <xref linkend="paps"/>, instead of
46 <application>Enscript</application>, for converting
47 UTF-8 encoded text to PostScript.
48 </para>
49 </caution>
50
51 <bridgehead renderas="sect3">Package Information</bridgehead>
52 <itemizedlist spacing="compact">
53 <listitem>
54 <para>
55 Download (HTTP): <ulink url="&enscript-download-http;"/>
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download (FTP): <ulink url="&enscript-download-ftp;"/>
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Download MD5 sum: &enscript-md5sum;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Download size: &enscript-size;
71 </para>
72 </listitem>
73 <listitem>
74 <para>
75 Estimated disk space required: &enscript-buildsize;
76 </para>
77 </listitem>
78 <listitem>
79 <para>
80 Estimated build time: &enscript-time;
81 </para>
82 </listitem>
83 </itemizedlist>
84
85 <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
86 <itemizedlist spacing="compact">
87 <listitem>
88 <para>
89 Required patch: <ulink url=
90 "&patch-root;/enscript-&enscript-version;-security_fixes-1.patch"/>
91 </para>
92 </listitem>
93 </itemizedlist> -->
94
95 <bridgehead renderas="sect3">Enscript Dependencies</bridgehead>
96
97 <bridgehead renderas="sect4">Optional</bridgehead>
98 <para role="optional">
99 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
100 </para>
101
102 </sect2>
103
104 <sect2 role="installation">
105 <title>Installation of Enscript</title>
106
107 <para>
108 Install <application>Enscript</application> by running the
109 following commands:
110 </para>
111
112<screen><userinput>./configure --prefix=/usr \
113 --sysconfdir=/etc/enscript \
114 --localstatedir=/var \
115 --with-media=Letter &amp;&amp;
116make &amp;&amp;
117
118pushd docs &amp;&amp;
119 makeinfo --plaintext -o enscript.txt enscript.texi &amp;&amp;
120popd</userinput></screen>
121
122 <para>
123 If you have <xref linkend="texlive"/> installed, you can create
124 Postscript and PDF documentation by issuing (does not support parallel
125 make):
126 </para>
127
128<screen remap="doc"><userinput>make -j1 -C docs ps pdf</userinput></screen>
129
130 <para>
131 To test the results, issue: <command>make check</command>.
132 </para>
133
134 <para>
135 Now, as the <systemitem class="username">root</systemitem> user:
136 </para>
137
138<screen role="root"><userinput>make install &amp;&amp;
139
140install -v -m755 -d /usr/share/doc/enscript-&enscript-version; &amp;&amp;
141install -v -m644 README* *.txt docs/*.txt \
142 /usr/share/doc/enscript-&enscript-version;</userinput></screen>
143
144 <para>
145 If you built Postscript and PDF documentation, install it
146 using the following command as the
147 <systemitem class="username">root</systemitem> user:
148 </para>
149
150<screen role="root"
151 remap="doc"><userinput>install -v -m644 docs/*.{dvi,pdf,ps} \
152 /usr/share/doc/enscript-&enscript-version;</userinput></screen>
153 </sect2>
154
155 <sect2 role="commands">
156 <title>Command Explanations</title>
157
158 <para>
159 <parameter>--sysconfdir=/etc/enscript</parameter>: This switch puts
160 configuration data in <filename class="directory">/etc/enscript</filename>
161 instead of <filename class="directory">/usr/etc</filename>.
162 </para>
163
164 <para>
165 <parameter>--localstatedir=/var</parameter>: This switch sets the
166 directory for runtime data to <filename class="directory">/var</filename>
167 instead of <filename class="directory">/usr/var</filename>.
168 </para>
169
170 <para>
171 <parameter>--with-media=Letter</parameter>: This switch sets the
172 medium format to letter size instead of the A4 default.
173 </para>
174 </sect2>
175
176 <sect2 role="content">
177 <title>Contents</title>
178
179 <segmentedlist>
180 <segtitle>Installed Programs</segtitle>
181 <segtitle>Installed Libraries</segtitle>
182 <segtitle>Installed Directories</segtitle>
183
184 <seglistitem>
185 <seg>diffpp, enscript, mkafmmap, over, sliceprint,
186 and states</seg>
187 <seg>None</seg>
188 <seg>/etc/enscript, /usr/share/doc/enscript-&enscript-version;, and
189 /usr/share/enscript</seg>
190 </seglistitem>
191 </segmentedlist>
192
193 <variablelist>
194 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
195 <?dbfo list-presentation="list"?>
196 <?dbhtml list-presentation="table"?>
197
198 <varlistentry id="diffpp">
199 <term><command>diffpp</command></term>
200 <listitem>
201 <para>
202 converts <command>diff</command> output files to a format
203 suitable to be printed with <command>enscript</command>
204 </para>
205 <indexterm zone="enscript diffpp">
206 <primary sortas="b-diffpp">diffpp</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="enscript-prog">
212 <term><command>enscript</command></term>
213 <listitem>
214 <para>
215 is a filter, used primarily by printing scripts, that
216 converts ASCII text files to PostScript, HTML, RTF, ANSI and
217 overstrikes
218 </para>
219 <indexterm zone="enscript enscript-prog">
220 <primary sortas="b-enscript">enscript</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="mkafmmap">
226 <term><command>mkafmmap</command></term>
227 <listitem>
228 <para>
229 creates a font map from a given file
230 </para>
231 <indexterm zone="enscript mkafmmap">
232 <primary sortas="b-mkafmmap">mkafmmap</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="over">
238 <term><command>over</command></term>
239 <listitem>
240 <para>
241 is a script which calls <command>enscript</command> and
242 passes the correct parameters to create overstriked fonts
243 </para>
244 <indexterm zone="enscript over">
245 <primary sortas="b-over">over</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="sliceprint">
251 <term><command>sliceprint</command></term>
252 <listitem>
253 <para>
254 slices documents with long lines
255 </para>
256 <indexterm zone="enscript sliceprint">
257 <primary sortas="b-sliceprint">sliceprint</primary>
258 </indexterm>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry id="states">
263 <term><command>states</command></term>
264 <listitem>
265 <para>
266 is an <command>awk</command>-like text processing tool
267 with some state machine extensions. It is designed for program
268 source code highlighting and for similar tasks where state
269 information helps input processing
270 </para>
271 <indexterm zone="enscript states">
272 <primary sortas="b-states">states</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 </variablelist>
278
279 </sect2>
280
281</sect1>
Note: See TracBrowser for help on using the repository browser.