diff options
Diffstat (limited to 'doc/man/tdm')
-rw-r--r-- | doc/man/tdm/CMakeLists.txt | 7 | ||||
-rw-r--r-- | doc/man/tdm/gentdmconf.1 | 91 | ||||
-rw-r--r-- | doc/man/tdm/krootimage.1 | 151 | ||||
-rw-r--r-- | doc/man/tdm/tdm.1 | 116 | ||||
-rw-r--r-- | doc/man/tdm/tdm_config.1 | 22 | ||||
-rw-r--r-- | doc/man/tdm/tdm_greet.1 | 22 | ||||
-rw-r--r-- | doc/man/tdm/tdmctl.1 | 220 |
7 files changed, 629 insertions, 0 deletions
diff --git a/doc/man/tdm/CMakeLists.txt b/doc/man/tdm/CMakeLists.txt new file mode 100644 index 000000000..65c83b94f --- /dev/null +++ b/doc/man/tdm/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/tdm/gentdmconf.1 b/doc/man/tdm/gentdmconf.1 new file mode 100644 index 000000000..d98e166c2 --- /dev/null +++ b/doc/man/tdm/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/tdm/krootimage.1 b/doc/man/tdm/krootimage.1 new file mode 100644 index 000000000..e9b19a604 --- /dev/null +++ b/doc/man/tdm/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/tdm/tdm.1 b/doc/man/tdm/tdm.1 new file mode 100644 index 000000000..1150fe5a8 --- /dev/null +++ b/doc/man/tdm/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/tdm_config.1 b/doc/man/tdm/tdm_config.1 new file mode 100644 index 000000000..b8753b168 --- /dev/null +++ b/doc/man/tdm/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/tdm_greet.1 b/doc/man/tdm/tdm_greet.1 new file mode 100644 index 000000000..10b7bde6e --- /dev/null +++ b/doc/man/tdm/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/tdm/tdmctl.1 b/doc/man/tdm/tdmctl.1 new file mode 100644 index 000000000..82be6ae16 --- /dev/null +++ b/doc/man/tdm/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. |