Bug#243344: artsdsp and artsd manpages
I was just trying to do something with artsdsp, and noticed the lack of
manpage, so I've prepared a slightly more helpful one and attached it to
this (I hope that was the right thing to do, I wasn't sure if I should
paste it in instead). I also noticed other bugs relating to the artsd
manpage, so I've written one which pretty much paraphrase artsd --help
if you're interested.
Alan
diff -Naur arts-1.3.1.old/debian/man/artsd.sgml arts-1.3.1/debian/man/artsd.sgml
--- arts-1.3.1.old/debian/man/artsd.sgml 2004-02-24 02:44:10.000000000 +0000
+++ arts-1.3.1/debian/man/artsd.sgml 2004-10-23 23:04:31.061825536 +0100
@@ -56,7 +56,7 @@
<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>fixme</refpurpose>
+ <refpurpose>The arts sound daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
@@ -90,8 +90,6 @@
<para>This manual page documents briefly the
<command>&dhpackage;</command> command.</para>
- <para><command>&dhpackage;</command> fixme.</para>
-
</refsect1>
<refsect1>
<title>OPTIONS</title>
@@ -105,133 +103,133 @@
<term><option>-A</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Print a list of available artsd audio backends. These options can be passed to artsd with <option>-a</option></para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a <replaceable>audioiomethod</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Tell artsd to use a specific audio method. For a list of available methods see <option>-a</option></para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b <replaceable>bits</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Set the number of bits to use with sound samples</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D <replaceable>devicename</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Specify an audio device to use. Normally /dev/dsp is used</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Enables full duplex mode. Full duplex mode allows for recording and playback simultaneously</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-F <replaceable>fragments</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Sets the number of fragments to use</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Forces artsd to start even if no soundcards were found. If no soundcard is present the null backend is used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Display usage summary and exit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l <replaceable>level</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Specify how much information artsd should print. 3 means quiet, 2 means print warnings only, 1 means display additional information and 0 means debug</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m <replaceable>appName</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Sets the application to use to display information messages</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-N</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Use larger than normal network buffers. This may help solve problems with sound over poor connections.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Enable network transparency</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable>port</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Specify which TCP port to use for network communications.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r <replaceable>samplingrate</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Set the sampling rate to use. Higher sampling rates sound better, but are more CPU intensive. CD quality audio is sampled at 44kHz</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-S <replaceable>size</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Sets the size of a fragment, in bytes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s <replaceable>seconds</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Set the auto-suspend time, in seconds.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Don't require authentication. (THIS IS DANGEROUS!!)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Print the version number and quit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w <replaceable>n</replaceable></option>
</term>
<listitem>
- <para>fixme</para>
+ <para>Increase the size of network buffers by a factor of <replaceable>n</replaceable></para>
</listitem>
</varlistentry>
@@ -241,7 +239,8 @@
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; <&dhemail;> for
- the &debian; system (but may be used by others). Permission is
+ the &debian; system (but may be used by others). It was modified
+ by Alan Woodland <ajw2@aber.ac.uk>. Permission is
granted to copy, distribute and/or modify this document under
the terms of the <acronym>GNU</acronym> Free Documentation
License, Version 1.1 or any later version published by the Free
diff -Naur arts-1.3.1.old/debian/man/artsdsp.sgml arts-1.3.1/debian/man/artsdsp.sgml
--- arts-1.3.1.old/debian/man/artsdsp.sgml 2004-02-24 02:44:10.000000000 +0000
+++ arts-1.3.1/debian/man/artsdsp.sgml 2004-10-23 22:52:50.891267640 +0100
@@ -92,7 +92,7 @@
<option>--help</option>
</term>
<listitem>
- <para>fixme.</para>
+ <para>Shows a brief summary of options available.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -100,7 +100,7 @@
<option>--name=<replaceable>name</replaceable></option>
</term>
<listitem>
- <para>fixme.</para>
+ <para>Specifies a name for artsd to use to identify the player.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -108,7 +108,8 @@
<option>--mmap</option>
</term>
<listitem>
- <para>fixme.</para>
+ <para>Enables memory mapped IO emulation. Memory mapping is required
+ by some applications including Doom3</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -116,7 +117,7 @@
<option>--single-threaded</option>
</term>
<listitem>
- <para>fixme.</para>
+ <para>Run artsdsp for use with single threaded applications.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -124,7 +125,7 @@
<option>--verbose</option>
</term>
<listitem>
- <para>fixme.</para>
+ <para>Display runtime parameters.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -132,7 +133,7 @@
<option>--version</option>
</term>
<listitem>
- <para>fixme.</para>
+ <para>Prints the version of artsdsp and exit.</para>
</listitem>
</varlistentry>
@@ -142,7 +143,8 @@
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; <&dhemail;> for
- the &debian; system (but may be used by others). Permission is
+ the &debian; system (but may be used by others). It was modified
+ by Alan Woodland <ajw2@aber.ac.uk>. Permission is
granted to copy, distribute and/or modify this document under
the terms of the <acronym>GNU</acronym> Free Documentation
License, Version 1.1 or any later version published by the Free
Reply to: