git-scribe 0.0.3 → 0.0.4

data/docbook-xsl/params/man.indent.refsect.xml

@@ -0,0 +1,70 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.indent.refsect">
+<refmeta>
+<refentrytitle>man.indent.refsect</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.indent.refsect</refname>
+<refpurpose>Adjust indentation of refsect* and refsection?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.indent.refsect.frag">
+<xsl:param name="man.indent.refsect" select="0"/></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If the value of <parameter>man.indent.refsect</parameter> is
+non-zero, the width of the left margin for
+<tag>refsect1</tag>, <tag>refsect2</tag> and
+<tag>refsect3</tag> contents and titles (and first-level,
+second-level, and third-level nested
+<tag>refsection</tag>instances) is adjusted by the value of
+the <parameter>man.indent.width</parameter> parameter. With
+<parameter>man.indent.width</parameter> set to its default value of
+<literal>3n</literal>, the main results are that:
+
+<itemizedlist>
+  <listitem>
+    <para>contents of <tag>refsect1</tag> are output with a
+    left margin of three characters instead the roff default of seven
+    or eight characters</para>
+  </listitem>
+  <listitem>
+    <para>contents of <tag>refsect2</tag> are displayed in
+    console output with a left margin of six characters instead the of
+    the roff default of seven characters</para>
+  </listitem>
+  <listitem>
+    <para> the contents of <tag>refsect3</tag> and nested
+    <tag>refsection</tag> instances are adjusted
+    accordingly.</para>
+  </listitem>
+</itemizedlist>
+
+If instead the value of <parameter>man.indent.refsect</parameter> is
+zero, no margin adjustment is done for <literal>refsect*</literal>
+output.</para>
+
+<tip>
+  <para>If your content is primarly comprised of
+  <tag>refsect1</tag> and <tag>refsect2</tag> content
+  (or the <tag>refsection</tag> equivalent) – with few or
+  no <tag>refsect3</tag> or lower nested sections , you may be
+  able to “conserve” space in your output by setting
+  <parameter>man.indent.refsect</parameter> to a non-zero value. Doing
+  so will “squeeze” the left margin in such as way as to provide an
+  additional four characters of “room” per line in
+  <tag>refsect1</tag> output. That extra room may be useful
+  if, for example, you have many verbatim sections with long lines in
+  them.</para>
+</tip>
+
+</refsection>
+</refentry>

data/docbook-xsl/params/man.indent.verbatims.xml

@@ -0,0 +1,33 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.indent.verbatims">
+<refmeta>
+<refentrytitle>man.indent.verbatims</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.indent.verbatims</refname>
+<refpurpose>Adjust indentation of verbatims?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.indent.verbatims.frag">
+<xsl:param name="man.indent.verbatims" select="1"/></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If the value of <parameter>man.indent.verbatims</parameter> is
+non-zero, the width of the left margin for output of verbatim
+environments (<tag>programlisting</tag>,
+<tag>screen</tag>, and so on) is set to the value of the
+<parameter>man.indent.width</parameter> parameter
+(<literal>3n</literal> by default). If instead the value of
+<parameter>man.indent.verbatims</parameter> is zero, the built-in roff
+default width (<literal>7.2n</literal>) is used.</para>
+
+</refsection>
+</refentry>

data/docbook-xsl/params/man.indent.width.xml

@@ -0,0 +1,39 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.indent.width">
+<refmeta>
+<refentrytitle>man.indent.width</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.indent.width</refname>
+<refpurpose>Specifies width used for adjusted indents</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.indent.width.frag">
+<xsl:param name="man.indent.width">4</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para>The <parameter>man.indent.width</parameter> parameter specifies
+the width used for adjusted indents. The value of
+<parameter>man.indent.width</parameter> is used for indenting of
+lists, verbatims, headings, and elsewhere, depending on whether the
+values of certain <literal>man.indent.*</literal> boolean parameters
+are non-zero.</para>
+
+<para>The value of <parameter>man.indent.width</parameter> should
+include a valid roff measurement unit (for example,
+<literal>n</literal> or <literal>u</literal>). The default value of
+<literal>4n</literal> specifies a 4-en width; when viewed on a
+console, that amounts to the width of four characters. For details
+about roff measurment units, see the <literal>Measurements</literal>
+node in the groff info page.</para>
+
+</refsection>
+</refentry>

data/docbook-xsl/params/man.justify.xml

@@ -0,0 +1,52 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.justify">
+<refmeta>
+<refentrytitle>man.justify</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.justify</refname>
+<refpurpose>Justify text to both right and left margins?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.justify.frag">
+<xsl:param name="man.justify">0</xsl:param></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If non-zero, text is justified to both the right and left
+margins (or, in roff terminology, "adjusted and filled" to both the
+right and left margins). If zero (the default), text is adjusted to
+the left margin only -- producing what is traditionally called
+"ragged-right" text.</para>
+
+<note>
+<para>The default value for this parameter is zero because justified
+text looks good only when it is also hyphenated. Without hyphenation,
+excessive amounts of space often end up getting between words, in
+order to "pad" lines out to align on the right margin.</para>
+
+<para>The problem is that groff is not particularly smart about how it
+does hyphenation; it can end up hyphenating a lot of things that you
+don't want hyphenated. So, disabling both justification and
+hyphenation ensures that hyphens won't get inserted where you don't
+want to them, and you don't end up with lines containing excessive
+amounts of space between words.</para>
+
+<para>However, if do you decide to set a non-zero value for the
+<parameter>man.justify</parameter> parameter (to enable
+justification), then you should probably also set a non-zero value for
+<parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
+
+<para>Yes, these default settings run counter to how most existing man
+pages are formatted. But there are some notable exceptions, such as
+the <literal>perl</literal> man pages.</para>
+</note>
+</refsection>
+</refentry>

data/docbook-xsl/params/man.output.base.dir.xml

@@ -0,0 +1,39 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.base.dir">
+<refmeta>
+<refentrytitle>man.output.base.dir</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.base.dir</refname>
+<refpurpose>Specifies separate output directory</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.base.dir.frag"><xsl:param name="man.output.base.dir">man/</xsl:param></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The <parameter>man.output.base.dir</parameter> parameter
+specifies the base directory into which man-page files are output. The
+<parameter>man.output.subdirs.enabled</parameter> parameter controls
+whether the files are output in subdirectories within the base
+directory.</para>
+
+<note>
+  <para>The values of the <parameter>man.output.base.dir</parameter>
+  and <parameter>man.output.subdirs.enabled</parameter> parameters are
+  used only if the value of
+  <parameter>man.output.in.separate.dir</parameter> parameter is
+  non-zero. If the value of the
+  <parameter>man.output.in.separate.dir</parameter> is zero, man-page
+  files are not output in a separate directory.</para>
+</note>
+
+</refsection>
+</refentry>

data/docbook-xsl/params/man.output.encoding.xml

@@ -0,0 +1,53 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.encoding">
+<refmeta>
+<refentrytitle>man.output.encoding</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.encoding</refname>
+<refpurpose>Encoding used for man-page output</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.encoding.frag">
+<xsl:param name="man.output.encoding">UTF-8</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>This parameter specifies the encoding to use for files generated
+by the manpages stylesheet. Not all processors support specification
+of this parameter.</para>
+
+<important>
+  <para>If the value of the <parameter>man.charmap.enabled</parameter>
+  parameter is non-zero (the default), keeping the
+  <parameter>man.output.encoding</parameter> parameter at its default
+  value (<literal>UTF-8</literal>) or setting it to
+  <literal>UTF-16</literal> <emphasis role="bold">does not cause your
+  man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
+  any Unicode characters for which matches are found in the enabled
+  character map will be replaced with roff escape sequences before the
+  final man-page files are generated.</para>
+
+  <para>So if you want to generate "real" UTF-8 man pages, without any
+  character substitution being performed on your content, you need to
+  set <parameter>man.charmap.enabled</parameter> to zero (which will
+  completely disable character-map processing). </para>
+
+  <para>You may also need to set
+  <parameter>man.charmap.enabled</parameter> to zero if you want to
+  output man pages in an encoding other than <literal>UTF-8</literal>
+  or <literal>UTF-16</literal>. Character-map processing is based on
+  Unicode character values and may not work with other output
+  encodings.</para>
+</important>
+
+</refsection>
+</refentry>

data/docbook-xsl/params/man.output.in.separate.dir.xml

@@ -0,0 +1,32 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.in.separate.dir">
+<refmeta>
+<refentrytitle>man.output.in.separate.dir</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.in.separate.dir</refname>
+<refpurpose>Output man-page files in separate output directory?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.in.separate.dir.frag">
+<xsl:param name="man.output.in.separate.dir" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If the value of <literal>man.output.in.separate.dir</literal>
+parameter is non-zero, man-page files are output in a separate
+directory, specified by the <parameter>man.output.base.dir</parameter>
+parameter; otherwise, if the value of
+<literal>man.output.in.separate.dir</literal> is zero, man-page files
+are not output in a separate directory.</para>
+
+</refsection>
+</refentry>

data/docbook-xsl/params/man.output.lang.in.name.enabled.xml

@@ -0,0 +1,50 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.lang.in.name.enabled">
+<refmeta>
+<refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.lang.in.name.enabled</refname>
+<refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.lang.in.name.enabled.frag">
+<xsl:param name="man.output.lang.in.name.enabled" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+  <para>The <parameter>man.output.lang.in.name.enabled</parameter>
+  parameter specifies whether a <literal>$lang</literal> value is
+  included in man-page filenames and pathnames.</para>
+
+  <para>If the value of
+  <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
+  man-page files are output with the <literal>$lang</literal> value
+  included in their filenames or pathnames as follows;
+
+  <itemizedlist>
+    <listitem>
+      <para>if <parameter>man.output.subdirs.enabled</parameter> is
+      non-zero, each file is output to, e.g., a
+      <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
+      pathname</para>
+    </listitem>
+    <listitem>
+      <para>if <parameter>man.output.subdirs.enabled</parameter> is
+      zero, each file is output with a
+      <literal>foo.<replaceable>$lang</replaceable>.8</literal>
+      filename</para>
+    </listitem>
+  </itemizedlist>
+  </para>
+
+</refsection>
+</refentry>

data/docbook-xsl/params/man.output.manifest.enabled.xml

@@ -0,0 +1,27 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.manifest.enabled">
+  <refmeta>
+    <refentrytitle>man.output.manifest.enabled</refentrytitle>
+    <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+  </refmeta>
+  <refnamediv>
+    <refname>man.output.manifest.enabled</refname>
+    <refpurpose>Generate a manifest file?</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <src:fragment xml:id="man.output.manifest.enabled.frag"><xsl:param name="man.output.manifest.enabled" select="0"/></src:fragment>
+  </refsynopsisdiv>
+
+  <refsection><info><title>Description</title></info>
+
+    <para>If non-zero, a list of filenames for man pages generated by
+    the stylesheet transformation is written to the file named by the
+    <parameter>man.output.manifest.filename</parameter> parameter.</para>
+
+  </refsection>
+</refentry>

data/docbook-xsl/params/man.output.manifest.filename.xml

@@ -0,0 +1,29 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.manifest.filename">
+  <refmeta>
+    <refentrytitle>man.output.manifest.filename</refentrytitle>
+    <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+  </refmeta>
+  <refnamediv>
+    <refname>man.output.manifest.filename</refname>
+    <refpurpose>Name of manifest file</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <src:fragment xml:id="man.output.manifest.filename.frag"><xsl:param name="man.output.manifest.filename">MAN.MANIFEST</xsl:param></src:fragment>
+  </refsynopsisdiv>
+
+  <refsection><info><title>Description</title></info>
+
+    <para>The <parameter>man.output.manifest.filename</parameter> parameter
+    specifies the name of the file to which the manpages manifest file
+    is written (if the value of the
+    <parameter>man.output.manifest.enabled</parameter> parameter is
+    non-zero).</para>
+
+  </refsection>
+</refentry>

data/docbook-xsl/params/man.output.quietly.xml

@@ -0,0 +1,37 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.quietly">
+<refmeta>
+<refentrytitle>man.output.quietly</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.quietly</refname>
+<refpurpose>Suppress filename messages emitted when generating output?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.quietly.frag">
+<xsl:param name="man.output.quietly" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If zero (the default), for each man-page file created, a message
+with the name of the file is emitted. If non-zero, the files are
+output "quietly" -- that is, the filename messages are
+suppressed.</para>
+
+<tip>
+  <para>If you are processing a large amount of <tag>refentry</tag>
+  content, you may be able to speed up processing significantly by
+  setting a non-zero value for
+  <parameter>man.output.quietly</parameter>.</para>
+</tip>
+
+</refsection>
+</refentry>