blob: 82d15dd0c0695a08e0ebb157d9e716c50e9c8268 [file] [log] [blame]
<refentry xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="5.0" xml:id="man.output.better.ps.enabled">
<refmeta>
<refentrytitle>man.output.better.ps.enabled</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
</refmeta>
<refnamediv>
<refname>man.output.better.ps.enabled</refname>
<refpurpose>Enable enhanced print/PostScript output?</refpurpose>
</refnamediv>
<refsynopsisdiv>
<src:fragment xml:id="man.output.better.ps.enabled.frag">
<xsl:param name="man.output.better.ps.enabled">0</xsl:param>
</src:fragment>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>If the value of the
<parameter>man.output.better.ps.enabled</parameter> parameter is
non-zero, certain markup is embedded in each generated man page
such that PostScript output from the <command>man -Tps</command>
command for that page will include a number of enhancements
designed to improve the quality of that output.</para>
<para>If <parameter>man.output.better.ps.enabled</parameter> is
zero (the default), no such markup is embedded in generated man
pages, and no enhancements are included in the PostScript
output generated from those man pages by the <command>man
-Tps</command> command.</para>
<warning>
<para>The enhancements provided by this parameter rely on
features that are specific to groff (GNU troff) and that are
not part of “classic” AT&amp;T troff or any of its
derivatives. Therefore, any man pages you generate with this
parameter enabled will be readable only on systems on which
the groff (GNU troff) program is installed, such as GNU/Linux
systems. The pages <emphasis role="bold">will not not be
readable on systems on with the classic troff (AT&amp;T
troff) command is installed</emphasis>.</para>
</warning>
<para>The value of this parameter only affects PostScript output
generated from the <command>man</command> command. It has no
effect on output generated using the FO backend.</para>
<tip>
<para>You can generate PostScript output for any man page by
running the following command:</para>
<programlisting> man <replaceable>FOO</replaceable> -Tps > <replaceable>FOO</replaceable>.ps</programlisting>
<para>You can then generate PDF output by running the following
command:</para>
<programlisting> ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>
</tip>
</refsection>
</refentry>