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