diff options
Diffstat (limited to 'doc')
27 files changed, 869 insertions, 83 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 5ec6480c..0b9cfdb5 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -9,4 +9,17 @@ # ################################################# -tde_auto_add_subdirectories() +add_subdirectory( man ) + +tde_conditional_add_subdirectory( BUILD_ARTS artsbuilder ) +tde_conditional_add_subdirectory( BUILD_TDEIOSLAVE audiocd ) +tde_conditional_add_subdirectory( BUILD_LIBKCDDB cddb ) +tde_conditional_add_subdirectory( BUILD_JUK juk ) +tde_conditional_add_subdirectory( BUILD_KABOODLE kaboodle ) +tde_conditional_add_subdirectory( BUILD_KAUDIOCREATOR kaudiocreator ) +tde_conditional_add_subdirectory( BUILD_KMIX kmix ) +tde_conditional_add_subdirectory( BUILD_KREC krec ) +tde_conditional_add_subdirectory( BUILD_KSCD kscd ) +tde_conditional_add_subdirectory( BUILD_NOATUN noatun ) +tde_conditional_add_subdirectory( BUILD_TDEIOSLAVE tdeioslave ) +tde_conditional_add_subdirectory( BUILD_TDEMID tdemid ) diff --git a/doc/artsbuilder/artsbuilder.docbook b/doc/artsbuilder/artsbuilder.docbook index b5f4f68c..63e39e0b 100644 --- a/doc/artsbuilder/artsbuilder.docbook +++ b/doc/artsbuilder/artsbuilder.docbook @@ -339,7 +339,7 @@ Finally, you can delete the Synth_SEQUENCE module, and rather connect connect the frequency input port of the structure to the Synth_FREQUENCY frequency port. Hm. But what do do about pos?</para> <para>We don't have this, because with no algorithm in the -world, you can predict when the user will release the note he just +world, you can predict when the user will release the note they just pressed on the midi keyboard. So we rather have a pressed parameter instead that just indicates wether the user still holds down the key. (pressed = 1: key still hold down, pressed = 0: key diff --git a/doc/artsbuilder/detail.docbook b/doc/artsbuilder/detail.docbook index c7ed7319..37d5e328 100644 --- a/doc/artsbuilder/detail.docbook +++ b/doc/artsbuilder/detail.docbook @@ -1415,7 +1415,7 @@ once you assigned something else (like a null reference). <para> The equivalent C++ terms would be <programlisting> - QWidget* w; + TQWidget* w; w->show(); </programlisting> @@ -1662,8 +1662,8 @@ objects that are send over wire are tagged before transfer. </para> <para> -If the receiver receives an object which is on his server, of course he -will not <function>_useRemote()</function> it. For this special case, +If the receiver receives an object which is on their server, of course +they will not <function>_useRemote()</function> it. For this special case, <function>_cancelCopyRemote()</function> exists to remove the tag manually. Other than that, there is also timer based tag removal, if tagging was done, but the receiver didn't really get the object (due to diff --git a/doc/artsbuilder/faq.docbook b/doc/artsbuilder/faq.docbook index 8bb7ae4c..65a14c87 100644 --- a/doc/artsbuilder/faq.docbook +++ b/doc/artsbuilder/faq.docbook @@ -414,7 +414,7 @@ Short answer: no, &arts; will not work if you compile it with gcc-3.0. <para> Long answer: In the official release, there are two gcc-3.0 bugs which affect &arts;. The first, gcc-3.0 bug c++/2733 is relatively harmless (and has to do -with problems with the asm statement). It breaks compilation of convert.cc. It +with problems with the asm statement). It breaks compilation of convert.cpp. It has been fixed in the gcc-3.0 CVS, and will no longer be a problem with gcc-3.0.1 and higher. A workaround has also been added to the CVS version of KDE/aRts. @@ -1018,7 +1018,7 @@ succeeds, which eventually leads to consuming all CPU power and reporting might get supplied with wrong information how much to write. Artsd will then <emphasis>stop with an assertion</emphasis> like: <screen> -artsd: audiosubsys.cc:458: void Arts::AudioSubSystem::handleIO(int): +artsd: audiosubsys.cpp:458: void Arts::AudioSubSystem::handleIO(int): Assertion `len == can_write' failed. Aborted </screen> diff --git a/doc/artsbuilder/helping.docbook b/doc/artsbuilder/helping.docbook index 72b2ff2b..dc635701 100644 --- a/doc/artsbuilder/helping.docbook +++ b/doc/artsbuilder/helping.docbook @@ -224,7 +224,7 @@ written. <para> Source files should have no capitalization in the name. They should have the name of the class when they implement a single class. Their -extension is <literal role="extension">.cc</literal> if they refer to +extension is <literal role="extension">.cpp</literal> if they refer to &Qt;/&GUI; independent code, and <literal role="extension">.cpp</literal> if they refer to &Qt;/&GUI; dependant code. Implementation files for interfaces should be called diff --git a/doc/artsbuilder/index.docbook b/doc/artsbuilder/index.docbook index 89706495..7308f2f9 100644 --- a/doc/artsbuilder/index.docbook +++ b/doc/artsbuilder/index.docbook @@ -378,16 +378,3 @@ url="http://www.kde.org/documentation/faq/index.html">&kde; &arts-glossary; </book> -<!-- -Local Variables: -mode: sgml -sgml-omittag:nil -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:0 -sgml-indent-data:nil -End: ---> diff --git a/doc/artsbuilder/mcop.docbook b/doc/artsbuilder/mcop.docbook index f140bff9..ca4a195a 100644 --- a/doc/artsbuilder/mcop.docbook +++ b/doc/artsbuilder/mcop.docbook @@ -1093,7 +1093,7 @@ interface Hello { You pass that through the &IDL; compiler by calling <userinput><command>mcopidl</command> <parameter>hello.idl</parameter></userinput>, which will in turn generate -<filename>hello.cc</filename> and <filename>hello.h</filename>. To +<filename>hello.cpp</filename> and <filename>hello.h</filename>. To implement it, you need to define a C++-class that inherits the skeleton: </para> @@ -1476,7 +1476,7 @@ Marshalling should be easy to implement. <listitem> <para> -Demarshalling requires the receiver to know what type he wants to +Demarshalling requires the receiver to know what type they want to demarshall. </para> </listitem> @@ -1991,7 +1991,7 @@ objects</quote> and <quote>the <acronym>CORBA</acronym> interface</quote> look natural, but it didn't, because <acronym>CORBA</acronym> knew nothing at all about streams. &MCOP; does. Look at the code (something like -<filename>simplesoundserver_impl.cc</filename>). Way better! Streams +<filename>simplesoundserver_impl.cpp</filename>). Way better! Streams can be declared in the interface of modules, and implemented in a natural looking way. </para> @@ -2197,12 +2197,12 @@ that, I am certainly proven wrong. While I do know that &DCOP; basically doesn't know about the data types it sends, so that you could use &DCOP; without using &Qt;, look at how it is used in daily &kde; usage: people send types like -<classname>QString</classname>, <classname>QRect</classname>, +<classname>TQString</classname>, <classname>QRect</classname>, <classname>QPixmap</classname>, <classname>QCString</classname>, ..., around. These use &Qt;-serialization. So if somebody choose to support -&DCOP; in a GNOME program, he would either have to claim to use -<classname>QString</classname>,... types (although he doesn't do so), -and emulate the way &Qt; does the streaming, or he would send other +&DCOP; in a GNOME program, they would either have to claim to use +<classname>TQString</classname>,... types (although they don't do so), +and emulate the way &Qt; does the streaming, or they would send other string, pixmap and rect types around, and thus not be interoperable. </para> diff --git a/doc/juk/index.docbook b/doc/juk/index.docbook index 196e81ac..bedacbac 100644 --- a/doc/juk/index.docbook +++ b/doc/juk/index.docbook @@ -1654,12 +1654,3 @@ for the &DCOP; interface.</para> &documentation.index; </book> -<!-- -Local Variables: -mode: sgml -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -sgml-indent-step:0 -sgml-indent-data:nil -End: ---> diff --git a/doc/kaudiocreator/index.docbook b/doc/kaudiocreator/index.docbook index 04c25a4a..08e334c6 100644 --- a/doc/kaudiocreator/index.docbook +++ b/doc/kaudiocreator/index.docbook @@ -1068,16 +1068,3 @@ As a bad example: sorry no mail. I cannot maintain this handbook. It is thought &documentation.index; </book> - -<!-- -Local Variables: -mode: sgml -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -sgml-indent-step:0 -sgml-indent-data:nil -End: - -vim:tabstop=2:shiftwidth=2:expandtab ---> - diff --git a/doc/kmix/index.docbook b/doc/kmix/index.docbook index 51813c0f..baeb926d 100644 --- a/doc/kmix/index.docbook +++ b/doc/kmix/index.docbook @@ -493,11 +493,3 @@ are &Linux;, FreeBSD, NetBSD and BSDI.</para></listitem> </appendix> </book> -<!-- -Local Variables: -mode: sgml -sgml-omittag: nil -sgml-shorttag: t -End: ---> - diff --git a/doc/krec/index.docbook b/doc/krec/index.docbook index 86ed8f3c..e390d91d 100644 --- a/doc/krec/index.docbook +++ b/doc/krec/index.docbook @@ -33,9 +33,6 @@ <date>2004-03-01</date> <releaseinfo>0.5.1</releaseinfo> -<!-- - vim: tw=80 et sw=2 ts=2 ---> <abstract> <para> &krec; is a recording application for &arts;. It can be used to record any @@ -629,11 +626,3 @@ running &kde; and &arts; too, everything should be fine. &documentation.index; </book> - -<!-- -Local Variables: -mode: sgml -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -End: ---> diff --git a/doc/kscd/index.docbook b/doc/kscd/index.docbook index 0b817241..b724ac6d 100644 --- a/doc/kscd/index.docbook +++ b/doc/kscd/index.docbook @@ -923,10 +923,3 @@ order to get &kscd; to compile on your platform.</para> &documentation.index; </book> -<!-- -Local Variables: -mode: sgml -sgml-minimize-attributes: nil -sgml-general-insert-case: lower -End: ---> diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt new file mode 100644 index 00000000..5e77a4a0 --- /dev/null +++ b/doc/man/CMakeLists.txt @@ -0,0 +1,17 @@ +################################################# +# +# (C) 2017 Slávek Banko +# slavek (DOT) banko (AT) axis.cz +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_conditional_add_subdirectory( BUILD_JUK juk ) +tde_conditional_add_subdirectory( BUILD_KABOODLE kaboodle ) +tde_conditional_add_subdirectory( BUILD_KAUDIOCREATOR kaudiocreator ) +tde_conditional_add_subdirectory( BUILD_KMIX kmix ) +tde_conditional_add_subdirectory( BUILD_KREC krec ) +tde_conditional_add_subdirectory( BUILD_NOATUN noatun ) diff --git a/doc/man/juk/CMakeLists.txt b/doc/man/juk/CMakeLists.txt new file mode 100644 index 00000000..65c83b94 --- /dev/null +++ b/doc/man/juk/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +install( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/juk/juk.1 b/doc/man/juk/juk.1 new file mode 100644 index 00000000..0981892b --- /dev/null +++ b/doc/man/juk/juk.1 @@ -0,0 +1,39 @@ +.TH "JuK" "1" "April 2006" +.SH "NAME" +juk \- music organizer and player for TDE +.SH "SYNOPSIS" +\fBjuk\fR +.SH "DESCRIPTION" +.LP + +JuK (pronounced "jook") is a jukebox and music manager for the TDE +desktop similar to jukebox software on other platforms such as +iTunes or RealOne. + +. +.SH "OPTIONS" +.l +\fIjuk\fP does not accept any command-line options. +. + +.SH "DCOP" + +\fIjuk\fP has a DCOP (Desktop Communications Protocol) interface +that may be used to start, stop, skip forward to the next song, +etc. This may be done from the command line using \fIdcop\fP +as follows: + +.RS +$ dcop juk Player forward + +$ dcop juk Player back + +$ dcop juk Player stop + +$ dcop juk Player play +.RE + +.SH "AUTHOR" +This page was written by David Schleef <ds@schleef.org> for Debian, +but may be used elsewhere. + diff --git a/doc/man/kaboodle/CMakeLists.txt b/doc/man/kaboodle/CMakeLists.txt new file mode 100644 index 00000000..65c83b94 --- /dev/null +++ b/doc/man/kaboodle/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +install( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kaboodle/kaboodle.1 b/doc/man/kaboodle/kaboodle.1 new file mode 100644 index 00000000..72ff225f --- /dev/null +++ b/doc/man/kaboodle/kaboodle.1 @@ -0,0 +1,261 @@ +.lf 1 info/tdemultimedia.kaboodle.1 +.TH KABOODLE 1 "May 2003" TDE "TDE Application" +.SH NAME +kaboodle \- TDE simple and lean Media Player +.SH SYNOPSIS +.B kaboodle +[\fIQt-options\fR] [\fITDE-options\fR] [\fIURL\fR] +.SH DESCRIPTION +This manual page documents briefly the +.B kaboodle +TDE Application. +This manual page was written for the Debian GNU/Linux distribution +because the original program does not have a manual page. +.PP +.B Kaboodle +is a simple KMedia (aRts) player for TDE, which can play standalone, +or embedded in Konqueror. The embedded player should work for media embedded in tdehtml, too. +It is meant for simple stuff like playing a quick video or sound file. +.B Kaboodle +does not accept plugins, does not have a playlist or volume control and other such features. +.P +To get a media-player with a full-fledged user interface, look at +.BR noatun (1) +.SH OPTIONS +.SS "Arguments:" +.TP +URL +URL of media file to play +.SS "General Options" +.B \-\-help +Show help about options +.TP +.B \-\-help\-qt +Show Qt specific options +.TP +.B \-\-help\-tde +Show TDE specific options +.TP +.B \-\-help\-all +Show all options +.TP +.B \-\-author +Show author information +.TP +.B \-v\fR, \fB\-\-version +Show version information +.TP +.B \-\-license +Show license information +.TP +.B \-\- +End of options +.lf 1 info/kdetqtoptions +.SS "TDE options" +.TP 12 +.BI \-\-caption \ caption +Use \fIcaption\fP as name in the titlebar. +.TP +.BI \-\-icon \ icon +Use \fIicon\fP as the application icon. \fIicon\fP is the name of the +icon, which can either be an absolute filename path, or otherwise the +icon is sought for in places according to the normal TDE rules. +.TP +.BI \-\-miniicon \ icon +Use \fIicon\fP as the icon in the titlebar. \fIicon\fP is the filename +of the icon, according to the same rules as for the \-\-icon parameter. +.TP +.BI \-\-config \ filename +Use an alternative configuration file, instead of the default, which +is normally located in +.I /usr/share/config +or in +.RB $ TDEHOME\fI/share/config +.TP +.BI \-\-dcopserver \ server +Set the address of the DCOP server to attach to. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. This option has the same +effect as definiting the environment variable TDE_DEBUG. +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.BI \-\-style \ style +sets the application GUI style. +.TP +.BI \-\-geometry \ geometry +sets the client geometry of the main widget. +The geometry parameter follows the normal X convention for geometry, +which is on the form: +.RS +.IP +[\fIwidth\fBx\fIheight\fR][{\fB+-\fR}\fIxpos\fR{\fB+-\fR}\fIypos\fR] +.P +Where \fIwidth\fR and \fIheight\fR gives the desired minimum width and +height, of the main application window. Both in pixels. A value of 0 +specifies the default size. The optional \fIxpos\fR and \fIypos\fR +specifies the x,y-position that which is desired for the application +window. Specifying negative values for x or y implies that the x or y +position is to be measured from the left or bottom screen edge, +instead of as in the normal case, with positive values, from the left +and top edges. +.RE +.SS "Qt options" +.TP 12 +.BI \-\-display \ displayname +Use the X-server display \fIdisplayname\fP. +.TP +.BI \-\-session \ sessionId +Restore the application for the given \fIsessionId\fP. +.TP +.B \-\-cmap +Causes the application to install a private color +map on an 8-bit display. +.TP +.BI \-\-ncols \ count +Limits the number of colors allocated in the color +cube on an 8-bit display, if the application is +using the QApplication::ManyColor color +specification. +.TP +.B \-\-nograb +Tells Qt to never grab the mouse or the keyboard. +.TP +.B \-\-dograb +Running under a debugger can cause an implicit +.B \-nograb, use \fB\-dograb\fR to override. +.TP +.B \-\-sync +switches to synchronous mode for debugging. +.TP +.BI "\-\-fn\fR, \fP\-\-font" \ fontname +Defines the default application font. The \fIfontname\fP should be in +the X logical font name description format XLFD. For a full description of +the format see +.I /usr/X11R6/lib/X11/doc/xlfd.TXT +Note that the application might override the font specified with +its own font. +.TP +.BI "-\-bg\fR, \fB\-\-background" \ color +Sets the default background color and an +application palette (light and dark shades are +calculated). +.TP +.BI "\-\-fg\fR, \fB\-\-foreground" \ color +Sets the default foreground color. +.TP +.BI \-\-btn\fR, \fB\-\-button \ color +Sets the default button color. +.TP +.BI \-\-name \ name +Sets the application name. +.TP +.BI \-\-title \ title +Sets the application title. This option might, or might not appear +in the title bar caption, depending on the application. To change the caption, use the +.B \-\-caption +option instead. +.TP +.B \-\-visual TrueColor +Forces the application to use a TrueColor visual on +an 8-bit display. +.TP +.BI \-\-inputstyle \ inputstyle +Sets XIM (X Input Method) input style. Possible +values are +.BR onthespot ", " overthespot ", " offthespot and root . +.TP +.BI \-\-im " XIM-server" +Set XIM server. +.TP +.B \-\-noxim +Disable XIM. +.TP +.B \-\-reverse +Mirror reverses the whole layout of widgets. This means that menus +will go in the opposite direction, the scroll bar will be on the +opposite side, etc. For a normal western layout that means that menus +and tool bars will go from the right edge to the left, the vertical +scroll bar will be on the left side and so on. + +.lf 53 info/tdemultimedia.kaboodle.1 +.SH ENVIRONMENT +.lf 1 info/kdeenviron +.SS "standard TDE environment variables" +.IP TDE_LANG +Language locale setting to use. This option makes it possible to set +another language environment for a program than what is the default. The +correct language pack for this language has to be installed for this option +to work. The default language when there is none set is en_US. When +deciding upon a language, the following resources are looked up, in +order: TDE_LANG, configuration file, LC_CTYPE, LC_MESSAGES, LC_ALL, +LANG. +.IP TDE_UTF8_FILENAMES +Assume that all filenames are in UTF-8 format regardless of the +current language setting. Otherwise the filename format is defined by +the language. +.IP TDE_MULTIHEAD +If this variable has the value +.B true +multihead multiple display mode is enabled. The TDE display will be +shared over more than one screen. +.IP DISPLAY +Specifies the X display to run TDE on. +.IP TDESYCOCA +Specifies and alternative path for the +.I tdesycoca +TDE system configuration cache file. +The default path is +/tmp/tde-$USER/tdesycoca +.IP DCOPSERVER +Specifies an alternative path for the DCOP server file. The default +file is +$HOME/.DCOPserver_\fIhostname\fP_\fIdisplayname\fP +.IP SESSION_MANAGER +The session manager to use. This option is set automatically by TDE +and is a network path to the session manager socket. +.IP HOME +Path to the home directory for the current user. +.IP TDEHOME +The TDE per-user setting directory. Default if not specified is +.I $HOME/.trinity +.lf 55 info/tdemultimedia.kaboodle.1 +.SH FILES +.TP +.I $HOME/.trinity/share/config/kaboodlerc +configuration file. +.SH AUTHOR +Kaboodle was written by +.nh +.ad l +Neil Stevens <neil@qualityassistant.com>, +Nikolas Zimmermann <wildfox@kde.org>, +and Charles Samuels <charles@kde.org>. +.hy +.br +Please use http://bugs.trinitydesktop.org to report bugs, do not mail the authors directly. +.br +This manual page was prepared by +.nh +.ad l +Karolina Lindqvist <pgd\-karolinali@algonet.se> +.hy +for the Debian GNU/Linux system (but may be used by others). +.SH "SEE ALSO" +.BR noatun (1) +.br +The full documentation for +.B kaboodle +is maintained as a docbook manual. If the +.B khelpcenter +program is properly installed at your site, the command +.IP +.B khelpcenter help:/kaboodle +.PP +should give you access to the complete manual. +.P +Alternatively the manual can be browsed in +.B konqueror +giving it the URL help:/kaboodle diff --git a/doc/man/kaudiocreator/CMakeLists.txt b/doc/man/kaudiocreator/CMakeLists.txt new file mode 100644 index 00000000..65c83b94 --- /dev/null +++ b/doc/man/kaudiocreator/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +install( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kaudiocreator/kaudiocreator.1 b/doc/man/kaudiocreator/kaudiocreator.1 new file mode 100644 index 00000000..35600bcd --- /dev/null +++ b/doc/man/kaudiocreator/kaudiocreator.1 @@ -0,0 +1,145 @@ +.TH kaudiocreator 1 "Nov 2005" "Trinity Desktop Environment" "" +.SH NAME +kaudiocreator \- CD ripper and audio encoder front-end +.SH SYNOPSIS +kaudiocreator [Qt-options] [TDE-options] +.SH DESCRIPTION +.B kaudiocreator +is the CD ripper and audio encoder front-end for the Trinity Desktop Environment. It +supports many encoders like +.BR lame (1), +.BR oggenc (1), +.BR flac (1), +and performs CDDB queries. + +.SH OPTIONS +.SS Generic options: +.TP +.B --help +Show help about options +.TP +.B --help-qt +Show Qt specific options +.TP +.B --help-tde +Show TDE specific options +.TP +.B --help-all +Show all options +.TP +.B --author +Show author information +.TP +.B -v, --version +Show version information +.TP +.B --license +Show license information +.TP +.B -- +End of options +.SS +.SS TDE options: +.TP +.B --caption <caption> +Use 'caption' as name in the title bar +.TP +.B --icon <icon> +Use 'icon' as the application icon +.TP +.B --miniicon <icon> +Use 'icon' as the icon in the title bar +.TP +.B --config <filename> +Use alternative configuration file +.TP +.B --dcopserver <server> +Use the DCOP Server specified by 'server' +.TP +.B --nocrashhandler +Disable crash handler, to get core dumps +.TP +.B --waitforwm +Waits for a WM_NET compatible window manager +.TP +.B --style <style> +sets the application GUI style +.TP +.B --geometry <geometry> +sets the client geometry of the main widget +.SS +.SS Qt options: +.TP +.B --display <displayname> +Use the X-server display 'displayname' +.TP +.B --session <sessionId> +Restore the application for the given 'sessionId' +.TP +.B --cmap +Causes the application to install a private color +map on an 8-bit display +.TP +.B --ncols <count> +Limits the number of colors allocated in the color +cube on an 8-bit display, if the application is +using the QApplication::ManyColor color +specification +.TP +.B --nograb +tells Qt to never grab the mouse or the keyboard +.TP +.B --dograb +running under a debugger can cause an implicit +-nograb, use -dograb to override +.TP +.B --sync +switches to synchronous mode for debugging +.TP +.B --fn, --font <fontname> +defines the application font +.TP +.B --bg, --background <color> +sets the default background color and an +application palette (light and dark shades are +calculated) +.TP +.B --fg, --foreground <color> +sets the default foreground color +.TP +.B --btn, --button <color> +sets the default button color +.TP +.B --name <name> +sets the application name +.TP +.B --title <title> +sets the application title (caption) +.TP +.B --visual TrueColor +forces the application to use a TrueColor visual on +an 8-bit display +.TP +.B --inputstyle <inputstyle> +sets XIM (X Input Method) input style. Possible +values are onthespot, overthespot, offthespot and +root +.TP +.B --im <XIM server> +set XIM server +.TP +.B --noxim +disable XIM +.TP +.B --reverse +mirrors the whole layout of widgets + + +.SH AUTHOR +Benjamin Meyer <ben+kaudiocreator@meyerhome.net> + +Please use <http://bugs.trinitydesktop.org> to report bugs, do not mail the authors +directly. + + +This man-page was written by Francois Wendling <frwendling@free.fr> diff --git a/doc/man/kmix/CMakeLists.txt b/doc/man/kmix/CMakeLists.txt new file mode 100644 index 00000000..65c83b94 --- /dev/null +++ b/doc/man/kmix/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +install( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kmix/kmix.1 b/doc/man/kmix/kmix.1 new file mode 100644 index 00000000..e603facb --- /dev/null +++ b/doc/man/kmix/kmix.1 @@ -0,0 +1,49 @@ +.TH KMIX 1 "August, 15 2003" +.SH NAME +Kmix \- TDE audio mini-mixer +.SH SYNOPSIS +.B kmix +.RI [ OPTIONS ] +.SH DESCRIPTION +This manual page documents briefly the +.B kmix +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +\fBKmix\fP is a mini audio mixer for TDE. It allows the user to change +volume settings for each sound device (master, CD, line, mic, ...). +.SH OPTIONS +A summary of options for Kmix is included below. +.TP +.B \-v, \-\-version +Show version of program. +.TP +.B \-\-help +Show summary of options. +.TP +.B \-\-help\-qt +Show QT specific help (common for all QT apps). +.TP +.B \-\-help\-tde +Show TDE specific help (common for all TDE apps). +.TP +.B \-\-help\-all +Show the complete help. +.TP +.B \-\-author +Show program author(s). +.TP +.B \-\-license +Show program license. + +.SH SEE ALSO +.BR kmixctrl (1), +.PP +For more details, you should have a look at the TDE Help center, available +from the T menu. +.SH AUTHOR +This manual page was written by Clement Stenac <zorglub@via.ecp.fr>, +for the Debian GNU/Linux project (but may be used by others). +.PP +kmix was written by the KDE project. diff --git a/doc/man/kmix/kmixctrl.1 b/doc/man/kmix/kmixctrl.1 new file mode 100644 index 00000000..58a586b1 --- /dev/null +++ b/doc/man/kmix/kmixctrl.1 @@ -0,0 +1,54 @@ +.TH KMIXCTRL 1 "August, 25 2003" +.SH NAME +kmixctrl \- Settings loader/saver for kmix +.SH SYNOPSIS +.B kmixctrl +.RI [ OPTIONS ] +.SH DESCRIPTION +This manual page documents briefly the +.B kmixctrl +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +\fBkmixctrl\fP is used to save or restore the settings of \fIkmix\fP. +.SH OPTIONS +A summary of options for kmixctrl is included below. +.TP +.B \-v, \-\-version +Show version of program. +.TP +.B \-\-help +Show summary of options. +.TP +.B \-\-help\-qt +Show QT specific help (common for all QT apps). +.TP +.B \-\-help\-tde +Show TDE specific help (common for all TDE apps). +.TP +.B \-\-help\-all +Show the complete help. +.TP +.B \-\-author +Show program author(s). +.TP +.B \-\-license +Show program license. +.TP +.B \-s, \-\-save +Save the current settings as default +.TP +.B \-r, \-\-restore +Restores the default settings + +.SH SEE ALSO +.BR kmix (1), +.PP +For more details, you should have a look at the TDE Help center, available +from the T menu. +.SH AUTHOR +This manual page was written by Clement Stenac <zorglub@via.ecp.fr>, +for the Debian GNU/Linux project (but may be used by others). +.PP +kmixctrl was written by the KDE project. diff --git a/doc/man/krec/CMakeLists.txt b/doc/man/krec/CMakeLists.txt new file mode 100644 index 00000000..65c83b94 --- /dev/null +++ b/doc/man/krec/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +install( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/krec/krec.1 b/doc/man/krec/krec.1 new file mode 100644 index 00000000..9e2c57e3 --- /dev/null +++ b/doc/man/krec/krec.1 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.33. +.TH krec "1" "July 2004" "Debian" "User Commands" +.SH NAME +krec \- A voice recording program +.SH SYNOPSIS +.B krec +[\fIoptions\fR] +.SH DESCRIPTION +This is a recording tool for TDE. +It uses aRts, just look at the audiomanager +and you will find it there accepting sound +for recording. +.SS "Generic options:" +.TP +\fB\-\-help\fR +Show help about options +.TP +\fB\-\-help\-qt\fR +Show Qt specific options +.TP +\fB\-\-help\-tde\fR +Show TDE specific options +.TP +\fB\-\-help\-all\fR +Show all options +.TP +\fB\-\-author\fR +Show author information +.TP +\fB\-v\fR, \fB\-\-version\fR +Show version information +.TP +\fB\-\-license\fR +Show license information + + +.SH USAGE +Details are shown in the built-in help system to krec. Run krec and go to help-krec handbook to access this data + +.SH AUTHORS +krec is (C)2002-2003 By Arnold Krille (arnold@arnoldarts.de) +.P +This man page was written and maintained by Ryan Waye (rmw998@gmail.com) +.PP +. +. +.SH "STANDARD DISCLAIMER" +Use only at your own risk! +There may be errors and inaccuracies that could be damaging to your system or +your eye. +Proceed with caution, and although this is highly unlikely, the authors don't +take any responsibility for that! +.PP + +This document is licensed under the GPL. +.P +KDE: 3.2.2 +.P +KRec: 0.5 diff --git a/doc/man/noatun/CMakeLists.txt b/doc/man/noatun/CMakeLists.txt new file mode 100644 index 00000000..65c83b94 --- /dev/null +++ b/doc/man/noatun/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +install( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/noatun/noatun.1 b/doc/man/noatun/noatun.1 new file mode 100644 index 00000000..1ed42ae0 --- /dev/null +++ b/doc/man/noatun/noatun.1 @@ -0,0 +1,175 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH NOATUN 1 "June 2006" "Trinity Desktop Environment" "Media Player" +.SH NAME +noatun +\- fully-featured plugin-based media player for TDE +.SH SYNOPSIS +\fBnoatun\fP [Qt\-options] [TDE\-options] [URL] +.SH DESCRIPTION +\fBNoatun\fP is a fully\-featured plugin\-based media player for TDE. +It is an elaborate front-end to aRts - the Analog Real\-Time Synthesizer. +By default aRts supports MP3 and MPEG\-1. Vorbis is also supported. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B URL +Files/URLs to open +.SS Generic options: +.TP +.B \-\-help +Show help about options +.TP +.B \-\-help\-qt +Show Qt specific options +.TP +.B \-\-help\-tde +Show TDE specific options +.TP +.B \-\-help\-all +Show all options +.TP +.B \-\-author +Show author information +.TP +.B \-v, \-\-version +Show version information +.TP +.B \-\-license +Show license information +.TP +.B \-\- +End of options +.SS +.SS Qt options: +.TP +.B \-\-display <displayname> +Use the X-server display 'displayname' +.TP +.B \-\-session <sessionId> +Restore the application for the given 'sessionId' +.TP +.B \-\-cmap +Causes the application to install a private color +map on an 8\-bit display +.TP +.B \-\-ncols <count> +Limits the number of colors allocated in the color +cube on an 8\-bit display, if the application is +using the QApplication::ManyColor color +specification +.TP +.B \-\-nograb +tells Qt to never grab the mouse or the keyboard +.TP +.B \-\-dograb +running under a debugger can cause an implicit +\-nograb, use \-dograb to override +.TP +.B \-\-sync +switches to synchronous mode for debugging +.TP +.B \-\-fn, \-\-font <fontname> +defines the application font +.TP +.B \-\-bg, \-\-background <color> +sets the default background color and an +application palette (light and dark shades are +calculated) +.TP +.B \-\-fg, \-\-foreground <color> +sets the default foreground color +.TP +.B \-\-btn, \-\-button <color> +sets the default button color +.TP +.B \-\-name <name> +sets the application name +.TP +.B \-\-title <title> +sets the application title (caption) +.TP +.B \-\-visual TrueColor +forces the application to use a TrueColor visual on +an 8\-bit display +.TP +.B \-\-inputstyle <inputstyle> +sets XIM (X Input Method) input style. Possible +values are onthespot, overthespot, offthespot and +root +.TP +.B \-\-im <XIM server> +set XIM server +.TP +.B \-\-noxim +disable XIM +.TP +.B \-\-reverse +mirrors the whole layout of widgets +.SS +.SS TDE options: +.TP +.B \-\-caption <caption> +Use 'caption' as name in the titlebar +.TP +.B \-\-icon <icon> +Use 'icon' as the application icon +.TP +.B \-\-miniicon <icon> +Use 'icon' as the icon in the titlebar +.TP +.B \-\-config <filename> +Use alternative configuration file +.TP +.B \-\-dcopserver <server> +Use the DCOP Server specified by 'server' +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager +.TP +.B \-\-style <style> +sets the application GUI style +.TP +.B \-\-geometry <geometry> +sets the client geometry of the main widget - see man X for the argument format +.TP +.B \-\-nofork +Don't run in the background. +.SS + +.SH SEE ALSO +To find additional playobjects, go to \fBhttp://noatun.kde.org/plugins.phtml\fP, or \fBhttp://mpeglib.sf.net\fP. +.sp 1 +Full user documentation is available through the TDE Help Center. You can enter the URL +.BR help:/noatun/ +directly into konqueror or you can run +.BR "khelpcenter help:/noatun/" +from the command\-line. +.br +.SH AUTHORS +.nf +Charles Samuels <charles@kde.org> +.br +Stefan Westerfeld <stefan@space.twc.de> +.br +Martin Vogt <mvogt@rhrk.uni\-kl.de> +.br +Malte Starostik <malte@kde.org> +.br +Nikolas Zimmermann <wildfox@kde.org> +.br +Stefan Schimanski <1Stein@gmx.de> +.br +Stefan Gehn <metz@gehn.net> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the authors directly. +.PP +This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the Debian Project, 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. diff --git a/doc/tdemid/index.docbook b/doc/tdemid/index.docbook index b08a1d9a..ff8f6446 100644 --- a/doc/tdemid/index.docbook +++ b/doc/tdemid/index.docbook @@ -1329,10 +1329,3 @@ list, or send a report directly to me. </appendix> </book> -<!-- -Local Variables: -mode: sgml -sgml-omittag: nil -sgml-shorttag: t -End: ---> |