data/man/test-tags-config.1.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!--
   3
   4 `xsltproc -''-nonet \
   5           -''-param man.charmap.use.subset "0" \
   6           -''-param make.year.ranges "1" \
   7           -''-param make.single.year.ranges "1" \
   8           /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
   9           manpage.xml'
  10
  11 A manual page <package>.<section> will be generated. You may view the
  12 manual page with: nroff -man <package>.<section> | less'. A typical entry
  13 in a Makefile or Makefile.am is:
  14
  15 DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
  16 XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
  17
  18 manpage.1: manpage.xml
  19         $(XP) $(DB2MAN) $<
  20
  21 The xsltproc binary is found in the xsltproc package. The XSL files are in
  22 docbook-xsl. A description of the parameters you can use can be found in the
  23 docbook-xsl-doc-* packages. Please remember that if you create the nroff
  24 version in one of the debian/rules file targets (such as build), you will need
  25 to include xsltproc and docbook-xsl in your Build-Depends control field.
  26 Alternatively use the xmlto command/package. That will also automatically
  27 pull in xsltproc and docbook-xsl.
  28
  29 Notes for using docbook2x: docbook2x-man does not automatically create the
  30 AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
  31 <refsect1> ... </refsect1>.
  32
  33 To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
  34 read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
  35 found in the docbook-xsl-doc-html package.
  36
  37 Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
  38
  39 General documentation about man-pages and man-page-formatting:
  40 man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
  41
  42 -->
  43 <!DOCTYPE refentry [
  44
  45   <!ENTITY dhsection   "1">
  46   <!ENTITY dhpackage "mpd-sima">
  47   <!ENTITY dhutils "test-tags-config">
  48
  49 ]>
  50
  51 <refentry xmlns="http://docbook.org/ns/docbook"
  52           xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0">
  53   <xi:include href="info.xml" />
  54   <refmeta>
  55       <refentrytitle>&dhutils;</refentrytitle>
  56       <manvolnum>&dhsection;</manvolnum>
  57   </refmeta>
  58   <refnamediv>
  59     <refname>&dhutils;</refname>
  60     <refpurpose>controls tags plugin configuration.</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhutils;</command>
  65       <arg choice="req"><option>config_file</option></arg>
  66     </cmdsynopsis>
  67   </refsynopsisdiv>
  68   <refsect1 id="description">
  69     <title>DESCRIPTION</title>
  70     <para>This manual page documents briefly the
  71       <command>&dhutils;</command> commands.</para>
  72     <para>
  73       <command>&dhutils;</command>
  74       will load <varname>config_file</varname> passed as argument and look for tags plugin configuration to query MPD with it. There is no attempt to auto-discover configuration file, positional argument is required.<sbr />
  75       See also environment variables special case for MPD host and port in <xref linkend="environment"/>.
  76     </para>
  77   </refsect1>
  78   <xi:include href="files.xml" />
  79   <refsect1 id="environment">
  80       <title>ENVIRONMENT</title>
  81       <variablelist>
  82           <varlistentry>
  83               <term><envar>MPD_HOST</envar>, <envar>MPD_PORT</envar></term>
  84               <listitem>
  85                   <para>&dhutils; will look for <envar>MPD_HOST</envar> and
  86                       <envar>MPD_PORT</envar> to override built-in configuration
  87                       (set to "localhost:6600").</para>
  88                   <para>&dhutils; expects <envar>MPD_HOST</envar> syntax as documented in mpc manual,
  89                       cf. <citerefentry><refentrytitle>mpc</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  90                       <sbr/>To use a password, provide a value of the form "password@host".
  91                   </para>
  92               </listitem>
  93           </varlistentry>
  94           <varlistentry>
  95               <term><envar>HTTP_PROXY</envar>, <envar>HTTPS_PROXY</envar></term>
  96               <listitem>
  97                   <para>&dhutils; honors <envar>HTTP_PROXY</envar> environment variables.</para>
  98               </listitem>
  99           </varlistentry>
 100       </variablelist>
 101   </refsect1>
 102   <xi:include href="feedback.xml" />
 103   <xi:include href="seealso.xml" />
 104 </refentry>