man.hyphenate.xml 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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.hyphenate">
  7. <refmeta>
  8. <refentrytitle>man.hyphenate</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.hyphenate</refname>
  13. <refpurpose>Enable hyphenation?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.hyphenate.frag">
  17. <xsl:param name="man.hyphenate">0</xsl:param></src:fragment>
  18. </refsynopsisdiv>
  19. <refsection><info><title>Description</title></info>
  20. <para>If non-zero, hyphenation is enabled.</para>
  21. <note>
  22. <para>The default value for this parameter is zero because groff is
  23. not particularly smart about how it does hyphenation; it can end up
  24. hyphenating a lot of things that you don't want hyphenated. To
  25. mitigate that, the default behavior of the stylesheets is to suppress
  26. hyphenation of computer inlines, filenames, and URLs. (You can
  27. override the default behavior by setting non-zero values for the
  28. <parameter>man.hyphenate.urls</parameter>,
  29. <parameter>man.hyphenate.filenames</parameter>, and
  30. <parameter>man.hyphenate.computer.inlines</parameter> parameters.) But
  31. the best way is still to just globally disable hyphenation, as the
  32. stylesheets do by default.</para>
  33. <para>The only good reason to enabled hyphenation is if you have also
  34. enabled justification (which is disabled by default). The reason is
  35. that justified text can look very bad unless you also hyphenate it; to
  36. quote the <quote>Hypenation</quote> node from the groff info page:
  37. <blockquote>
  38. <para><emphasis>Since the odds are not great for finding a set of
  39. words, for every output line, which fit nicely on a line without
  40. inserting excessive amounts of space between words, 'gtroff'
  41. hyphenates words so that it can justify lines without inserting too
  42. much space between words.</emphasis></para>
  43. </blockquote>
  44. So, if you set a non-zero value for the
  45. <parameter>man.justify</parameter> parameter (to enable
  46. justification), then you should probably also set a non-zero value for
  47. <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
  48. </note>
  49. </refsection>
  50. </refentry>