man.output.better.ps.enabled.xml 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  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. <para>If the value of the
  22. <parameter>man.output.better.ps.enabled</parameter> parameter is
  23. non-zero, certain markup is embedded in each generated man page
  24. such that PostScript output from the <command>man -Tps</command>
  25. command for that page will include a number of enhancements
  26. designed to improve the quality of that output.</para>
  27. <para>If <parameter>man.output.better.ps.enabled</parameter> is
  28. zero (the default), no such markup is embedded in generated man
  29. pages, and no enhancements are included in the PostScript
  30. output generated from those man pages by the <command>man
  31. -Tps</command> command.</para>
  32. <warning>
  33. <para>The enhancements provided by this parameter rely on
  34. features that are specific to groff (GNU troff) and that are
  35. not part of “classic” AT&amp;T troff or any of its
  36. derivatives. Therefore, any man pages you generate with this
  37. parameter enabled will be readable only on systems on which
  38. the groff (GNU troff) program is installed, such as GNU/Linux
  39. systems. The pages <emphasis role="bold">will not not be
  40. readable on systems on with the classic troff (AT&amp;T
  41. troff) command is installed</emphasis>.</para>
  42. </warning>
  43. <para>The value of this parameter only affects PostScript output
  44. generated from the <command>man</command> command. It has no
  45. effect on output generated using the FO backend.</para>
  46. <tip>
  47. <para>You can generate PostScript output for any man page by
  48. running the following command:</para>
  49. <programlisting> man <replaceable>FOO</replaceable> -Tps > <replaceable>FOO</replaceable>.ps</programlisting>
  50. <para>You can then generate PDF output by running the following
  51. command:</para>
  52. <programlisting> ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>
  53. </tip>
  54. </refsection>
  55. </refentry>