]> git.stg.codes - stg.git/blob - doc/xslt/params/man.indent.width.xml
Help book chapter 2 complete
[stg.git] / doc / xslt / params / man.indent.width.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.indent.width">
7 <refmeta>
8 <refentrytitle>man.indent.width</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.indent.width</refname>
13 <refpurpose>Specifies width used for adjusted indents</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.indent.width.frag">
18 <xsl:param name="man.indent.width">4</xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23 <para>The <parameter>man.indent.width</parameter> parameter specifies
24 the width used for adjusted indents. The value of
25 <parameter>man.indent.width</parameter> is used for indenting of
26 lists, verbatims, headings, and elsewhere, depending on whether the
27 values of certain <literal>man.indent.*</literal> boolean parameters
28 are non-zero.</para>
29
30 <para>The value of <parameter>man.indent.width</parameter> should
31 include a valid roff measurement unit (for example,
32 <literal>n</literal> or <literal>u</literal>). The default value of
33 <literal>4n</literal> specifies a 4-en width; when viewed on a
34 console, that amounts to the width of four characters. For details
35 about roff measurment units, see the <literal>Measurements</literal>
36 node in the groff info page.</para>
37
38 </refsection>
39 </refentry>