doc/xslt/params/man.output.better.ps.enabled.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"
   2           xmlns:xlink="http://www.w3.org/1999/xlink"
   3           xmlns:xi="http://www.w3.org/2001/XInclude"
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   6           version="5.0" xml:id="man.output.better.ps.enabled">
   7 <refmeta>
   8 <refentrytitle>man.output.better.ps.enabled</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>man.output.better.ps.enabled</refname>
  13 <refpurpose>Enable enhanced print/PostScript output?</refpurpose>
  14 </refnamediv>
  15 <refsynopsisdiv>
  16 <src:fragment xml:id="man.output.better.ps.enabled.frag">
  17 <xsl:param name="man.output.better.ps.enabled">0</xsl:param>
  18 </src:fragment>
  19 </refsynopsisdiv>
  20 <refsection><info><title>Description</title></info>
  21
  22 <para>If the value of the
  23 <parameter>man.output.better.ps.enabled</parameter> parameter is
  24 non-zero, certain markup is embedded in each generated man page
  25 such that PostScript output from the <command>man -Tps</command>
  26 command for that page will include a number of enhancements
  27 designed to improve the quality of that output.</para>
  28
  29 <para>If <parameter>man.output.better.ps.enabled</parameter> is
  30 zero (the default), no such markup is embedded in generated man
  31 pages, and no enhancements are included in the PostScript
  32 output generated from those man pages by the <command>man
  33  -Tps</command> command.</para>
  34
  35 <warning>
  36   <para>The enhancements provided by this parameter rely on
  37     features that are specific to groff (GNU troff) and that are
  38     not part of “classic” AT&amp;T troff or any of its
  39     derivatives. Therefore, any man pages you generate with this
  40     parameter enabled will be readable only on systems on which
  41     the groff (GNU troff) program is installed, such as GNU/Linux
  42     systems. The pages <emphasis role="bold">will not not be
  43       readable on systems on with the classic troff (AT&amp;T
  44       troff) command is installed</emphasis>.</para>
  45 </warning>
  46
  47 <para>The value of this parameter only affects PostScript output
  48   generated from the <command>man</command> command. It has no
  49   effect on output generated using the FO backend.</para>
  50
  51 <tip>
  52   <para>You can generate PostScript output for any man page by
  53     running the following command:</para>
  54   <programlisting>  man <replaceable>FOO</replaceable> -Tps > <replaceable>FOO</replaceable>.ps</programlisting>
  55   <para>You can then generate PDF output by running the following
  56     command:</para>
  57   <programlisting>  ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>
  58 </tip>
  59
  60 </refsection>
  61 </refentry>