diff options
Diffstat (limited to 'doc/man/kreadconfig')
-rw-r--r-- | doc/man/kreadconfig/CMakeLists.txt | 7 | ||||
-rw-r--r-- | doc/man/kreadconfig/kreadconfig.1 | 173 | ||||
-rw-r--r-- | doc/man/kreadconfig/kwriteconfig.1 | 173 |
3 files changed, 353 insertions, 0 deletions
diff --git a/doc/man/kreadconfig/CMakeLists.txt b/doc/man/kreadconfig/CMakeLists.txt new file mode 100644 index 000000000..65c83b94f --- /dev/null +++ b/doc/man/kreadconfig/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +install( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kreadconfig/kreadconfig.1 b/doc/man/kreadconfig/kreadconfig.1 new file mode 100644 index 000000000..3bb6c4d0b --- /dev/null +++ b/doc/man/kreadconfig/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/kreadconfig/kwriteconfig.1 b/doc/man/kreadconfig/kwriteconfig.1 new file mode 100644 index 000000000..b347b9849 --- /dev/null +++ b/doc/man/kreadconfig/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. |