man.justify.xml 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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.justify">
  7. <refmeta>
  8. <refentrytitle>man.justify</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.justify</refname>
  13. <refpurpose>Justify text to both right and left margins?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.justify.frag">
  17. <xsl:param name="man.justify">0</xsl:param></src:fragment>
  18. </refsynopsisdiv>
  19. <refsection><info><title>Description</title></info>
  20. <para>If non-zero, text is justified to both the right and left
  21. margins (or, in roff terminology, "adjusted and filled" to both the
  22. right and left margins). If zero (the default), text is adjusted to
  23. the left margin only -- producing what is traditionally called
  24. "ragged-right" text.</para>
  25. <note>
  26. <para>The default value for this parameter is zero because justified
  27. text looks good only when it is also hyphenated. Without hyphenation,
  28. excessive amounts of space often end up getting between words, in
  29. order to "pad" lines out to align on the right margin.</para>
  30. <para>The problem is that groff is not particularly smart about how it
  31. does hyphenation; it can end up hyphenating a lot of things that you
  32. don't want hyphenated. So, disabling both justification and
  33. hyphenation ensures that hyphens won't get inserted where you don't
  34. want to them, and you don't end up with lines containing excessive
  35. amounts of space between words.</para>
  36. <para>However, if do you decide to set a non-zero value for the
  37. <parameter>man.justify</parameter> parameter (to enable
  38. justification), then you should probably also set a non-zero value for
  39. <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
  40. <para>Yes, these default settings run counter to how most existing man
  41. pages are formatted. But there are some notable exceptions, such as
  42. the <literal>perl</literal> man pages.</para>
  43. </note>
  44. </refsection>
  45. </refentry>