diff options
author | Michele Calgaro <michele.calgaro@yahoo.it> | 2022-07-10 17:27:55 +0900 |
---|---|---|
committer | Michele Calgaro <michele.calgaro@yahoo.it> | 2022-07-10 18:12:34 +0900 |
commit | 69ce1d06ccfab3724be8ab6451933346a0474b30 (patch) | |
tree | dc12d9d959c03e9baa971c630a7f51d8e5753111 /doc/man/kaboodle | |
parent | 1dc199a1f62d4ab3e0a17c30d0b1aee3c4489886 (diff) | |
download | tdemultimedia-69ce1d06ccfab3724be8ab6451933346a0474b30.tar.gz tdemultimedia-69ce1d06ccfab3724be8ab6451933346a0474b30.zip |
Add man pages for TDE applications.
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'doc/man/kaboodle')
-rw-r--r-- | doc/man/kaboodle/CMakeLists.txt | 7 | ||||
-rw-r--r-- | doc/man/kaboodle/kaboodle.1 | 261 |
2 files changed, 268 insertions, 0 deletions
diff --git a/doc/man/kaboodle/CMakeLists.txt b/doc/man/kaboodle/CMakeLists.txt new file mode 100644 index 00000000..24ccd704 --- /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 |