Blame params/man.output.better.ps.enabled.xml

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