diff options
Diffstat (limited to 'params/man.hyphenate.xml')
-rw-r--r-- | params/man.hyphenate.xml | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/params/man.hyphenate.xml b/params/man.hyphenate.xml new file mode 100644 index 0000000..9198bbb --- /dev/null +++ b/params/man.hyphenate.xml @@ -0,0 +1,59 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.hyphenate"> +<refmeta> +<refentrytitle>man.hyphenate</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.hyphenate</refname> +<refpurpose>Enable hyphenation?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.hyphenate.frag"> +<xsl:param name="man.hyphenate">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, hyphenation is enabled.</para> + +<note> +<para>The default value for this parameter is zero because groff is +not particularly smart about how it does hyphenation; it can end up +hyphenating a lot of things that you don't want hyphenated. To +mitigate that, the default behavior of the stylesheets is to suppress +hyphenation of computer inlines, filenames, and URLs. (You can +override the default behavior by setting non-zero values for the +<parameter>man.hyphenate.urls</parameter>, +<parameter>man.hyphenate.filenames</parameter>, and +<parameter>man.hyphenate.computer.inlines</parameter> parameters.) But +the best way is still to just globally disable hyphenation, as the +stylesheets do by default.</para> + +<para>The only good reason to enabled hyphenation is if you have also +enabled justification (which is disabled by default). The reason is +that justified text can look very bad unless you also hyphenate it; to +quote the <quote>Hypenation</quote> node from the groff info page: + +<blockquote> + <para><emphasis>Since the odds are not great for finding a set of + words, for every output line, which fit nicely on a line without + inserting excessive amounts of space between words, 'gtroff' + hyphenates words so that it can justify lines without inserting too + much space between words.</emphasis></para> +</blockquote> + +So, if you set a non-zero value for the +<parameter>man.justify</parameter> parameter (to enable +justification), then you should probably also set a non-zero value for +<parameter>man.hyphenate</parameter> (to enable hyphenation).</para> +</note> + + +</refsection> +</refentry> |