1intro
2 <i>Resources</i> are used to configure %p%.  Resources are named items with
3 string, integer or Boolean values.
4 <p>
5 Resource definitions come from the following sources:
6 <ul>
7 <li>Default values are compiled into %p%.</li>
8if x
9 <li>Standard X11 methods can be used to override the compiled-in
10  defaults.  These methods include:
11  <ul>
12  <li>The %p% app-defaults file (only if %p% is built with app-defaults
13   support).  This can be a locale-specific or generic app-defaults file
14   located in the user's home directory or in the system X11 directory.</li>
15  <li>Definitions set by the <i>xrdb</i> command.
16  <li>The <b>~/.Xdefaults</b> file.
17 </ul>
18endif
19 <li>If a session file <b><i>foo</i>.%p%</b> is specified on the command line,
20 its contents are applied.
21if x c
22 Otherwise, if the %p% profile (<b>~/.%p%pro</b>) exists, it is read and its
23 contents are applied.
24endif
25 These definitions override resource values defined by
26if x
27 X11 methods and
28endif
29 compiled-in defaults.</li>
30 <li>Command-line options override all other resource definitions.  If more
31  than one command-line option sets a resource, the last one is used.</li>
32 </ul>
33 Many resources have their own command-line switches, which are listed below.
34 Those that do not can still be set from the command-line via the <b>-xrm</b>
35 command-line option.  For example %-bsdTm% can be set by the
36 following command-line option:
37 <pre>
38     -xrm "%p%.bsdTm: true"
39 </pre>
40 Note that <b>-xrm</b> is supported on all of the 3270 emulators, not just on
41 x3270.
42
43 <h2>Resource File Syntax</h2>
44 A resource file
45if x
46 (app-defaults file, profile or session file)
47else
48if c
49 (profile or session file)
50else
51 (session file)
52endif
53endif
54 has the following syntax.
55 <ul>
56  <li>Each definition consists of:
57  <pre>
58    <b>%p%.</b><i>resource-name</i><b>:</b> <i>value</i>
59  </pre></li>
60  <li>Comment lines begin with <b>!</b>.</li>
61  <li>Line continuation is indicated by a backshash (<b>\</b>) character at
62   the end of a line.</li>
63if x C
64  <li>Multi-line resources, such as keymap definitions, are split with
65   newline characters, e.g.:
66  <pre>
67    <b>%p%.keymap.foo: \
68      &lt;Key>a: String("bob") \n\
69      &lt;Key>b: String("fred") \n\
70      &lt;Key>c: String("joe")</b>
71  </pre></li>
72endif
73 </ul>
74.
75
76name acceptHostname
77applies a
78type s
79groups s
80switch -accepthostname
81description
82    Defines a specific name to accept when validating the name presented in
83    the server's SSL/TLS certificate, instead of using the name used
84    to make the connection.
85    (The form <b>DNS:</b><i>name</i>
86    is also accepted for backwards compatibility.)
87.
88
89name acs
90applies c
91type b
92default true
93desc
94    When true, %p% will use the curses Alternative Character Set (ACS) to
95    display box-drawing characters.
96    When false, %p% will use Unicode box-drawing characters.
97.
98
99name activeIcon
100applies x
101groups a
102type b
103default false
104switch -activeicon
105description
106    When true, %p%'s icon becomes a live miniature of the
107    screen display.
108.
109
110name aidWait
111applies x c s
112type b
113default false
114switch -set aidWait
115switch -clear aidWait
116desc
117    When true, %p% will not block a script after executing
118    an AID action (<b>Enter</b>, <b>Clear</b>, <b>PF</b> or <b>PA</b>).
119    It is then script's responsibility to poll %p%'s status until it shows
120    that the keyboard is no longer unlocked.
121.
122
123name allBold
124applies c
125groups a
126type s
127default auto
128switch -allbold
129desc
130    When true, %p% will display all text in bold.  This is needed
131    for terminals like Linux consoles and xterms that display non-bold text
132    in unreadably-dim colors.  When false, text will be displayed in normal or
133    bold, depending on the host-specified highlighting attribute.
134    <p class=indented>
135    When set to <b>auto</b>, it will be assumed <b>true</b> for 3279 emulation,
136    and <b>false</b> for 3278 emulation.
137.
138
139name allowResize
140applies x
141type b
142default true
143description
144    When true, the %p% window can be resized by the mouse (actually,
145    by the
146    window manager).  When false, the window can only be resized from
147    menu
148    options.  The purpose of disabling mouse resizing is to allow a window
149    bigger than will fit on the screen, which some window managers (e.g., mwm)
150    will not allow if permitted to resize it.
151.
152
153name alwaysInsert
154applies a
155type b
156default false
157description
158    When true, %p% will set insert mode by default, and insert mode can only
159    be disabled by the ToggleInsert() action.
160.
161
162name altCursor
163applies x wc
164groups a
165type b
166default false
167switch -set altCursor
168switch -clear altCursor
169option Options -&gt; Toggles -&gt; Underline Cursor
170option Options -&gt; Toggles -&gt; Block Cursor
171description
172    When true, this causes %p% to use the alternate
173    (underscore) cursor.  When false, it will use a block cursor.
174.
175
176name altScreen
177applies c
178type s
179switch -altscreen
180desc
181    Defines a character string that will be output to switch the terminal from
182    80-column mode to 132-column mode.
183    Within the string, the sequence <b>\E</b> is translated to the ASCII
184    ESC character (0x1b).
185    <p class=indented>
186    When %-model% is 5, and this and
187    %-defScreen% are defined, %p% will automatically change the
188    terminal size when the host switches between the default (24x80) screen
189    and the alternate (27x132) screen.
190.
191
192name aplCircledAlpha
193applies x
194groups a
195type b
196default false
197description
198    When set to true, allows %p% to work properly with special APL fonts like
199    the APL385 font.
200    APL385 maps the APL underscored alphabetic characters, which have no
201    Unicode equivalent, to the DBCS circled alphabetic characters in the range
202    U+24B6 to U+25CF.
203    Otherwise, the only way to display these characters is with one of the
204    special 3270 fonts included with %p%.
205    <p class=indented>
206    Because this mapping is non-standard, this setting affects only the
207    display. The <b>Ascii</b> action will always output underscored alphabetics
208    as blanks, and copy-and-paste operations will also represent them this way,
209    though this may change to use the Unicode Combining Low Line character
210    U+0332 at some point.
211.
212
213name aplMode
214applies x
215type b
216default false
217switch -apl
218desc
219    Sets %p% APL mode at start-up.
220    APL mode sets up a temporary keymap and compose map to allow the entry of
221    APL symbols.
222    At run-time, APL mode is toggled with the Shift-Esc key.
223.
224
225name asciiBoxDraw
226applies C
227type b
228default false
229desc
230    When true, this causes box-drawing characters (the Unicode 2500 block) to
231    be drawn with ASCII-art characters (<b>+</b>, <b>-</b> and <b>|</b>).
232    This allows a readable representation of these characters on the screen
233    when using fonts that do not include them or have them with the wrong
234    width.
235.
236
237name autoShortcut
238applies wc
239type b
240default false
241switch -S
242switch +S
243desc
244    When true, %p% will run in <i>auto-shortcut</i> mode.  In auto-shortcut
245    mode, %p% automatically creates a desktop shortcut (<b>.lnk</b> file)
246    in %TEMP% that is compatible with its session file, then starts it.  This
247    ensures that the console window's screen size, character set, font, etc.
248    will be correct.
249    <p class="indented">
250    Auto-shortcut mode requires the use of a session file; the session file
251    must have been created by the Session Wizard (release 3.3.9 or later) and
252    must not have been modified incorrectly.  All desktop shortcuts created
253    by the Session Wizard release 3.3.10 or later include setting autoShortcut
254    to true.
255    <p class="indented">
256    The <b>+S</b> command-line switch turns off auto-shortcut mode.  All
257    desktop shortcuts created by the Session Wizard release 3.3.10 or later
258    include this switch.
259    <p class="indented">
260    Auto-shortcut mode does not work on Windows 9x.
261.
262
263name background
264applies x
265groups a
266type s
267default white
268switch -bg
269switch -rv
270description
271    The background color for menus, buttons, and on monochrome X11 displays, the
272    emulator window.
273.
274
275name bellMode
276applies wc
277type s
278groups i
279description
280    Controls how %p% responds to an ALARM WCC or BELL character.
281    The value of <b>beepFlash</b> causes both the Windows console to
282    beep and the %p% window to flash; this is the default behavior.
283    The values of <b>beep</b> and <b>flash</b> cause just the beep and just
284    the window flash respectively.  The value <b>none</b> causes ALARM WCCs
285    and BELL characters to be ignored.
286    <p class="indented">
287    If this resource is defined, it overrides %-visualBell%.
288.
289
290name bellVolume
291applies x
292type i
293default 0
294description
295    Controls the volume used when ringing the terminal bell.  The value
296    ranges from -100 (silent) through 0 (normal) to +100 (loud).  Not all
297    X11 servers can vary the bell volume, other than turning it on and off.
298    This resource can be overridden by %-visualBell%, which
299    if true, will replace the bell with a flash of the screen.
300.
301
302name bindLimit
303applies a
304groups p
305type b
306default true
307description
308    When true, %p% will restrict its screen dimensions to those specified in
309    the BIND image sent by the host.
310    If false, it will not.
311.
312
313name bindUnlock
314applies a
315type b
316groups p
317default false
318description
319    When true, %p% will unlock the keyboard as soon as the host sends a BIND
320    image. Otherwise, it will wait until the host sends a Write command.
321    <p class=indented>
322    Note that in some previous releases, unlocking as soon as the BIND image
323    was recevied was the default, and this behavior could be overridden
324    (forcing %p% to wait for the Write) by the <b>B:</b> option on the
325    hostname. Since waiting for the Write is now the default, <b>B:</b> is
326    still supported as a no-op.
327.
328
329name blankFill
330applies a
331groups i
332type b
333default true
334option Options -&gt; Toggles -&gt; Blank Fill
335switch -set blankFill
336switch -clear blankFill
337description
338    When true, in 3270 mode %p% will automatically convert
339    trailing blanks in a field to NULLs in order to insert a character, and will
340    automatically convert leading NULLs to blanks so that input data is not
341    squeezed to the left.  This works around some of the quirkier behavior of
342    real 3270 terminals.
343.
344
345name boldColor
346applies x
347groups a
348default green
349type s
350description
351    This resource defines the X11 color used to display intensified text in
352    3278 mode.
353    <p class=indented>
354    Previous versions of %p% implemented something called <i>pseudo-color
355    mode</i>, where a monochrome (3278) terminal was emulated with various
356    colors assigned to different kinds of fields.
357    To emulate pseudo-color mode with the current version of %p%, select 3278
358    emulation with %-model%, set %-inputColor% to <b>orange</b> and set
359    %-boldColor% to <b>cyan</b>.
360.
361
362name bsdTm
363applies a
364groups p
365type b
366default false
367description
368    Defines %p%'s response to the TELNET DO TIMING MARK option.  When set
369    to false, %p% will respond to DO TIMING MARK with
370    WONT
371    TIMING MARK, which is consistent with most modern TELNET clients.  When
372    true, %p% will respond with WILL TIMING MARK, which is consistent
373    with the old BSD <i>telnet</i> command and with previous versions of
374    %p%.  In either case, %p% will never respond to a DONT TIMING MARK option.
375.
376
377name caDir
378applies u
379type s
380groups s
381switch -cadir
382description
383    Defines a directory containing CA (root) certificates, used to validate
384    a certificate presented by the host during SSL/TLS negotiation.
385    The default is determined by the OpenSSL library on your workstation.
386    (OpenSSL only)
387.
388
389name caFile
390applies u
391type s
392groups s
393switch -cafile
394description
395    Defines a PEM-format file containing CA (root) certificates, used to
396    validate a certificate presented by the host during SSL/TLS negotiation.
397    The default is determined by the OpenSSL library on your workstation.
398    (OpenSSL only)
399.
400
401name cbreak
402applies c
403type b
404default false
405switch -cbreak
406desc
407    If true, %p% will set up the terminal in <b>cbreak</b> mode
408    instead of the default <b>raw</b> mode.  <b>Cbreak</b> mode enables
409    flow-control processing in the TTY driver, and may be required for
410    certain terminals that use flow control to avoid dropping characters.
411.
412
413name certFile
414applies u
415groups s
416type s
417switch -certfile
418desc
419    Gives the name of a client certificate file, provided to the host
420    during SSL/TLS negotiation.
421    <p class=indented>
422    With OpenSSL, the default file format is PEM; it can be overridden by
423    %-certFileType%.
424    The private key for the certificate is specified by %-keyFile%.
425    If %-chainFile% is specified, it overrides %-certFile%.
426    <p class=indented>
427    On the Mac, the file must be in PKCS12 format.
428.
429
430name certFileType
431applies u
432groups s
433type s
434default pem
435switch -certfiletype
436desc
437    Gives the type of the certificate file specified by %-certFile%.
438    The value can be <b>pem</b> or <b>asn1</b>.
439    (OpenSSL only)
440.
441
442name chainFile
443applies u
444groups s
445type s
446switch -chainfile
447desc
448    Gives the name of a certificate chain file to provided to the host
449    during SSL/TLS negotiation.
450    The file contains a PEM-format certificate, optionally followed by
451    any intermediate certificates used to sign it, and the CA (root)
452    certificate.
453    The private key for the certificate is specified by %-keyFile%.
454    If %-chainFile% is specified, it overrides %-certFile%.
455    (OpenSSL only)
456.
457
458name charClass
459applies x
460type s
461desc
462    Defines groups of characters that should be treated the same when doing
463    cut and paste of words.  Identical in use to the <i>xterm</i> resource
464    of the same name.
465.
466
467name clientCert
468applies w
469groups s
470type s
471switch -clientcert
472desc
473    Gives the name of a client certificate, provided during SSL/TLS
474    negotiation. The certificate is searched for in the Personal store.
475.
476
477name clientCert
478applies u
479groups s
480type s
481switch -clientcert
482desc
483    Gives the name of a client certificate, provided during SSL/TLS
484    negotiation. (Mac only)
485.
486
487name codepage
488applies a
489groups c
490type s
491default bracket
492switch -codepage
493option Options -&gt; Code Page
494description
495    This defines the host EBCDIC code page, that is, what glyph (image) is
496    displayed for each EBCDIC code sent by the host, and what EBCDIC code is
497    sent to the host for each character typed on the keyboard.
498    <p class="indented">
499    To display the code pages supported by %p%, use the <b>-v</b>
500    command-line option or the <b>Query(CodePages)</b> action.
501if wc
502    <p class="indented">
503    Note that %p% DBCS support is limited. On Windows XP, Windows East Asian
504    language support must be installed. On Windows Vista and later, the Windows
505    System Locale must be set to a matching language.
506endif
507.
508
509name colorBackground
510applies x
511groups a
512type s
513default black
514description
515    The background color for the emulator window.  This resource is used only
516    on color X11 displays when %-model% specifies 3278 mode.  On
517    monochrome X11 displays, the background color is <b>white</b>, unless
518    <b>-rv</b>
519    (reverse video) is selected on the command line; in 3279 mode, the screen
520    background is determined by %-colorScheme%.
521.
522
523name colorScheme
524applies x
525groups a
526type s
527default default
528option Options -&gt; Color Scheme
529description
530    Defines the colors used to paint the emulator window in 3279 (full-color)
531    mode.  This resource is used only when %-model% specifies a 3279
532    display.
533    %-colorScheme% is just the name of the color scheme.
534    The actual color scheme definition for color scheme <i>foo</i> is
535    %-colorScheme.<i>foo</i>%.
536.
537
538name colorScheme.<i>foo</i>
539applies x
540groups a
541type s
542description
543    An individual color scheme definition.
544    I.e., to define color scheme <i>foo</i>, a resource named <b>%p%.colorScheme.<i>foo</i></b> must be defined.
545    <p class=indented>
546    Each resource is a whitespace-separated list of 23 items:
547<ol>
548 <li>X11 color for host color 0 NeutralBlack (also used for NVT color 0)</li>
549 <li>X11 color for host color 1 Blue (also used for NVT color 4)</li>
550 <li>X11 color for host color 2 Red (also used for NVT color 1)</li>
551 <li>X11 color for host color 3 Pink (also used for NVT color 5)</li>
552 <li>X11 color for host color 4 Green (also used for NVT color 2)</li>
553 <li>X11 color for host color 5 Turquoise</li>
554 <li>X11 color for host color 6 Yellow (also used for NVT color 3)</li>
555 <li>X11 color for host color 7 NeutralWhite</li>
556 <li>X11 color for host color 8 Black</li>
557 <li>X11 color for host color 9 DeepBlue</li>
558 <li>X11 color for host color 10 Orange</li>
559 <li>X11 color for host color 11 Purple</li>
560 <li>X11 color for host color 12 PaleGreen</li>
561 <li>X11 color for host color 13 PaleTurquoise (also used for NVT color 6)</li>
562 <li>X11 color for host color 14 Grey</li>
563 <li>X11 color for host color 15 white (also used for NVT color 7)</li>
564 <li>X11 color to use if one of 0..15 cannot be allocated (white or black)</li>
565 <li>X11 color to use as the default screen background</li>
566 <li>X11 color to use as the select background</li>
567 <li>Host color (0..15) for unprotected, unhighlighted fields</li>
568 <li>Host color (0..15) for unprotected, highlighted fields</li>
569 <li>Host color (0..15) for protected, unhighlighted fields</li>
570 <li>Host color (0..15) for protected, highlighted fields</li>
571</ol>
572<p class=indented>
573<i>Note</i>: Host color 0 (NeutralBlack) means black on a display screen (a
574white-on-black device) and white on a printer (a black-on-white device).
575Host color 7 (NeutralWhite) means white on a display screen and black on a
576printer.
577.
578
579name composeMap
580applies x C
581type s
582default latin1
583description
584    Gives the name of the map used to define the pairs of characters that
585    form composite characters with the <i>Compose</i> key.
586    The definition of compose map <i>foo</i> is the resource
587    %-composeMap.<i>foo</i>%.
588.
589
590name composeMap.<i>foo</i>
591applies x C
592type s
593description
594    An individual compose map definition.
595    Each line in the resource is of the form:
596<pre>
597         keysym1 + keysym2 = keysym3
598</pre>
599<p class=indented>
600    meaning "when the </i>Compose</i> key is pressed,
601    followed by keysym1 and keysym2 (in either order), interpret it as
602    keysym3."  The definitions are case-sensitive.
603.
604
605name confDir
606applies a
607type s
608if u
609default /usr/local/etc/x3270
610else
611default .
612endif
613desc
614    Defines the %p% configuration directory, where %p% will search for the
615    <b>ibm_hosts</b> file by default.  (See %-hostsFile%.)
616if w
617    <p class=indented>
618    The default is to search the directory where %p% was started, which
619    usually its installation directory.
620endif
621.
622
623name connectFileName
624applies x
625type s
626default ~/.x3270connect
627description
628    Gives the name of the file to store the recently-connected
629    host list in.  If given the value <b>none</b>, no file will be read or
630    written.  Note that by default, this file is shared among all instances
631    of %p% that run under the same username.
632.
633
634name connectTimeout
635applies a
636type i
637groups c
638switch -connecttimeout
639description
640    Specifies a timeout, in seconds, that %p% will wait for a host connection
641    to complete. If this is not set, the timeout will be determined by the
642    operating system. Note that %p% will wait for the lesser of the two times
643    (the specified timeout and the system-defined timeout).
644.
645
646name console
647applies x
648type s
649desc
650    Overrides the default console emulator program used for the %p%&gt; prompt
651    and the trace monitor window.
652    <p class=indented>
653    The resource can take two forms. If it is just a keyword, it is the name
654    of a well-known console: <b>gnome-terminal</b>, <b>konsole</b>,
655    <b>xfce4-terminal</b> or <b>xterm</b>.
656    If the string includes colons (:), it defines a console, and consists of
657    four fields: <i>program-name</i>:<i>title-option</i>:<i>extra-option</i>:<i>exec-option</i>.
658    <p class=indented>
659    <i>program-name</i> is the name of the executable program.
660    <p class=indented>
661    <i>title-option</i> is the option used to set the window title.
662    <p class=indented>
663    <i>extra-option</i> is an extra command-line option to pass, such as
664    <b>-sb</b> to turn on the xterm scroll bar. It can be empty.
665    <p class=indented>
666    <i>exec-option</i> is the option used to end the argument list, with the
667    remaining options specifying the command and arguments to run inside the
668    console window.
669    <p class=indented>
670    For example, the specification for gnome-terimnal is <b>gnome-terminal:--title::--</b>.
671.
672
673name consoleColorForHostColor0 consoleColorForHostColorNeutralBlack consoleColorForHostColor1 consoleColorForHostColorBlue consoleColorForHostColor2 consoleColorForHostColorRed consoleColorForHostColor3 consoleColorForHostColorPink consoleColorForHostColor4 consoleColorForHostColorGreen consoleColorForHostColor5 consoleColorForHostColorTurquoise consoleColorForHostColor6 consoleColorForHostColorYellow consoleColorForHostColor7 consoleColorForHostColorNeutralWhite consoleColorForHostColor8 consoleColorForHostColorBlack consoleColorForHostColor9 consoleColorForHostColorDeepBlue consoleColorForHostColor10 consoleColorForHostColorOrange consoleColorForHostColor12 consoleColorForHostColorPurple consoleColorForHostColor13 consoleColorForHostColorPaleGreen consoleColorForHostColor14 consoleColorForHostColorPaleTurquoise consoleColorForHostColor15 consoleColorForHostColorGrey consoleColorForHostColor16 consoleColorForHostColorWhite
674applies wc
675groups a
676type i
677desc
678    Defines what console color to use to render a particular host color.
679    Host colors can be specified by name or number.  That is, to define the
680    console color to use when the host specifies <b>green</b>, which is host
681    color 4, either the resource <b>%p%.consoleColorForHostColorGreen</b> or
682    the resource <b>%p%.consoleColorForHostColor4</b> can be used.
683    <p class=indented>
684    The default definitions are as follows.
685    <table cols=3 width="75%">
686    <tr> <th>Host Color Index</th>
687         <th>Host Color Name</th>
688         <th>Default Console Color</th>
689    <tr> <td>0</td> <td>NeutralBlack</td> <td>0</td> </tr>
690    <tr> <td>1</td> <td>Blue</td> <td>9</td> </tr>
691    <tr> <td>2</td> <td>Red</td> <td>12</td> </tr>
692    <tr> <td>3</td> <td>Pink</td> <td>13</td> </tr>
693    <tr> <td>4</td> <td>Green</td> <td>10</td> </tr>
694    <tr> <td>5</td> <td>Turquoise</td> <td>11</td> </tr>
695    <tr> <td>6</td> <td>Yellow</td> <td>14</td> </tr>
696    <tr> <td>7</td> <td>NeutralWhite</td> <td>15</td> </tr>
697    <tr> <td>8</td> <td>Black</td> <td>0</td> </tr>
698    <tr> <td>9</td> <td>DeepBlue</td> <td>1</td> </tr>
699    <tr> <td>10</td> <td>Orange</td> <td>12</td> </tr>
700    <tr> <td>11</td> <td>Purple</td> <td>5</td> </tr>
701    <tr> <td>12</td> <td>PaleGreen</td> <td>2</td> </tr>
702    <tr> <td>13</td> <td>PaleTurquoise</td> <td>3</td> </tr>
703    <tr> <td>14</td> <td>Grey</td> <td>7</td> </tr>
704    <tr> <td>15</td> <td>White</td> <td>15</td> </tr>
705    </table>
706    <p class=indented>
707    Note that "neutral black" means black on a display device and white on
708    a printing device, and "neutral white" means white on a display device and
709    black on a printing device.
710    <p class=indented>
711    The value of the resource is a console color index (0 through 15).
712    Console colors are defined as follows:
713    <table cols=3 width="75%">
714    <tr> <th>Index</th> <th>Sample</th> </tr>
715    <tr> <td>0</td>
716         <td><span style="color: #000000; background-color: black">[<b>sample</b>]<span></td> </tr>
717    <tr> <td>1</td>
718         <td><span style="color: #000080; background-color: black">[<b>sample</b>]<span></li>
719    <tr> <td>2</td>
720         <td><span style="color: #008000; background-color: black">[<b>sample</b>]<span></td>
721    <tr> <td>3</td>
722         <td><span style="color: #008080; background-color: black">[<b>sample</b>]<span></td>
723    <tr> <td>4</td>
724         <td><span style="color: #800000; background-color: black">[<b>sample</b>]<span></td>
725    <tr> <td>5</td>
726         <td><span style="color: #800080; background-color: black">[<b>sample</b>]<span></td>
727    <tr> <td>6</td>
728         <td><span style="color: #808000; background-color: black">[<b>sample</b>]<span></td>
729    <tr> <td>7</td>
730         <td><span style="color: #c0c0c0; background-color: black">[<b>sample</b>]<span></td>
731    <tr> <td>8</td>
732         <td><span style="color: #808080; background-color: black">[<b>sample</b>]<span></td>
733    <tr> <td>9</td>
734         <td><span style="color: #0080ff; background-color: black">[<b>sample</b>]<span></td>
735    <tr> <td>10</td>
736         <td><span style="color: #00ff00; background-color: black">[<b>sample</b>]<span></td>
737    <tr> <td>11</td>
738         <td><span style="color: #00ffff; background-color: black">[<b>sample</b>]<span></td>
739    <tr> <td>12</td>
740         <td><span style="color: #ff0000; background-color: black">[<b>sample</b>]<span></td>
741    <tr> <td>13</td>
742         <td><span style="color: #ff00ff; background-color: black">[<b>sample</b>]<span></td>
743    <tr> <td>14</td>
744         <td><span style="color: #ffff00; background-color: black">[<b>sample</b>]<span></td>
745    <tr> <td>15</td>
746         <td><span style="color: #ffffff; background-color: black">[<b>sample</b>]<span></td>
747    </table>
748    <p class=indented>
749    The color samples above are the default values used by the %p% Session
750    Wizard when it creates a desktop shortcut.  The RGB values for any of the
751    console colors can be changed later using the Colors tab on the Properties
752    dialog of the shortcut.
753    <p class=indented>
754    In NVT mode, %p% maps the ANSI-standard colors 0 through
755    7 to host colors, and from host colors to console colors.
756    The mapping from ANSI colors to host colors cannot be changed, but the
757    mapping from host colors to console colors can be with
758    <b>%p%.consoleColorForHostColor*</b> resources.
759    The mappings and defaults are as follows:
760    <table cols=3 width="75%">
761    <tr><th>NVT ANSI Color</th>
762        <th>Mapped Host Color (not configurable)</th>
763	<th>Default Console Color</th>
764    <tr> <td>0 (black)</td>     <td>0 (Black)</td> <td>0</td> </tr>
765    <tr> <td>1 (red)</td>       <td>2 (Red) </td> <td>12</td> </tr>
766    <tr> <td>2 (green)</td>     <td>4 (Green)</td> <td>10</td> </tr>
767    <tr> <td>3 (yellow)</td>    <td>6 (Yellow)</td> <td>14</td> </tr>
768    <tr> <td>4 (blue)</td>      <td>1 (Blue)</td> <td>9</td> </tr>
769    <tr> <td>5 (magenta)</td>   <td>3 (Pink)</td> <td>13</td> </tr>
770    <tr> <td>6 (turquoise)</td> <td>6 (Turquoise)</td> <td>14</td> </tr>
771    <tr> <td>7 (white)</td>     <td>7 (NeutralWhite)</td> <td>15</td> </tr>
772    </table>
773    <p class=indented>
774    For example, to change the display from white-on-black to black-on-white,
775    define the following resources:
776    <pre>
777     %p%.consoleColorForHostColorNeutralBlack: 15
778     %p%.consoleColorForHostColorNeutralWhite: 0
779    </pre>
780.
781
782name crosshair
783applies x C
784groups a
785type b
786default false
787option Options -&gt; Toggles -&gt; Crosshair Cursor
788switch -set crosshair
789switch -clear crosshair
790description
791    When true, causes %p% to display a crosshair over the
792    cursor: lines extending with height and width of the screen.
793.
794
795name crosshairColor
796applies x C
797groups a
798type s
799default purple
800description
801    Defines the color used for the crosshair cursor (see %-crosshair%).
802    The value is a host color name or numeric host color index:
803    <table cols=2 width="75%">
804    <tr> <th>Host Color Name</th>
805         <th>Host Color Index</th>
806    <tr> <td>NeutralBlack</td> <td>0</td> </tr>
807    <tr> <td>Blue</td> <td>1</td> </tr>
808    <tr> <td>Red</td> <td>2</td> </tr>
809    <tr> <td>Pink</td> <td>3</td> </tr>
810    <tr> <td>Green</td> <td>4</td> </tr>
811    <tr> <td>Turquoise</td> <td>5</td> </tr>
812    <tr> <td>Yellow</td> <td>6</td> </tr>
813    <tr> <td>NeutralWhite</td> <td>7</td> </tr>
814    <tr> <td>Black</td> <td>8</td> </tr>
815    <tr> <td>DeepBlue</td> <td>9</td> </tr>
816    <tr> <td>Orange</td> <td>10</td> </tr>
817    <tr> <td>Purple</td> <td>11</td> </tr>
818    <tr> <td>PaleGreen</td> <td>12</td> </tr>
819    <tr> <td>PaleTurquoise</td> <td>13</td> </tr>
820    <tr> <td>Grey</td> <td>14</td> </tr>
821    <tr> <td>White</td> <td>15</td> </tr>
822    </table>
823.
824
825name cursesColorForDefault cursesColorForIntensified cursesColorForProtected cursesColorForProtectedIntensified
826applies c
827groups a
828type s
829desc
830    Defines the default color to use to render text based on its attributes,
831    when the host does not specify a particular color.
832    <p class=indented>
833    The value of the resource can be either a curses color index or curses color
834    name.  These are are defined as follows:
835    <table cols=2 width="75%">
836    <tr> <th>Curses Color Index</th> <th>Curses Color Name</th> </tr>
837    <tr> <td>0</td> <td>black</td> </tr>
838    <tr> <td>1</td> <td>red</td> </tr>
839    <tr> <td>2</td> <td>green</td> </tr>
840    <tr> <td>3</td> <td>yellow</td> </tr>
841    <tr> <td>4</td> <td>blue</td> </tr>
842    <tr> <td>5</td> <td>magenta</td> </tr>
843    <tr> <td>6</td> <td>cyan</td> </tr>
844    <tr> <td>7</td> <td>white</td> </tr>
845    <tr> <td>8</td> <td><i>no name -- displays as grey</i></td> </tr>
846    <tr> <td>9</td> <td><i>no name -- displays as bright red</i></td> </tr>
847    <tr> <td>10</td> <td><i>no name -- displays as bright green</i></td> </tr>
848    <tr> <td>11</td> <td><i>no name -- displays as bright yellow</i></td> </tr>
849    <tr> <td>12</td> <td><i>no name -- displays as bright blue</i></td> </tr>
850    <tr> <td>13</td> <td><i>no name -- displays as bright magenta</i></td> </tr>
851    <tr> <td>14</td> <td><i>no name -- displays as bright cyan</i></td> </tr>
852    <tr> <td>15</td> <td><i>no name -- displays as bright white</i></td> </tr>
853    </table>
854    <p class=indented>
855    The default values are:
856    <table cols=3 width="75%" cellspacing=5>
857    <tr> <th>%p% Resource</th>
858         <th>Default Curses Color (8-color terminal)</th>
859	 <th><b>Default Curses Color (16-color terminal)</th> </tr>
860    <tr> <td>cursesColorForDefault</td> <td>green</td> <td>10 (bright green)</td> </tr>
861    <tr> <td>cursesColorForIntensified</td> <td>red</td> <td>red</td> </tr>
862    <tr> <td>cursesColorForProtected</td> <td>blue</td> <td>12 (bright blue)</td> </tr>
863    <tr> <td>cursesColorForProtectedIntensified</td> <td>white</td> <td>15 (bright white)</td> </tr>
864    </table>
865.
866
867name cursesColorForHostColor0 cursesColorForHostColorNeutralBlack cursesColorForHostColor1 cursesColorForHostColorBlue cursesColorForHostColor2 cursesColorForHostColorRed cursesColorForHostColor3 cursesColorForHostColorPink cursesColorForHostColor4 cursesColorForHostColorGreen cursesColorForHostColor5 cursesColorForHostColorTurquoise cursesColorForHostColor6 cursesColorForHostColorYellow cursesColorForHostColor7 cursesColorForHostColorNeutralWhite cursesColorForHostColor8 cursesColorForHostColorBlack cursesColorForHostColor9 cursesColorForHostColorDeepBlue cursesColorForHostColor10 cursesColorForHostColorOrange cursesColorForHostColor12 cursesColorForHostColorPurple cursesColorForHostColor13 cursesColorForHostColorPaleGreen cursesColorForHostColor14 cursesColorForHostColorPaleTurquoise cursesColorForHostColor15 cursesColorForHostColorGrey cursesColorForHostColor16 cursesColorForHostColorWhite
868applies c
869groups a
870type s
871desc
872    Defines what curses color to use to render a particular host color.
873    Host colors can be specified by name or number.  That is, to define the
874    curses color to use when the host specifies <b>green</b>, which is host
875    color 4, either the resource <b>%p%.cursesColorForHostColorGreen</b> or
876    the resource <b>%p%.cursesColorForHostColor4</b> can be defined.
877    <p class=indented>
878    The default definitions are as follows.  Note that on an 8-color
879    terminal, %p% only displays 8 host colors.
880    <table cols=4 width="75%">
881    <tr> <th>Host Color Index</th>
882         <th>Host Color Name</th>
883         <th>Default Curses Color (8-color terminal)</th>
884         <th>Default Curses Color (16-color terminal)</th> </tr>
885    <tr> <td>0</td> <td>NeutralBlack</td> <td>black</td> <td>black</td> </tr>
886    <tr> <td>1</td> <td>Blue</td> <td>blue</td> <td>12 (bright blue)</td> </tr>
887    <tr> <td>2</td> <td>Red</td> <td>red</td> <td>red</td> </tr>
888    <tr> <td>3</td> <td>Pink</td> <td>red</td> <td>13 (bright magenta)</td> </tr>
889    <tr> <td>4</td> <td>Green</td> <td>green</td> <td>10 (bright green)</td> </tr>
890    <tr> <td>5</td> <td>Turquoise</td> <td>cyan</td> <td>14 (bright cyan)</td> </tr>
891    <tr> <td>6</td> <td>Yellow</td> <td>yellow</td> <td>11 (bright yellow)</td> </tr>
892    <tr> <td>7</td> <td>NeutralWhite</td> <td>white</td> <td>15 (bright white)</td> </tr>
893    <tr> <td>8</td> <td>Black</td> <td>-</td> <td>black</td> </tr>
894    <tr> <td>9</td> <td>DeepBlue</td> <td>-</td> <td>blue</td> </tr>
895    <tr> <td>10</td> <td>Orange</td> <td>-</td> <td>9 (bright red)</td> </tr>
896    <tr> <td>11</td> <td>Purple</td> <td>-</td> <td>magenta</td> </tr>
897    <tr> <td>12</td> <td>PaleGreen</td> <td>-</td> <td>green</td> </tr>
898    <tr> <td>13</td> <td>PaleTurquoise</td> <td>-</td> <td>cyan</td> </tr>
899    <tr> <td>14</td> <td>Grey</td> <td>-</td> <td>white</td> </tr>
900    <tr> <td>15</td> <td>White</td> <td>-</td> <td>15 (bright white)</td> </tr>
901    </table>
902    <p class=indented>
903    Note that "neutral black" means black on a display device and white on
904    a printing device, and "neutral white" means white on a display device and
905    black on a printing device.
906    <p class=indented>
907    In NVT mode, %p% maps the ANSI-standard colors 0 through
908    7 to host colors, and from host colors to curses colors.
909    The mapping from ANSI colors to host colors cannot be changed, but the
910    mapping from host colors to curses colors can be with
911    <b>%p%.cursesColorForHostColor*</b> resources.
912    The mappings and defaults are as follows:
913    <table cols=4 width="75%">
914    <tr><th>NVT ANSI Color</th>
915        <th>Mapped Host Color (not configurable)</th>
916	<th>Default Curses Color (8-color terminal)</th>
917	<th>Default Curses Color (16-color terminal)</th> </tr>
918    <tr> <td>0 (black)</td> <td>0 (Black)</td> <td>black</td> <td>black</td> </tr>
919    <tr> <td>1 (red)</td> <td>2 (Red)</td> <td>red</td> <td>red</td> </tr>
920    <tr> <td>2 (green)</td> <td>4 (Green)</td> <td>green</td> <td>10 (bright green)</td> </tr>
921    <tr> <td>3 (yellow)</td> <td>6 (Yellow)</td> <td>yellow</td> <td>11 (bright yellow)</td> </tr>
922    <tr> <td>4 (blue)</td> <td>1 (Blue)</td> <td>blue</td> <td>12 (bright blue)</td> </tr>
923    <tr> <td>5 (magenta)</td> <td>3 (Pink)</td> <td>red</td> <td>13 (bright magenta)</td> </tr>
924    <tr> <td>6 (turquoise)</td> <td>13 (PaleTurquioise)</td> <td>cyan</td> <td>cyan</td> </tr>
925    <tr> <td>7 (white)</td> <td>15 (White)</td> <td>white</td> <td>15 (bright white)</td> </tr>
926    </table>
927    <p class=indented>
928    See %-cursesColorForDefault% for the definitions of curses colors.
929.
930
931name cursesKeypad
932applies c
933type b
934default false
935desc
936    When true, %p% will set up the terminal in curses keypad mode.
937.
938
939name cursorBlink
940applies x
941groups a
942type b
943default false
944option Options -&gt; Toggles -&gt; Blinking Cursor
945switch -set cursorBlink
946switch -clear cursorBlink
947description
948    When true, causes %p% to use a blinking cursor.
949.
950
951name cursorColor
952applies x
953groups a
954type s
955default red
956description
957    On color X11 displays, this is the color of the text cursor.  This resource
958    is used only if %-useCursorColor% is true.
959.
960
961name dbcsCgcsgid
962applies a
963groups p
964type s
965description
966    Overrides the compiled-in value of the CGCSGID for the current host
967    character set, which will be reported to the host in response to a
968    Query(Character Sets).  The value is an integer, which can be prefixed with
969    '0x' to be in hexadecimal.  The upper 16 bits are the GCSGID (character
970    set) and the lower 16 bits are the CPGID (code page).  This value
971    applies only to the double-byte (DBCS) character set.  Use
972    %-sbcsCgcsgid% for the single-byte (SBCS) character set.
973.
974
975name debugTracing
976applies x
977groups t s
978type b
979default true
980description
981    If true, options are available on the <b>File</b> menu
982    to trace the 3270 data stream and X11 events.  If false, these
983    options are not displayed.
984.
985
986name defaultFgBg
987applies c
988type b
989groups a
990default false
991switch -defaultfgbg
992description
993    If true, %p% will use the terminal's default foreground color instead of
994    specifying the curses color <b>white</b>, and it will use the terminal's
995    default background color instead of specifying the curses color
996    <b>black</b>. This is helpful in two cases: for emulators such as
997    <b>gnome-terminal</b> whose usual representation of a black background is
998    a murky gray, and for emulators configured with a black foreground and a
999    white background, so that %p%'s screen will appear the same way.
1000    <p class=indented>
1001    <b>defaultFgBg</b> will be set to true automatically if the environment
1002    variable <b>COLORTERM</b> is set to <b>gnome-terminal</b>.
1003    <p class=indented>
1004    Note that this resource and option are available only if %p% has been
1005    compiled with a version of ncurses that supports default foreground and
1006    background colors, and if the terminal and its associated termcap/terminfo
1007    entry also support it (it is usually implemented as ANSI color 9).
1008.
1009
1010name defScreen
1011applies c
1012type s
1013switch -defscreen
1014desc
1015    Defines a character string that will be output to switch the terminal from
1016    132-column mode to 80-column mode.
1017    Within the string, the sequence <b>\E</b> is translated to the ASCII
1018    ESC character (0x1b).
1019    <p class=indented>
1020    When %-model% is 5, and this and
1021    %-altScreen% are defined, %p% will automatically change the
1022    terminal size when the host switches between the default (24x80) screen
1023    and the alternate (27x132) screen.
1024.
1025
1026name devName
1027applies a
1028type s
1029switch -devname
1030groups p
1031description
1032    Specifies the device name (workstation ID) sent in response to a TELNET
1033    NEW-ENVIRON sub-negotiation request, used by iSeries hosts (RFC 4777).
1034.
1035
1036name disconnectClear
1037applies x
1038type b
1039default false
1040description
1041    If true, %p% will clear the screen when a host disconnects.
1042.
1043
1044name doConfirms
1045applies x
1046type b
1047default true
1048description
1049    When true, %p% will display a pop-up to report successful
1050    completion of certain operations, such as screen printing.  When
1051    false, these pop-ups are not displayed.
1052.
1053
1054name dpi
1055applies x
1056type i
1057default 96
1058description
1059    Overrides the system DPI (screen resolution) setting, normally retrieved
1060    from Xft.dpi. This resource modifies the sizes of visual elements on the
1061    screen, but not fonts.
1062.
1063
1064name emulatorFont
1065type s
1066applies x
1067groups a
1068default 3270
1069switch -efont
1070option Options -&gt; Font
1071description
1072    The font used for the emulator window.  By default it is <b>3270</b>,
1073    a 14-pixel
1074    clone of a real 3278 display font.  Other 3270-specific fonts are
1075    available in 8-, 12-, 16-, 24- and 32-pixel sizes.
1076    Any standard X11 constant-spaced font can also be used, provided that
1077    it implements a display character set compatible with the host code page
1078    (%-codepage%).  However, the special
1079    OIA (status line) symbols are only available with the 3270 fonts.
1080.
1081
1082name eof
1083type s
1084applies a
1085groups n
1086default ^D
1087description
1088    This setting is used only in NVT mode, and is similar in function to
1089    the <i>stty</i> parameter of the same name.
1090    <p class=indented>
1091    When connected in line-at-a-time mode (when %p% gathers a line of input
1092    before forwarding it to the host), entering this character at the
1093    keyboard causes
1094    the current line of
1095    input to be forwarded to the host without a trailing CR/LF sequence.
1096    <p class=indented>
1097.
1098
1099name erase
1100type s
1101applies a
1102groups n
1103default ^?
1104description
1105    This setting is used only in NVT mode, and is similar in function to
1106    the <i>stty</i> parameter of the same name.
1107    <p class="indented">
1108    When connected in line-at-a-time mode (%p% gathers a line of input
1109    before forwarding it ot the host), entering this character at the keyboard
1110    will cause %p% to discard the last character on the input line.
1111    <p class="indented">
1112    When connected in character-at-a-time mode (%p% sends each keystroke
1113    to the host as it is entered), this is the character that will be sent
1114    to the host by the <b>Erase</b> action.
1115.
1116
1117name fixedSize
1118type s
1119applies x
1120groups a
1121description
1122    Specifies a fixed size for the %p% display window.
1123    If set, %p% will not allow its window to be resized by the window manager.
1124    The syntax is <b><i>width</i>x<i>height</i></b>.
1125    The 3270 display screen will float in the center of the window if necessary.
1126.
1127
1128name foreground
1129type s
1130applies x
1131groups a
1132default black
1133switch -fg
1134switch -rv
1135description
1136    The foreground color for menus, buttons, and on monochrome X11 displays, the
1137    emulator display.
1138.
1139
1140name ftAllocation
1141type s
1142applies a
1143groups i
1144default default
1145description
1146    Defines the default allocation type for files sent to TSO hosts by IND$FILE
1147    file transfers.
1148    Possible values are default, which lets the host decide the allocation
1149    type, or tracks, cylinders, or avblock.
1150.
1151
1152name ftAvblock
1153type i
1154applies a
1155groups i
1156description
1157    Defines the default AVBOCK (average block) allocation size for files sent
1158    to TSO hosts by IND$FILE file transfers.
1159.
1160
1161name ftBlksize
1162type i
1163applies a
1164groups i
1165description
1166    Defines the default block size for files sent to TSO hosts by IND$FILE
1167    file transfers.
1168.
1169
1170name ftBufferSize
1171applies a
1172groups p
1173type i
1174default 4096
1175description
1176    Specifies the default buffer size for DFT IND$FILE file transfers.  This
1177    value can be overridden in the File Transfer dialog and by a parameter to
1178    the <b>Transfer</b> action.
1179.
1180
1181name ftCr
1182type s
1183applies a
1184groups i
1185default auto
1186description
1187    Defines the default action for line separators (carriage returns and line
1188    feeds) in ASCII files during IND$FILE file transfers.
1189    The value can be auto, which will add them when files are received from the
1190    host and remove them when they are sent to the host, add (same as auto),
1191    remove (same as auto), or keep, meaning no special processing is done.
1192.
1193
1194name ftDirection
1195type s
1196applies a
1197groups i
1198default receive
1199description
1200    Defines the default IND$FILE file transfer direction, from the perspective
1201    of the workstation.
1202    The value can be either send (send file from workstation to host) or
1203    receive (receive file from host to workstation).
1204.
1205
1206name ftExist
1207type s
1208applies a
1209groups i
1210default keep
1211description
1212    Defines the default behavior for IND$FILE file transfers when the
1213    destination file already exists.
1214    The value keep means that the transfer will be
1215if x
1216    aborted (or if invoked interactively, the user will be prompted to confirm
1217    the file is to be overwritten),
1218else
1219    aborted,
1220endif
1221    replace means that the file will be overwritten unconditionally, and
1222    append means that the new file will be appended to the old file.
1223.
1224
1225name ftHost
1226type s
1227applies a
1228groups i
1229default tso
1230description
1231    Defines the default host type for IND$FILE file transfers.
1232    The value can be vm, tso or cics.
1233.
1234
1235name ftHostFile
1236type s
1237applies a
1238groups i
1239description
1240    Defines the default host file name for IND$FILE file transfers.
1241.
1242
1243name ftLocalFile
1244type s
1245applies a
1246groups i
1247description
1248    Defines the default local file name for IND$FILE file transfers.
1249.
1250
1251name ftLrecl
1252type i
1253applies a
1254groups i
1255description
1256    Defines the default logical record length for files sent to the host via
1257    IND$FILE.
1258.
1259
1260name ftMode
1261type s
1262applies a
1263groups i
1264default ascii
1265description
1266    Defines the default mode for IND$FILE file transfers: ascii (text, with
1267    translation between the workstation's code page and EBCDIC), or binary (no
1268    translation).
1269.
1270
1271name ftPrimarySpace
1272type i
1273applies a
1274groups i
1275description
1276    Defines the default primary space allocation for files sent to TSO hosts
1277    via IND$FILE.
1278.
1279
1280name ftRecfm
1281type s
1282applies a
1283groups i
1284default default
1285description
1286    Defines the default record format for files sent to the host using
1287    IND$FILE.
1288    Possibe values are default, fixed, variable, and undefined.
1289    The default value of 'default' lets IND$FILE choose an appropriate format.
1290.
1291
1292name ftRemap
1293type s
1294applies a
1295groups i
1296default yes
1297description
1298    Defines the default mapping behavior for ASCII files transferred with
1299    IND$FILE.
1300    When set to yes, ASCII files are translated by
1301    %p% to produce as accurate a mapping as possible between the workstation's
1302    code page and the host's EBCDIC code page. When set to no, only the fixed
1303    translation built into the IND$FILE application is run, which (roughly)
1304    maps ISO 8859-1 to host code page 37.
1305.
1306
1307name ftSecondarySpace
1308type i
1309applies a
1310groups i
1311description
1312    Defines the default secondary space allocation for files sent to TSO hosts
1313    via IND$FILE.
1314.
1315
1316name ftWindowsCodePage
1317type i
1318applies w
1319groups i
1320description
1321    The Windows code page to use for translating between EBCDIC and ASCII in
1322    IND$FILE file transfers. The default is to use the system ANSI code page.
1323    This value can be overridden in the File Transfer dialog and by a parameter
1324    to the <b>Transfer</b> action.
1325.
1326
1327name highlightBold
1328type b
1329applies x
1330groups a
1331default false
1332description
1333    If true, highlighted fields will be displayed in bold.  If
1334    false, highlighted fields will be displayed in the normal
1335    font.
1336.
1337
1338name hostColorForDefault hostColorForIntensified hostColorForProtected hostColorForProtectedIntensified
1339applies wc
1340groups a
1341type s
1342desc
1343    Defines the default color to use to render text with a particular
1344    attribute, when the host does not specify a particular color.
1345    <p class=indented>
1346    The value of the resource is a host color name or color index.
1347    See %-consoleColorForHostColor0% for the definitions of host colors.
1348    <p class=indented>
1349    The default values are:
1350    <table cols=2 width="75%">
1351    <tr> <th>%p% Resource</th>
1352         <th>Default Host Color</th>
1353    <tr> <td>hostColorForDefault</td> <td>Green</td> </tr>
1354    <tr> <td>hostColorForIntensified</td> <td>Red</td> </tr>
1355    <tr> <td>hostColorForProtected</td> <td>Blue</td> </tr>
1356    <tr> <td>hostColorForProtectedIntensified</td> <td>NeutralWhite</td> </tr>
1357    </table>
1358.
1359
1360name hostname
1361type s
1362applies a
1363groups c
1364desc
1365    Gives the name of the host to connect to.  The name can include the usual
1366    options (prefixes to specify special connection options, LU names, and
1367    port).  A hostname specified on the command line takes precedence over
1368    %-hostname%.
1369    <p class=indented>
1370    The most common use of %-hostname% is in <i>session files</i>, where a
1371    file is used to pass all of the options to establish a %p% session.
1372.
1373
1374name hostsFile
1375type s
1376applies x
1377default /usr/local/etc/x3270/ibm_hosts
1378description
1379    The pathname of a file listing the host names that appear on the
1380    <b>File -&gt; Connect</b> menu.
1381    The file can also be used to create hostname aliases and to define a set
1382    of actions to perform when connecting to a host.
1383    <p class="indented">
1384    The format of the file is explained on the <i>ibm_hosts</i> manual page.
1385    The default pathname is actually <b>ibm_hosts</b> in the directory
1386    defined by %-confDir%.
1387.
1388
1389name hostsFile
1390type s
1391applies C S
1392if u
1393default /usr/local/etc/x3270/ibm_hosts
1394else
1395default ibm_hosts
1396endif
1397description
1398    The pathname of a file containing hostname aliases.
1399    The file can also be used to define a set of actions to perform when
1400    connecting to a host.
1401    <p class="indented">
1402    The format of the file is explained on the <i>ibm_hosts</i> manual page.
1403if u
1404    The default pathname is actually <b>ibm_hosts</b> in the directory
1405    defined by %-confDir%.
1406endif
1407.
1408
1409name httpd
1410type s
1411applies C S x
1412switch -httpd
1413description
1414    Defines the TCP port and optional address to listen on for HTTP
1415    connections. (%p% implements a simple REST API and a set of HTML objects
1416    for access by scripts.) The syntax of this resource is
1417    [<i>address</i>:]<i>port</i>, where <i>address</i> is an IPv4 or IPv6
1418    address such as <b>127.0.0.1</b> or <b>0.0.0.0</b>, and <i>port</i> is a
1419    TCP port such as <b>4080</b>. The address can also be specified as <b>*</b>
1420    to indicate <b>0.0.0.0</b>. A numeric IPv6 address must be enclosed in
1421    square brackets, e.g., <b>[1234:5678::3]</b>, to avoid ambiguity between
1422    the colons inside the address and the colon separating the address from the
1423    port. If no address is specified, it defaults to <b>127.0.0.1</b>.
1424.
1425
1426name iconFont
1427type s
1428applies x
1429groups a
1430default nil2
1431description
1432    The font used to paint the text inside the active icon (see %-activeIcon%).
1433    The default of <b>nil2</b> is a one-by-two pixel font that produces a
1434    "greeked" picture of the screen image.
1435.
1436
1437name iconLabelFont
1438type s
1439applies x
1440groups a
1441default 8x13
1442description
1443    When %-activeIcon% and %-labelIcon% are true, this is the
1444    name of the font used to paint the icon label.
1445.
1446
1447name icrnl
1448type b
1449applies a
1450groups n
1451default true
1452description
1453    This setting is used only in NVT mode, and is similar in function to
1454    the <i>stty</i> parameter of the same name.
1455    It controls whether input carriage returns are mapped to newlines.
1456.
1457
1458name idleCommand
1459applies x C S
1460groups i
1461type s
1462description
1463    When %-idleCommand% is defined, it specifies a command to execute after a
1464    period of keyboard inactivity (no AID keys pressed).
1465    The %-idleCommand% can be an arbitrary sequence of %p% actions, but it
1466    should include an action which generates an AID (<b>Enter</b>, <b>Clear</b>,
1467    <b>PF</b> or <b>PA</b>).
1468    %-idleCommandEnabled% must be true in order for the
1469    %-idleCommand% to take effect. (This is so an idle command can be defined,
1470    but needs to be enabled explicitly at some point after login.)
1471    %-idleTimeout% specifies the inactivity interval.
1472.
1473
1474name idleCommandEnabled
1475applies x C S
1476groups i
1477type b
1478default false
1479description
1480    Controls whether %-idleCommand% has effect as soon as a host session
1481    is established.  (This is so an idle command can be defined, but needs to
1482    be explicitly enabled at some point after login.)
1483.
1484
1485name idleTimeout
1486applies x C S
1487groups i
1488type s
1489default ~7m
1490description
1491    The timeout value for %-idleCommand%.
1492    If the value ends in <b>h</b>, it specifies hours; if it ends in
1493    <b>m</b> it specifies minutes; if it ends in <b>s</b> or does not have
1494    an alphanumeric suffix, it specifies seconds.
1495    <p class="indented">
1496    If the value begins with a tilde <b>~</b>, the time will be randomly
1497    varied +/-10% from the value specified.
1498.
1499
1500name inlcr
1501applies a
1502groups n
1503type b
1504default false
1505description
1506    This setting is used only in NVT mode, and is similar in function to
1507    the <i>stty</i> parameter of the same name.
1508    It controls whether input newlines are mapped to carriage returns.
1509.
1510
1511name inputColor
1512applies x
1513groups a
1514type s
1515default green
1516description
1517    This resource defines the color used to display light-pen selectable
1518    text in 3278 (monochrome) emulation mode.
1519    <p class=indented>
1520    Previous versions of %p% implemented something called <i>pseudo-color
1521    mode</i>, where a monochrome (3278) terminal was emulated with various
1522    colors assigned to different kinds of fields.
1523    To emulate pseudo-color mode with the current version of %p%, select 3278
1524    emulation with %-model%, set %-inputColor% to <b>orange</b> and set
1525    %-boldColor% to <b>cyan</b>.
1526    <p class=indented>
1527    If the resource %-modifiedSel% is true, modified fields
1528    are also displayed using %-inputColor%.
1529.
1530
1531name inputMethod
1532applies x
1533type s
1534switch -im
1535description
1536    Specifies the name of the multi-byte input method.  The
1537    default is specified by the XMODIFIERS environment variable, if set, or
1538    will be constructed by Xlib based on the current locale.
1539.
1540
1541name insertMode
1542applies a
1543type b
1544default false
1545description
1546    Controls 3270 insert mode.
1547.
1548
1549name intr
1550applies a
1551groups n
1552type s
1553default ^C
1554description
1555    This setting is used only in NVT mode, and is similar in function to
1556    the <i>stty</i> parameter of the same name.
1557    When this character is typed on the keyboard, the TELNET IP
1558    (Interrupt Process) sequence is sent to the host.
1559.
1560
1561name invertKeypadShift
1562applies x
1563type b
1564default false
1565description
1566    When true, causes the PF1-PF12 and PF13-PF24 keys on the
1567    pop-up keypad to be swapped.  Normally, the low-numbered keys appear;
1568    when Shift, Alt, Ctrl or Meta is pressed, the high-numbered keys appear.
1569    With this resource true, that is reversed.
1570.
1571
1572name keyFile
1573applies u
1574groups s
1575type s
1576switch -keyfile
1577desc
1578    Gives the name of a file containg the private key for the certificate
1579    specified by %-certFile% or %-chainFile%.  The default file type is PEM;
1580    it can be overridden by %-keyFileType%.  If the private key is encrypted,
1581    the password is specified by %-keyPasswd%.
1582    (OpenSSL only)
1583.
1584
1585name keyFileType
1586applies u
1587groups s
1588type s
1589default pem
1590switch -keyfileType
1591desc
1592    Gives the type of the private key file specified by %-keyFile%.
1593    The value can be <b>pem</b> or <b>asn1</b>.
1594    (OpenSSL only)
1595.
1596
1597name keyHeight
1598applies x
1599groups a
1600type i
1601default 24
1602desc
1603    Defines the height of the keys on the pop-up keypad.
1604.
1605
1606name keymap
1607applies x C
1608groups c
1609type s
1610switch -keymap
1611description
1612    The name of the keyboard map to use.
1613    It can be a single keymap name or a comma-separated list of keymaps,
1614    which will be applied in order.
1615    <p class=indented>
1616    Each keymap can optionally be defined in three separate parts: a common
1617    keymap, which is applied at all times, an NVT-mode keymap, which is
1618    applied only in NVT mode, and a 3270-mode keymap, which is only applied
1619    in 3270 mode.
1620    The NVT-mode keymap has the same name as the common keymap, with the
1621    suffix <b>.nvt</b> appended.
1622    The 3270-mode keymap has the suffix <b>.3270</b> appended.
1623    Thus specifying a %-keymap% value of <i>foo</i> implies the use of
1624    three different keymaps (if found): <b>foo</b>, <b>foo.nvt</b> and
1625    <b>foo.3270</b>.
1626if x
1627    <p class=indented>
1628    After that, the string <b>.user</b>
1629    is appended to the keymap name and three more keymaps are searched
1630    for: <b>foo.user</b>, <b>foo.user.nvt</b> and <b>foo.user.3270</b>,
1631    for a total of six.
1632endif
1633    <p class=indented>
1634if x
1635    If no %-keymap% is defined, the environment variables $KEYMAP and
1636    $KEYBD are checked, in that order, for the name.
1637    %-keymap% is only the name; the keymap definition for name
1638    <i>foo</i> is the resource %-keymap.<i>foo</i>%.
1639endif
1640if C
1641    %-keymap% is only the name; the actual keymap for name
1642    <i>foo</i> can be defined either by the resource %-keymap.<i>foo</i>%, or
1643    by a
1644    <i>keymap file</i>.
1645if c
1646    The keymap file is not searched for in any particular
1647    location, nor does it have a special suffix, so %-keymap% can specify the
1648    full pathname of the keymap file.
1649else
1650    Keymap files are located in the wc3270 documents directory
1651    (usually <b>My Documents\wc3270</b>)
1652    and have the suffix <b>.wc3270km</b>.
1653endif
1654endif
1655.
1656
1657name keymap.<i>foo</i>
1658applies x C
1659type s
1660description
1661    The definition of keymap <i>foo</i>.
1662    Please refer to the <i>How To Create a Custom Keymap</i> document for a
1663    full description of the syntax.
1664.
1665
1666name keypad
1667applies x
1668groups a
1669type s
1670default right
1671description.
1672    This controls the position of the pop-up keypad.  It can have one of
1673    five values:
1674    <ul>
1675    <li><b>left</b>, a pop-up window positioned to the left
1676    of the main %p% window</li>
1677    <li><b>right</b>, a pop-up window positioned
1678    to the right of the main x3270 window</li>
1679    <li><b>bottom</b>, a pop-up window positioned below
1680    the main %p% window</li>
1681    <li><b>integral</b>, making the keypad an extension of the
1682    bottom of the main window itself</li>
1683    <li><b>insideRight</b>, placing the keypad
1684    over the upper-right corner of the emulator window, just below the keypad
1685    button on the menu bar</li>
1686    </ul>
1687.
1688
1689name keypad.keyHeight
1690applies x
1691groups a
1692type i
1693default 24
1694description
1695    The height in pixels of all of the buttons on the keypad.
1696.
1697
1698name keyPasswd
1699applies u
1700groups s
1701type s
1702switch -keypasswd
1703desc
1704    On OpenSSL,
1705    gives the password for the private key file specified by %-keyFile%, if it
1706    is encrypted.
1707    The value can take one of two forms. <b>file</b>:<i>filename</i> specifies
1708    that the password is in a file. <b>string</b>:<i>string</i> gives the
1709    password value in the resource itself.
1710    <p class=indented>
1711    On the Mac, this gives the password for the %-certfile% certifiate file.
1712.
1713
1714name keyWidth
1715applies x
1716groups a
1717type i
1718default 48
1719description
1720    The width in pixels of the lower tier of buttons on a horizontal keypad.
1721.
1722
1723name keypad.largeKeyWidth
1724applies x
1725groups a
1726type i
1727default 56
1728description
1729    The width in pixels of the lower tier of buttons on a vertical keypad.
1730.
1731
1732name keypad.paWidth
1733applies x
1734groups a
1735type i
1736default 36
1737description
1738    The width in pixels of PA and cursor keys on the keypad.
1739.
1740
1741name keypad.pfWidth
1742applies x
1743groups a
1744type i
1745default 32
1746description
1747    The width in pixels of PF keys on the keypad.
1748.
1749
1750name keypadBackground
1751applies x
1752groups a
1753type s
1754default grey70
1755description
1756    On color X11 displays, this is the color of the empty area behind the
1757    buttons on the main window and keypad window.  On monochrome X11 displays,
1758    these areas are filled with a 50% grey bitmap.
1759.
1760
1761name keypadOn
1762applies x
1763type b
1764groups a
1765default false
1766description
1767    If true, the keypad will automatically appear when %p% is
1768    started.
1769.
1770
1771name kill
1772applies a
1773groups n
1774type s
1775default ^U
1776description
1777    This setting is used only in NVT mode, and is similar in function to
1778    the <i>stty</i> parameter of the same name.
1779    <p class=indented>
1780    When connected in line-at-a-time mode (when %p% gathers a line of input
1781    before forwarding it to the host), entering this character at the
1782    keyboard causes
1783    the current input line to be erased.
1784    <p class=indented>
1785    When connected in character-at-a-time mode (when %p% sends each
1786    keystroke to the host), this is the ASCII character that is sent to
1787    the host by the <b>DeleteField</b>
1788    action.
1789.
1790
1791name labelIcon
1792applies x
1793groups a
1794type b
1795default false
1796description
1797    When %-activeIcon% is true, the <i>twm</i> window manager will
1798    not put a label on %p%'s icon.
1799    Setting %-labelIcon% to true causes
1800    %p% to supply its own label for the icon.
1801    <p class=indented>
1802    The icon label is drawn using the font specified by %-iconLabelFont%.
1803.
1804
1805name largeKeyWidth
1806applies x
1807groups a
1808type i
1809default 56
1810desc
1811    Defines the width of the "large" keys in the lower section of the pop-up
1812    keypad.
1813.
1814
1815name lightPenPrimary
1816applies wc
1817groups i
1818type b
1819default false
1820description
1821    Controls how a left mouse button works with the Alt key.
1822    When set to the default of false, clicking the left mouse button without a
1823    modifier will move the cursor or highlight an area for copy and paste.
1824    Clicking the left mouse button with Alt pressed will cause a lightpen
1825    select operation at the screen location where the mouse cursor is (it will
1826    not move the 3270 cursor).
1827    <p class=indented>
1828    When set to true, these are reversed. The left mouse button without a
1829    modifier will do a lightpen select; with Alt it will move the cursor or
1830    select for copy and paste.
1831.
1832
1833name lineWrap
1834applies a
1835groups n
1836type b
1837default true
1838switch -set lineWrap
1839switch -clear lineWrap
1840option Options -&gt; Toggles -&gt; Wraparound
1841description
1842    This setting is used only in NVT mode.
1843    When true, %p% will automatically insert a
1844    CR/LF sequence when output reaches the end of a line.  When false,
1845    output will pile up at the end of each line until the host sends a
1846    CR/LF sequence.
1847.
1848
1849name loginMacro
1850applies a
1851type s
1852switch -loginmacro
1853desc
1854    Defines a sequence of commands to run as soon as a host connection is
1855    established.  Usually these would be commands used to navigate through
1856    login screens, such <b>String</b>, <b>Tab</b> and <b>Enter</b>.
1857    <p class=indented>
1858    If a %-hostsFile% is in use and a matching entry is found, the login
1859    macro from that entry will be used in preference to the %-loginMacro%.
1860.
1861
1862name lnext
1863applies a
1864groups n
1865type s
1866default ^V
1867description
1868    This setting is used only in NVT mode, and is similar in function to
1869    the <i>stty</i> parameter of the same name.
1870    <p class=indented>
1871    When connected in line-at-a-time mode (when %p% gathers a line of input
1872    before forwarding it to the host), entering this character at the
1873    keyboard removes any special meaning from the next character entered.
1874.
1875
1876name localCp
1877applies ws
1878type i
1879desc
1880    Forces %p% to use the specified codepage in place of the system ANSI
1881    codepage.  This codepage is used when interpreting keymap files and
1882    when generating trace files.
1883.
1884
1885name lockedCursor
1886applies x
1887groups a
1888type s
1889default X_cursor
1890description
1891    The name of the mouse cursor displayed with %p% is not connected to a
1892    host.
1893.
1894
1895name macros
1896applies x
1897type s
1898description
1899    Defines a set of macros assigned to the <b>Macros</b> menu that appears
1900    when connected to a host.
1901    The syntax is similar to a keymap (an X11 translation
1902    table), except that rather than a keysym name, the left-hand side is a
1903    name that will appear on the menu.  A list of actions can be specified
1904    on the right-hand side.
1905    <p class=indented>
1906    %-macros% defines a set of macros for all hosts.
1907    To specify a set of macros for host <i>foo</i>, use %-macros.<i>foo</i>%.
1908.
1909
1910name macros.<i>foo</i>
1911applies x
1912type s
1913description
1914    Defines a set of macros assigned to the <b>Macros</b> menu that appears
1915    when connected to host <i>foo</i>.
1916    It overrides the contents of %-macros%.
1917    See %-macros% for details on its syntax.
1918.
1919
1920name marginedPaste
1921applies x wc
1922groups i
1923type b
1924default false
1925switch -set marginedPaste
1926switch -clear marginedPaste
1927option Options -&gt; Toggles -&gt; Paste With Left Margin
1928description
1929    When true, %p% will use the current cursor position as a
1930    left margin for pasted data: no pasted data will be input into an area to
1931    the left of the current cursor positon.
1932.
1933
1934name maxRecent
1935applies x
1936groups i
1937type i
1938default 5
1939description
1940    The maximum number of entries in the Connect menu's recent host list.
1941.
1942
1943name menuBar
1944applies x wc
1945groups a
1946type b
1947default true
1948description
1949    If false, the menu bar will not be displayed at the top of
1950    the %p% main window.
1951if x
1952    The three pull-down menus are still available,
1953    however, by pressing Ctrl and each of the mouse buttons.
1954endif
1955.
1956
1957name menuBar
1958applies c
1959groups a
1960type b
1961default true
1962description
1963    If false, the menu bar will not be displayed at the top of
1964    the %p% display, even if the terminal supports a mouse.
1965.
1966
1967name metaEscape
1968applies c
1969type b
1970default true
1971desc
1972    When true, %p% will assume that pressing a key while holding down the
1973    <b>Alt</b> key will cause the terminal to transmit the ASCII ESC character
1974    (0x1b) before the key.  Thus %p% will interpret ESC-x as Alt-x.
1975    <p class=indented>
1976    When false, ESC is treated like any other input character.
1977.
1978
1979name minVersion
1980applies S
1981type s
1982switch -minversion
1983description
1984    Defines a minimum required version for %p%. If the version of %p% is less
1985    than the specified version, it will abort.
1986    <p class=indented>
1987    The format of a version is
1988    <i>major</i><b>.</b><i>minor</i><i><b>type</b></i><i>iteration</i>, for example,
1989    3.4ga5 or 3.5alpha2.
1990    The version can also be under-specified, such as 3.4 or 3, where the
1991    missing parts default to 0.
1992    The value of <i><b>type</b></i> is ignored, so 3.4ga5 and 3.4foo5 are
1993    considered equal.
1994.
1995
1996name model
1997applies a
1998groups c
1999type s
2000default 3279-4-E
2001switch -model
2002option Options -&gt; Screen Size
2003description
2004    The terminal model that %p% is emulating.  The model is in three parts,
2005    separated by dashes; each part is optional.
2006    <ul>
2007	<li>3278 or 3279<br>
2008	    3278 specifies a monochrome (green) 3270 display.
2009if x
2010	    If used on a color
2011	     X11 display, it will cause all fields to be drawn in green.
2012	     3278 is the default for monochrome X11 displays.
2013endif
2014	     <br>
2015	    3279 specifies a color 3270 display.
2016if x
2017	    This is the default for color X11 displays.
2018endif
2019	     </li>
2020	<li>2, 3, 4 or 5</br>
2021	    The model number, which determines the size of the screen.</br>
2022	    Model 2 has 24 rows and 80 columns.</br>
2023	    Model 3 has 32 rows and 80 columns.</br>
2024	    Model 4 has 43 rows and 80 columns.</br>
2025	    Model 5 has 27 rows and 132 columns.</br>
2026	    The default is
2027if C
2028	     the largest model that will fit on the console or terminal
2029	     emulator window where %p% is running.
2030	     Displaying the OIA (status line) requires one more row than
2031	     what is listed above.
2032else
2033	     4.
2034endif
2035	     </li>
2036	<li>E</br>
2037	    An optional suffix which indicates support for the 3270 Extended
2038	     Data Stream (color, extended attributes, Query Reply).  3279
2039	     implies E.</li>
2040	     </ul>
2041.
2042
2043name modifiedSel
2044applies x
2045groups a
2046type b
2047default false
2048description
2049    When true, modified fields are displayed in a different
2050    color than other modifiable fields.
2051    In 3278 mode, this color is the "input" (light pen selectable) color,
2052    defined by %-inputColor%.
2053    In 3279 mode, this is the color whose index is defined by
2054    %-modifiedSelColor%.
2055    When %-modifiedSel% is false,
2056    modified fields are displayed in the same colors as unmodified fields.
2057.
2058
2059name modifiedSelColor
2060applies x
2061groups a
2062type i
2063default 10
2064description
2065    In 3279 mode, when %-modifiedSel% is true,
2066    this is index of the host color used to display modified fields.
2067    The default value of 10 corresponds to "orange".
2068    (See %-colorSchemes% for the host color index definitions.)
2069.
2070
2071name mono
2072applies x c
2073type b
2074default false
2075switch -mono
2076description
2077if x
2078    If true, %p% will operate as if it were running on a
2079    monochrome X11 display.
2080else
2081    If true, %p% will emulate a 3278, and will not use any of the terminal's
2082    color attributes.
2083endif
2084.
2085
2086name monoCase
2087applies a
2088type b
2089default false
2090switch -set monoCase
2091switch -clear monoCase
2092option Options -&gt; Toggles -&gt; Monocase
2093description
2094    When true, causes %p% to run in uppercase-only mode.
2095.
2096
2097name mouse
2098applies c
2099groups i
2100type b
2101default true
2102description
2103    If true, enables %p% to accept mouse-control events on terminals and
2104    emulators that support them.  This allows a left mouse click to move the
2105    cursor.  On terminals like xterm and gnome-terminal, this means that the
2106    usual mouse selection actions must be performed with the Shift key pressed.
2107
2108    If false, mouse-control events will not be enabled.
2109.
2110
2111name newEnviron
2112applies a
2113type b
2114default true
2115description
2116    If true, %p% will respond to the TELNET NEW-ENVIRONMENT option. If false,
2117    it will not.
2118.
2119
2120name noOther
2121applies x
2122groups s
2123type b
2124default false
2125description
2126    If true, the "Other" options are disabled for selecting
2127    fonts and connecting to hosts, limiting users to the options provided on
2128    the menus.
2129.
2130
2131name noPrompt
2132applies C
2133groups s
2134type b
2135default false
2136desc
2137    If true, the interactive <b>%p%&gt;</b> prompt will be
2138    disabled.  In particular, this means that when %p% is not connected to
2139    a host, a keymap or an external script is the only way to start a new
2140    host connection.
2141.
2142
2143name normalCursor
2144applies x
2145type s
2146groups a
2147default top_left_arrow
2148desc
2149    Defines the mouse cursor that %p% uses when it is connected to a host, not
2150    waiting for the host to complete a command, and the keyboard is not
2151    locked.
2152.
2153
2154name nopSeconds
2155applies a
2156type i
2157groups i
2158default 0
2159desc
2160    If nonzero, %p% will send a TELNET NOP to the host every <i>n</i> seconds.
2161    This can be used to keep host sessions running that would otherwise be
2162    terminated due to inactivity.
2163.
2164
2165name normalColor
2166applies x
2167groups a
2168type s
2169default green
2170desc
2171    On color X11 displays in 3278 mode, this is the color of normal-intensity
2172    text.  On monochrome X11 displays, normal text uses the foreground color.
2173.
2174
2175name numericLock
2176applies a
2177groups i
2178type b
2179default false
2180desc
2181    When true, causes %p% to lock the keyboard when non-numeric data
2182    is entered into fields with the Numeric attribute.
2183.
2184
2185name nvtMode
2186applies a
2187groups i
2188type b
2189default false
2190switch -nvt
2191desc
2192    When true, causes %p% to start immediately in NVT mode and allow keyboard
2193    input immediately, instead of waiting for the host to send data or
2194    negotiate 3270 mode. It also causes the default terminal type to be
2195    <b>xterm</b>.
2196    <p class="indented">
2197    NVT mode can also be selected per session by prepending an <b>A:</b> onto
2198    the hostname.
2199.
2200
2201name onlcr
2202applies a
2203groups n
2204type b
2205default true
2206desc
2207    Used only in NVT line-at-a-time mode; similar to the <i>stty</i> parameter
2208    of the same name.
2209    It controls whether output newlines are mapped to CR/LF sequences.
2210.
2211
2212name oerrLock
2213applies a
2214groups i
2215type b
2216default true
2217desc
2218    If true, operator errors (typing into protected fields,
2219    insert overflow, etc.) will cause the keyboard to lock with an error
2220    message in the OIA (status line).  If false, these
2221    errors will simply cause the terminal bell will ring, without any
2222    keyboard lock or message.
2223.
2224
2225name once
2226applies x C S t
2227type b
2228default false
2229switch -once
2230desc
2231    When true, %p% will exit as soon as a host disconnects.
2232    The default is <b>false</b> if no hostname is specified on the command
2233if x C
2234    line or in a session file,
2235else
2236    line,
2237endif
2238    <b>true</b> otherwise.
2239.
2240
2241name overlayPaste
2242applies wc x
2243groups i
2244type b
2245default false
2246switch -set overlayPaste
2247switch -clear overlayPaste
2248option Options -&gt; Toggles -&gt; Overlay Paste
2249desc
2250    When true, the <b>Paste</b> action will overlay protected fields,
2251    instead of locking the keyboard and stopping. This means that when the
2252    cursor is on a protected field, a displayable character read from the paste
2253    buffer will simply cause the cursor to advance to the right; the actual
2254    character is ignored. This allows regions of the screen that include
2255    protected fields to be copied and pasted back into a formatted screens that
2256    include the same protected fields (i.e., a form).
2257    <p class="indented">
2258    Note: Setting overlayPaste to <b>true</b> will cause %p% to act as if the
2259    %-marginedPaste% toggle were also set.
2260.
2261
2262name oversize
2263applies a
2264type s
2265switch -oversize
2266desc
2267    Sets the screen dimensions to be larger than the default for the
2268    chosen model.  Its value is a string in the format
2269    <b><i>cols</i>x<i>rows</i></b>.
2270if C
2271    It can also be the string <b>auto</b>, which will cause %p% to use the
2272    entire screen area of the
2273endif
2274if c
2275    terminal.
2276endif
2277if wc
2278    console window it is running in.
2279endif
2280    It is used only if the %-model% includes the "-E" (extended
2281    data stream) suffix, and only if the specified dimensions are larger than
2282    the model number defaults.  Also, only hosts that support the Query Reply
2283    structured field will function properly with %p% in this mode.
2284.
2285
2286name paWidth
2287applies x
2288groups a
2289type i
2290default 36
2291desc
2292    Defines the width of the PA keys in the lower section of the pop-up
2293    keypad.
2294.
2295
2296name pfWidth
2297applies x
2298groups a
2299type i
2300default 32
2301desc
2302    Defines the width of the PF keys on the pop-up keypad.
2303.
2304
2305name port
2306applies a
2307groups c
2308type s
2309default telnet
2310switch -port
2311desc
2312    The name of the default TCP port for %p% to connect to.  This can be
2313    either a symbolic name from /etc/services, or an integer.
2314.
2315
2316name proxy
2317applies a
2318groups c
2319type s
2320switch -proxy
2321desc
2322    Defines a proxy server that %p% will use to connect to hosts.
2323    The value is of the form
2324    <b><i>type</i>:[<i>username</i>:<i>password</i>@]<i>server</i></b>[<b>:<i>port</i></b>],
2325    where options for <i>type</i> are described on the %p% manual page.
2326.
2327
2328name preeditType
2329applies x
2330type s
2331default OverTheSpot+1
2332switch -pt
2333desc
2334    The preedit type for the multi-byte input method.  Valid values are
2335    <b>OverTheSpot</b>, <b>OffTheSpot</b>, <b>Root</b> and
2336    <b>OnTheSpot</b>.  The value for
2337    <b>OverTheSpot</b> can include an optional suffix, a signed number
2338    indicating the vertical distance in rows of the preedit window from the
2339    cursor position, e.g. <b>OverTheSpot+1</b> or <b>OverTheSpot-2</b>.
2340.
2341
2342name printerLu
2343type s
2344applies x C
2345groups c
2346switch -printerlu
2347desc
2348    If a value is set, %p% will automatically start a
2349if u
2350    pr3287
2351else
2352    wpr3287
2353endif
2354    printer session
2355    when a host connection is established.
2356    If the value is "<b>.</b>", the
2357if u
2358    pr3287
2359else
2360    wpr3287
2361endif
2362    session will
2363    be associated with the interactive terminal session (this requires that
2364    the host supports TN3270E).  Otherwise, the value is taken as the LU
2365    name to associate with the printer session.
2366.
2367
2368name printer.assocCommandLine
2369applies x C
2370type s
2371if x c
2372default pr3287 -assoc %L% -command %C% %R% %P% %V% %S% %O% %H%
2373else
2374default wpr3287.exe -assoc %L% -command %R% %P% %V% %S% %I% %O% %H%
2375endif
2376desc
2377    <i><b>Note:</b> This resource is for debug purposes only. To add optional
2378    parameters to the wc3270 command line, use %-printer.options.%</i>
2379    <p class="indented">
2380    The shell command to use to start a printer session, when associated with
2381    the current TN3270E session LU (when %-printerLU% is "<b>.</b>").
2382    Within the string, the following substitutions
2383    are made:
2384    <ul>
2385if x c
2386	<li><b>%C%</b> is replaced with the %-printer.command%</li>
2387endif
2388	<li><b>%H%</b> is replaced with the current host name</li>
2389if wc
2390	<li><b>%I%</b> is replaced with an option to pass %-printer.codepage%</li>
2391endif
2392	<li><b>%L%</b> is replaced with the current session's LU</li>
2393	<li><b>%O%</b> is replaced with the value of %-printer.options%</li>
2394	<li><b>%P%</b> is replaced with the current session's proxy option (%-proxy%)</li>
2395	<li><b>%R%</b> is replaced with an option to pass the current character set</li>
2396	<li><b>%S%</b> is replaced with an option to pass the port of the sync socket</li>
2397	<li><b>%V%</b> is replaced with SSL-related options</li>
2398    </ul>
2399.
2400
2401name printer.codepage
2402applies wc
2403type i
2404desc
2405    The codepage used by the printer associated with wpr3287 printer sessions.
2406    The default is to use the system's ANSI codepage.
2407.
2408
2409name printer.command
2410applies x c
2411type s
2412default lpr
2413desc
2414    The name of the command supplied to the "-command" option of the pr3287
2415    program to print each job.  This is the text which is substituted for
2416    <b>%C</b> in %-printer.assocCommandLine% and %-printer.luCommandLine%
2417    resources.
2418.
2419
2420name printer.luCommandLine
2421applies x C
2422type s
2423if x c
2424default pr3287 -command %C% %R% %P% %V% %S% %O% %L%@%H%
2425else
2426default wpr3287.exe %R% %P% %V% %S% %I% %O% %L%@%H%
2427endif
2428desc
2429    <i><b>Note:</b> This resource is for debug purposes only. To add optional
2430    parameters to the wc3270 command line, use %-printer.options.%</i>
2431    <p class="indented">
2432    The shell command to use to start a printer session, when associated with a
2433    specific LU.  Within the string, the following substitutions are made:
2434    <ul>
2435if x c
2436	<li><b>%C%</b> is replaced with %-printer.command%</li>
2437endif
2438	<li><b>%H%</b> is replaced with the current host name</li>
2439if wc
2440	<li><b>%I%</b> is replaced with an option to pass %-printer.codepage%</li>
2441endif
2442	<li><b>%L%</b> is replaced with the LU value entered into the dialog box</li>
2443	<li><b>%O%</b> is replaced with the value of %-printer.options%</li>
2444	<li><b>%P%</b> is replaced with current session's proxy option (%-proxy%)</li>
2445	<li><b>%R%</b> is replaced with an option to pass the current character set</li>
2446	<li><b>%S%</b> is replaced with an option to pass the port of the sync socket</li>
2447	<li><b>%V%</b> is replaced with SSL-related options</li>
2448    </ul>
2449.
2450
2451name printer.name
2452applies wc
2453type s
2454desc
2455    Defines the name of the printer used for wpr3287 sessions and by the
2456    <b>PrintText</b> action.  The default is to use the system's default
2457    printer.
2458.
2459
2460name printer.options
2461applies x C
2462type s
2463desc
2464    Defines extra parameters to substutute for the <b>%O%</b> token in the
2465    printer command line.
2466.
2467
2468name printTextCommand
2469applies x c
2470type s
2471default lpr
2472desc
2473    The shell command used by the <b>PrintText</b> action.  An ASCII image of
2474    the 3270 display becomes the standard input to this command.
2475if x
2476    If the first
2477    character of the command is '@', the usual pop-up windows before and after
2478    the text is printed will not appear.
2479endif
2480.
2481
2482name printTextFont
2483applies wc
2484type s
2485default Courier New
2486desc
2487    The font used by the <b>PrintText</b> action.
2488.
2489
2490name printTextHorizontalMargin
2491applies wc
2492type i
2493default 0.5
2494desc
2495    The left- and right-hand margins used by the <b>PrintText</b> action when
2496    printing.
2497    The value is in inches by default, but can be
2498    suffixed with <b>mm</b> or <b>cm</b> to specify SI units.
2499.
2500
2501name printTextOrientation
2502applies wc
2503type i
2504desc
2505    The page orientation used by the <b>PrintText</b> action when
2506    printing.
2507    The value is either <b>portrait</b> or </b>landscape</b>. The default is
2508    to use whatever the printer's default is.
2509.
2510
2511name printTextScreensPerPage
2512applies wc c x
2513type i
2514default 1
2515desc
2516    The number of screens to display on a page when tracing screens to the
2517    printer.
2518.
2519
2520name printTextSize
2521applies wc
2522type i
2523default auto
2524desc
2525    The font size used by the <b>PrintText</b> action.
2526    The default is to select the largest font that
2527    will fit across the page.
2528.
2529
2530name printTextVerticalMargin
2531applies wc
2532type i
2533default 0.5
2534desc
2535    The top and bottom margins used by the <b>PrintText</b> action when
2536    printing.
2537    The value is in inches by default, but can be
2538    suffixed with <b>mm</b> or <b>cm</b> to specify SI units.
2539.
2540
2541name printWindowCommand
2542applies x
2543type s
2544default xwd -id %d | xpr | lpr
2545desc
2546    The shell command used by the <b>PrintWindow</b> action.
2547    The X11 window identifier of the main x3270 window is substituted for
2548    any <b>%d</b> in the command.
2549    If the first character of the command is '<b>@</b>', the usual pop-up
2550    windows before and after the window is printed will not appear.
2551.
2552
2553name qrBgColor
2554applies C s b
2555type b
2556default false
2557desc
2558    When true, %p% will report in the QueryReply(color) that it supports
2559    background color; when false, it will not.  It is disabled by default
2560    because certain versions of GDDM are confused by this report and will
2561    crash.
2562.
2563
2564name quit
2565applies a
2566groups n
2567type s
2568default ^\
2569desc
2570    This setting is used only in NVT mode, and is similar in function to
2571    the <i>stty</i> parameter of the same name.
2572    When connected in line-at-a-time mode (when %p%
2573    gathers a line of input before forwarding it to the host),
2574    entering this character at the keyboard causes the
2575    TELNET BREAK sequence to be sent to the host.
2576.
2577
2578name reconnect
2579applies x C
2580type b
2581default false
2582desc
2583    When true, %p% will automatically reconnect to a host after it disconnects.
2584.
2585
2586name rectangleSelect
2587applies x
2588groups i
2589type b
2590default false
2591switch -set rectangleSelect
2592switch -clear rectangleSelect
2593option Options -&gt; Toggles -&gt; Select by Rectangles
2594desc
2595    When true, %p% will always select rectangular areas of the
2596    screen.  When false, %p% will select rectangular areas in 3270
2597    mode, but in NVT mode it will select continuous areas of the screen like
2598    <i>xterm</i>.
2599.
2600
2601name reverseInputMode
2602applies a
2603type b
2604default false
2605desc
2606    When true in 3270 mode, input fields fill in the opposite direction of the
2607    screen display.
2608.
2609
2610name reverseVideo
2611applies c
2612type b
2613groups a
2614default false
2615option -rv
2616desc
2617    When true, %p% will use a white background instead of a black one.
2618.
2619
2620name rightToLeftMode
2621applies x C
2622type b
2623default false
2624desc
2625    When true, the %p% display will be in right-to-left mode, with column 1
2626    on the right instead of on the left.
2627.
2628
2629name rprnt
2630applies a
2631groups n
2632type s
2633default ^R
2634desc
2635    This setting is used only in NVT mode, and is similar in function to
2636    the <i>stty</i> parameter of the same name.
2637    When connected in line-at-a-time mode (when %p%
2638    gathers a line of input before forwarding it to the host), entering this
2639    character at the keyboard causes the current input line to be redisplayed.
2640.
2641
2642name saveLines
2643applies x C
2644type i
2645default 4096
2646switch -sl
2647desc
2648    The number of display lines to save for the scroll bar. Note that the
2649    scroll bar operates on full screens of data, so the value divided by the
2650    number of rows on the screen gives you the number of screens that will be
2651    saved.
2652.
2653
2654name sbcsCgcsgid
2655applies a
2656groups p
2657type s
2658desc
2659    Overrides the compiled-in value of the CGCSGID for the current host
2660    character set.  The value is an integer, which can be prefixed with '0x'
2661    to be in hexadecimal.  The upper 16 bits are the GCSGID (character
2662    set) and the lower 16 bits are the CPGID (code page).  This value
2663    applies only to the single-byte (SBCS) character set.  Use
2664    %-dbcsCgcsgid% for the double-byte (DBCS) character set.
2665.
2666
2667name schemeList
2668applies x
2669type s
2670desc
2671    Lists the options on the Color Scheme menu.  Can contain '>' characters to
2672    indicate a menu hierarchy. The format of the list is one entry per line,
2673    each line containing the menu label, a colon and the name of the color
2674    scheme.
2675.
2676
2677name screenTrace
2678applies a
2679groups t
2680type b
2681default false
2682switch -set screenTrace
2683switch -clear screenTrace
2684option File -&gt; Save Screen(s) in File
2685desc
2686    When true, %p% will save an ASCII version of the screen image in
2687    a file every time it changes.
2688    The file name defaults to
2689if u
2690    <b>x3scr.<i>pid</i></b>.
2691else
2692    <b>x3scr.<i>pid</i>.txt</b>.
2693endif
2694    The directory where the file is written is defined by %-traceDir%.
2695    If %-screenTraceFile% is defined, it defines the
2696    file name and %-traceDir% is ignored.
2697if w
2698    file name.
2699endif
2700.
2701
2702name screenTraceFile
2703applies a
2704groups t
2705type s
2706desc
2707    If defined, gives the name of the file that screen traces will be
2708    written into.
2709.
2710
2711name scripted
2712applies x
2713type b
2714default false
2715switch -script
2716desc
2717    When true, %p% will read commands from standard input.  The rules
2718    for these commands are documented in the <i>x3270-script</i> manual page.
2719.
2720
2721name scriptPort
2722applies a
2723type i
2724switch -scriptport
2725desc
2726    If defined, %p% will accept script connections on the specified local TCP
2727    port.
2728    The rules for the commands passed over these connections are documented
2729    in the <i>x3270-script</i> manual page.
2730    The syntax of this resource is [<i>address</i>:]<i>port</i>, where
2731    <i>address</i> is an IPv4 or IPv6 address such as <b>127.0.0.1</b> or
2732    <b>0.0.0.0</b>, and <i>port</i> is a TCP port such as <b>4081</b>. The
2733    address can also be specified as <b>*</b> to indicate <b>0.0.0.0</b>. A
2734    numeric IPv6 address must be enclosed in square brackets, e.g.,
2735    <b>[1234:5678::3]</b>, to avoid ambiguity between the colons inside the
2736    address and the colon separating the address from the port. If no address
2737    is specified, it defaults to <b>127.0.0.1</b>.
2738.
2739
2740name scriptPortOnce
2741applies a
2742type b
2743default false
2744switch -scriptportonce
2745desc
2746    If defined, %p% will accept only one script connection. When that
2747    connection is broken, it will exit.
2748.
2749
2750name scrollBar
2751applies x
2752type b
2753default false
2754switch -sb
2755switch +sb
2756switch -set scrollBar
2757switch -clear scrollBar
2758desc
2759    When true, %p% will display a scroll bar to the right of the emulator
2760    window.
2761.
2762
2763name secure
2764applies x
2765groups s
2766type b
2767default false
2768desc
2769    When true, %p% will prevent users from executing arbitrary
2770    commands from within the program.
2771    In particular, the <b>File -&gt; x3270&gt; Prompt</b> menu option is
2772    disabled, as are the pop-ups which allow editing the commands
2773    for <b>File -&gt; Print Screen Text</b> and
2774    <b>File -&gt; Print Window Bitmap</b>, and
2775    %-disconnectClear% is true.
2776    See %-noOther% and %-suppressActions% for additional security options.
2777.
2778
2779name selectBackground
2780applies x
2781groups a
2782type s
2783default dimGrey
2784desc
2785    On color X11 displays, this is the background color used for selected text
2786    (text highlighted with the mouse for cut and paste).  On monochrome
2787    X11 displays, selected text is in reverse video.
2788.
2789
2790name showTiming
2791applies x
2792groups a
2793type b
2794default false
2795switch -set showTiming
2796switch -clear showTiming
2797option Options -&gt; Toggles -&gt; Show Timing
2798desc
2799    When true, %p% will display on the OIA (status line) the time
2800    that the host takes to unlock the keyboard after an AID is sent.
2801.
2802
2803name socket
2804applies u
2805type b
2806default false
2807switch -socket
2808desc
2809    When true, %p% will create a Unix-domain socket than can be used
2810    by an external script to control the session.  The name of the socket is
2811    <b>/tmp/x3sck.<i>pid</i></b>.  The <b>-p</b> option of the
2812    <i>x3270if</i> command can be used to connect to this socket.
2813.
2814
2815name startTls
2816applies a
2817type b
2818groups s
2819default true
2820description
2821    If true, %p% will accept the TELNET STARTTLS negotiation from the host. If
2822    false, it will
2823    reject them.
2824.
2825
2826name *suppress
2827applies x
2828groups s
2829type b
2830desc
2831    When true, suppresses a menu item.  For example, setting
2832    <b>x3270*aboutConfig.suppress</b> to true will remove
2833    the <b>Configuration</b> option from the <b>About</b> menu.
2834    The names of the menu items are:<br>
2835&nbsp;&nbsp;&nbsp;aboutMenu.aboutConfig.suppress<br>
2836&nbsp;&nbsp;&nbsp;aboutMenu.aboutCopyright.suppress<br>
2837&nbsp;&nbsp;&nbsp;aboutMenu.aboutStatus.suppress<br>
2838&nbsp;&nbsp;&nbsp;fileMenu.abortScriptOption.suppress<br>
2839&nbsp;&nbsp;&nbsp;fileMenu.aboutOption.suppress<br>
2840&nbsp;&nbsp;&nbsp;fileMenu.disconnectOption.suppress<br>
2841&nbsp;&nbsp;&nbsp;fileMenu.exitOption.suppress<br>
2842&nbsp;&nbsp;&nbsp;fileMenu.ftOption.suppress<br>
2843&nbsp;&nbsp;&nbsp;fileMenu.printerOption.suppress<br>
2844&nbsp;&nbsp;&nbsp;fileMenu.printWindowOption.suppress<br>
2845&nbsp;&nbsp;&nbsp;fileMenu.promptOption.suppress<br>
2846&nbsp;&nbsp;&nbsp;fileMenu.saveOption.suppress<br>
2847&nbsp;&nbsp;&nbsp;fileMenu.screenTraceOption.suppress<br>
2848&nbsp;&nbsp;&nbsp;fileMenu.traceOption.suppress<br>
2849&nbsp;&nbsp;&nbsp;modelsMenu.model2Option.suppress<br>
2850&nbsp;&nbsp;&nbsp;modelsMenu.model3Option.suppress<br>
2851&nbsp;&nbsp;&nbsp;modelsMenu.model4Option.suppress<br>
2852&nbsp;&nbsp;&nbsp;modelsMenu.model5Option.suppress<br>
2853&nbsp;&nbsp;&nbsp;modelsMenu.oversizeOption.suppress<br>
2854&nbsp;&nbsp;&nbsp;optionsMenu.codepageOption.suppress<br>
2855&nbsp;&nbsp;&nbsp;optionsMenu.colorsOption.suppress<br>
2856&nbsp;&nbsp;&nbsp;optionsMenu.fontsOption.suppress<br>
2857&nbsp;&nbsp;&nbsp;optionsMenu.idleCommandOption.suppress<br>
2858&nbsp;&nbsp;&nbsp;optionsMenu.keymapDisplayOption.suppress<br>
2859&nbsp;&nbsp;&nbsp;optionsMenu.keymapOption.suppress<br>
2860&nbsp;&nbsp;&nbsp;optionsMenu.modelsOption.suppress<br>
2861&nbsp;&nbsp;&nbsp;optionsMenu.togglesOption.suppress<br>
2862&nbsp;&nbsp;&nbsp;printerMenu.assocButton.suppress<br>
2863&nbsp;&nbsp;&nbsp;printerMenu.luButton.suppress<br>
2864&nbsp;&nbsp;&nbsp;printerMenu.printerOffButton.suppress<br>
2865&nbsp;&nbsp;&nbsp;togglesMenu.blankFillOption.suppress<br>
2866&nbsp;&nbsp;&nbsp;togglesMenu.blockCursorOption.suppress<br>
2867&nbsp;&nbsp;&nbsp;togglesMenu.characterModeOption.suppress<br>
2868&nbsp;&nbsp;&nbsp;togglesMenu.crosshairOption.suppress<br>
2869&nbsp;&nbsp;&nbsp;togglesMenu.cursorBlinkOption.suppress<br>
2870&nbsp;&nbsp;&nbsp;togglesMenu.extendedDsOption.suppress<br>
2871&nbsp;&nbsp;&nbsp;togglesMenu.lineModeOption.suppress<br>
2872&nbsp;&nbsp;&nbsp;togglesMenu.lineWrapOption.suppress<br>
2873&nbsp;&nbsp;&nbsp;togglesMenu.m3278Option.suppress<br>
2874&nbsp;&nbsp;&nbsp;togglesMenu.m3279Option.suppress<br>
2875&nbsp;&nbsp;&nbsp;togglesMenu.marginedPasteOption.suppress<br>
2876&nbsp;&nbsp;&nbsp;togglesMenu.monocaseOption.suppress<br>
2877&nbsp;&nbsp;&nbsp;togglesMenu.overlayPasteOption.suppress<br>
2878&nbsp;&nbsp;&nbsp;togglesMenu.rectangleSelectOption.suppress<br>
2879&nbsp;&nbsp;&nbsp;togglesMenu.scrollBarOption.suppress<br>
2880&nbsp;&nbsp;&nbsp;togglesMenu.showTimingOption.suppress<br>
2881&nbsp;&nbsp;&nbsp;togglesMenu.underlineCursorOption.suppress<br>
2882&nbsp;&nbsp;&nbsp;togglesMenu.visibleControlOption.suppress
2883.
2884
2885name suppressActions
2886applies a
2887groups s
2888type s
2889desc
2890    A list of whitespace-separated action names, with or without parentheses,
2891    which are to be ignored.  The actions will be completely inaccessible,
2892    whether by keymaps, scripts, macros or at the prompt.
2893    This resource is intended to be used as a security precaution for users
2894    who can define their own keymaps, but who do not have access to resource
2895    definitions or command-line options.
2896.
2897
2898name suppressFontMenu
2899applies x
2900type b
2901default false
2902desc
2903    If true, the <b>Options -&gt; Font</b> menu will not be displayed.
2904.
2905
2906name suppressHost
2907applies x
2908type b
2909default false
2910desc
2911    If true, %p% will omit the hostname from the
2912    <b>File -&gt; About %p% -&gt; Connection Status</b> pop-up.
2913.
2914
2915name termName
2916applies a
2917groups p
2918type s
2919switch -tn
2920desc
2921    An alternate name to be sent in response to the host's TELNET DO OPTION
2922    TERMINAL-NAME request.  The default is <b>IBM-</b>, followed by the
2923    value of %-model%.
2924.
2925
2926name title
2927applies x wc
2928groups a
2929type s
2930switch -title
2931desc
2932    Sets the title for the %p% window, overriding the default of constructing
2933    the name from the host that is connected to.
2934.
2935
2936name trace
2937applies a
2938groups t
2939type b
2940default false
2941switch -trace
2942switch -set trace
2943switch -clear trace
2944option File -&gt; Trace Data and Events
2945description
2946    When true, %p% writes information about events and actions, as well as a
2947    hexadecimal representation of all network traffic (and its interpretation)
2948    into a file, which defaults to
2949if u
2950    <b>x3trc.<i>pid</i></b>.
2951else
2952    <b>x3trc.<i>process-id</i>.txt</b>.
2953endif
2954if x wc
2955    It also pops up a window to watch the file as it
2956    is created, with the pathname of the file as the window title.
2957endif
2958if x
2959    The command run in the window is defined by %-traceCommand%.
2960endif
2961    The directory where the file is written is defined by %-traceDir%.
2962    If %-traceFile% is defined, it gives the entire pathname
2963    and %-traceDir% is ignored.
2964.
2965
2966name traceCommand
2967applies x
2968type s
2969default tail -f
2970desc
2971    Defines the command that runs in the trace window.
2972.
2973
2974name traceDir
2975applies a
2976groups t
2977type s
2978if u
2979default /tmp
2980endif
2981if wc
2982default current user's Desktop
2983endif
2984if ws
2985default current directory
2986endif
2987desc
2988    Defines the directory that trace files are written into.
2989.
2990
2991name traceFile
2992applies a
2993groups t
2994type s
2995switch -tracefile
2996desc
2997    If defined, gives the name of the file that data stream and event traces
2998    will be written into.
2999    If it begins with ">>", data will be appended to the file.
3000if x
3001    If given the value <b>stdout</b>, traces will
3002    be written to standard output.  If given the value <b>none</b>, then the
3003    traces will be piped directory to the monitor window, and no file will
3004    be created.
3005endif
3006.
3007
3008name traceFileSize
3009applies a
3010groups t
3011type s
3012switch -tracefilesize
3013desc
3014    If defined, gives a limit on the size of the file that data stream and
3015    event traces will be written into.  If not defined, or defined as <b>0</b>,
3016    there
3017    will be no limit on the size of the file.  The value is a number, followed
3018    by an optional suffix.  If the suffix is <b>K</b> (e.g., 128K),
3019    the value will be multiplied by 1024.
3020    If the suffix is <b>M</b>, the value will be multiplied
3021    by (1024*1024).  The size limit enforced at operation boundaries, not per
3022    byte, so the actual file may grow slightly larger.  When the file size
3023    exceeds the limit, the trace file will be renamed with a "-" appended and
3024    a new file started.
3025.
3026
3027name traceMonitor
3028applies x wc
3029groups t
3030type b
3031default true
3032desc
3033    When true, %p% will create a window to monitor data stream and
3034    event traces.
3035    When false, no monitor window will be
3036if x
3037    created (and the value of <b>none</b> for %-traceFile% will be
3038    considered invalid).
3039else
3040    created.
3041endif
3042.
3043
3044name typeahead
3045applies C x b
3046type b
3047default true
3048switch -set typeahead
3049switch -clear typeahead
3050desc
3051    When true, %p% will store keystrokes in a buffer when the
3052    keyboard is locked.  When false, these keystrokes will be dropped.
3053.
3054
3055name underscore
3056applies C
3057groups a
3058type b
3059if c
3060default false
3061else
3062default true
3063endif
3064switch -set underscore
3065switch -clear underscore
3066desc
3067    When true, %p% will display fields with the <i>underlined</i>
3068    attribute in a special way: blank characters will be translated to
3069    underscore (<b>_</b>) characters.  This is needed
3070if c
3071    on terminals that
3072else
3073    to overcome the fact that Windows consoles
3074endif
3075    are unable to display real underlined text.
3076.
3077
3078name unlockDelay
3079applies x c wc
3080type b
3081default true
3082desc
3083    When %p% sends the host an AID (the <b>Enter</b>, <b>Clear</b>, <b>PF</b>
3084    or <b>PA</b>
3085    actions), it locks the keyboard until the host sends a reply to
3086    unlock it.  Some hosts unlock the keyboard before they are actually
3087    finished processing the command, which can cause scripts to malfunction
3088    subtly.  To avoid this, %p% implements a hack to briefly delay actually
3089    unlocking the keyboard.
3090    When %-unlockDelay% is true (the default), the keyboard unlock
3091    will be delayed for %-unlockDelayMs% milliseconds.  Setting it to
3092    false removes this delay.
3093.
3094
3095name unlockDelay
3096applies s ws b
3097type b
3098default false
3099desc
3100    When %p% sends the host an AID (the <b>Enter</b>, <b>Clear</b>, <b>PF</b>
3101    or <b>PA</b>
3102    actions), it locks the keyboard until the host sends a reply to
3103    unlock it.  Some hosts unlock the keyboard before they are actually
3104    finished processing the command, which can cause scripts to malfunction
3105    subtly.  To avoid this, %p% can implement a hack to briefly delay actually
3106    unlocking the keyboard.
3107    When set to false (the default), there is no delay.
3108    When set to true, the keyboard unlock will be delayed for %-unlockDelayMs%
3109    milliseconds.
3110.
3111
3112name unlockDelayMs
3113applies a
3114type i
3115default 350
3116desc
3117    Overrides the default value for the unlock delay (the delay between the
3118    host unlocking the keyboard and %p% actually performing the unlock).
3119    The value is in milliseconds; use 0 to turn off the delay completely,
3120    including for macros.
3121.
3122
3123name useCursorColor
3124applies x
3125groups a
3126type b
3127default false
3128desc
3129    If false, the cursor will be drawn using the same color as
3130    the text behind it.  If true, on color X11 displays the
3131    cursor will be drawn with the color specified by %-cursorColor%.
3132.
3133
3134name user
3135applies a
3136type s
3137switch -user
3138groups p
3139description
3140    Specifies the user name sent in response to a TELNET NEW-ENVIRON
3141    sub-negotiation request, used by iSeries hosts (RFC 4777).
3142.
3143
3144name utf8
3145applies S
3146type b
3147switch -utf8
3148description
3149    Forces local I/O to use UTF-8 encoding, regardless of the local codepage.
3150.
3151
3152name verifyHostCert
3153applies a
3154type b
3155groups s
3156switch -noverifycert
3157switch -verifycert
3158default true
3159description
3160    If true (the default), %p% will verify SSL/TLS host certificates, and not
3161    allow an SSL/TLS connection to complete unless the host certificate can be
3162    validated.
3163    If false, %p% will not verify SSL/TLS host certificates.
3164    <p class="indented">
3165    This resource is overridden by a <b>y:</b> prepended to the hostname when
3166    connecting, which disables certificate checking.
3167.
3168
3169name visibleControl
3170applies x C
3171type b
3172default false
3173switch -set visibleControl
3174switch -clear visibleControl
3175option Options -&gt; Toggles -&gt; Visible Control Characters
3176desc
3177    If true, certain control characters, which are normally displayed as
3178    blanks, are displayed on the screen.
3179    <p class="indented">
3180    EBCDIC control characters,
3181if x c
3182    displayed with underlines,
3183endif
3184    are as follows:
3185    <table cols=3 width="75%">
3186    <tr> <th>Character</th>
3187         <th>Meaning</th>
3188    </tr>
3189    <tr> <td>.</td> <td>NUL (X'00')</td> </tr>
3190    <tr> <td>&lt;</td> <td>The SO character (begins a DBCS subfield)</td> </tr>
3191    <tr> <td>&gt;</td> <td>The SI character (ends a DBCS subfield)</td> </tr>
3192    <table>
3193    <p>
3194    3270 field attributes,
3195if x c
3196    displayed in yellow with underlines,
3197endif
3198if wc
3199    displayed in reverse-video yellow,
3200endif
3201    are decoded as follows:
3202    <table cols=6 width="75%">
3203    <tr> <th>Character</th>
3204         <th>Protected</th>
3205         <th>Numeric</th>
3206         <th>Display</th>
3207         <th>Selectable</th>
3208         <th>Modified</th>
3209    </tr>
3210    <tr> <td>0</td> <td>-</td> <td>-</td> <td>normal</td> <td>-</td> <td>-</td> </tr>
3211    <tr> <td>1</td> <td>-</td> <td>-</td> <td>normal</td> <td>-</td> <td>modified</td> </tr>
3212    <tr> <td>2</td> <td>-</td> <td>-</td> <td>normal</td> <td>selectable</td> <td>-</td> </tr>
3213    <tr> <td>3</td> <td>-</td> <td>-</td> <td>normal</td> <td>selectable</td> <td>modified</td> </tr>
3214    <tr> <td>4</td> <td>-</td> <td>-</td> <td>intensified</td> <td>selectable</td> <td>-</td> </tr>
3215    <tr> <td>5</td> <td>-</td> <td>-</td> <td>intensified</td> <td>selectable</td> <td>modified</td> </tr>
3216    <tr> <td>6</td> <td>-</td> <td>-</td> <td>nondisplay</td> <td>-</td> <td>-</td> </tr>
3217    <tr> <td>7</td> <td>-</td> <td>-</td> <td>nondisplay</td> <td>-</td> <td>modified</td> </tr>
3218    <tr> <td>8</td> <td>-</td> <td>numeric</td> <td>normal</td> <td>-</td> <td>-</td> </tr>
3219    <tr> <td>9</td> <td>-</td> <td>numeric</td> <td>normal</td> <td>-</td> <td>modified</td> </tr>
3220    <tr> <td>A</td> <td>-</td> <td>numeric</td> <td>normal</td> <td>selectable</td> <td>-</td> </tr>
3221    <tr> <td>B</td> <td>-</td> <td>numeric</td> <td>normal</td> <td>selectable</td> <td>modified</td> </tr>
3222    <tr> <td>C</td> <td>-</td> <td>numeric</td> <td>intensified</td> <td>selectable</td> <td>-</td> </tr>
3223    <tr> <td>D</td> <td>-</td> <td>numeric</td> <td>intensified</td> <td>selectable</td> <td>modified</td> </tr>
3224    <tr> <td>E</td> <td>-</td> <td>numeric</td> <td>nondisplay</td> <td>-</td> <td>-</td> </tr>
3225    <tr> <td>F</td> <td>-</td> <td>numeric</td> <td>nondisplay</td> <td>-</td> <td>modified</td> </tr>
3226    <tr> <td>G</td> <td>protected</td> <td>-</td> <td>normal</td> <td>-</td> <td>-</td> </tr>
3227    <tr> <td>H</td> <td>protected</td> <td>-</td> <td>normal</td> <td>-</td> <td>modified</td> </tr>
3228    <tr> <td>I</td> <td>protected</td> <td>-</td> <td>normal</td> <td>selectable</td> <td>-</td> </tr>
3229    <tr> <td>J</td> <td>protected</td> <td>-</td> <td>normal</td> <td>selectable</td> <td>modified</td> </tr>
3230    <tr> <td>K</td> <td>protected</td> <td>-</td> <td>intensified</td> <td>selectable</td> <td>-</td> </tr>
3231    <tr> <td>L</td> <td>protected</td> <td>-</td> <td>intensified</td> <td>selectable</td> <td>modified</td> </tr>
3232    <tr> <td>M</td> <td>protected</td> <td>-</td> <td>nondisplay</td> <td>-</td> <td>-</td> </tr>
3233    <tr> <td>N</td> <td>protected</td> <td>-</td> <td>nondisplay</td> <td>-</td> <td>modified</td> </tr>
3234    <tr> <td>O</td> <td>protected</td> <td>numeric</td> <td>normal</td> <td>-</td> <td>-</td> </tr>
3235    <tr> <td>P</td> <td>protected</td> <td>numeric</td> <td>normal</td> <td>-</td> <td>modified</td> </tr>
3236    <tr> <td>Q</td> <td>protected</td> <td>numeric</td> <td>normal</td> <td>selectable</td> <td>-</td> </tr>
3237    <tr> <td>R</td> <td>protected</td> <td>numeric</td> <td>normal</td> <td>selectable</td> <td>modified</td> </tr>
3238    <tr> <td>S</td> <td>protected</td> <td>numeric</td> <td>intensified</td> <td>selectable</td> <td>-</td> </tr>
3239    <tr> <td>T</td> <td>protected</td> <td>numeric</td> <td>intensified</td> <td>selectable</td> <td>modified</td> </tr>
3240    <tr> <td>U</td> <td>protected</td> <td>numeric</td> <td>nondisplay</td> <td>-</td> <td>-</td> </tr>
3241    <tr> <td>V</td> <td>protected</td> <td>numeric</td> <td>nondisplay</td> <td>-</td> <td>modified</td> </tr>
3242    </table>
3243.
3244
3245name visualBell
3246applies x
3247groups i
3248type b
3249default false
3250desc
3251    When true, %p% will flash the screen in response to an ALARM WCC
3252    or BELL character, rather than ringing the terminal's bell.
3253.
3254
3255name visualSelect
3256applies x
3257groups a
3258type b
3259default false
3260desc
3261    This resource controls how %p% displays light pen selectable fields
3262    that do not have a color explicitly set by the host.
3263    When true,
3264    %p% will display these fields using the color defined by
3265    %-visualSelectColor%.
3266    When false, %p% will display these fields based on
3267    their highlighting attribute.  This attribute is used only in 3279 mode.
3268.
3269
3270name visualSelectColor
3271applies x
3272groups a
3273type i
3274default 6
3275desc
3276    The host color index of the color to use to display light pen
3277    selectable fields.  This resource is used only if %-visualSelect% is
3278    true.  The default is 6 (yellow).
3279.
3280
3281name waitCursor
3282applies x
3283groups a
3284type s
3285default watch
3286desc
3287    The name of the mouse cursor displayed when %p% is connected to a host,
3288    but is unable to process keyboard input.  Cursor names are in the file
3289    <b>&lt;X11/cursorfont.h&gt;</b>.
3290.
3291
3292name werase
3293applies a
3294groups n
3295type s
3296default ^W
3297desc
3298    This setting is used only in NVT mode, and is similar in function to
3299    the <i>stty</i> parameter of the same name.
3300    When connected in line-at-a-time mode (when %p%
3301    gathers a line of input before forwarding it to the host), entering
3302    this character at the keyboard erases the last word of input.
3303    <p class=indented>
3304    When connected in character-at-a-time mode (when %p% sends each
3305    keystroke to the host), this is the ASCII character that is sent to
3306    the host by the <b>DeleteWord</b> action.
3307.
3308
3309EOF
3310