1Customizable hercules 3270 Logo
2
3The initial welcome screen presented when a TN 3270 terminal connects
4to a hercules 3270 device can now be customized.
5
6The customized logo is stored in a plain text file which contains
7positioning orders, attributes and variable substitutions.
8
9hercules also contains a built-in logo should no suitable file be found.
10
11Upon startup, hercules will first look for a file named "herclogo.txt" in
12the current directory.
13
14The name of the logo file can also be specified as a startup option by
15using the '-b' flag.
16
17Additionally, the file may also be specified by using the 'HERCLOGO'
18configuration statement.
19
20(NOTE : The statement was previously LOGOFILE, but LOGOFILE has been
21 deprecated).
22
23The file may also be specified by using the 'HERCLOGO' environment
24variable.
25
26The file to be used can also be specified at run time using the
27'HERCLOGO' panel command.
28
29Each line in the file represent either an order or a plain text line.
30
31The orders are as follows :
32
33@SBA X,Y
34Position the current buffer position to Row X col Y (X and Y start at 0)
35
36@SF [H][P]
37Set the Highlight and/or Protected attribute
38
39@NL
40Forces going to the next line
41
42@ALIGN NONE|LEFT|RIGHT|CENTER
43Specified the text alignement (relative to the left and right borders of the
44terminal). When ALIGN is other than "NONE", a new line is automatically
45inserted after each line of text. If ALIGN is "NONE", then the text will
46be written without skipping to the next line.
47
48It is also possible to embbed substitution variables in outgoing text.
49Substition is indicated by enclosing the variable name between $( and )
50
51The following variables are defined in that environment :
52
53VERSION : The hercules version
54HOSTNAME : The host name on which hercules is running
55HOSTOS : The host operating system
56HOSTOSREL : The Host operating system release
57HOSTOSVER : The host operating system version
58HOSTARCH : The host architecture
59HOSTNUMCPUS : UP (for 1) or MP=X (for more than 1)
60LPARNAME : The LPAR name specified in the configuration file
61CCUU,ccuu,CUU,cuu : Various forms of the device number of the terminal
62CSS : The Logical Channel Subsystem Set or Channel Set for the terminal
63SUBCHAN : The Subchannel number for the terminal
64
65Additionally, it is also possible to specify environment variable names.
66
67The file 'herclogo.txt' is provided in the distribution as a sample template.
68It reflects the contents of the built-in logo.
69
70Ivan Warren 3/1/2006
71