]> git.stg.codes - stg.git/blob - doc/xslt/params/man.output.lang.in.name.enabled.xml
More clear plugin API
[stg.git] / doc / xslt / params / man.output.lang.in.name.enabled.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.output.lang.in.name.enabled">
7 <refmeta>
8 <refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.output.lang.in.name.enabled</refname>
13 <refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.output.lang.in.name.enabled.frag">
18 <xsl:param name="man.output.lang.in.name.enabled" select="0"/>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24   <para>The <parameter>man.output.lang.in.name.enabled</parameter>
25   parameter specifies whether a <literal>$lang</literal> value is
26   included in man-page filenames and pathnames.</para>
27
28   <para>If the value of
29   <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
30   man-page files are output with the <literal>$lang</literal> value
31   included in their filenames or pathnames as follows;
32
33   <itemizedlist>
34     <listitem>
35       <para>if <parameter>man.output.subdirs.enabled</parameter> is
36       non-zero, each file is output to, e.g., a
37       <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
38       pathname</para>
39     </listitem>
40     <listitem>
41       <para>if <parameter>man.output.subdirs.enabled</parameter> is
42       zero, each file is output with a
43       <literal>foo.<replaceable>$lang</replaceable>.8</literal>
44       filename</para>
45     </listitem>
46   </itemizedlist>
47   </para>
48
49 </refsection>
50 </refentry>