diff options
| author | Michele Calgaro <[email protected]> | 2022-05-23 11:56:39 +0900 |
|---|---|---|
| committer | Michele Calgaro <[email protected]> | 2022-05-23 17:57:33 +0900 |
| commit | e54ce66f9624a64c46350824164723ae23b74824 (patch) | |
| tree | 1aae09129aaca3a082e88f619a0ee6e10e16d19b | |
| parent | cc94c3dc3632d66f534972e61a8c88eb0d41fdad (diff) | |
| download | tdebase-e54ce66f9624a64c46350824164723ae23b74824.tar.gz tdebase-e54ce66f9624a64c46350824164723ae23b74824.zip | |
Add man pages for TDE applications.
Signed-off-by: Michele Calgaro <[email protected]>
46 files changed, 6228 insertions, 1 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 5d172f466..a884913ca 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -251,7 +251,7 @@ tde_conditional_add_subdirectory( BUILD_TDEINIT tdeinit ) tde_conditional_add_subdirectory( BUILD_L10N l10n ) tde_conditional_add_subdirectory( BUILD_PICS pics ) tde_conditional_add_subdirectory( BUILD_APPLNK applnk ) -tde_conditional_add_subdirectory( BUILD_DOC doc ) +tde_conditional_add_project_docs( BUILD_DOC ) tde_conditional_add_subdirectory( BUILD_LIBKONQ libkonq ) tde_conditional_add_subdirectory( BUILD_KCMINIT kcminit ) tde_conditional_add_subdirectory( BUILD_TWIN twin ) diff --git a/doc/man/appletproxy.1 b/doc/man/appletproxy.1 new file mode 100644 index 000000000..3ab13208f --- /dev/null +++ b/doc/man/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 <file> +The config file to be used +.TP +.B \-\-callbackid <id> +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 <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/applets\fP +kicker applets directory +.SH SEE ALSO +\fBkicker\fP(1), \fBextensionproxy\fP(1) +.SH AUTHORS +.nf +Matthias Elter <[email protected]> +.br +Matthias Ettrich <[email protected]> +.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 <[email protected]> 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/drkonqi.1 b/doc/man/drkonqi.1 new file mode 100644 index 000000000..987164834 --- /dev/null +++ b/doc/man/drkonqi.1 @@ -0,0 +1,175 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH DRKONQI 1 "June 2006" "Trinity Desktop Environment" "TDE crash handler" +.SH NAME +drkonqi +\- TDE crash handler gives the user feedback if a program crashed +.SH SYNOPSIS +\fBdrkonqi\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +The TDE crash handler gives the user feedback if a program crashed. +.SH OPTIONS +.SS Options: +.TP +.B \-\-signal <number> +The signal number that was caught +.TP +.B \-\-appname <name> +Name of the program +.TP +.B \-\-apppath <path> +Path to the executable +.TP +.B \-\-appversion <version> +The version of the program +.TP +.B \-\-bugaddress <address> +The bug address to use +.TP +.B \-\-programname <name> +Translated name of the program +.TP +.B \-\-pid <pid> +The PID of the program +.TP +.B \-\-startupid <id> +Startup ID of the program +.TP +.B \-\-tdeinit +The program was started by tdeinit +.TP +.B \-\-safer +Disable arbitrary disk access +.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 AUTHORS +.nf +Hans Petter Bieker <[email protected]> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/extensionproxy.1 b/doc/man/extensionproxy.1 new file mode 100644 index 000000000..4ea041189 --- /dev/null +++ b/doc/man/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 <[email protected]> +.br +Matthias Ettrich <[email protected]> +.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 <[email protected]> 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/gentdmconf.1 b/doc/man/gentdmconf.1 new file mode 100644 index 000000000..d98e166c2 --- /dev/null +++ b/doc/man/gentdmconf.1 @@ -0,0 +1,91 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH GENTDMCONF 1 "June 2006" "Trinity Desktop Environment" "generate configuration files for tdm" +.SH NAME +gentdmconf +\- generate configuration files for tdm +.SH SYNOPSIS +\fBgentdmconf\fP +.RB [ \-\-in +.IR /path/to/new/tdm\-config\-dir ] +.RS 11 +.RB [ \-\-old\-xdm +.IR /path/to/old/xdm\-dir ] +.br +.RB [ \-\-old\-kde +.IR /path/to/old/kde\-config\-dir ] +.br +.RB [ \-\-no\-old ] +.RB [ \-\-no\-old\-xdm ] +.RB [ \-\-no\-old\-kde ] +.RB [ \-\-old\-scripts ] +.br +.RB [ \-\-no\-old\-scripts ] +.RB [ \-\-old\-confs ] +.RB [ \-\-no\-backup ] +.br +.RB [ \-\-no\-in\-notice ] +.RE + +.SH DESCRIPTION +\fBgentdmconf\fP is used to generate configuration files for \fBtdm\fP. +.br +If an older xdm/tdm configuration is found, its config files are "absorbed"; +if it lives in the new target directory, its scripts are reused (and possibly +modified) as well, otherwise the scripts are ignored and default scripts are +installed. +.SH OPTIONS +.TP +.BI \-\-in \ /path/to/new/tdm\-config\-dir +In which directory to put the new configuration. You can use this to support a $(DESTDIR), but not to change the final location of the installation \- the paths inside the files are not affected. +.br +Default is \fI/etc/trinity/tdm\fP. +.TP +.BI \-\-old\-xdm \ /path/to/old/xdm\-dir +Where to look for the config files of an \fBxdm\fP / older \fBtdm\fP. Default is to scan +.IR /etc/X11/tdm , \ $XLIBDIR/tdm , \ /etc/X11/xdm , \ $XLIBDIR/xdm ; +there in turn look for \fItdm\-config\fP and \fIxdm\-config\fP. +.br +Note that you possibly need to use \fB\-\-no\-old\-kde\fP to make this take effect. +.TP +.BI \-\-old\-kde \ /path/to/old/kde\-config\-dir +Where to look for the \fItdmrc\fP of an older \fBtdm\fP. +.br +.RI Default\ is\ to\ scan\ /etc/trinity \ and\ { /usr,/usr/local , +.RI { /opt,/usr/local }{ trinity,kde,kde2,kde1 }} /share/config . +.TP +.B \-\-no\-old +Don't look at older xdm/tdm configurations, just create default config. +.TP +.B \-\-no\-old\-xdm +Don't look at older xdm configurations. +.TP +.B \-\-no\-old\-kde +Don't look at older tdm configurations. +.TP +.B \-\-old\-scripts +Directly use all scripts from the older xdm/tdm configuration. +.TP +.B \-\-no\-old\-scripts +Don't use scripts from the older xdm/tdm configuration even if it lives in the new target directory. +.TP +.B \-\-old\-confs +Directly use all ancillary config files from the older xdm/tdm configuration. This is usually a bad idea. +.TP +.B \-\-no\-backup +Overwrite/delete old config files instead of backing them up. +.TP +.B \-\-no\-in\-notice +Don't put the notice about \fB\-\-in\fP being used into the generated README. +.SH SEE ALSO +.BR tdm (1) +.SH AUTHORS +.nf +Oswald Buddenhagen <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/kappfinder.1 b/doc/man/kappfinder.1 new file mode 100644 index 000000000..ec8eae964 --- /dev/null +++ b/doc/man/kappfinder.1 @@ -0,0 +1,54 @@ +.TH KAPPFINDER 1 "August, 24 2003" +.SH NAME +kappfinder \- searches for program to add to the Kde menu +.SH SYNOPSIS +.B kappfinder +.RI [ options ] +.SH DESCRIPTION +This manual page documents briefly the +.B kappfinder +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBkappfinder\fP is a program that searches your system for applications that can be inserted in the TDE menu, but that are not yet there. User can then select individually each of them and choose whether to add them. +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.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 \-v, \-\-version +Show version of program. +.TP +.B \-\-dir directory +Use this option to set where the .desktop files will be installed (default is $(HOME)/.trinity/share/applnk + +.SH SEE ALSO +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 <[email protected]>, +for the Debian GNU/Linux project (but may be used by others). +.PP +kappfinder was written by the KDE project diff --git a/doc/man/kasbar.1 b/doc/man/kasbar.1 new file mode 100644 index 000000000..7d57958d2 --- /dev/null +++ b/doc/man/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 <[email protected]> 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/kate.1 b/doc/man/kate.1 new file mode 100644 index 000000000..e48268d6f --- /dev/null +++ b/doc/man/kate.1 @@ -0,0 +1,83 @@ +.TH KATE 1 "May 2006" +.SH NAME +kate \- TDE Advanced Text Editor +.SH SYNOPSIS +.B kate +.RI [ options ] [file(s)] +.SH DESCRIPTION +This manual page documents briefly the +.B kate +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBkate\fP is a powerful text editor for TDE. It allows multiple documents (MDI interface), syntax coloration for many languages, ... + +It is able to expand or collapse parts of code (C functions, ...), can handle complete projects, and includes a terminal emulator. + +Kate is primarily intended for developers but can be used by anyone. It will for example be very useful to edit configuration files for example. + +It can handle plugins to expand its capabilities (more languages support, vim/Emacs compatibility, ...) + +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.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 \-v, \-\-version +Show version of program. +.TP +.B \-s, \-\-start <name> +Start Kate with a given session +.TP +.B \-u, \-\-use +Use a already running kate instance (if possible) +.TP +.B \-p, \-\-pid <pid> +Only try to reuse kate instance with this pid +.TP +.B \-e, \-\-encoding <name> +Set encoding for the file to open +.TP +.B \-l, \-\-line <line> +Navigate to this line +.TP +.B \-c, \-\-column <column> +Navigate to this column +.TP +.B \-i, \-\-stdin +Read the contents of stdin +.TP +.B file(s) +is the file or the files to open + +.SH SEE ALSO +.BR kwrite (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 <[email protected]>, for Debian GNU/Linux, but may be used by others. +.PP +kate was written by the KDE project diff --git a/doc/man/kblankscrn.kss.1 b/doc/man/kblankscrn.kss.1 new file mode 100644 index 000000000..46b2d4e1a --- /dev/null +++ b/doc/man/kblankscrn.kss.1 @@ -0,0 +1,156 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KBLANKSCRN.KSS 1 "June 2006" "Trinity Desktop Environment" "TDE screen saver" +.SH NAME +kblankscrn.kss +\- TDE screensaver which shows a blank screen +.SH SYNOPSIS +\fBkblankscrn.kss\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +\fBKBlankScreen\fP is a screensaver which shows a blank screen. +.SH OPTIONS +.SS Options: +.TP +.B \-\-setup +Setup screen saver +.TP +.B \-\-window\-id wid +Run in the specified XWindow +.TP +.B \-\-root +Run in the root XWindow +.TP +.B \-\-demo +Start screen saver in demo mode [default] +.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 AUTHORS +.nf +The KDE Project <www.kde.org> + +.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 <[email protected]> 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/kcheckpass.1 b/doc/man/kcheckpass.1 new file mode 100644 index 000000000..fa5a4c817 --- /dev/null +++ b/doc/man/kcheckpass.1 @@ -0,0 +1,49 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KCHECKPASS 1 "June 2006" "Trinity Desktop Environment" "authentication software" +.SH NAME +kcheckpass +\- The KCheckPass authentication software +.SH SYNOPSIS +\fBkcheckpass\fP +.SH DESCRIPTION +\fBKCheckPass\fP is TDE's authentication program. It is meant to be +used by any software in need of user authentication, most +notably screensavers. +.sp 1 +It enhances security be the following means: +.br +.IP " \-" +It's only a small program, which is hopefully simple enough to +allow it to be SUID root. Setting it to SUID root is necessary +on Shadow Password systems. +.IP " \-" +No other program in need of user authentication, must be +SUID root. +.IP " \-" +It provides a single implementation to check passwords. So one only must take a closer look at \fBKCheckPass\fP to ensure password security. It's much easier for programs using \fBKCheckPass\fP to preserve security. +.PP +.br +\fBTechnique:\fP +.sp 1 +\fBKCheckPass\fP is a simple password checker. Just invoke and send it the password on stdin. +.sp 1 +If the password was accepted, the program exits with 0; +.br +if it was rejected, it exits with 1. Any other exit code signals an error. + +.SH AUTHORS +.nf +Olaf Kirch <[email protected]> +.br +Christian Esken <[email protected]> +.br +Oswald Buddenhagen <[email protected]> +.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 <[email protected]> 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/kcminit.1 b/doc/man/kcminit.1 new file mode 100644 index 000000000..4c557456e --- /dev/null +++ b/doc/man/kcminit.1 @@ -0,0 +1,153 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KCMINIT 1 "June 2006" "Trinity Desktop Environment" "Trinity Control Modules initialization" +.SH NAME +kcminit +\- runs startups initialization for Control Modules. +.SH SYNOPSIS +\fBkcminit\fP [Qt\-options] [TDE\-options] [options] module +.SH DESCRIPTION +\fBkcminit\fP runs startups initialization for Control Modules. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B module +Configuration module to run +.SS Options: +.TP +.B \-\-list +List modules that are run at startup +.SS +.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 AUTHORS +.nf +Matthias Hoelzer\-Kluepfel <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/kdcop.1 b/doc/man/kdcop.1 new file mode 100644 index 000000000..1c01dcc47 --- /dev/null +++ b/doc/man/kdcop.1 @@ -0,0 +1,159 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KDCOP 1 "June 2006" "Trinity Desktop Environment" "A graphical DCOP browser/client" +.SH NAME +kdcop +\- A graphical DCOP browser/client +.SH SYNOPSIS +\fBkdcop\fP [Qt\-options] [TDE\-options] +.SH DESCRIPTION +\fBkdcop\fP is a browser/executor for DCOP. It queries the DCOP clients in a system, +their interfaces, and the interfaces' arguments. You can even execute DCOP +calls by double\-clicking on a call. If the method has parameters, \fBkdcop\fP will +open a dialog and prompt you for them. If the method returns a return value, +you will see it in a message box after the call. +.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 +.SS + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/kdcop/ +directly into konqueror or you can run +.BR "khelpcenter help:/kdcop/" +from the command\-line. +.br +.SH AUTHORS +.nf +Matthias Kalle Dalheimer <[email protected]> +.br +Rik Hemsley <[email protected]> +.br +Ian Reinhart Geiser <[email protected]> +.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 <[email protected]> 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/kdialog.1 b/doc/man/kdialog.1 new file mode 100644 index 000000000..243709ed1 --- /dev/null +++ b/doc/man/kdialog.1 @@ -0,0 +1,209 @@ +.TH KDIALOG "1" "December 2002" "TDE" "TDE Application" +.SH NAME +kdialog \- Show TDE dialog boxes from shell scripts +.SH SYNOPSIS +.B kdialog +[\fIQt-options\fR] [\fITDE-options\fR] [\fIoptions\fR] [\fIarg\fR] +.SH DESCRIPTION +This manual page documents briefly the +.B kdialog +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 kdialog +allows to display dialog boxes from shell scripts. +The syntax is very much inspired from the +.B dialog +command +(which shows text mode dialogs). +.SH OPTIONS +.TP +.BI \-\-yesno " text" +Question message box with yes/no buttons +.TP +.BI \-\-yesnocancel " text" +Question message box with yes/no/cancel buttons +.TP +.BI \-\-warningyesno " text" +Warning message box with yes/no buttons +.TP +.BI \-\-warningcontinuecancel " text" +Warning message box with continue/cancel buttons +.TP +.BI \-\-warningyesnocancel " text" +Warning message box with yes/no/cancel buttons +.TP +.BI \-\-sorry " text" +\&'Sorry' message box +.TP +.BI \-\-error " text" +\&'Error' message box +.TP +.BI \-\-msgbox " text" +Message Box dialog +.TP +.BI \-\-inputbox " text init" +Input Box dialog +.TP +.BI \-\-password " text" +Password dialog +.TP +.RI \fB\-\-textbox\fP \ file " [" width "] [" height ] +Text Box dialog +.TP +.RI \fB\-\-menu\fP \ text " [" "tag item" "] [" "tag item" "] ..." +Menu dialog +.TP +.RI \fB\-\-checklist\fP \ text " [" "tag item status" "] ..." +Check List dialog +.TP +.RI \fB\-\-radiolist\fP " text" " [" "tag item status" "] ..." +Radio List dialog +.TP +.BI \-\-title " text" +Dialog title +.TP +.B \-\-separate\-output +Return list items on separate lines (for checklist option) +.SS "Arguments:" +.TP +arg +Arguments - depending on main option +.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 +\fB\-v\fR, \fB\-\-version\fR +Show version information +.TP +.B \-\-license +Show license information +.TP +.B \-\- +End of options +.SS "Qt options:" +.TP +.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 application 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 (caption). +.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 +mirrors the whole layout of widgets. +.SS "TDE options:" +.TP +.BI \-\-caption \ caption +Use \fIcaption\fP as name in the titlebar. +.TP +.BI \-\-icon \ icon +Use \fIicon\fP as the application icon. +.TP +.BI \-\-miniicon \ icon +Use \fIicon\fP as the icon in the titlebar. +.TP +.BI \-\-config \ filename +Use alternative configuration file. +.TP +.BI \-\-dcopserver \ server +Use the DCOP Server specified by \fIserver\fP. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. +.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. +.SH AUTHOR +KDialog was written by +.nh +.ad l +David Faure <[email protected]>, +Nick Thompson, +Nick Thompson, +Matthias Hoelzer <[email protected]> and +David Gumbel <[email protected]>. +.br +.hy +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\[email protected]> +.hy +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/keditbookmarks.1 b/doc/man/keditbookmarks.1 new file mode 100644 index 000000000..23606dccb --- /dev/null +++ b/doc/man/keditbookmarks.1 @@ -0,0 +1,181 @@ +.\" This file was generated by kdemangen.pl +.TH KEDITBOOKMARKS 1 "Jan 2005" "Trinity Desktop Environment" "Konqueror Bookmarks Editor" +.SH NAME +keditbookmarks +- Konqueror Bookmark Editor +.SH SYNOPSIS +keditbookmarks [Qt-options] [TDE-options] [options] [file] +.SH DESCRIPTION +Bookmark editor for TDE. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B file +File to edit +.SS Options: +.TP +.B --importmoz <filename> +Import bookmarks from a file in Mozilla format +.TP +.B --importns <filename> +Import bookmarks from a file in Netscape (4.x and earlier) format +.TP +.B --importie <filename> +Import bookmarks from a file in Internet Explorer's Favorites format +.TP +.B --importopera <filename> +Import bookmarks from a file in Opera format +.TP +.B --exportmoz <filename> +Export bookmarks to a file in Mozilla format +.TP +.B --exportns <filename> +Export bookmarks to a file in Netscape (4.x and earlier) format +.TP +.B --exporthtml <filename> +Export bookmarks to a file in a printable HTML format +.TP +.B --exportie <filename> +Export bookmarks to a file in Internet Explorer's Favorites format +.TP +.B --exportopera <filename> +Export bookmarks to a file in Opera format +.TP +.B --address <address> +Open at the given position in the bookmarks file +.TP +.B --customcaption <caption> +Set the user readable caption for example "Konsole" +.TP +.B --nobrowser +Hide all browser related functions +.SS +.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 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 +.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 +.SH AUTHORS +.nf +David Faure <[email protected]> +.br +Alexander Kellett <[email protected]> +.br + diff --git a/doc/man/kfind.1 b/doc/man/kfind.1 new file mode 100644 index 000000000..55542fd66 --- /dev/null +++ b/doc/man/kfind.1 @@ -0,0 +1,58 @@ +.TH KFIND 1 "August, 25 2003" +.SH NAME +kfind \- TDE find tool +.SH SYNOPSIS +.B kfind +.RI [ options ] [searchpath] +.SH DESCRIPTION +This manual page documents briefly the +.B kfind +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBkfind\fP is a find tool for TDE. It allows fine tuning of the search options (name, path, type, plain text search, meta search, modification date, size, user, group, ...) + +It also permits to save the results of the search in a file, which is a plain-text list of file URIs. (file:/path_to_file) + +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.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 \-v, \-\-version +Show version of program. + +.TP +.B searchpath +is the path in which the search must be done + +.SH SEE ALSO +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 <[email protected]>, +for the Debian GNU/Linux project (but may be used by others). +.PP +kfind was written by the KDE project diff --git a/doc/man/kfmclient.1 b/doc/man/kfmclient.1 new file mode 100644 index 000000000..67cbed380 --- /dev/null +++ b/doc/man/kfmclient.1 @@ -0,0 +1,222 @@ +.\" This file was generated by kdemangen.pl +.\" Further edits by Adeodato Simó. COMMANDS and EXAMPLES sections added. +.TH KFMCLIENT 1 "Jan 2005" "Trinity Desktop Environment" "TDE tool for opening URLs from the command line" +.SH NAME +kfmclient +- TDE tool for opening URLs from the command line +.SH SYNOPSIS +kfmclient [Qt-options] [TDE-options] [options] command [URL(s)] +.SH DESCRIPTION +kfmclient is a tool for opening local and remote URLs in Konqueror from +the command line. +.SH COMMANDS +.SS +.SS openURL +.TP +kfmclient openURL \fIurl\fR [ \fImimetype\fR ] +Opens a window showing \fIurl\fR. \fIurl\fR may be a relative path or file name, +such as . or subdir/. If \fIurl\fR is omitted, $HOME is used instead. + +If \fImimetype\fR is specified, it will be used to determine the component +that Konqueror should use. For instance, set it to text/html for a web +page, to make it appear faster. +.SS newTab +.TP +kfmclient newTab \fIurl\fR [ \fImimetype\fR ] +Same as above but opens a new tab with \fIurl\fR in an existing Konqueror +window on the current active desktop if possible. +.SS openProfile +.TP +kfmclient openProfile \fIprofile\fR [ \fIurl\fR ] +Opens a window using the given profile. \fIprofile\fR is a file under +~/.trinity/share/apps/konqueror/profiles. \fIurl\fR is an optional URL to open. +.SS openProperties +.TP +kfmclient openProperties \fIurl\fR +Opens a properties menu. +.SS exec +.TP +kfmclient exec [ \fIurl\fR [ \fIbinding\fR ] ] +Tries to execute \fIurl\fR. \fIurl\fR may be a usual URL, this URL will +be opened. You may omit \fIbinding\fR. In this case the default binding +is tried. Of course URL may be the URL of a document, or it may be a +*.desktop file. +This way you could for example mount a device by passing 'Mount default' +as binding to 'cdrom.desktop'. +.SS move +.TP +kfmclient move \fIsrc\fR \fIdest\fR +Moves the URL \fIsrc\fR to \fIdest\fR. \fIsrc\fR may be a list of URLs. +.SS copy +.TP +kfmclient copy \fIsrc\fR \fIdest\fR +Copies the URL \fIsrc\fR to \fIdest\fR. \fIsrc\fR may be a list of URLs. +.SS download +.TP +kfmclient download [ \fIsrc\fR ] +Copies the URL \fIsrc\fR to a user specified location. \fIsrc\fR may be +a list of URLs, if not present then a URL will be requested. +.SS sortDesktop +.TP +kfmclient sortDesktop +Rearranges all icons on the desktop. +.SS configure +.TP +kfmclient configure +Re-read Konqueror's configuration. +.SS configureDesktop +.TP +kfmclient configureDesktop +Re-read kdesktop's configuration. +.SH OPTIONS +.SS +.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 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 +.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 EXAMPLES +.TP +kfmclient exec file:/root/Desktop/cdrom.desktop "Mount default" +Mounts the CD-ROM. +.TP +kfmclient exec file:/home/weis/data/test.html +Opens the file with default binding. +.TP +kfmclient exec file:/home/weis/data/test.html Netscape +Opens the file with netscape. +.TP +kfmclient exec ftp://localhost/ +Opens new window with URL. +.TP +kfmclient exec file:/root/Desktop/emacs.desktop +Starts emacs. +.TP +kfmclient exec file:/root/Desktop/cdrom.desktop +Opens the CD-ROM's mount directory. +.TP +kfmclient exec . +Opens the current directory. Very convenient. +.SH OTHER +This manual page was written by Adeodato Simo <[email protected]> for the +Debian system (but may be used by others). + +This manual page can be redistribute and/or modified it under the terms +of the GNU General Public License as published by the Free Software +Foundation; version 2 dated June, 1991. +.nf diff --git a/doc/man/khotkeys.1 b/doc/man/khotkeys.1 new file mode 100644 index 000000000..34d754b05 --- /dev/null +++ b/doc/man/khotkeys.1 @@ -0,0 +1,150 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KHOTKEYS 1 "June 2006" "Trinity Desktop Environment" "KHotKeys daemon" +.SH NAME +khotkeys +\- daemon to bind actions to triggers and conditions +.SH SYNOPSIS +\fBkhotkeys\fP [Qt\-options] [TDE\-options] +.SH DESCRIPTION +\fBKHotKeys\fP is a utility that allows you to bind actions to triggers and conditions. The most common case is where action means launching some command/application/URL, the trigger is some key combination pressed and condition is some window being (not) active/existing. +.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. +.SS + +.SH FILES +.I ~/.trinity/share/config/khotkeysrc +\fBkhotkeys\fP configuration file + +.SH AUTHORS +.nf +Lubos Lunak <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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.1 b/doc/man/kicker.1 new file mode 100644 index 000000000..1d17fa199 --- /dev/null +++ b/doc/man/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 <[email protected]> +.br +Matthias Elter <[email protected]> +.br +Matthias Ettrich <[email protected]> +.br +Wilco Greven <[email protected]> +.br +Rik Hemsley <[email protected]> +.br +Daniel M. Duley <[email protected]> +.br +Preston Brown <[email protected]> +.br +John Firebaugh <[email protected]> +.br +Waldo Bastian <[email protected]> +.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 <[email protected]> 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/kjobviewer.1 b/doc/man/kjobviewer.1 new file mode 100644 index 000000000..6dae2692e --- /dev/null +++ b/doc/man/kjobviewer.1 @@ -0,0 +1,202 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KJOBVIEWER 1 "June 2006" "Trinity Desktop Environment" "A print job viewer" +.SH NAME +kjobviewer +\- a print job viewer +.SH SYNOPSIS +\fBkjobviewer\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +\fBKJobViewer\fP is a powerful queue and spool manager. You can view jobs in the different queues waiting for print as well as manipulate jobs in many ways. +.sp 1 +The details are, again, as with all other modules of \fBTDEPrint\fP, dependent on the print subsystem in use. \fBCUPS\fP, as is usual now, in this field is the most feature\-complete system for "doing something with jobs that are sent away already and wait for print, possibly on a remote print server". +.sp 1 +With kjobviewer you can... +.IP " \-" +see an overview for a certain queue or see all jobs on all queues; +.IP " \-" +filter the list to see your "own" jobs only; +.IP " \-" +sort the pending jobs according to different criteria (size, ownership, job\-ide, job\-name; billing\-tags); +.IP " \-" +stop a job from printing, putting it into a "held" state; +.IP " \-" +re\-start a held job; +.IP " \-" +manually release a job that was sent to "hold" from the client already; +.IP " \-" +reschedule a job for printing at a specified time; +.IP " \-" +increase or decrease the job\-priorities (allowed values are 1\-100) to re-arrange the order of automatic printing; +.IP " \-" +move a job to a different print\-queue; +.IP " \-" +stop jobs from leaving the queue (while still accepting incoming ones); +.IP " \-" +reject new incoming jobs (while still printing all the pending ones until the queue is empty); +.IP " \-" +check and re\-set all job options \-\- even adapt them to another target printet which might have a complete different set of commands; +.IP " \-" +view the existing and re\-assign a new job\-billing tag to a job; +.IP " \-" +pop up on screen a nicely formatted report of IPP attributes for any job and also print it; +.IP " \-" +increase or decrease the number of required copies; +.IP " \-" +cancel and delete a no-longer\-required job. +.PP +Note, that some of these manipulations require job ownership or root access. +.SH OPTIONS +.SS Options: +.TP +.B \-d +<printer\-name> The printer for which jobs are requested +.TP +.B \-\-noshow +Show job viewer at startup +.TP +.B \-\-all +Show jobs for all printers +.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 +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/kjobviewer/ +directly into konqueror or you can run +.BR "khelpcenter help:/kjobviewer/" +from the command\-line. +.br +.SH AUTHORS +.nf +Michael Goffioul <[email protected]> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/kmenuedit.1 b/doc/man/kmenuedit.1 new file mode 100644 index 000000000..fd5c7daf5 --- /dev/null +++ b/doc/man/kmenuedit.1 @@ -0,0 +1,51 @@ +.TH KMENUEDIT 1 "August, 24 2003" +.SH NAME +kmenuedit \- editor for the TDE menu +.SH SYNOPSIS +.B kmenuedit +.RI [ options ] +.SH DESCRIPTION +This manual page documents briefly the +.B kmenuedit +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBkmenuedit\fP is a powerful editor for the TDE menu. It allows you to add, remove, or move items in the menu, add sub-menus, ... +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.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 \-v, \-\-version +Show version of program. + +.SH SEE ALSO +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 <[email protected]>, +for the Debian GNU/Linux project (but may be used by others). +.PP +kmenuedit was written by the KDE project diff --git a/doc/man/knetattach.1 b/doc/man/knetattach.1 new file mode 100644 index 000000000..84bc38fcf --- /dev/null +++ b/doc/man/knetattach.1 @@ -0,0 +1,164 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KNETATTACH 1 "June 2006" "Trinity Desktop Environment" "TDE Network Wizard" +.SH NAME +knetattach +\- TDE Network Wizard +.SH SYNOPSIS +\fBknetattach\fP [Qt\-options] [TDE\-options] +.SH DESCRIPTION +The \fBTDE Network Wizard\fP is an application which makes it easier to integrate your network resources with your Trinity Desktop. +.sp 1 +The program, also known as the \fBNetwork Folder Wizard\fP, allows easy addition and integration of various network folders with your Trinity desktop. +.sp 1 +The \fBNetwork Folder Wizard\fP currently allows you to add four types of network folders: +.br +.RS 3 +\- WebDav +.br +\- FTP +.br +\- Microsoft(R) Windows(R) (Samba) network drives +.br +\- SSH +.RE +.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 + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/knetattach/ +directly into konqueror or you can run +.BR "khelpcenter help:/knetattach/" +from the command\-line. +.br +.SH AUTHORS +.nf +George Staikos <[email protected]> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/konqueror.1 b/doc/man/konqueror.1 new file mode 100644 index 000000000..0515c4f87 --- /dev/null +++ b/doc/man/konqueror.1 @@ -0,0 +1,245 @@ +.\" This file was generated by kdemangen.pl +.TH KONQUEROR 1 "Jan 2005" "Trinity Desktop Environment" "Web browser, file manager, ..." +.SH NAME +konqueror +- Web browser, file manager, ... +.SH SYNOPSIS +konqueror [Qt-options] [TDE-options] [options] [URL] +.SH DESCRIPTION +Konqueror is the file manager for the Trinity Desktop Environment. +It supports basic file management on local UNIX filesystems, +from simple cut/copy and paste operations to advanced remote +and local network file browsing. + +It is also the canvas for all the latest TDE technology, +from KIO slaves (which provide mechanisms for file access) to +component embedding via the KParts object interface, and it +is one of the most customizable applications available. + +Konqueror is an Open Source web browser with HTML4.0 compliance, +supporting Java applets, JavaScript, CSS1 and (partially) CSS2, +as well as Netscape plugins (for example, Flash or RealVideo plugins). + +It is a universal viewing application, capable of embedding +read-only viewing components in itself to view +documents without ever launching another application. + +This package is part of the official TDE base module. + + +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B URL +Location to open +.SS Options: +.TP +.B --silent +Start without a default window +.TP +.B --preload +Preload for later use +.TP +.B --profile <profile> +Profile to open +.TP +.B --profiles +List available profiles +.TP +.B --mimetype <mimetype> +Mimetype to use for this URL (e.g. text/html or inode/directory) +.TP +.B --select +For URLs that point to files, opens the directory and selects the file, instead of opening the actual file +.SS +.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 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 +.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 + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/konqueror/ +directly into konqueror or you can run +.BR "`khelpcenter help:/konqueror/'" +from the command-line. +.br +.SH AUTHORS +.nf +David Faure <[email protected]> +.br +Simon Hausmann <[email protected]> +.br +Michael Reiher <[email protected]> +.br +Matthias Welk <[email protected]> +.br +Alexander Neundorf <[email protected]> +.br +Michael Brade <[email protected]> +.br +Lars Knoll <[email protected]> +.br +Dirk Mueller <[email protected]> +.br +Peter Kelly <[email protected]> +.br +Waldo Bastian <[email protected]> +.br +Germain Garand <[email protected]> +.br +Leo Savernik <[email protected]> +.br +Stephan Kulow <[email protected]> +.br +Antti Koivisto <[email protected]> +.br +Apple Safari Developers +.br +Harri Porten <[email protected]> +.br +Koos Vriezen <[email protected]> +.br +Matt Koss <[email protected]> +.br +Alex Zepeda <[email protected]> +.br +Richard Moore <[email protected]> +.br +Dima Rogozin <[email protected]> +.br +Wynn Wilkes <[email protected]> +.br +Stefan Schimanski <[email protected]> +.br +George Staikos <[email protected]> +.br +Dawit Alemayehu <[email protected]> +.br +Carsten Pfeiffer <[email protected]> +.br +Torsten Rahn <[email protected]> +.br +Torben Weis <[email protected]> +.br +Joseph Wenninger <[email protected]> +.br + diff --git a/doc/man/konsole.1 b/doc/man/konsole.1 new file mode 100644 index 000000000..5de5500b4 --- /dev/null +++ b/doc/man/konsole.1 @@ -0,0 +1,179 @@ +.\" The draft of this file was generated by kdemangen.pl and edited after. +.TH Konsole 1 "Nov 2005" "Trinity Desktop Environment" "" +.SH NAME +.BR Konsole +\- X terminal emulator for TDE. +.SH SYNOPSIS +.BR Konsole +[Qt\-options] [TDE\-options] [options] [args] +.SH DESCRIPTION +Konsole is an X terminal emulation which provides a command-line interface +(CLI) while using the graphical Trinity Desktop Environment. Konsole helps to +better organize user's desktop by containing multiple sessions in a single +window (a less cluttered desktop). +.PP +Konsole advanced features include simple configuration and the ability to use +multiple terminal shells in a single window, making for a less +cluttered desktop. +.PP +Using Konsole, a user can open: +.PP +.RS +Linux console sessions +.PP +Shell sessions +.PP +Screen sessions +.PP +Midnight Commander file manager sessions +.PP +Root console sessions +.PP +Root Midnight Commander sessions +.PP +User created sessions +.RE + +These sessions can be renamed to help you keep track of all your shells, +or signaled (STOP, CONT, HUP, INT, TERM, KILL). +.PP +For more control over konsole, a user can: +hide/show the menubar and/or frame; +select the size of a konsole window, fonts, color +schemes, and key mapping; +change location of the scrollbar or hide the scrollbar; +change location of the tabbar or hide the tabbar. +.PP +All chosen settings can be made the default for forthcoming sessions by +saving them. +.SH OPTIONS +.SS +.SS Konsole specific options: +.TP +.B \-\-name <name> +Set window class +.TP +.B \-\-ls +Start login shell +.B \-T <title> +Set the window title +.TP +.B \-\-tn <terminal> +Specify terminal type as set in the TERM [xterm] +environment variable +.TP +.B \-\-noclose +Do not close Konsole when command exits +.TP +.B \-\-nohist +Do not save lines in history +.TP +.B \-\-nomenubar +Do not display menubar +.TP +.B \-\-notabbar, \-\-notoolbar +Do not display tab bar +.TP +.B \-\-noframe +Do not display frame +.TP +.B \-\-noscrollbar +Do not display scrollbar +.TP +.B \-\-noxft +Do not use Xft (anti-aliasing) +.TP +.B \-\-vt_sz CCxLL +Terminal size in columns x lines +.TP +.B \-\-noresize +Terminal size is fixed +.TP +.B \-\-type <type> +Start with given session type +.TP +.B \-\-types +List available session types +.TP +.B \-\-keytab <name> +Set keytab to 'name' +.TP +.B \-\-keytabs +List available keytabs +.TP +.B \-\-profile <name> +Start with given session profile +.TP +.B \-\-profiles +List available session profiles +.TP +.B \-\-schema <name> +| <file> Set schema to 'name' or use 'file' +.TP +.B \-\-schemas, \-\-schemata +List available schemata +.TP +.B \-\-script +Enable extended DCOP Qt functions +.TP +.B \-\-workdir <dir> +Change working directory to 'dir' +.TP +.B \-e <command> [ arguments ] +Execute 'command' instead of shell. It also sets the window title and +icon name to be the basename of the program being executed if neither +-T nor -n are given on the command line. +This must be the last option on the command line. +.SS +.SS Arguments: +.TP +.B args +Arguments for 'command' +.SS +.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 + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/konsole/ +directly into konqueror or you can run +.BR "`khelpcenter help:/konsole/'" +from the command-line. +.BR + +Konsole homepage: +.BR http://konsole.kde.org/ +.SH AUTHORS +Kurt V. Hindenburg <[email protected]> + +Lars Doelle <[email protected]> +.BR +.SH OTHER +This manual page was written by Ana Beatriz Guerrero Lopez <[email protected]> for the Debian +system (but may be used by others). +.BR + diff --git a/doc/man/kpager.1 b/doc/man/kpager.1 new file mode 100644 index 000000000..63a24f267 --- /dev/null +++ b/doc/man/kpager.1 @@ -0,0 +1,53 @@ +.TH KPAGER 1 "August, 24 2003" +.SH NAME +kpager \- Trinity desktop pager +.SH SYNOPSIS +.B kpager +.RI [ options ] +.SH DESCRIPTION +This manual page documents briefly the +.B kpager +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBkpager\fP is a desktop pager for the Trinity desktop. It creates mini-views of the different Trinity desktops. These views show the real content of the desktop, or only icons. +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.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 \-v, \-\-version +Show version of program. +.TP +.B \-\-hidden +Create the preview of the desktops, but hide the window +.SH SEE ALSO +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 <[email protected]>, +for the Debian GNU/Linux project (but may be used by others). +.PP +kpager was written by the KDE project diff --git a/doc/man/kpersonalizer.1 b/doc/man/kpersonalizer.1 new file mode 100644 index 000000000..01dc0b3cc --- /dev/null +++ b/doc/man/kpersonalizer.1 @@ -0,0 +1,66 @@ +.TH KPERSONALIZER 1 +.SH NAME +kpersonalizer - TDE basic settings wizard + +.SH SYNOPSIS + +.B kpersonalizer [OPTION...] + +.SH DESCRIPTION + +The TDE Personalizer (KPersonalizer) is a wizard to configure TDE, and should automatically be run the first time a user runs TDE, to allow the user to configure basic TDE settings. +.PP +KPersonalizer allows the user to set locales, desktop behavior, enable accessibility features, and so forth. The options can be changed later by the Trinity Control Center application. + +.SH OPTIONS + +KPersonalizer accepts the following options: +.PP +.B Help 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. + +.PP +.B Options +.TP +.B \-r +KPersonalizer is restarted by itself. +.TP +.B \-\-before-session +KPersonalizer is started before the TDE session. + +.SH EXAMPLES +.TP +.B kpersonalizer +Run kpersonalizer to set (or reset) TDE preferences. +.TP +.B kpersonalizer --before-session +Run kpersonalizer before the first TDE session. + +.SH AUTHORS + +Kpersonalizer was written by Ralf Nolden <[email protected]>, Carsten Wolff <[email protected]>, qwertz <[email protected]>, and Bernhard Rosenkraenzer <[email protected]>. +.PP +This manual page was written by Joe Brockmeier <[email protected]>, for the Debian GNU/Linux project, but may be used by others. +.SH "SEE ALSO" +.TP +.BR khelpcenter (1) diff --git a/doc/man/kprinter.1 b/doc/man/kprinter.1 new file mode 100644 index 000000000..a3ecdc88b --- /dev/null +++ b/doc/man/kprinter.1 @@ -0,0 +1,209 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KPRINTER 1 "June 2006" "Trinity Desktop Environment" "A printer tool for TDE" +.SH NAME +kprinter +\- a printer tool for TDE +.SH SYNOPSIS +\fBkprinter\fP [Qt\-options] [TDE\-options] [options] file(s) +.SH DESCRIPTION +\fBKPrinter\fP opens automatically when you click on the "Print" icon of any TDE application. Choose your print job settings by going through the dialog and then click on the "Print" button. +.sp 1 +\fBkprinter\fP is a very versatile tool. Depending on the actual features and power of the print subsystem of your computer, \fBkprinter\fP translates the former's abilities into a nice and easy\-to\-understand GUI. If your print subsystem does not support duplexing, \fBkprinter\fP will not show the option. If your print subsystem is CUPS, kprinter is at its peak shape. +.sp 1 +With \fBKPrinter\fP you can... +.IP " \-" +switch "on the fly" the print subsystem\-to\-use, +.IP " \-" +start the Add Printer Wizard, +.IP " \-" +choose the target printer, +.IP " \-" +possibly select one or more files to print, +.IP " \-" +drag'n'drop files for print, +.IP " \-" +check for or set the print options, +.IP " \-" +schedule the job for later printing, +.IP " \-" +tag the print job with accounting information for billing purposes, +.IP " \-" +set the job priority for a higher or lower level to influence the order of the job queue, +.IP " \-" +access the TDEPrint configurator, +.IP " \-" +and activate (or disable) a viewing filter that shows all or just the selected few printers relevant to the user. +.SP +.SH OPTIONS +.SS +.SS Arguments: +file(s) Files to load +.SS Options: +.TP +.B \-c +Make an internal copy of the files to print +.TP +.B \-P, \-d <printer> +Printer/destination to print on +.TP +.B \-J, \-t <title> +Title/Name for the print job +.TP +.B \-#, \-n <number> +Number of copies +.TP +.B \-o +<option=value> Printer option +.TP +.B \-j <mode> +Job output mode (gui, console, none) [gui] +.TP +.B \-\-system <printsys> +Print system to use (lpd, cups) +.TP +.B \-\-stdin +Allow printing from STDIN +.TP +.B \-\-nodialog +Do not show the print dialog (print directly) +.SS +.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 +\fB\-\-nograb\fP, use \fB\-\-dograb\fP 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 +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/kprinter/ +directly into konqueror or you can run +.BR "khelpcenter help:/kprinter/" +from the command\-line. +.br +.SH AUTHORS +.nf +Michael Goffioul <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/krandom.kss.1 b/doc/man/krandom.kss.1 new file mode 100644 index 000000000..4a13d95ec --- /dev/null +++ b/doc/man/krandom.kss.1 @@ -0,0 +1,152 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KRANDOM.KSS 1 "June 2006" "Trinity Desktop Environment" "TDE screen saver" +.SH NAME +krandom.kss +\- Start a random TDE screen saver +.SH SYNOPSIS +\fBkrandom.kss\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +\fBkrandom.kss\fP starts a random TDE screen saver. +.SH OPTIONS +.SS Options: +.TP +.B \-\-setup +Setup screen saver +.TP +.B \-\-window\-id wid +Run in the specified XWindow +.TP +.B \-\-root +Run in the root XWindow +.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 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 <[email protected]> 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/kreadconfig.1 b/doc/man/kreadconfig.1 new file mode 100644 index 000000000..3bb6c4d0b --- /dev/null +++ b/doc/man/kreadconfig.1 @@ -0,0 +1,173 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KREADCONFIG 1 "June 2006" "Trinity Desktop Environment" "Read TDEConfig entries" +.SH NAME +kreadconfig +\- Read TDEConfig entries (for use in shell scripts) +.SH SYNOPSIS +\fBkreadconfig\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +\fBkreadconfig\fP is a command line tool to retrieve values from TDE configuration files. +.sp 1 +If a file given via option \fB\-\-file\fP does not contain a path the TDE standard configuration directory is used. +.SS Example: +.TP +\fBkreadconfig \-\-group\fP Directories \fB--key\fP dir_tmp +read the \fBvalue\fP for \fBkey\fP dir_tmp in \fBgroup\fP Directories from TDE's main configuration file + +.SH OPTIONS +.SS Options: +.TP +.B \-\-file <file> +Use <file> instead of global config +.TP +.B \-\-group <group> +Group to look in [TDE] +.TP +.B \-\-key <key> +Key to look for +.TP +.B \-\-default <default> +Default value +.TP +.B \-\-type <type> +Type of variable +.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 +.I /etc/trinity/system.kdeglobals +global TDE configuration file +.I ~/.trinity/share/config +standard configuration directory + +.SH AUTHORS +.nf +Bernhard Rosenkraenzer <[email protected]> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/krootimage.1 b/doc/man/krootimage.1 new file mode 100644 index 000000000..e9b19a604 --- /dev/null +++ b/doc/man/krootimage.1 @@ -0,0 +1,151 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KROOTIMAGE 1 "June 2006" "Trinity Desktop Environment" "helper program" +.SH NAME +krootimage +\- set desktop background for tdm +.SH SYNOPSIS +\fBkrootimage\fP [Qt\-options] [TDE\-options] config +.SH DESCRIPTION +\fBkrootimage\fP is a helper program for \fBtdm\fP to set the desktop background. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B config +Name of the configuration file +.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 +.BR tdm (1) +.SH AUTHORS +.nf +Matthias Hoelzer\-Kluepfel <[email protected]> +.br +Oswald Buddenhagen <[email protected]> + +.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 <[email protected]> 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/kstart.1 b/doc/man/kstart.1 new file mode 100644 index 000000000..9d3a77ddc --- /dev/null +++ b/doc/man/kstart.1 @@ -0,0 +1,215 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KSTART 1 "June 2006" "Trinity Desktop Environment" "application launch utility" +.SH NAME +kstart +\- Utility to launch applications with special window properties +.SH SYNOPSIS +\fBkstart\fP [Qt\-options] [TDE\-options] [options] command +.SH DESCRIPTION +Utility to launch applications with special window properties. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B command +Command to execute +.SS +.SS Options: +.TP +.B \-\-window <regexp> +A regular expression matching the window title +.TP +.B \-\-windowclass <class> +A string matching the window class (WM_CLASS property) +The window class can be found out by running +'xprop | grep WM_CLASS' and clicking on a window +(use either both parts separated by a space or only the right part). +NOTE: If you specify neither window title nor window class, +then the very first window to appear will be taken; +omitting both options is NOT recommended. +.TP +.B \-\-desktop <number> +Desktop on which to make the window appear +.TP +.B \-\-currentdesktop +Make the window appear on the desktop that was active +when starting the application +.TP +.B \-\-alldesktops +Make the window appear on all desktops +.TP +.B \-\-iconify +Iconify the window +.TP +.B \-\-maximize +Maximize the window +.TP +.B \-\-maximize\-vertically +Maximize the window vertically +.TP +.B \-\-maximize\-horizontally +Maximize the window horizontally +.TP +.B \-\-fullscreen +Show window fullscreen +.TP +.B \-\-type <type> +The window type: Normal, Desktop, Dock, Tool, +Menu, Dialog, TopMenu or Override +.TP +.B \-\-activate +Jump to the window even if it is started on a +different virtual desktop +.TP +.B \-\-ontop, \-\-keepabove +Try to keep the window above other windows +.TP +.B \-\-onbottom, \-\-keepbelow +Try to keep the window below other windows +.TP +.B \-\-skiptaskbar +The window does not get an entry in the taskbar +.TP +.B \-\-skippager +The window does not get an entry on the pager +.TP +.B \-\-tosystray +The window is sent to the system tray in Kicker +.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 AUTHORS +.nf +Matthias Ettrich <[email protected]> +.br +David Faure <[email protected]> +.br +Richard J. Moore <[email protected]> +.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 <[email protected]> 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/ksystraycmd.1 b/doc/man/ksystraycmd.1 new file mode 100644 index 000000000..4807276c0 --- /dev/null +++ b/doc/man/ksystraycmd.1 @@ -0,0 +1,189 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KSYSTRAYCMD 1 "June 2006" "Trinity Desktop Environment" "system tray utility" +.SH NAME +ksystraycmd +\- Allows any application to be kept in the system tray +.SH SYNOPSIS +\fBksystraycmd\fP [Qt\-options] [TDE\-options] [options] command +.SH DESCRIPTION +The system tray is an area in which an application can display a small window. +It may be used to display status information or provide quick access to commands. +Normally tray icons are developed as part of an application. +\fBksystraycmd\fP allows any application to be kept in the system tray. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B command +Command to execute +.SS +.SS Options: +.TP +.B \-\-window <regexp> +A regular expression matching the window title +If you do not specify one, then the very first window +to appear will be taken \- not recommended. +.TP +.B \-\-wid <int> +The window id of the target window +Specifies the id of the window to use. If the id starts with 0x +it is assumed to be in hex. +.TP +.B \-\-hidden +Hide the window to the tray on startup +.TP +.B \-\-startonshow +Wait until we are told to show the window before +executing the command +.TP +.B \-\-tooltip <text> +Sets the initial tooltip for the tray icon +.TP +.B \-\-keeprunning +Keep the tray icon even if the client exits. This option +has no effect unless startonshow is specified. +.TP +.B \-\-ownicon +Use ksystraycmd's icon instead of window's icon in systray +(should be used with \-\-icon to specify ksystraycmd icon) +.TP +.B \-\-ontop +Try to keep the window above other windows +.TP +.B \-\-quitonhide +Quit the client when we are told to hide the window. +This has no effect unless startonshow is specified and implies keeprunning. +.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 AUTHORS +.nf +Richard Moore <[email protected]> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/ktrash.1 b/doc/man/ktrash.1 new file mode 100644 index 000000000..0094c84fa --- /dev/null +++ b/doc/man/ktrash.1 @@ -0,0 +1,155 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KTRASH 1 "June 2006" "Trinity Desktop Environment" "helper program" +.SH NAME +ktrash +\- Helper program to handle the TDE trash can +.SH SYNOPSIS +\fBktrash\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +\fBktrash\fP is a helper program to handle the TDE trash can. +.sp 1 +Note: to move files to the trash, do not use \fBktrash\fP, but "\fBkfmclient\fP move 'url' trash:/" +.SH OPTIONS +.SS +.SS Options: +.TP +.B \-\-empty +Empty the contents of the trash +.TP +.B \-\-restore <file> +Restore a trashed file to its original location +.SS +.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 +\fBkfmclient\fP(1) +.SH AUTHORS +.nf +David Faure <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/kwrite.1 b/doc/man/kwrite.1 new file mode 100644 index 000000000..f7d39f61d --- /dev/null +++ b/doc/man/kwrite.1 @@ -0,0 +1,60 @@ +.TH KWRITE 1 "August, 25 2003" +.SH NAME +kwrite \- TDE text editor +.SH SYNOPSIS +.B kwrite +.RI [ options ] [file] +.SH DESCRIPTION +This manual page documents briefly the +.B kwrite +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBkwrite\fP is a text editor for TDE, that is a light version of \fIkate\fP. +It allows syntax coloration for many langages. + +It is able to expand or collapse parts of code (C functions, ...). + +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.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 \-v, \-\-version +Show version of program. + +.B file +is the file to open + +.SH SEE ALSO +.BR kate (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 <[email protected]>, +for the Debian GNU/Linux project (but may be used by others). +.PP +kwrite was written by the KDE project diff --git a/doc/man/kwriteconfig.1 b/doc/man/kwriteconfig.1 new file mode 100644 index 000000000..b347b9849 --- /dev/null +++ b/doc/man/kwriteconfig.1 @@ -0,0 +1,173 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KWRITECONFIG 1 "June 2006" "Trinity Desktop Environment" "Write TDEConfig entries" +.SH NAME +kwriteconfig +\- Write TDEConfig entries (for use in shell scripts) +.SH SYNOPSIS +\fBkwriteconfig\fP [Qt\-options] [TDE\-options] [options] value +.SH DESCRIPTION +\fBkwriteconfig\fP is a command line tool to write values in TDE configuration files. +Nonexisting files/groups/keys will be created. +.sp 1 +If a file given via option \fB\-\-file\fP does not contain a path the TDE standard configuration directory is used. +.SS Example: +.TP +\fBkwriteconfig \-\-file\fP \fImyrc\fP \fB\-\-group\fP Directories \fB\-\-key\fP dir_tmp /tmp +writes the \fBvalue\fP for \fBkey\fP dir_tmp in \fBgroup\fP Directories in configuration \fBfile\fP \fImyrc\fP + +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B value +The value to write. Mandatory, on a shell use '' for empty +.SS Options: +.TP +.B \-\-file <file> +Use <file> instead of global config +.TP +.B \-\-group <group> +Group to look in [TDE] +.TP +.B \-\-key <key> +Key to look for +.TP +.B \-\-type <type> +Type of variable. Use "bool" for a boolean, otherwise it is treated as a string +.SS +.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 AUTHORS +.nf +Luis Pedro Coelho <[email protected]> +.br +Bernhard Rosenkraenzer <[email protected]> +.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 <[email protected]> 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/kxkb.1 b/doc/man/kxkb.1 new file mode 100644 index 000000000..9a6a6bcf6 --- /dev/null +++ b/doc/man/kxkb.1 @@ -0,0 +1,163 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KXKB 1 "June 2006" "Trinity Desktop Environment" "A utility to switch keyboard maps" +.SH NAME +kxkb +\- A utility to switch keyboard maps +.SH SYNOPSIS +\fBkxkb\fP [Qt\-options] [TDE\-options] +.SH DESCRIPTION +\fBKxkb\fP is a keyboard layout switching utility based on X11 xkb extension. It allows to use different keyboard layouts for inputing text. \fBKxkb\fP features keyboard layout indicator. +.sp 1 +\fBKxkb\fP starts automatically and stays in system tray as a flag with 2 or 3 letter abbreviation of layout name on top of it if more than one layout is defined or Show indicator for single layout option is turned on. +.sp 1 +When \fBKxkb\fP is running you can change layouts clicking on its tray icon with the mouse or pressing its keyboard shortcut. Keyboard shortcut or mouse click will switch to next layout or alternatively you can right mouse button click the \fBKxkb\fP icon and select layout from the list. +.sp 1 +Right mouse button clicking on the \fBKxkb\fP icon you can start its configuration by selecting Configure... or by opening \fBControl Center\fP and selecting Localization/Keyboard Layout. Alternatively, you can start it by typing \fBtdecmshell keyboard_layout\fP in a terminal. +.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 +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/kxkb/ +directly into konqueror or you can run +.BR "khelpcenter help:/kxkb/" +from the command\-line. +.br +.SH AUTHORS +.nf +Andriy Rysin <[email protected]> +.br +Shaheed Haque <[email protected]> +.br +Ilya Konstantinov <kde\[email protected]> +.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 <[email protected]> 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/starttde.1 b/doc/man/starttde.1 new file mode 100644 index 000000000..73ab27b9c --- /dev/null +++ b/doc/man/starttde.1 @@ -0,0 +1,46 @@ +.TH starttde 1 "Jan 17, 2005" +.SH NAME +starttde \- Starts up the Trinity Desktop Environment +.SH SYNOPSIS +.B starttde +.br +.SH DESCRIPTION +This manual page documents briefly the +.B starttde +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +The \fBstarttde\fP script starts up the Trinity Desktop Environment and +is typically executed by your login manager (e.g. xdm, gdm, tdm, wdm or from +your X startup scripts). \fBstarttde\fP in turn launches ksmserver, which +will load your last session, or a default session that includes the standard +TDE programs if no saved session is available. + +\fBstarttde\fP, with ksmserver, is a standard X11R6 session manager that can manage +any X11R6 SM compliant program. + +\fBstarttde\fP and ksmserver use the contents of the ~/.trinity directory +for starting previously saved sessions. Source scripts found in ~/.trinity/env/*.sh +can be used to define environment variables that will be available to all TDE +programs. + +For anything else (that doesn't set env vars, or that needs a window manager), +better use the ~/.trinity/Autostart folder. + +At the end of a session, the scripts found in ~/.trinity/shutdown will be executed. + + +.SH OPTIONS +\fBstarttde\fP takes no command line options. + +.SH AUTHOR +\fBstarttde\fP is written by the KDE Project. + +This manual page was written by Philipp Grau. + +.SH "REPORTING BUGS" +Report bugs of this modified Debian version of starttde to the Bug +Tracking System at: http://bugs.debian.org +.SH COPYRIGHT +Copyright \(co 2005 Philipp Grau. diff --git a/doc/man/tdedebugdialog.1 b/doc/man/tdedebugdialog.1 new file mode 100644 index 000000000..af48f59e6 --- /dev/null +++ b/doc/man/tdedebugdialog.1 @@ -0,0 +1,200 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH TDEDEBUGDIALOG 1 "June 2006" "Trinity Desktop Environment" "control debug output" +.SH NAME +tdedebugdialog +\- A dialog box for setting preferences for debug output +.SH SYNOPSIS +\fBtdedebugdialog\fP [Qt\-options] [TDE\-options] [options] +.SH DESCRIPTION +\fBTDEDebugDialog\fP shows a dialog box for managing diagnostic messages at runtime. +.sp 1 +If you simply start \fBtdedebugdialog\fP, you will see a list of \fBareas\fP, that can be disabled or enabled. +.sp 1 +If you start \fBtdedebugdialog \-\-fullmode\fP, then for every severity level you can define separately what should be done with the diagnostic messages of that level, and the same for each debug area. +.sp 1 +In full mode, first you should select the debug area you are interested in from the drop down list at the top. +.sp 1 +You may independently set the output for various types of messages: +.sp 1 +.RS 3 +\- Information +.br +\- Warning +.br +\- Error +.br +\- Fatal Error +.RE +.PP +For each of these types, you can set the following: +.sp 1 +\fBOutput to\fP: +.br +In this Combobox, you can choose where the messages should be output. The choices are: \fBFile\fP?, \fBMessage Box\fP, \fBShell\fP (meaning stderr), \fBSyslog\fP an \fBNone\fP. Please do not direct fatal messages to syslog unless you are the system administrator yourself. The default is ?Message Box?. +.sp 1 +\fBFilename:\fP +.br +This is only enabled when you have chosen \fBFile\fP as the output and provides the name of that file (which is interpreted as relative to the current folder). The default is \fIkdebug.dbg\fP. +Apart from this, you can also tick the checkbox Abort on fatal errors. In this case, if a diagnostic message with the severity level TDEBUG_FATAL is output, the application aborts with a SIGABRT after outputting the message. +.sp 1 +When you close the dialog by pressing OK, your entries apply immediately and are saved in \fIkdebugrc\fP. When you press Cancel, your entries are discarded and the old ones are restored. + +.SH OPTIONS +.SS Options: +.TP +.B \-\-fullmode +Show the fully\-fledged dialog instead of the default list dialog +.TP +.B \-\-on <area> +Turn area on +.TP +.B \-\-off <area> +Turn area off +.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 FILES +.I ~/.trinity/share/config/kdebugrc +\fBtdedebugdialog\fP configuration file + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/tdedebugdialog/ +directly into konqueror or you can run +.BR "khelpcenter help:/tdedebugdialog/" +from the command\-line. +.br +.SH AUTHORS +.nf +David Faure <[email protected]> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/tdeio_media_mounthelper.1 b/doc/man/tdeio_media_mounthelper.1 new file mode 100644 index 000000000..1e7b055f6 --- /dev/null +++ b/doc/man/tdeio_media_mounthelper.1 @@ -0,0 +1,163 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH KIO_MEDIA_MOUNTHELPER 1 "June 2006" "Trinity Desktop Environment" "helper program" +.SH NAME +tdeio_media_mounthelper +\- tdeio_media_mounthelper +.SH SYNOPSIS +\fBtdeio_media_mounthelper\fP [Qt\-options] [TDE\-options] [options] URL +.SH DESCRIPTION +\fBtdeio_media_mounthelper\fP is a helper program to handle the mounting of media in TDE. It is part of the KIO subsystem. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B URL +media:/ URL to mount/unmount/eject/remove +.SS Options: +.TP +.B \-u +Unmount given URL +.TP +.B \-m +Mount given URL (default) +.TP +.B \-e +Eject given URL via tdeeject +.TP +.B \-s +Unmount and Eject given URL (necessary for some USB devices) +.SS +.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 AUTHORS +.nf +Waldo Bastian <[email protected]> +.br +Kevin Ottens <[email protected]> + +.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 <[email protected]> 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/tdeio_system_documenthelper.1 b/doc/man/tdeio_system_documenthelper.1 new file mode 100644 index 000000000..270dd86e6 --- /dev/null +++ b/doc/man/tdeio_system_documenthelper.1 @@ -0,0 +1,22 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH tdeio_system_documenthelper 1 "June 2006" "Trinity Desktop Environment" "helper script" +.SH NAME +tdeio_system_documenthelper +\- TDE helper script used by document.desktop +.SH SYNOPSIS +\fBtdeio_system_documenthelper\fP + +.SH DESCRIPTION +The script is used by document.desktop entry to determine if it must be shown or not. + +.SH AUTHORS +.nf +Kevin Ottens <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/tdepasswd.1 b/doc/man/tdepasswd.1 new file mode 100644 index 000000000..e09aff0e2 --- /dev/null +++ b/doc/man/tdepasswd.1 @@ -0,0 +1,169 @@ +.TH TDEPASSWD 1 + +.SH NAME +tdepasswd \- graphical frontend to change the user's password + +.SH SYNOPSIS +.B tdepasswd [ \fIQt-options\fR ] [ \fITDE-options\fR ] \fIoptions\fR + +.SH DESCRIPTION +Changes a UNIX password. + +.SH OPTIONS +.B Generic options: +.TP +.HP +.B \-\-help +Show help about options +.TP +.HP +.B \-\-help\-qt +Show Qt specific options +.TP +.HP +.B \-\-help\-tde +Show TDE specific options +.TP +.HP +.B \-\-help\-all +Show all options +.TP +.HP +.B \-\-author +Show author information +.TP +.HP +.B \-v\fR, \fB \-\-version +Show version information +.TP +.HP +.B \-\-license +Show license information +.TP +.B Qt options: +.TP +.HP +.B \-\-display <displayname> +Use the X-server display 'displayname'. +.TP +.HP +.B \-\-session <sessionId> +Restore the application for the given 'sessionId'. +.TP +.HP +.B \-\-cmap +Causes the application to install a private +color map on an 8-bit display. +.TP +.HP +.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 +.HP +.B \-\-nograb +Tells Qt to never grab the mouse or the keyboard. +.TP +.HP +.B \-\-dograb +Running under a debugger can cause an implicit +-nograb, use -dograb to override. +.TP +.HP +.B \-\-sync +Switches to synchronous mode for debugging. +.TP +.HP +.B \-\-fn, \-\-font <fontname> +Defines the application font. +.TP +.HP +.B \-\-bg, \-\-background <color> +sets the default background color and an +application palette (light and dark shades are +calculated). +.TP +.HP +.B \-\-fg, \-\-foreground <color> +Sets the default foreground color. +.TP +.HP +.B \-\-btn, \-\-button <color> +Sets the default button color. +.TP +.HP +.B \-\-name <name> +Sets the application name. +.TP +.HP +.B \-\-title <title> +Sets the application title (caption). +.TP +.HP +.B \-\-visual TrueColor +Forces the application to use a TrueColor visual on +an 8-bit display. +.TP +.HP +.B \-\-inputstyle <inputstyle> +Sets XIM (X Input Method) input style. Possible +values are onthespot, overthespot, offthespot and +root. +.TP +.HP +.B \-\-im <XIM server> +Set XIM server. +.TP +.HP +.B \-\-noxim +Disable XIM. +.TP +.HP +.B \-\-reverse +Mirrors the whole layout of widgets. +.TP +.B TDE options: +.TP +.HP +.B \-\-caption <caption> +Use 'caption' as name in the titlebar. +.TP +.HP +.B \-\-icon <icon> +Use 'icon' as the application icon. +.TP +.HP +.B \-\-miniicon <icon> +Use 'icon' as the icon in the titlebar. +.TP +.HP +.B \-\-config <filename> +Use alternative configuration file. +.TP +.HP +.B \-\-dcopserver <server> +Use the DCOP Server specified by 'server'. +.TP +.HP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. +.TP +.HP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.HP +.B \-\-style <style> +Sets the application GUI style. +.TP +.HP +.B \-\-geometry <geometry> +Sets the client geometry of the main widget. + +.SH "SEE ALSO" +.BR passwd (1). + +.SH AUTHOR +Andre Ramos <[email protected]> diff --git a/doc/man/tdeprintfax.1 b/doc/man/tdeprintfax.1 new file mode 100644 index 000000000..e407c294e --- /dev/null +++ b/doc/man/tdeprintfax.1 @@ -0,0 +1,160 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH TDEPRINTFAX 1 "June 2006" "Trinity Desktop Environment" "A fax utility" +.SH NAME +tdeprintfax +\- a interface to fax-packages +.SH SYNOPSIS +\fBtdeprintfax\fP [Qt\-options] [TDE\-options] [options] [file] +.SH DESCRIPTION +\fBtdeprintfax\fP is a small fax utility to be used with tdeprint. +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B file +File to fax (added to the file list) +.SS Options: +.TP +.B \-\-phone +Phone number to fax to +.TP +.B \-\-immediate +Send fax immediately +.TP +.B \-\-batch +Exit after sending +.SS +.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 AUTHORS +.nf +Michael Goffioul <[email protected]> +.br + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/tdesu.1 b/doc/man/tdesu.1 new file mode 100644 index 000000000..fa8c45e09 --- /dev/null +++ b/doc/man/tdesu.1 @@ -0,0 +1,102 @@ +.TH TDESU 1 "May 2005" "Trinity Desktop Environment" "Runs a program with elevated privileges." +.SH NAME +tdesu \- Runs a program with elevated privileges. +.SH SYNOPSIS +\fBtdesu\fR [Qt\-options] [TDE\-options] [tdesu options] command +.SH DESCRIPTION +Runs a program with elevated privileges. +.PP +TDE su is a graphical front end to the Unix \fBsu\fR utility. It allows you to run programs as another user by entering their password. It is not a SUID root program, but runs unprivileged. The system program \fBsu\fR is used for acquiring special privileges. +.PP +\fBtdesu\fR has the ability to store passwords for the convenience of users. The passwords are NOT written to disk, but stored in memory using a special program, \fBtdesud\fR. This is only done if the user specifies that the password be remembered. In this case, passwords are stored in memory for a certain period of time before being removed. \fBtdesud\fR runs in such a way that only the user who entered the password originally can use it, though no one, not even the user who originally entered the password, can retrieve the password that is stored by \fBtdesud\fR. Through these measures, users can avoid having to repeatedly enter root passwords or other passwords, without a significant risk to overall system security. +.PP +\fBtdesu\fR uses normally \fBsu\fR to gain root by using the root password. \fBtdesu\fR can also be configured to use other commands to gain root like sudo to use users password. +.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 +.SS +.SS tdesu Options: +.TP +.TP +.B -c <command> +Specifies the command to run +.TP +.B -f <file> +Run command under target uid if <file> is not writable +.TP +.B -u <user> +Specifies the target uid [default is root] +.TP +.B -n +Do not keep password +.TP +.B -s +Stop the daemon (forgets all passwords) +.TP +.B -t +Enable terminal output (no password keeping) +.TP +.B -p <prio> +Set priority value: 0 <= prio <= 100, 0 is lowest [default is 50] +.TP +.B -r +Use realtime scheduling +.TP +.B --nonewdcop +Let command use existing dcopserver +.TP +.B -i <icon name> +Specify icon to use in the password dialog +.TP +.B -d +Do not show the command to be run in the dialog +.SS +.SS Arguments: +.TP +.B command +Specifies the command to run + +.SH CONFIGURATION FILES +.PP +\fBtdesu\fR can be configured with a default configuration file /etc/trinity/tdesurc and with a per user configuration file in .trinity/share/config/tdesurc. Alternative a section could be added to kdeglobals. +.SH EXAMPLE +The configuration item for the configuration files is the following: +.br +[super-user-command] +.br +super-user-command=sudo + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/tdesu/ +directly into konqueror or you can run +.BR "`khelpcenter help:/tdesu/'" +from the command-line. +.br +.SH AUTHORS +.br +Geert Jansen <[email protected]> +.br +Pietro Iglio <[email protected]> +.PP +This manual page was written by Christopher Martin <[email protected]> for Debian GNU/Linux, but may be used by others. It borrows from an earlier manpage by Karolina Lindqvist <pgd\[email protected]>. diff --git a/doc/man/tdm.1 b/doc/man/tdm.1 new file mode 100644 index 000000000..1150fe5a8 --- /dev/null +++ b/doc/man/tdm.1 @@ -0,0 +1,116 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH TDM 1 "June 2006" "Trinity Desktop Environment" "Trinity Display Manager" +.SH NAME +tdm +\- Trinity Display Manager +.SH SYNOPSIS +\fBtdm\fP [options] [tty] +.SH DESCRIPTION +\fBtdm\fP is the Trinity display manager also known as login manager. It shows a graphical login screen for username and password. After authenticating the user it starts a session. +.br +\fBtdm\fP can be configured for remote login via XDMCP. XDMCP is the "X Display Manager Control Protocol" which is used to set up connections between remote systems over the network. +.sp 1 +\fBtdm\fP is a derivative of \fBxdm\fP. \fBman 1 xdm\fP may provide useful information (requires installed \fBxdm\fP). For X-related problems try \fBman 7x X\fP and \fBman 1 startx\fP. +.SH OPTIONS +.TP +.B \-daemon +Daemonize even when started by init +.TP +.B \-nodaemon +Don't daemonize even when started from command line +.TP +.BI \-config\ file +Use alternative master configuration file +.TP +.BR \-xrm \ res +Override frontend\-specific resource +.TP +.BI \-error\ file +Use alternative log file +.TP +.BR \-debug \ num +Debug option bitfield: +.RS 11 +0x1 \- core log +.br +0x2 \- config reader log +.br +0x4 \- greeter log +.br +0x8 \- IPC log +.br +0x10 \- session sub-daemon post-fork delay +.br +0x20 \- config reader post-start delay +.br +0x40 \- greeter post-start delay +.br +0x80 \- don't use syslog +.br +0x100 \- core Xauth log +.br +0x400 \- valgrind config reader and greeter +.br +0x800 \- strace config reader and greeter +.RE +.SH FILES +.TP +.I /etc/trinity/tdm/backgroundrc +configuration file with background settings +.TP +.I /etc/trinity/tdm/tdm.options +options for X display manager tdm +.TP +.I /etc/trinity/tdm/tdmrc +the tdm configuration file +.TP +.I /etc/trinity/tdm/Xaccess +access control file for XDMCP connections +.TP +.I /etc/trinity/tdm/Xservers +list of local X-servers +.TP +.I /etc/trinity/tdm/Xreset +script to run as root after session exits +.TP +.I /etc/trinity/tdm/Xsession +script to run as user after login of user +.TP +.I /etc/trinity/tdm/Xsetup +script to run as root before the login dialog appears +.sp 1 +this script can be edited to disable or modify the running of \fBxconsole\fP on the tdm greeter screen +.TP +.I /etc/trinity/tdm/Xstartup +script to run as root before session starts +.TP +.I /etc/trinity/tdm/Xwilling +output of this script is displayed in the chooser window +.SH SEE ALSO +.BR tdm.options (5),\ tdmctl (1),\ tdm_config (1),\ tdm_greet (1),\ startx (1),\ X (7x),\ xconsole (1),\ xdm (1) +.TP +.I /opt/trinity/share/doc/tdm/README.gz +Information about \fBtdm\fP and its options +.sp 1 +.RE +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/tdm/ +directly into konqueror or you can run +.BR "khelpcenter help:/tdm/" +from the command\-line. +.br +.SH AUTHORS +.nf +Steffen Hansen <[email protected]> +.br +Thomas Tanghus <[email protected]> +.br +Oswald Buddenhagen <[email protected]> + +.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 <[email protected]> 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/tdm_config.1 b/doc/man/tdm_config.1 new file mode 100644 index 000000000..b8753b168 --- /dev/null +++ b/doc/man/tdm_config.1 @@ -0,0 +1,22 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH TDM_CONFIG 1 "June 2006" "Trinity Desktop Environment" "helper program" +.SH NAME +tdm_config +\- helper programm for tdm to read configuration files +.SH SYNOPSIS +\fBtdm_config\fP +.SH DESCRIPTION +\fBtdm_config\fP is a helper program for \fBtdm\fP to read configuration files. +.SH SEE ALSO +\fBtdm\fP(1) +.SH AUTHORS +.nf +Oswald Buddenhagen <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/tdm_greet.1 b/doc/man/tdm_greet.1 new file mode 100644 index 000000000..10b7bde6e --- /dev/null +++ b/doc/man/tdm_greet.1 @@ -0,0 +1,22 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH TDM_GREET 1 "June 2006" "Trinity Desktop Environment" "TDE greeter module" +.SH NAME +tdm_greet +\- TDE greeter module for tdm +.SH SYNOPSIS +\fBtdm_greet\fP +.SH DESCRIPTION +\fBtdm_greet\fP is a TDE greeter module for \fBtdm\fP. It shows the login dialog. +.SH SEE ALSO +.BR tdm (1) +.SH AUTHORS +.nf +Oswald Buddenhagen <[email protected]> + +.br +.fi +Please use http://bugs.trinitydesktop.org to report bugs; do not mail the author directly. +.PP +This manual page was written by Holger Hartmann <[email protected]> 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/tdmctl.1 b/doc/man/tdmctl.1 new file mode 100644 index 000000000..82be6ae16 --- /dev/null +++ b/doc/man/tdmctl.1 @@ -0,0 +1,220 @@ +.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand +.TH TDMCTL 1 "June 2006" "Trinity Desktop Environment" "TDM remote control application" +.SH NAME +tdmctl +\- tdm remote control application +.SH SYNOPSIS +\fBtdmctl\fP [options] [command [command arguments]] +.SH DESCRIPTION +\fBtdmctl\fP is an application to remote\-control \fBtdm\fP. It makes use of UNIX domain sockets. +.sp 1 +There are two types of sockets: the global one (dmctl) and the per\-display ones (dmctl\-<display>). The global one's subdir is owned by root, the subdirs of the per\-display ones' are owned by the user currently owning the session (root or the logged in user). +.sp 1 +The directory in which the sockets are located is determined this way: +.RS 3 +\- the \fB\-s\fP option is examined +.br +\- the $DM_CONTROL variable is examined +.br +\- the tdm config file is searched for the FifoDir key +.br +.RI \- /var/run/xdmctl \ and\ /var/run \ are\ tried +.RE +.sp 1 +If $DISPLAY is set (or \fB\-d\fP was specified) and \fB\-g\fP was not specified, the +display\-specific control socket will be used, otherwise the global one. +.sp 1 +Tokens in the command and the reply are tab\-separated. +Command arguments can be specified as separate command line parameters, +in which case they are simply concatenated with tabs in between. +.sp 1 +If the command is '\-', \fBtdmctl\fP reads commands from stdin. +The default command is 'caps'. +.SH OPTIONS +.SS +.SS Options: +.TP +.B \-h \-help +print help message. +.TP +.B \-g \-global +Use global control socket even if $DISPLAY is set +.TP +.B \-d \-display +Override $DISPLAY +.TP +.B \-s \-sockets +Override $DM_CONTROL +.TP +.B \-c \-config +Use alternative tdm config file +.SS Commands: +.br +.SS Global commands: +.TP +.B login +display (now|schedule) user password [session_arguments] +.br + login user at specified display. if "now" is specified, a possibly running session is killed, otherwise the login is done after the session exits. +.br +session_arguments are printf\-like escaped contents for \fI.dmrc\fP. Unlisted keys will default to previously saved values. +.SS Per\-display commands: +.TP +.B lock +The display is marked as locked. If the X\-Server crashes in this state, no auto\-relogin will be performed even if the option is on. +.TP +.B unlock +Reverse the effect of "lock": re\-enable auto\-relogin. +.TP +.B suicide +The currently running session is forcibly terminated. No auto\-relogin is attempted, but a scheduled "login" command will be executed. +.SS Commands for all sockets: +.TP +.B caps +Returns a list of this socket's capabilities: +.IP " \- tdm" +identifies tdm, in case some other DM implements this protocol, too. +.IP " \- list, activate, lock, suicide, login" +the respective command is supported. +.IP " \- bootoptions" +the "listbootoptions" command and the "=" option to "shutdown" are supported. +.IP " \- shutdown <list>" +"shutdown" is supported and allowed to the listed users (comma\-separated). "*" means all authenticated users. +.IP " \- shutdown" +"shutdown" is supported and allowed to everybody. +.IP " \- nuke <list>" +forced shutdown is allowed to the listed users. +.IP " \- nuke" +forced shutdown is allowed to everybody. +.IP " \- reserve <number>" +reserve displays are configured and <number> are available at this time. +.TP +\fBlist\fP [all|alllocal] +.br +Return a list of running sessions. By default all active sessions are listed. If "all" is specified, passive sessions are listed as well. If "alllocal" is specified, passive sessions are listed as well, but all incoming remote sessions are skipped. +.sp 1 +Each session entry is a comma\-separated tuple of: +.RS 7 +\- Display or TTY name +.br +\- VT name for local sessions +.br +\- Logged in user's name, empty for passive sessions and outgoing +.br + remote sessions (local chooser mode) +.br +\- Session type or remote host for outgoing remote sessions, +.br + empty for passive sessions +.br +\- A flag field: +.RS 5 +\- "t" for tty sessions +.br +\- "*" for the display belonging to the requesting socket +.br +\- "!" for sessions that cannot be killed by the requesting +.br + socket +.br +\- New flags might be added later +.br +.RE +\- New fields might be added later +.RE +.TP +\fBreserve\fP [timeout in seconds] +.br +Start a reserve login screen. If nobody logs in within the specified amount of time (one minute by default), the display is removed again. When the session on the display exits, the display is removed, too. +.br +Permitted only on sockets of local displays and the global socket. +.TP +\fBactivate\fP (vt|display) +.br +Switch to a particular VT (virtual terminal). The VT may be specified either directly (e.g., vt3) or by a display using it (e.g., :2). +.br +Permitted only on sockets of local displays and the global socket. +.TP +.B listbootoptions +List available boot options. +.br +=> "ok" list default current default and current are indices into the list and are \-1 if unset or undeterminable. +.TP +\fBshutdown\fP (reboot|halt) [=bootchoice] +.br + (ask|trynow|forcenow|schedule|start +.br + (\-1|end (force|forcemy|cancel))) +.br +.RS 7 +Request a system shutdown, either a reboot or a halt/poweroff. +.sp 1 +An OS choice for the next boot may be specified from the list returned by "listbootoptions". +.sp 1 +Shutdowns requested from per\-display sockets are executed when the current session on that display exits. Such a request may pop up a dialog asking for confirmation and/or authentication. +.sp 1 +start is the time for which the shutdown is scheduled. If it starts with a plus\-sign, the current time is added. Zero means immediately. +.sp 1 +end is the latest time at which the shutdown should be performed if active sessions are still running. If it starts with a plus\-sign, the start time is added. Minus one means wait infinitely. If end is through and active sessions are still running, \fBTDM\fP can do one of the following: +.RS 3 +- "cancel" \- give up the shutdown. +.br +- "force" \- shut down nonetheless. +.br +- "forcemy" \- shut down nonetheless if all active sessions +.br + belong to the requesting user. Only for per\-display sockets. +.RE +.sp 1 +start and end are specified in seconds since the UNIX epoch. +.sp 1 +"trynow" is a synonym for "0 0 cancel", "forcenow" for "0 0 force" and "schedule" for "0 \-1". +.sp 1 +"ask" attempts an immediate shutdown and interacts with the user if active sessions are still running. Only for per\-display sockets. +.RE +.TP +\fBshutdown cancel\fP [local|global] +.br +Cancel a scheduled shutdown. The global socket always cancels the currently pending shutdown, while per\-display sockets default to cancelling their queued request. +.TP +\fBshutdown status\fP +Return a list with information about shutdowns. +.br +The entries are comma\-separated tuples of: +.RS 10 +\- ("global"|"local") \- pending vs. queued shutdown. A local +.br + entry can be returned only by a per\-display socket. +.br +\- ("halt"|"reboot") +.br +\- start +.br +\- end +.br +\- ("ask"|"force"|"forcemy"|"cancel") +.br +\- Numeric user ID of the requesting user, \-1 for the global +.br + socket. +.br +\- The next boot OS choice or "\-" for none. +.br +\- New fields might be added later. +.RE +.SH SEE ALSO +.BR tdm (1) +.TP +.I /opt/trinity/share/doc/tdm/README.gz +Information about the command sockets (and \fBtdm\fP) +.SH AUTHORS +.nf +Oswald Buddenhagen <[email protected]> + +.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 <[email protected]> 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. |