]> git.stg.codes - stg.git/blob - doc/xslt/params/man.hyphenate.filenames.xml
Ticket 26. The std::string modulePath variable definition moved after
[stg.git] / doc / xslt / params / man.hyphenate.filenames.xml
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.filenames">
7 <refmeta>
8 <refentrytitle>man.hyphenate.filenames</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.hyphenate.filenames</refname>
13 <refpurpose>Hyphenate filenames?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.hyphenate.filenames.frag">
18 <xsl:param name="man.hyphenate.filenames">0</xsl:param></src:fragment>
19 </refsynopsisdiv>
20
21 <refsection><info><title>Description</title></info>
22
23 <para>If zero (the default), hyphenation is suppressed for
24 <tag>filename</tag> output.</para>
25
26 <note>
27   <para>If hyphenation is already turned off globally (that is, if
28   <parameter>man.hyphenate</parameter> is zero, setting
29   <parameter>man.hyphenate.filenames</parameter> is not
30   necessary.</para>
31 </note>
32
33 <para>If <parameter>man.hyphenate.filenames</parameter> is non-zero,
34 filenames will not be treated specially and are subject to hyphenation
35 just like other words.</para>
36
37 <note>
38   <para>If you are thinking about setting a non-zero value for
39   <parameter>man.hyphenate.filenames</parameter> in order to make long
40   filenames/pathnames break across lines, you'd probably be better off
41   experimenting with setting the
42   <parameter>man.break.after.slash</parameter> parameter first. That
43   will cause long pathnames to be broken after slashes.</para>
44 </note>
45
46 </refsection>
47 </refentry>