Add man pages from tde-packaging repo.

Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>

8 files changed, 149 insertions, 6 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 96d138f..de310d0 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -49,7 +49,7 @@ include( TDESetupPaths )
 tde_setup_paths( )
 
 
-##### user requested options ####################
+##### user requested modules ####################
 
 option( WITH_ALL_OPTIONS "Enable all optional support" OFF )
 option( WITH_ALSA "Enable ALSA support" ON )
@@ -61,6 +61,9 @@ option( WITH_JACK "Enable JACK support" ${WITH_ALL_OPTIONS} )
 option( WITH_SNDIO "Enable SNDIO support" OFF )
 option( WITH_GCC_VISIBILITY "Enable fvisibility and fvisibility-inlines-hidden" ${WITH_ALL_OPTIONS} )
 
+option( BUILD_ALL "Build all" ON )
+option( BUILD_DOC "Build doc" ${BUILD_ALL} )
+
 
 ##### configure checks
 
@@ -88,6 +91,11 @@ add_subdirectory( gmcop )
 add_subdirectory( qtmcop )
 
 
+##### other data ################################
+
+tde_conditional_add_project_docs( BUILD_DOC )
+
+
 ##### write config.h file #######################
 
 configure_file( config.h.cmake config.h @ONLY )
diff --git a/doc/NEWS b/NEWS
index 081bca6..081bca6 100644
--- a/doc/NEWS
+++ b/NEWS
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0302d0c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+
+aRts sound system
+
+aRts is a short form for "analog realtime synthesizer". aRts is highly
+modular, creating and processing sound using small modules performing
+specific tasks. These may create a waveform (oscillators), play samples,
+filter data, add signals, perform effects like delay/flanger/chorus, or
+output the data to the soundcard.
+
+All of the aRts documentation is now in "The aRts Handbook" which is
+in TDE DocBook format, part of tdemultimedia. It should be found on a
+KDE system in $TDEDIR/share/doc/tde/HTML/default/artsbuilder/index.html.
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to aRts, you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/weblate
diff --git a/doc/TODO b/TODO
index 29d2123..29d2123 100644
--- a/doc/TODO
+++ b/TODO
diff --git a/doc/README b/doc/README
deleted file mode 100644
index 906e214..0000000
--- a/doc/README
+++ /dev/null
@@ -1,5 +0,0 @@
-All of the aRts documentation is now in "The aRts Handbook" which is
-in KDE DocBook format, part of tdemultimedia. It should be found on a
-KDE system in $TDEDIR/share/doc/tde/HTML/default/artsbuilder/index.html.
-
-An on-line version can be found at http://www.arts-project.org/doc/handbook
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 
+<ccheney@debian.org> 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 
+<ccheney@debian.org> 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 <fabo@debian.org>,
+for the Debian project (but may be used by others).
+