debian/manpage.xml

   1 <?xml version='1.0' encoding='ISO-8859-1'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!--
   6
   7 Process this file with an XSLT processor: `xsltproc \
   8 -''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
   9 manpages/docbook.xsl manpage.dbk'.  A manual page
  10 <package>.<section> will be generated.  You may view the
  11 manual page with: nroff -man <package>.<section> | less'.  A
  12 typical entry in a Makefile or Makefile.am is:
  13
  14 DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
  15 manpages/docbook.xsl
  16 XP=xsltproc -''-nonet
  17
  18 manpage.1: manpage.dbk
  19         $(XP) $(DB2MAN) $<
  20
  21 The xsltproc binary is found in the xsltproc package.  The
  22 XSL files are in docbook-xsl.  Please remember that if you
  23 create the nroff version in one of the debian/rules file
  24 targets (such as build), you will need to include xsltproc
  25 and docbook-xsl in your Build-Depends control field.
  26
  27 -->
  28
  29   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  30   <!ENTITY dhfirstname "<firstname>Hans</firstname>">
  31   <!ENTITY dhsurname   "<surname>Baier</surname>">
  32   <!-- Please adjust the date whenever revising the manpage. -->
  33   <!ENTITY dhdate      "<date>März  6, 2009</date>">
  34   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  35        allowed: see man(7), man(1). -->
  36   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  37   <!ENTITY dhemail     "<email>hansfbaier@googlemail.com</email>">
  38   <!ENTITY dhusername  "Hans Baier">
  39   <!ENTITY dhucpackage "<refentrytitle>JACKPANEL</refentrytitle>">
  40   <!ENTITY dhpackage   "jackpanel">
  41
  42   <!ENTITY debian      "<productname>Debian</productname>">
  43   <!ENTITY gnu         "<acronym>GNU</acronym>">
  44   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  45 ]>
  46
  47 <refentry>
  48   <refentryinfo>
  49     <address>
  50       &dhemail;
  51     </address>
  52     <copyright>
  53       <year>2009</year>
  54       <holder>&dhusername;</holder>
  55     </copyright>
  56     &dhdate;
  57   </refentryinfo>
  58   <refmeta>
  59     &dhucpackage;
  60
  61     &dhsection;
  62   </refmeta>
  63   <refnamediv>
  64     <refname>&dhpackage;</refname>
  65
  66     <refpurpose>GTK/GNOME based control application for the JACK audio server</refpurpose>
  67   </refnamediv>
  68   <refsynopsisdiv>
  69     <cmdsynopsis>
  70       <command>&dhpackage;</command>
  71     </cmdsynopsis>
  72   </refsynopsisdiv>
  73   <refsect1>
  74     <title>DESCRIPTION</title>
  75
  76     <para>This manual page documents briefly the
  77       <command>&dhpackage;</command> command
  78     </para>
  79
  80     <para><command>&dhpackage;</command> is a program that controls the JACK audio server.
  81     </para>
  82
  83     <para>
  84         When started the first time, &dhpackage; reads $HOME/.jackdrc and
  85         stores the settings in its configuration store in $HOME/.gconf/apps/jackpanel.
  86         After that the .jackdrc only the GConf store is used for reading the
  87         JACK server settings.
  88     </para>
  89
  90     <para>
  91         When Settings like samplerate or buffersize or realtime are changed in
  92         the user interface, the configuration store is automatically updated.
  93     </para>
  94
  95     <para>
  96         Currently only ALSA driver options are supported.
  97     </para>
  98
  99     <para>
 100         When you double / triple click on the fast forward/backward
 101         buttons, the winding speed is doubled or tripled respectively.
 102     </para>
 103
 104     <para>
 105         &dhpackage; is also available as a GNOME panel applet and thus
 106         can be added via GNOME. It features a mini display in the gnome
 107         panel. When double clicked, the same window as standalone &dhpackage;
 108         is opened. Please note that currently it is only possible to change realtime settings
 109         or samplerate, if the JACK server had been started by &dhpackage; or the
 110         panel applet.
 111     </para>
 112
 113   </refsect1>
 114   <refsect1>
 115     <title>OPTIONS</title>
 116
 117     <para>This program recognizes no command line options</para>
 118
 119   </refsect1>
 120   <refsect1>
 121     <title>SEE ALSO</title>
 122
 123     <para>jackd (1)</para>
 124
 125
 126   </refsect1>
 127   <refsect1>
 128     <title>AUTHOR</title>
 129
 130     <para>This manual page was written by &dhusername; &dhemail; for
 131       the &debian; system (but may be used by others).  Permission is
 132       granted to copy, distribute and/or modify this document under
 133       the terms of the &gnu; General Public License, Version 2 any
 134           later version published by the Free Software Foundation.
 135     </para>
 136         <para>
 137           On Debian systems, the complete text of the GNU General Public
 138           License can be found in /usr/share/common-licenses/GPL.
 139         </para>
 140
 141   </refsect1>
 142 </refentry>
 143