TDE
/
tdebase
mirror of https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase
0
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

Add man pages for TDE applications. 

Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Michele Calgaro 2 months ago
parent
cc94c3dc36
commit
c4f45361a6
Signed by: MicheleC
GPG Key ID: 2A75B7CA8ADED5CF
46 changed files with 6278 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 51
      doc/man/CMakeLists.txt
  2. 163
      doc/man/appletproxy.1
  3. 175
      doc/man/drkonqi.1
  4. 163
      doc/man/extensionproxy.1
  5. 91
      doc/man/gentdmconf.1
  6. 54
      doc/man/kappfinder.1
  7. 148
      doc/man/kasbar.1
  8. 83
      doc/man/kate.1
  9. 156
      doc/man/kblankscrn.kss.1
  10. 49
      doc/man/kcheckpass.1
  11. 153
      doc/man/kcminit.1
  12. 159
      doc/man/kdcop.1
  13. 209
      doc/man/kdialog.1
  14. 181
      doc/man/keditbookmarks.1
  15. 58
      doc/man/kfind.1
  16. 222
      doc/man/kfmclient.1
  17. 150
      doc/man/khotkeys.1
  18. 171
      doc/man/kicker.1
  19. 202
      doc/man/kjobviewer.1
  20. 51
      doc/man/kmenuedit.1
  21. 164
      doc/man/knetattach.1
  22. 245
      doc/man/konqueror.1
  23. 179
      doc/man/konsole.1
  24. 53
      doc/man/kpager.1
  25. 66
      doc/man/kpersonalizer.1
  26. 209
      doc/man/kprinter.1
  27. 152
      doc/man/krandom.kss.1
  28. 173
      doc/man/kreadconfig.1
  29. 151
      doc/man/krootimage.1
  30. 215
      doc/man/kstart.1
  31. 189
      doc/man/ksystraycmd.1
  32. 155
      doc/man/ktrash.1
  33. 60
      doc/man/kwrite.1
  34. 173
      doc/man/kwriteconfig.1
  35. 163
      doc/man/kxkb.1
  36. 46
      doc/man/starttde.1
  37. 200
      doc/man/tdedebugdialog.1
  38. 163
      doc/man/tdeio_media_mounthelper.1
  39. 22
      doc/man/tdeio_system_documenthelper.1
  40. 169
      doc/man/tdepasswd.1
  41. 160
      doc/man/tdeprintfax.1
  42. 102
      doc/man/tdesu.1
  43. 116
      doc/man/tdm.1
  44. 22
      doc/man/tdm_config.1
  45. 22
      doc/man/tdm_greet.1
  46. 220
      doc/man/tdmctl.1

51
doc/man/CMakeLists.txt
Unescape View File

@ -0,0 +1,51 @@
INSTALL(
FILES
appletproxy.1
drkonqi.1
extensionproxy.1
gentdmconf.1
kappfinder.1
kasbar.1
kate.1
kblankscrn.kss.1
kcheckpass.1
kcminit.1
kdcop.1
kdialog.1
keditbookmarks.1
kfind.1
kfmclient.1
khotkeys.1
kicker.1
kjobviewer.1
kmenuedit.1
knetattach.1
konqueror.1
konsole.1
kpager.1
kpersonalizer.1
kprinter.1
krandom.kss.1
kreadconfig.1
krootimage.1
kstart.1
ksystraycmd.1
ktrash.1
kwrite.1
kwriteconfig.1
kxkb.1
starttde.1
tdedebugdialog.1
tdeio_media_mounthelper.1
tdeio_system_documenthelper.1
tdepasswd.1
tdeprintfax.1
tdesu.1
tdm.1
tdm_config.1
tdmctl.1
tdm_greet.1
DESTINATION ${MAN_INSTALL_DIR}/man1
COMPONENT doc
)

163
doc/man/appletproxy.1
Unescape View File

@ -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 <elter@kde.org>
.br
Matthias Ettrich <ettrich@kde.org>
.br
.br
.fi
Please use http://bugs.trinitydesktop.org to report bugs; do not mail the authors directly.
.PP
This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

175
doc/man/drkonqi.1
Unescape View File

@ -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 <bieker@kde.org>
.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 <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

163
doc/man/extensionproxy.1
Unescape View File

@ -0,0 +1,163 @@
.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand
.TH EXTENSIONPROXY 1 "June 2006" "Trinity Desktop Environment" "Panel extension proxy"
.SH NAME
extensionproxy
\- TDE kicker panel extension proxy
.SH SYNOPSIS
\fBextensionproxy\fP [Qt\-options] [TDE\-options] \fIdesktopfile\fP
.SH DESCRIPTION
\fBextensionproxy\fP is a small application that allows you to run a kicker extension outside of \fBkicker\fP itself.
.SH OPTIONS
.SS
.SS Arguments:
.TP
.B desktopfile
The extension's desktop file
.SS
.SS Options:
.TP
.B \-\-configfile <file>
The config file to be used
.TP
.B \-\-callbackid <id>
DCOP callback id of the extension container
.SS Generic options:
.TP
.B \-\-help
Show help about options
.TP
.B \-\-help\-qt
Show Qt specific options
.TP
.B \-\-help\-tde
Show TDE specific options
.TP
.B \-\-help\-all
Show all options
.TP
.B \-\-author
Show author information
.TP
.B \-v, \-\-version
Show version information
.TP
.B \-\-license
Show license information
.TP
.B \-\-
End of options
.SS
.SS Qt options:
.TP
.B \-\-display <displayname>
Use the X\-server display 'displayname'
.TP
.B \-\-session <sessionId>
Restore the application for the given 'sessionId'
.TP
.B \-\-cmap
Causes the application to install a private color
map on an 8\-bit display
.TP
.B \-\-ncols <count>
Limits the number of colors allocated in the color
cube on an 8\-bit display, if the application is
using the QApplication::ManyColor color
specification
.TP
.B \-\-nograb
tells Qt to never grab the mouse or the keyboard
.TP
.B \-\-dograb
running under a debugger can cause an implicit
\-nograb, use \-dograb to override
.TP
.B \-\-sync
switches to synchronous mode for debugging
.TP
.B \-\-fn, \-\-font <fontname>
defines the application font
.TP
.B \-\-bg, \-\-background <color>
sets the default background color and an
application palette (light and dark shades are
calculated)
.TP
.B \-\-fg, \-\-foreground <color>
sets the default foreground color
.TP
.B \-\-btn, \-\-button <color>
sets the default button color
.TP
.B \-\-name <name>
sets the application name
.TP
.B \-\-title <title>
sets the application title (caption)
.TP
.B \-\-visual TrueColor
forces the application to use a TrueColor visual on
an 8\-bit display
.TP
.B \-\-inputstyle <inputstyle>
sets XIM (X Input Method) input style. Possible
values are onthespot, overthespot, offthespot and
root
.TP
.B \-\-im <XIM server>
set XIM server
.TP
.B \-\-noxim
disable XIM
.TP
.B \-\-reverse
mirrors the whole layout of widgets
.SS
.SS TDE options:
.TP
.B \-\-caption <caption>
Use 'caption' as name in the titlebar
.TP
.B \-\-icon <icon>
Use 'icon' as the application icon
.TP
.B \-\-miniicon <icon>
Use 'icon' as the icon in the titlebar
.TP
.B \-\-config <filename>
Use alternative configuration file
.TP
.B \-\-dcopserver <server>
Use the DCOP Server specified by 'server'
.TP
.B \-\-nocrashhandler
Disable crash handler, to get core dumps
.TP
.B \-\-waitforwm
Waits for a WM_NET compatible windowmanager
.TP
.B \-\-style <style>
sets the application GUI style
.TP
.B \-\-geometry <geometry>
sets the client geometry of the main widget \- see man X for the argument format
.SS
.SH FILES
\fI/usr/share/apps/kicker/extensions\fP
kicker extensions directory
.SH SEE ALSO
\fBkicker\fP(1), \fBappletproxy\fP(1)
.SH AUTHORS
.nf
Matthias Elter <elter@kde.org>
.br
Matthias Ettrich <ettrich@kde.org>
.br
.br
.fi
Please use http://bugs.trinitydesktop.org to report bugs; do not mail the authors directly.
.PP
This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

91
doc/man/gentdmconf.1
Unescape View File

@ -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 <ossi@kde.org>
.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 <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

54
doc/man/kappfinder.1
Unescape View File

@ -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 <zorglub@via.ecp.fr>,
for the Debian GNU/Linux project (but may be used by others).
.PP
kappfinder was written by the KDE project

148
doc/man/kasbar.1
Unescape View File

@ -0,0 +1,148 @@
.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand
.TH KASBAR 1 "June 2006" "Trinity Desktop Environment" "An alternative task manager"
.SH NAME
kasbar
\- An alternative task manager
.SH SYNOPSIS
\fBkasbar\fP [Qt\-options] [TDE\-options] [options]
.SH DESCRIPTION
The \fBKasBar\fP is an iconic replacement of the taskbar. It always shows the icons of all currently running applications on any desktop, they can be chosen by clicking with the left mouse button. The active window is highlighted, minimized windows will show a little triangle pointing downwards instead of the square in the lower right of the icons. A triangle pointing to the right indicates that the application is shaded.
.SH OPTIONS
.SS Options:
.TP
.B \-\-test
Test the basic kasbar code
.SS Generic options:
.TP
.B \-\-help
Show help about options
.TP
.B \-\-help\-qt
Show Qt specific options
.TP
.B \-\-help\-tde
Show TDE specific options
.TP
.B \-\-help\-all
Show all options
.TP
.B \-\-author
Show author information
.TP
.B \-v, \-\-version
Show version information
.TP
.B \-\-license
Show license information
.TP
.B \-\-
End of options
.SS
.SS Qt options:
.TP
.B \-\-display <displayname>
Use the X-server display 'displayname'
.TP
.B \-\-session <sessionId>
Restore the application for the given 'sessionId'
.TP
.B \-\-cmap
Causes the application to install a private color
map on an 8\-bit display
.TP
.B \-\-ncols <count>
Limits the number of colors allocated in the color
cube on an 8\-bit display, if the application is
using the QApplication::ManyColor color
specification
.TP
.B \-\-nograb
tells Qt to never grab the mouse or the keyboard
.TP
.B \-\-dograb
running under a debugger can cause an implicit
\-nograb, use \-dograb to override
.TP
.B \-\-sync
switches to synchronous mode for debugging
.TP
.B \-\-fn, \-\-font <fontname>
defines the application font
.TP
.B \-\-bg, \-\-background <color>
sets the default background color and an
application palette (light and dark shades are
calculated)
.TP
.B \-\-fg, \-\-foreground <color>
sets the default foreground color
.TP
.B \-\-btn, \-\-button <color>
sets the default button color
.TP
.B \-\-name <name>
sets the application name
.TP
.B \-\-title <title>
sets the application title (caption)
.TP
.B \-\-visual TrueColor
forces the application to use a TrueColor visual on
an 8\-bit display
.TP
.B \-\-inputstyle <inputstyle>
sets XIM (X Input Method) input style. Possible
values are onthespot, overthespot, offthespot and
root
.TP
.B \-\-im <XIM server>
set XIM server
.TP
.B \-\-noxim
disable XIM
.TP
.B \-\-reverse
mirrors the whole layout of widgets
.SS
.SS TDE options:
.TP
.B \-\-caption <caption>
Use 'caption' as name in the titlebar
.TP
.B \-\-icon <icon>
Use 'icon' as the application icon
.TP
.B \-\-miniicon <icon>
Use 'icon' as the icon in the titlebar
.TP
.B \-\-config <filename>
Use alternative configuration file
.TP
.B \-\-dcopserver <server>
Use the DCOP Server specified by 'server'
.TP
.B \-\-nocrashhandler
Disable crash handler, to get core dumps
.TP
.B \-\-waitforwm
Waits for a WM_NET compatible windowmanager
.TP
.B \-\-style <style>
sets the application GUI style
.TP
.B \-\-geometry <geometry>
sets the client geometry of the main widget - see man X for the argument format
.SS
.SH SEE ALSO
\fBkicker\fP(1)
.SH AUTHORS
.nf
.br
.fi
Please use http://bugs.trinitydesktop.org to report bugs; do not mail the authors directly.
.PP
This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

83
doc/man/kate.1
Unescape View File

@ -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 <zorglub@via.ecp.fr>, for Debian GNU/Linux, but may be used by others.
.PP
kate was written by the KDE project

156
doc/man/kblankscrn.kss.1
Unescape View File

@ -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 <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

49
doc/man/kcheckpass.1
Unescape View File

@ -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 <okir@caldera.de>
.br
Christian Esken <esken@kde.org>
.br
Oswald Buddenhagen <ossi@kde.org>
.br
.br
.fi
Please use http://bugs.trinitydesktop.org to report bugs; do not mail the authors directly.
.PP
This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

153
doc/man/kcminit.1
Unescape View File

@ -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 <hoelzer@kde.org>
.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 <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

159
doc/man/kdcop.1
Unescape View File

@ -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 <kalle@kde.org>
.br
Rik Hemsley <rik@kde.org>
.br
Ian Reinhart Geiser <geiseri@kde.org>
.br
.br
.fi
Please use http://bugs.trinitydesktop.org to report bugs; do not mail the authors directly.
.PP
This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the Debian Project, but may be used by others. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

209
doc/man/kdialog.1
Unescape View File

@ -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