Link with C++ linker
[oweals/cde.git] / cde / programs / dthello / dthello.man
1 .\" *                                                                      *
2 .\" * (c) Copyright 1993, 1994 Hewlett-Packard Company                     *
3 .\" * (c) Copyright 1993, 1994 International Business Machines Corp.       *
4 .\" * (c) Copyright 1993, 1994 Sun Microsystems, Inc.                      *
5 .\" * (c) Copyright 1993, 1994 Novell, Inc.                                *
6 .\" *
7 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
8 .\"
9 .\" $XConsortium: dthello.man /main/3 1995/11/02 08:55:09 rswiston $
10 .\"
11 .\" (c)1992 Hewlett-Packard Company
12 .\"
13 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
14 .TH DTHELLO 1 
15 .ds ]W HP DT 3.0 (7/92)
16 .SH NAME
17 \fBdthello - startup transition program for HP DT\fP
18 .P
19 \fBdtcolor - transition program and color server for HP DT Lite\fP
20 .sp 1
21 .SH SYNOPSIS
22 .B dthello
23 [options]
24 .br
25 .B dtcolor
26 [options]
27 .PP  
28 .SH DESCRIPTION
29 \fIDthello\fP is a client that provides a transitory visual during 
30 the startup of the Hewlett-Packard Visual User Environment (HP DT). 
31 \fIDthello\fP is designed to cover the interval between login 
32 (see \fBdtlogin(1)\fP) and the start up of the window manager 
33 (see \fBdtwm(1)\fP).
34 .PP  
35 \fIDthello\fP covers the screen with a window and displays a boxed
36 message.
37 The message consists of two parts: The first
38 part is a short welcome string.  This string may contain literal
39 and new-line characters. The second
40 part is the content of one or more (up to five) files. 
41 Each line of text from these two parts is left-justified 
42 against the boxed outline.
43 .PP  
44 \fIDtcolor\fP is used in HP DT Lite in place of \fIdthello\fR.
45 \fIDtcolor\fR offers the same
46 command line options, resources,
47 and behavior \fIexcept\fR that after
48 initialization, the \fIdtcolor\fR process puts itself in the
49 background and continues running for the duration of the HP DT Lite
50 session as a color server.  In HP DT Regular, the color server code 
51 is built into the session manager
52 (\fIdtsession\fP), so that the \fIdtcolor\fR
53 daemon needs to run only in HP DT Lite sessions.  
54 Because \fIdtcolor\fR offers a strict superset of \fIdthello\fR
55 functionality,
56 all comments about \fIdthello\fR apply equally to \fIdtcolor\fR.
57 .PP  
58 The default font for \fIdthello\fR
59 is chosen in a device-dependent way, depending
60 on the screen resolution of the display, whether high resolution
61 (\fIe.g.\fR, 1280x1024), medium resolution (\fIe.g.\fR, 1024x768), or
62 low resolution (\fIe.g.\fR, 640x480).
63 .PP  
64 \fIDthello\fP will display only a ``reasonable'' number of lines of
65 text. It
66 does not scroll or try to prevent the text from getting clipped if the
67 text does not fit on the screen.  If the line length is too long,
68 then \fIdthello\fR will not draw the encompassing box, and
69 will instead
70 align the text flush against the left edge of the screen.
71 .PP  
72 \fIDthello\fP is designed to be invoked just after login. The 
73 script file
74 that contains the default invocation of \fIdthello\fR is 
75 \fI/usr/dt/config/Xsession\fR.
76 .PP  
77 .SH OPTIONS
78 .TP 8
79 .BI \-display " display_name"
80 This option names the display on which to run.
81 The default display is taken from the DISPLAY environment variable.
82 .TP 8
83 .BI \-bground " background_color"
84 This option specifies the background color of the window.
85 The default value is "black" for B&W and screens with limited color
86 (16 or less) and "cornflowerblue" for screens with more 
87 colors (more than 16). 
88 The background color can also be specified by
89 setting the \fBvbackground\fR (class \fBVbackground\fR) resource.
90 .TP 8
91 .BI \-fground " foreground_color"
92 This option specifies the foreground color (for the text).
93 The default value is "white."
94 The foreground color can also be specified by
95 setting the \fBvforeground\fR (class \fBVforeground\fR) resource.
96 .TP 8
97 .BI \-file " file_name"
98 This option specifies a file from which to read message text. This option may
99 appear up to five times to include text from five different
100 files.  
101 If no file option is specified (the
102 default), the file \fI/etc/copyright\fR is displayed.
103 The \fBfile\fR (class \fBFile\fR) resource is recognized, but only one file
104 can be specified this way.
105 .TP 8
106 .BI \-font " font_name"
107 This option specifies the font to use with which to render the text string.
108 The default values are \fIsystem23\fR for high resolution displays,
109 \fIsystem19\fR for medium resolution displays, and \fIsystem16\fR
110 for low resolution displays.
111 The equivalent resource is \fBvfont\fR (class \fBVfont\fR).
112 .TP 8
113 .BI \-string " text_string"
114 This option specifies the message text to display.
115 Messages with embedded spaces must be quoted. Literal
116 new-line characters can be embedded in the text string to specify line
117 breaks. Each line will be left-justified on the screen.
118 The default text is:
119 .sp
120 Starting the
121 .br
122 Common Desktop Environment
123 .sp
124 The message text can also be specified with the \fBstring\fR (class
125 \fBString\fR) resource.
126 .TP 8
127 .BI \-timeout " num_seconds"
128 This option specifies the timeout value in seconds.
129 \fIDthello\fP sets a timer and then waits for the \fBReparentNotify\fP event
130 that signals that the window manager is up. If the timer expires,
131 \fIdthello\fP stops waiting on the window manager and terminates
132 immediately. The default value is 240 seconds. The equivalent resource
133 is \fBtimeout\fR (class \fBTimeout\fR).
134 .PP  
135 .SH ENVIRONMENT
136 \fIDthello\fP uses the DISPLAY environment variable.
137 .PP  
138 .SH WARNINGS
139 Lines that contain non-printable characters (such as the
140 tab character) may not display as expected.
141 .PP  
142 .SH COPYRIGHT
143 (c) Copyright 1990, 1991, 1992 by Hewlett-Packard Company.
144 .br
145 (c) Copyright 1993, 1994 Hewlett-Packard Company 
146 .br
147 (c) Copyright 1993, 1994 International Business Machines Corp.
148 .br
149 (c) Copyright 1993, 1994 Sun Microsystems, Inc. 
150 .br
151 (c) Copyright 1993, 1994 Novell, Inc.
152 .PP  
153 .SH AUTHOR
154 \fIDthello\fP and \fIdtcolor\fR were developed by HP.
155 .PP  
156 .SH FILES
157 /usr/lib/X11/dt/Dtlogin/Xsession
158 .br
159 /etc/copyright
160 .PP  
161 .SH SEE ALSO
162 dtlite(1), dtlogin(1), dtwm(1).