stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/man.justify.xml

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