Initial import of the CDE 2.1.30 sources from the Open Group.
[oweals/cde.git] / cde / programs / dtsession / dtsession.man
1 .\" $XConsortium: dtsession.man /main/2 1995/07/17 10:51:34 drk $
2 .\" *                                                                      *
3 .\" * (c) Copyright 1993, 1994 Hewlett-Packard Company                     *
4 .\" * (c) Copyright 1993, 1994 International Business Machines Corp.       *
5 .\" * (c) Copyright 1993, 1994 Sun Microsystems, Inc.                      *
6 .\" * (c) Copyright 1993, 1994 Novell, Inc.                                *
7 .\" *
8 .TH DTSESSION 1X
9 .ds ]W HP DT 3.0
10 .SH NAME
11 \fBdtsession \(em The HP DT Session Manager.\fP
12 .sp 1
13 .SH SYNOPSIS
14 .B dtsession
15 [options]
16 .sp 1
17 .SH DESCRIPTION
18 \fIDtsession\fP provides session management functionality during an HP DT
19 session, the time from login to logout.  It allows for saving a session, 
20 restoring a session, locking a session, and allocating colors for HP DT 
21 compatible clients.
22 .P
23 When a session is saved, client information, server settings, and
24 resources are retained.  Client information consists of
25 all clients currently active in the session.  Server settings consist of
26 settings (such as the beeper or keyboard) that are modified by a call to
27 the server.  Resources consist of all resources currently stored on the
28 \fBRESOURCE_MANAGER\fP property on the root window of the default screen.
29 .P
30 The session is locked by pressing the "lock" button on the workspace manager
31 (front panel).
32 When the display is locked, no further input is accepted until a correct
33 password is entered.  Correct passwords include the user who locked the
34 display, the root password for the system, and any users specified in
35 the \fBkeys\fP resource.
36 .P
37 Color allocation provides each client with a set of colors which are used
38 in creating visual components.  These colors can then be dynamically
39 changed by using the HP DT Style Manager (\fIdtstyle(1X)\fP).
40 .P
41 \fIDtsession\fP is automatically invoked by the HP DT Login Manager
42 (\fIdtlogin(1X)\fP).  If the
43 HP DT Login Manager is not currently being used, \fIdtsession\fP can
44 be invoked by putting the following command in an .xsession or .x11start
45 file:
46 .P
47 /usr/dt/bin/dtsession -norestore
48 .P
49 WARNING:  This command must be the first X11 client in the file (other
50 than xrdb).  It must be run in the foreground.  When using this command,
51 no save and restore functionality is available.  Any calls that start
52 up window managers must be removed from the startup file.  The default
53 window manager can only be changed by setting the \fBwmStartupCommand\fP 
54 resource.
55 .sp 1
56 .SH OPTIONS
57 .TP 8
58 .BI \-norestore
59 This option allows users to use \fIdtsession\fP in a limited way.  The
60 advantage of using this option is that \fIdtsession\fP can be started
61 directly from an .x11start or .xsession script.  See use and warning above.
62 .SH CUSTOMIZATION
63 \fIDtsession's\fP behavior can be customized through the use of the HP DT 
64 Style Manager's startup dialog.  The following is the behavior that can be
65 customized.
66 .sp 1
67 .TS
68 center;
69 cB s
70 lB lB
71 l l.
72 HP DT Session Manager Customization Options
73 Name    Default
74 Display Logout Confirmation     On
75 Set Home Session        N/A
76 Startup Behavior        Resume Current Session
77 .TE
78 .sp 1
79 .TP 8
80 .BR "Display Logout Confirmation"
81 "Display Logout Confirmation" allows you to toggle the appearance of the logout
82 confirmation box that appears after you click on the logout button
83 located in the workspace manager, or choose the "Log out..." option available in
84 the \fIdtwm\fP root menu.  Setting the button displays the logout dialog.
85 Clearing the button causes immediate exit with no
86 confirmation.  The default behavior is that the logout confirmation
87 dialog will be displayed.
88 .TP 8
89 .BR "Set Home Session"
90 The "Set Home Session" button allows you to save a home session for use
91 later.  The home session is a "snapshot" session that you can return to
92 by changing logout options.
93 .TP 8
94 .BR "Startup Behavior"
95 The startup behavior allows you to specify which state the HP DT Session
96 Manager will restore upon startup (login).  The default is that it
97 automatically restarts the state you were in at logout (Resume Current
98 Session).  The other
99 states available are "Return to Home Session" and "Ask Me at Logout."  "Return
100 to Home Session" returns you to the last saved home session at next
101 startup.  "Ask Me at Logout" allows you to choose which behavior you would
102 prefer at logout time.  If "Return to Home Session" is chosen, a home
103 session has to have been previously saved.  Otherwise the default system
104 session will appear at next login.  Note that "Ask Me at Logout" cannot be
105 active while "Display Logout Confirmation" is turned off.
106 .SH RESOURCES
107 \fIDtsession\fP uses the following resources.
108 .sp 1
109 .TS
110 center;
111 cB sss
112 lB lB lB lB
113 l l l l.
114 HP DT Session Manager Resource Set
115 Name    Class   Type    Default
116 _
117 alarmTime       AlarmTime       unsigned int    10
118 colorUse        ColorUse        int     dynamic*
119 coverScreen     CoverScreen     Boolean False
120 dynamicColor    DynamicColor    Boolean True
121 foregroundColor ForegroundColor int     dynamic*
122 lockOnTimeout   LockOnTimeout   Boolean False
123 keys    Keys    unsigned char   NULL
124 queryServerSettings     QueryServerSettings     Boolean False
125 shadowPixmaps   ShadowPixmaps   int     dynamic*
126 wmStartupCommand        WmStartupCommand        executable path NULL
127 writeXrdbColors writeXrdbColors Boolean True
128 .TE
129 .ps 7
130 \h'30p'*The display type determines default.
131 .ps
132 .sp 1
133 .IP "\fBalarmTime\fP"
134 This resource specifies (in seconds) the amount of time before the lock
135 dialog is removed from the screen.  When the display is locked, the
136 pointer shows a lock cursor, and a dialog appears which asks for the
137 user password.  If no activity from the pointer or keyboard is detected
138 for \fBalarmTime\fP seconds, the dialog is removed from the screen.  The lock
139 dialog is redisplayed as soon as a pointer or keyboard event is
140 detected.  An
141 \fBalarmTime\fP of 0 leaves the lock dialog in place for the entire time the
142 display is locked.  The default value is 10 seconds.
143 .IP "\fBcolorUse\fP"
144 This resource specifies the number of colors to use for the user interface.
145 Valid types are:
146 .RS
147 .IP \(bu 3
148 \fBB_W\fP \(em  Specifies a black and white system.  
149 The color palettes will use two color cells for the user interface.
150 In this configuration only two color palettes are available:
151 BlackWhite and WhiteBlack.
152 These palettes cannot dynamically change.  To change a palette,
153 all applications using that color palette must be restarted.
154 This resource value forces \fBShadowPixmaps\fP to True, and 
155 \fBForegroundColor\fP to either black or white depending on the palette chosen.
156 .IP \(bu 3
157 \fBLOW_COLOR\fP \(em Specifies a low color system.  
158 The color palettes will have two color sets and use a maximum of 12 color 
159 cells for the user interface, including black and white (color cells 0 and 1).
160 The number of color cells can be reduced by using the resources 
161 \fBShadowPixmaps\fP and \fBForegroundColor\fP.
162 .IP \(bu 3
163 \fBMEDIUM_COLOR\fP \(em Specifies a medium color system.  
164 The color palettes will have 4 color sets and use a maximum of 22 color cells
165 for the user interface, including black and white (color cells 0 and 1).
166 The number of color cells can be reduced by using the resources 
167 \fBShadowPixmaps\fP and \fBForegroundColor\fP.
168 .IP \(bu 3
169 \fBHIGH_COLOR\fP \(em Specifies a high color system.  
170 The color palettes will have 8 color sets and use a maximum of 42 color cells
171 for the user interface, including black and white (color cells 0 and 1).
172 The number of color cells can be reduced by using the resources 
173 \fBShadowPixmaps\fP
174 and \fBForegroundColor\fP.
175 The default value for this resource will be determined by querying
176 the X server for the number of color cells on the system.
177 .RE
178 .sp 1
179 .TS
180 center;
181 cb  cb
182 l | l.
183 planes  ColorUse
184 _
185 2-3     B_W
186 4       LOW_COLOR
187 6       MEDIUM_COLOR
188 8+      HIGH_COLOR
189 .TE
190 .sp 1
191 .IP "\fBcoverScreen\fP"
192 This resource specifies whether or not the screens of the display will
193 be covered when the display is locked.  The default value is True,
194 which means that the screens will be covered.
195
196 .IP "\fBdynamicColor\fP"
197 This resource can have values of True or False.  \fBdynamicColor\fP is
198 used to reduce the number of color cells being used.  Once a palette has 
199 been selected and it is not likely to be changed,  \fBdynamicColor\fP can 
200 be set to False. 
201 If set to False colors cannot be dynamically changed using the DT
202 style manager. A selected
203 palette will take effect the next session.
204 The next time the session comes up, the color server uses Read Only
205 color cells that can be shared by all clients, thus reducing
206 the number of color cells used.
207
208 .IP "\fBforegroundColor\fP" 
209 This resource can have values of White, Black or Dynamic.
210 \fBForegroundColor\fP causes all text (foreground) to use either pixel 0 
211 or 1 (Black
212 or White) or to have a color cell dedicated to foreground and changes in
213 response to the background color (Dynamic) for each ColorSet.
214 If set to White or Black, the number of color cells used per ColorSet is
215 reduced by 1.
216 .IP "\fBkeys\ \ \ \ \      \fP"
217 This resource is a list of "keyholders" who have the ability to unlock
218 the screen any time it is locked by the user.  The list is a list of user
219 id's separated by commas.  For example if user kim has the following
220 resource active during a session:
221 .sp 1
222 \fBDtsession*keys: fred,keith\fP
223 .sp 1
224 Users fred and keith have the ability to unlock the display when kim
225 locks it.
226 .IP "\fBlockOnTimeout\fP"
227 This resource specifies whether or not dtsession will lock the screen
228 when there has been a period of time without pointer or keyboard activity.
229 The default value is False,
230 which means that the screen will not be locked automatically.  This 
231 resource only applies when using a server that has the ability to 
232 notify dtsession when the period of inactivity has occurred.
233 .IP "\fBqueryServerSettings\fP"
234 This resource specifies whether \fIdtsession\fP queries the server at
235 logout for all its settings or saves only those settings set by using
236 the HP DT Style Manager.  Querying the server ensures that all settings are
237 saved; however, there is a degradation in performance when a full query
238 is done.  The default value is False, which means that the server
239 will not be queried.
240 .IP "\fBshadowPixmaps\fP"
241 For color systems, this resource can have a value of True or False.
242 If True, \fBtopShadowColor\fP and \fBbottomShadowColor\fP use the same
243 pixel as background and \fBtopShadowPixmap\fP and 
244 \fBbottomShadowPixmap\fP are specified
245 instead of solid color to create the 3D look.
246 This reduces the number of color cells per ColorSet by 2.
247 \fBShadowPixmaps\fP defaults to True for systems with 4 or less color planes
248 (16 or less color cells),
249 and False for systems with more than 4 color planes.
250 .IP "\fBwmStartupCommand\fP"
251 This resource allows for an alternate window manager to be started at
252 login.  If this resource is NULL, dtsession starts /usr/dt/bin/dtwm.  An 
253 alternate startup might look like:
254 .sp 1
255 \fBDtsession*wmStartupCommand: /usr/bin/X11/mwm\fP
256 .sp 1
257 Note that the command should not have any commands to a shell in it, and
258 that it should not be surrounded by quotes.  Also, if any
259 other window manager other than \fIdtwm\fP is used, clients will be restored,
260 but may not be restored to the correct position.  By default, this resource
261 contains a NULL value.
262 .IP "\fBwriteXrdbColors\fP"
263 This resource should only be used if you are running non HP Motif 1.1 clients
264 that have color schemes that conflict with HP DT colors.  This has no
265 impact on clients linked with the Motif 1.1 library.  This resource
266 specifies whether color resource information should be written out.
267 If set to False, \fBbackground\fP and \fBforeground\fP resources will not
268 be written out with the values of the current palette.  This means that
269 non HP Motif 1.1 clients will not get HP DT colors when they are started.
270 The default value is True.
271 .sp 1
272 .SH COPYRIGHT
273 Copyright 1990, 1991, 1992 Hewlett-Packard Company.
274 .br
275 (c) Copyright 1993, 1994 Hewlett-Packard Company
276 .br
277 (c) Copyright 1993, 1994 International Business Machines Corp.
278 .br
279 (c) Copyright 1993, 1994 Sun Microsystems, Inc.
280 .br
281 (c) Copyright 1993, 1994 Novell, Inc.
282 .sp 1 
283 .SH ORIGIN
284 Hewlett-Packard Comany UTD-CV.
285 .br
286 International Business Machines Corp.
287 .br
288 Sun Microsystems, Inc.
289 .br
290 Novell, Inc.
291 .sp 1
292 .SH SEE ALSO
293 \fBX(1)\fP, \fBdtstyle(1X)\fP, \fBdtwm(1X)\fP, \fBdtlogin(1X)\fP.