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.break.after.slash">
|
---|
7 | <refmeta>
|
---|
8 | <refentrytitle>man.break.after.slash</refentrytitle>
|
---|
9 | <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
|
---|
10 | </refmeta>
|
---|
11 | <refnamediv>
|
---|
12 | <refname>man.break.after.slash</refname>
|
---|
13 | <refpurpose>Enable line-breaking after slashes?</refpurpose>
|
---|
14 | </refnamediv>
|
---|
15 |
|
---|
16 | <refsynopsisdiv>
|
---|
17 | <src:fragment xml:id="man.break.after.slash.frag">
|
---|
18 | <xsl:param name="man.break.after.slash">0</xsl:param></src:fragment>
|
---|
19 | </refsynopsisdiv>
|
---|
20 |
|
---|
21 | <refsection><info><title>Description</title></info>
|
---|
22 |
|
---|
23 | <para>If non-zero, line-breaking after slashes is enabled. This is
|
---|
24 | mainly useful for causing long URLs or pathnames/filenames to be
|
---|
25 | broken up or "wrapped" across lines (though it also has the side
|
---|
26 | effect of sometimes causing relatively short URLs and pathnames to be
|
---|
27 | broken up across lines too).</para>
|
---|
28 |
|
---|
29 | <para>If zero (the default), line-breaking after slashes is
|
---|
30 | disabled. In that case, strings containing slashes (for example, URLs
|
---|
31 | or filenames) are not broken across lines, even if they exceed the
|
---|
32 | maximum column widith.</para>
|
---|
33 |
|
---|
34 | <warning>
|
---|
35 | <para>If you set a non-zero value for this parameter, check your
|
---|
36 | man-page output carefuly afterwards, in order to make sure that the
|
---|
37 | setting has not introduced an excessive amount of breaking-up of URLs
|
---|
38 | or pathnames. If your content contains mostly short URLs or
|
---|
39 | pathnames, setting a non-zero value for
|
---|
40 | <parameter>man.break.after.slash</parameter> will probably result in
|
---|
41 | in a significant number of relatively short URLs and pathnames being
|
---|
42 | broken across lines, which is probably not what you want.</para>
|
---|
43 | </warning>
|
---|
44 |
|
---|
45 | </refsection>
|
---|
46 | </refentry>
|
---|