summaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/artsc-config-trinity.141
-rw-r--r--doc/man/artscat-trinity.143
-rw-r--r--doc/man/artsdsp-trinity.131
3 files changed, 115 insertions, 0 deletions
diff --git a/doc/man/artsc-config-trinity.1 b/doc/man/artsc-config-trinity.1
new file mode 100644
index 0000000..6e61ea5
--- /dev/null
+++ b/doc/man/artsc-config-trinity.1
@@ -0,0 +1,41 @@
+.TH "ARTSC-CONFIG" "1"
+.SH "NAME"
+artsc-config \(em Get information about a libartsc installation
+.SH "SYNOPSIS"
+.PP
+\fBartsc-config\fR [\fB\-\-arts-prefix\fI\fR\fP] [\fB\-\-arts-version\fI\fR\fP] [\fB\-\-cflags\fI\fR\fP] [\fB\-\-libs\fI\fR\fP] [\fB\-\-version\fI\fR\fP]
+.SH "DESCRIPTION"
+.PP
+This manual page documents briefly the
+\fBartsc-config\fR command.
+.PP
+\fBartsc-config\fR displays information about a previous libartsc installation.
+.SH "OPTIONS"
+.PP
+This program follows the usual GNU command line syntax,
+with long options starting with two dashes (`\-'). A summary of
+options is included below.
+.IP "\fB\-\-arts-prefix\fP " 10
+This is the prefix used when libartsc was installed.
+.IP "\fB\-\-arts-version\fP " 10
+Outputs version information about the installed arts.
+.IP "\fB\-\-cflags\fP " 10
+Set of compiler options (CFLAGS) to use when compiling files that use libartsc.
+.IP "\fB\-\-libs\fP " 10
+Shows the complete set of libs and other linker options you will need in order to link your application with libartsc.
+.IP "\fB\-\-version\fP " 10
+Outputs version information about the installed libartsc.
+.SH "AUTHOR"
+.PP
+This manual page was written by Chris Cheney
+<[email protected]> for the \fBDebian\fP system (but may be used by
+others). Permission is granted to copy, distribute and/or
+modify this document under the terms of the GNU General Public
+License, Version 2 or any later version published by the Free
+Software Foundation.
+
+.PP
+On Debian systems, the complete text of the GNU General
+Public License can be found in /usr/share/common-licenses/GPL.
+
+.\" created by instant / docbook-to-man
diff --git a/doc/man/artscat-trinity.1 b/doc/man/artscat-trinity.1
new file mode 100644
index 0000000..7c809df
--- /dev/null
+++ b/doc/man/artscat-trinity.1
@@ -0,0 +1,43 @@
+.TH "ARTSCAT" "1"
+.SH "NAME"
+artscat \(em pipe data to sound device
+.SH "SYNOPSIS"
+.PP
+\fBartscat\fR [\fB\fI options \fR\fP] [\fB\fI filename \fR\fP]
+.SH "DESCRIPTION"
+.PP
+This manual page documents briefly the
+\fBartscat\fR command.
+.PP
+\fBartscat\fR pipes data from a pipe to the sound device through arts.
+.SH "OPTIONS"
+.PP
+This program follows the usual GNU command line syntax,
+with long options starting with two dashes (`\-'). A summary of
+options is included below.
+.IP "\fB-b \fIbits\fR\fP " 10
+set number of bits (8 or 16)
+.IP "\fB-c \fIchannels\fR\fP " 10
+set number of channels (1 or 2)
+.IP "\fB-h\fP " 10
+display help and exit
+.IP "\fB-r \fIsamplingrate\fR\fP " 10
+set samplingrate to use
+.IP "\fB-t \fItitle\fR\fP " 10
+set stream title
+.IP "\fB-v\fP " 10
+show version
+.SH "AUTHOR"
+.PP
+This manual page was written by Chris Cheney
+<[email protected]> for the \fBDebian\fP system (but may be used by
+others). Permission is granted to copy, distribute and/or
+modify this document under the terms of the GNU General Public
+License, Version 2 or any later version published by the Free
+Software Foundation.
+
+.PP
+On Debian systems, the complete text of the GNU General
+Public License can be found in /usr/share/common-licenses/GPL.
+
+.\" created by instant / docbook-to-man
diff --git a/doc/man/artsdsp-trinity.1 b/doc/man/artsdsp-trinity.1
new file mode 100644
index 0000000..2615f47
--- /dev/null
+++ b/doc/man/artsdsp-trinity.1
@@ -0,0 +1,31 @@
+.TH ARTSDSP "1" "February 2008" "artsdsp" "User Commands"
+.SH NAME
+artsdsp \- manual page for artsdsp
+.SH DESCRIPTION
+artsdsp \- attempt to reroute audio device to artsd
+.PP
+artsdsp [options] binary
+.PP
+options:
+.TP
+.B \-h, \-\-help
+Show brief help.
+.TP
+.B \-n, \-\-name\fR=\fINAME\fR
+Use name to identify player to artsd.
+.TP
+.B \-m, \-\-mmap
+Emulate memory mapping (i.e. for quake).
+.TP
+.B \-s, \-\-single\-threaded
+Use the single\-threaded version.
+.TP
+.B \-v, \-\-verbose
+Show parameters.
+.TP
+.B \-V, \-\-version
+Show version.
+.PP
+This manual page was written by Fathi Boudra <[email protected]>,
+for the Debian project (but may be used by others).
+