From 62547444d92320e4b47c4540ab46827f4b53518e Mon Sep 17 00:00:00 2001 From: ormorph Date: Sat, 11 May 2024 17:09:03 +0300 Subject: Build documentation for each subpackage separately Signed-off-by: ormorph (cherry picked from commit 95c3cba08ea09ecabb84cfd662bec76668b89bf7) --- doc/man/kicker/CMakeLists.txt | 7 ++ doc/man/kicker/appletproxy.1 | 163 ++++++++++++++++++++++++++++++++++++++ doc/man/kicker/extensionproxy.1 | 163 ++++++++++++++++++++++++++++++++++++++ doc/man/kicker/kasbar.1 | 148 ++++++++++++++++++++++++++++++++++ doc/man/kicker/kicker.1 | 171 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 652 insertions(+) create mode 100644 doc/man/kicker/CMakeLists.txt create mode 100644 doc/man/kicker/appletproxy.1 create mode 100644 doc/man/kicker/extensionproxy.1 create mode 100644 doc/man/kicker/kasbar.1 create mode 100644 doc/man/kicker/kicker.1 (limited to 'doc/man/kicker') diff --git a/doc/man/kicker/CMakeLists.txt b/doc/man/kicker/CMakeLists.txt new file mode 100644 index 000000000..65c83b94f --- /dev/null +++ b/doc/man/kicker/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/kicker/appletproxy.1 b/doc/man/kicker/appletproxy.1 new file mode 100644 index 000000000..3ab13208f --- /dev/null +++ b/doc/man/kicker/appletproxy.1 @@ -0,0 +1,163 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH APPLETPROXY 1 "June 2006" "Trinity Desktop Environment" "Panel applet proxy" +.SH NAME +appletproxy +\- TDE kicker panel applet proxy +.SH SYNOPSIS +\fBappletproxy\fP [Qt\-options] [TDE\-options] \fIdesktopfile\fP +.SH DESCRIPTION +\fBappletproxy\fP is a small application that allows you to run a kicker applet outside of \fBkicker\fP itself. The applet will appear in it's own window, making this a convenient way to debug panel applets. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B desktopfile +The applet's desktop file +.SS +.SS Options: +.TP +.B \-\-configfile +The config file to be used +.TP +.B \-\-callbackid +DCOP callback id of the applet container +.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 +Use the X\-server display 'displayname' +.TP +.B \-\-session +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 +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 +defines the application font +.TP +.B \-\-bg, \-\-background +sets the default background color and an +application palette (light and dark shades are +calculated) +.TP +.B \-\-fg, \-\-foreground +sets the default foreground color +.TP +.B \-\-btn, \-\-button +sets the default button color +.TP +.B \-\-name +sets the application name +.TP +.B \-\-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 +.SS +.SH FILES +\fI/usr/share/apps/kicker/applets\fP +kicker applets directory +.SH SEE ALSO +\fBkicker\fP(1), \fBextensionproxy\fP(1) +.SH AUTHORS +.nf +Matthias Elter <elter@kde.org> +.br +Matthias Ettrich <ettrich@kde.org> +.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/man/kicker/extensionproxy.1 b/doc/man/kicker/extensionproxy.1 new file mode 100644 index 000000000..4ea041189 --- /dev/null +++ b/doc/man/kicker/extensionproxy.1 @@ -0,0 +1,163 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH EXTENSIONPROXY 1 "June 2006" "Trinity Desktop Environment" "Panel extension proxy" +.SH NAME +extensionproxy +\- TDE kicker panel extension proxy +.SH SYNOPSIS +\fBextensionproxy\fP [Qt\-options] [TDE\-options] \fIdesktopfile\fP +.SH DESCRIPTION +\fBextensionproxy\fP is a small application that allows you to run a kicker extension outside of \fBkicker\fP itself. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B desktopfile +The extension's desktop file +.SS +.SS Options: +.TP +.B \-\-configfile <file> +The config file to be used +.TP +.B \-\-callbackid <id> +DCOP callback id of the extension container +.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 +.SS +.SH FILES +\fI/usr/share/apps/kicker/extensions\fP +kicker extensions directory +.SH SEE ALSO +\fBkicker\fP(1), \fBappletproxy\fP(1) +.SH AUTHORS +.nf +Matthias Elter <elter@kde.org> +.br +Matthias Ettrich <ettrich@kde.org> +.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/man/kicker/kasbar.1 b/doc/man/kicker/kasbar.1 new file mode 100644 index 000000000..7d57958d2 --- /dev/null +++ b/doc/man/kicker/kasbar.1 @@ -0,0 +1,148 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KASBAR 1 "June 2006" "Trinity Desktop Environment" "An alternative task manager" +.SH NAME +kasbar +\- An alternative task manager +.SH SYNOPSIS +\fBkasbar\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +The \fBKasBar\fP is an iconic replacement of the taskbar. It always shows the icons of all currently running applications on any desktop, they can be chosen by clicking with the left mouse button. The active window is highlighted, minimized windows will show a little triangle pointing downwards instead of the square in the lower right of the icons. A triangle pointing to the right indicates that the application is shaded. +.SH OPTIONS +.SS Options: +.TP +.B \-\-test +Test the basic kasbar code +.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 +.SS + +.SH SEE ALSO +\fBkicker\fP(1) +.SH AUTHORS +.nf + +.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/man/kicker/kicker.1 b/doc/man/kicker/kicker.1 new file mode 100644 index 000000000..1d17fa199 --- /dev/null +++ b/doc/man/kicker/kicker.1 @@ -0,0 +1,171 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KICKER 1 "June 2006" "Trinity Desktop Environment" "The TDE panel" +.SH NAME +kicker +\- The TDE panel +.SH SYNOPSIS +\fBkicker\fP [Qt\-options] [TDE\-options] +.SH DESCRIPTION +\fBKicker\fP is the TDE application starter panel and is also capable of some useful applets and extensions. It usually resides on the bottom of the desktop. +.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 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. + +.SH SEE ALSO +\fBkasbar\fP(1) +.sp 1 +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/kicker/ +directly into konqueror or you can run +.BR "khelpcenter help:/kicker/" +from the command\-line. +.br +.SH AUTHORS +.nf +Aaron J. Seigo <aseigo@kde.org> +.br +Matthias Elter <elter@kde.org> +.br +Matthias Ettrich <ettrich@kde.org> +.br +Wilco Greven <greven@kde.org> +.br +Rik Hemsley <rik@kde.org> +.br +Daniel M. Duley <mosfet@kde.org> +.br +Preston Brown <pbrown@kde.org> +.br +John Firebaugh <jfirebaugh@kde.org> +.br +Waldo Bastian <bastian@kde.org> +.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. -- cgit v1.2.1