1x3270(1) General Commands Manual x3270(1)
2
6 x3270 - IBM host access tool
7
9 x3270 [options] [host]
10 x3270 [options] session-file.x3270
12
15 x3270 opens a telnet connection to an IBM host in an X window. It
16 implements RFCs 2355 (TN3270E), 1576 (TN3270) and 1646 (LU name selec‐
17 tion), and supports IND$FILE file transfer. The window created by
18 x3270 can use its own font for displaying characters, so it is a fairly
19 accurate representation of an IBM 3278 or 3279. It is similar to
20 tn3270(1) except that it is X-based, not curses-based.
21 The full syntax for host is:
23 [prefix:]...[LUname@]hostname[:port]
24 Prepending a P: onto hostname causes the connection to go through the
26 telnet-passthru service rather than directly to the host. See PASSTHRU
27 below.
28 Prepending an S: onto hostname removes the "extended data stream"
30 option reported to the host. See -tn below for further information.
31 Prepending an N: onto hostname turns off TN3270E support for the ses‐
33 sion.
34 Prepending an L: onto hostname causes x3270 to first create an SSL tun‐
36 nel to the host, and then create a TN3270 session inside the tunnel.
37 (This function is supported only if x3270 was built with SSL/TLS sup‐
38 port). Note that TLS-encrypted sessions using the TELNET START-TLS
39 option are negotiated with the host automatically; for these sessions
40 the L: prefix should not be used.
41 A specific Logical Unit (LU) name to use may be specified by prepending
43 it to the hostname with an `@'. Multiple LU names to try can be sepa‐
44 rated by commas. An empty LU can be placed in the list with an extra
45 comma. (Note that the LU name is used for different purposes by dif‐
46 ferent kinds of hosts. For example, CICS uses the LU name as the Ter‐
47 minal ID.)
48 The hostname may optionally be placed inside square-bracket characters
50 `[' and `]'. This will prevent any colon `:' characters in the host‐
51 name from being interpreted as indicating option prefixes or port num‐
52 bers. This allows numeric IPv6 addresses to be used as hostnames.
53 On systems that support the forkpty library call, the hostname may be
55 replaced with -e and a command string. This will cause x3270 to con‐
56 nect to a local child process, such as a shell.
57 The port to connect to defaults to telnet. This can be overridden with
59 the -port option, or by appending a port to the hostname with a colon
60 `:'. (For compatability with previous versions of x3270 and with
61 tn3270(1), the port may also be specified as a second, separate argu‐
62 ment.)
63
66 x3270 is a toolkit based program, so it understands standard Xt options
67 and resources. It also understands the following options:
68 -activeicon
70 Specifies that the icon should be a miniature version of the
71 screen image. See ICONS below.
72 -apl Sets up APL mode. This is actually an abbreviation for several
74 options. See APL SUPPORT below.
75 -cc range:value[,...]
77 Sets character classes.
78 -charset name
80 Specifies an EBCDIC host character set.
81 -clear toggle
83 Sets the initial value of toggle to false. The list of toggle
84 names is under MENUS below.
85 -efont name
87 Specifies a font for the emulator window.
88 -iconname name
90 Specifies an alternate title for the program icon.
91 -iconx x
93 Specifies the initial x coordinate for the program icon.
94 -icony y
96 Specifies the initial y coordinate for the program icon.
97 -im method
99 Specifies the name of the input method to use for multi-byte
100 input. (Supported only when x3270 is compiled with DBCS sup‐
101 port.)
102 -keymap name
104 Specifies a keymap name and optional modifiers. See KEYMAPS
105 below.
106 -keypad
108 Turns on the keypad as soon as x3270 starts.
109 -km name
111 Specifies the local encoding method for multi-byte text. name
112 is an encoding name recognized by the ICU library. (Supported
113 only when x3270 is compiled with DBCS support, and necessary
114 only when x3270 cannot figure it out from the locale.)
115 -model name
117 The model of 3270 display to be emulated. The model name is in
118 two parts, either of which may be omitted:
119 The first part is the base model, which is either 3278 or 3279.
121 3278 specifies a monochrome (green on black) 3270 display; 3279
122 specifies a color 3270 display.
123 The second part is the model number, which specifies the number
125 of rows and columns. Model 4 is the default.
126 Model Number Columns Rows
128 ──────────────────────────────
129 2 80 24
130 3 80 32
131 4 80 43
132 5 132 27
133 Note: Technically, there is no such 3270 display as a 3279-4 or
135 3279-5, but most hosts seem to work with them anyway.
136 The default model for a color X display is 3279-4. For a
138 monochrome X display, it is 3278-4.
139 -mono Forces x3270 to believe it is running on a monochrome X display.
141 -once Causes x3270 to exit after a host disconnects. This option has
143 effect only if a hostname is specified on the command line.
144 -oversize colsxrows
146 Makes the screen larger than the default for the chosen model
147 number. This option has effect only in combination with
148 extended data stream support (controlled by the "x3270.extended"
149 resource), and only if the host supports the Query Reply
150 structured field. The number of columns multiplied by the
151 number of rows must not exceed 16383 (3fff hex), the limit of
152 14-bit 3270 buffer addressing.
153 -port n
155 Specifies a different TCP port to connect to. n can be a name
156 from /etc/services like telnet, or a number. This option
157 changes the default port number used for all connections. (The
158 positional parameter affects only the initial connection.)
159 -printerlu luname
161 Causes x3270 to automatically start a pr3287 printer session.
162 If luname is ".", then the printer session will be associated
163 with the interactive terminal session (this requires that the
164 host support TN3270E). Otherwise, the value is used as the
165 explicit LU name to associate with the printer session.
166 -proxy type:host[:port]
168 Causes x3270 to connect via the specified proxy, instead of
169 using a direct connection. The host can be an IP address or
170 hostname. The optional port can be a number or a service name.
171 For a list of supported proxy types, see PROXY below.
172 -pt type
174 Specifies the preedit type for the multi-byte input method.
175 Valid values are OverTheSpot, OffTheSpot, Root and OnTheSpot.
176 The value for OverTheSpot can include an optional suffix, a
177 signed number indicating the vertical distance in rows of the
178 preedit window from the cursor position, e.g. OverTheSpot+1 or
179 OverTheSpot-2. The default value is OverTheSpot+1. (Supported
180 only when x3270 is compiled with DBCS support.)
181 -reconnect
183 Causes x3270 to automatically reconnect to the host if it ever
184 disconnects. This option has effect only if a hostname is
185 specified on the command line.
186 -sb Turns on the scrollbar.
188 +sb Turns the scrollbar off.
190 -scheme name
192 Specifes a color scheme to use in 3279 mode. This option has
193 effect only in combination with 3279 emulation.
194 -script
196 Causes x3270 to read commands from standard input, with the
197 results written to standard output. The protocol for these
198 commands is documented in x3270-script(1).
199 -sl n Specifies that n lines should be saved for scrolling back. The
201 default is 64.
202 -scriptport port
204 Causes x3270 to listen for scripting connections on local TCP
205 port port.
206 -set toggle
208 Sets the initial value of toggle to true. The list of toggle
209 names is under MENUS below.
210 -socket
212 Causes the emulator to create a Unix-domain socket when it
213 starts, for use by script processes to send commands to the
214 emulator. The socket is named /tmp/x3sck.process_id. The -p
215 option of x3270if causes it to use this socket, instead of pipes
216 specified by environment variables.
217 -tn name
219 Specifies the terminal name to be transmitted over the telnet
220 connection. The default name is IBM-model_name-E, for example,
221 IBM-3279-4-E for a color X display, or IBM-3278-4-E for a
222 monochrome X display.
223 Some hosts are confused by the -E suffix on the terminal name,
225 and will ignore the extra screen area on models 3, 4 and 5.
226 Prepending an s: on the hostname, or setting the
227 "x3270.extended" resource to "false", removes the -E from the
228 terminal name when connecting to such hosts.
229 The name can also be specified with the "x3270.termName"
231 resource.
232 -trace Turns on data stream tracing at startup. Unlike turning it on
234 from a menu option, there is no pop-up to confirm the file name,
235 which defaults to /tmp/x3trc.process_id.
236 -tracefile file
238 Specifies a file to save data stream and event traces into. If
239 the value stdout is given, then traces will be written to
240 standard output. If the value none is given, then traces will
241 be piped directly to the monitor window, and no file will be
242 created.
243 -tracefilesize size
245 Places a limit on the size of a trace file. If this option is
246 not specified, or is specified as 0 or none, the trace file will
247 be unlimited. If specified, the trace file cannot already
248 exist, and the (silently enforced) minimum size is 64 Kbytes.
249 The value of size can have a K or M suffix, indicating kilobytes
250 or megabytes respectively.
251 -v Display the version and build options for x3270 and exit.
253 After reading resource definitions from the X server and any
255 standandard X11 resource definition files ($HOME/.Xdefaults, etc.),
256 x3270 will read definitions from the file $HOME/.x3270pro. This file
257 contains local customizations and is also used to save changed options
258 by the Save Changed Options in File menu option.
259 Note that -xrm options override any definitions in the .x3270pro file.
261 In addition, the toggle altCursor can be used to select the cursor
263 type. If set, an underline cursor will be used. If clear, the normal
264 block cursor will be used.
265 These names also represent resources that can be set in your .Xdefaults
267 or .x3270pro file. For example, if you always want to have the
268 scrollbar on, you can add the following to your .Xdefaults or
269 .x3270pro:
270 x3270.scrollBar: true
271 These names are also used as the first parameter to the Toggle action.
273
275 The x3270 status line contains a variety of information. From left to
276 right, the fields are:
277 comm status
279 The first symbol is always a 4. If x3270 is in TN3270E mode,
280 the second symbol is a B; otherwise it is an A. If x3270 is
281 disconnected, the third symbol is a question mark. Otherwise,
282 if x3270 is in SSCP-LU mode, the third symbol is an S.
283 Otherwise it is blank.
284 keyboard lock
286 If the keyboard is locked, an "X" symbol and a message field
287 indicate the reason for the keyboard lock.
288 shift Three characters indicate the keyboard modifier status. "M"
290 indicates the Meta key, "A" the Alt key, and an up-arrow or "^"
291 indicates the Shift key.
292 compose
294 The letter "C" indicates that a composite character is in
295 progress. If another symbol follows the "C", it is the first
296 character of the composite.
297 typeahead
299 The letter "T" indicates that one or more keystrokes are in the
300 typeahead buffer.
301 temporary keymap
303 The letter "K" indicates that a temporary keymap is in effect.
304 reverse
306 The letter "R" indicates that the keyboard is in reverse field
307 entry mode.
308 insert mode
310 A thick caret "^" or the letter "I" indicates that the keyboard
311 is in insert mode.
312 printer session
314 The letter "P" indicates that a pr3287 session is active.
315 script The letter "S" indicates that a script is active.
317 LU name
319 The LU name associated with the session, if there is one.
320 timing A clock symbol and a time in seconds indicate the time it took
322 to process the last AID or the time to connect to a host. This
323 display is optional.
324 cursor position
326 The cursor row and column are optionally displayed, separated by
327 a "/".
328
330 If the -activeicon option is given (or the "x3270.activeIcon" resource
331 is set to true), x3270 will attempt to make its icon a miniature
332 version of the current screen image. This function is highly dependent
333 on your window manager:
334 mwm The size of the icon is limited by the "Mwm.iconImageMaximum"
336 resource, which defaults to 50x50. The image will be clipped at
337 the bottom and right. The icon cannot accept keyboard input.
338 olwm The full screen image of all 3270 models can be displayed on the
340 icon. However, the icon cannot be resized, so if the model is
341 later changed with an x3270 menu option, the icon image will be
342 corrupted. The icon cannot accept keyboard input.
343 twm and tvtwm
345 The full screen image of all 3270 models can be displayed on the
346 icon, and the icon can be resized. The icon can accept keyboard
347 input.
348 However, twm does not put labels on application-supplied icon
350 windows. You can have x3270 add its own label to the icon by
351 setting the "x3270.labelIcon" resource to true. The default
352 font for icon labels is 8x13; you may change it with the
353 "x3270.iconLabelFont" resource.
354
356 The type of keyboard may be specified with the -keymap switch or using
357 either the KEYMAP or KEYBD environment variables. The types of
358 supported keyboards include sun_k3, sun_k4, sun_k5, hp-k1, hp-pc and
359 ncd.
360 The keymap may also be specified as a comma-separated list of names.
362 Later definitions override earlier ones. This is used to specify both
363 a primary keyboard type and a set of modifiers. The modifiers defined
364 include:
365 ow (OpenWindows) Swaps the middle and right mouse button
367 definitions, so the middle button performs the "Extend" function
368 and the right-hand button performs the "Paste" function. Also
369 changes the cut and paste actions to use the OpenWindows
370 CLIPBOARD.
371 apl Allows entry of APL characters (see APL SUPPORT below).
373 finnish7
375 Replaces the bracket, brace and bar keys with common Finnish
376 characters.
377 norwegian7
379 Replaces the bracket, brace and bar keys with common Norwegian
380 characters.
381 A temporary keymap can also be specified while x3270 is running with
383 the Keymap action. When the action Keymap(n) is executed, temporary
384 keymap n is added to or deleted from the current keymap. Multiple
385 temporary keymaps can be active simultaneously. The action
386 Keymap(None) restores the original keymap. Note: When Keymap() is
387 specified as part of a list of multiple actions in a keymap, it must be
388 the last action in the list.
389 The temporary keymap hebrew is provided to allow entry of Hebrew
391 characters.
392 The X Toolkit translation mechanism is used to provide keyboard
394 emulation. It maps events into actions. The best documentation can be
395 found with X toolkit documents, but the following should suffice for
396 simple customization.
397 An Xt event consists of (at least) four fields. The first is called a
399 modifier. It may be any combination of Meta, Shift and Ctrl. If it is
400 prefaced by !, it means those modifiers only. The second field is the
401 specific event, in x3270 usually just <Key>. The third field is the
402 detail field, which gives the actual key. The name of the key may be
403 determined using the xev program or with the "Trace X Events" menu
404 option. The last field is the action, which is the internal emulator
405 function. A complete list of actions may be found later in the manual.
406 There are three levels of translation tables in x3270. The first is a
408 defined by the resource x3270.keymap.base. It defines alphabetic,
409 numeric, function keys, and such basic functions as Enter and Delete.
410 It allows a minimal useful functionality. It is generally compiled in
411 x3270, but can be overridden.
412 The second level is a keyboard specific table, which is selected by the
414 x3270.keymap resource, and defined by the x3270.keymap.name resource
415 (where name is the value of the x3270.keymap resource). This keymap
416 defines actions for such things as keypad keys, and keys unique to
417 certain keyboards. Several predefined keymaps are included with x3270.
418 The third level is a user customizable table which may be used to
420 augment or override key definitions. This keymap is defined by the
421 x3270.keymap.name.user resource.
422 In addition, keymaps may be defined for use in 3270 mode or NVT mode
424 only. These keymaps use the suffixes .3270 and .nvt in their names,
425 respectively. If a keymap x3270.keymap.name.mode is defined, it will
426 augment the keymap x3270.keymap.name when x3270 is in the given mode.
427 If a keymap x3270.keymap.name.user.mode is defined, it will augment the
428 keymap x3270.keymap.name.user when x3270 is in the given mode.
429 The default translation table x3270.keymap.base is:
431 <Key>Multi_key Compose()
433 Shift<Key>Left KybdSelect(Left,PRIMARY)
434 <Key>Left Left()
435 Meta<Key>Right NextWord()
436 Shift<Key>Right KybdSelect(Right,PRIMARY)
437 <Key>Right Right()
438 Shift<Key>Up KybdSelect(Up,PRIMARY)
439 <Key>Up Up()
440 Shift<Key>Down KybdSelect(Down,PRIMARY)
441 <Key>Down Down()
442 Ctrl<Btn1Down> HandleMenu(quitMenu)
443 Ctrl<Btn2Down> HandleMenu(optionsMenu)
444 Ctrl<Btn3Down> HandleMenu(hostMenu)
445 Shift<Btn1Down> MoveCursor()
446 <Btn1Down> select-start()
447 <Btn1Motion> select-extend()
448 <Btn2Down> ignore()
449 <Btn2Motion> ignore()
450 <Btn2Up> insert-selection(PRIMARY)
451 <Btn3Down> start-extend()
452 <Btn3Motion> select-extend()
453 <BtnUp> select-end(PRIMARY)
454 Meta<Key>F1 PF(13)
455 Meta<Key>F2 PF(14)
456 Meta<Key>F3 PF(15)
457 Meta<Key>F4 PF(16)
458 Meta<Key>F5 PF(17)
459 Meta<Key>F6 PF(18)
460 Meta<Key>F7 PF(19)
461 Meta<Key>F8 PF(20)
462 Meta<Key>F9 PF(21)
463 Meta<Key>F10 PF(22)
464 Meta<Key>F11 PF(23)
465 Meta<Key>F12 PF(24)
466 <Key>F1 PF(1)
467 <Key>F2 PF(2)
468 <Key>F3 PF(3)
469 <Key>F4 PF(4)
470 <Key>F5 PF(5)
471 <Key>F6 PF(6)
472 <Key>F7 PF(7)
473 <Key>F8 PF(8)
474 <Key>F9 PF(9)
475 <Key>F10 PF(10)
476 <Key>F11 PF(11)
477 <Key>F12 PF(12)
478 Alt<Key>q Quit()
479 :<Key> Default()
480 The default 3270-mode table x3270.keymap.base.3270 adds the following
482 definitions:
483 Shift<Key>Return Newline()
485 <Key>Return Enter()
486 <Key>Linefeed Newline()
487 Shift<Key>Tab BackTab()
488 <Key>Tab Tab()
489 <Key>Home Home()
491 Meta<Key>Left PreviousWord()
492 Meta<Key>Right NextWord()
493 <Key>Insert Insert()
494 <Key>Delete Delete()
495 <Key>BackSpace BackSpace()
496 Ctrl Shift<Btn1Down> MouseSelect()
497 Shift<Btn1Down> MoveCursor()
498 Meta<Key>1 PA(1)
499 Meta<Key>2 PA(2)
500 Meta<Key>3 PA(3)
501 Ctrl<Key>a SelectAll(PRIMARY)
502 Meta<Key>a Attn()
503 Meta<Key>b PrintWindow()
504 Ctrl<Key>c set-select(CLIPBOARD)
505 Meta<Key>c Clear()
506 Meta<Key>d Delete()
507 Meta<Key>h Home()
508 Meta<Key>i Insert()
509 Meta<Key>l Redraw()
510 Meta<Key>p PrintText()
511 Meta<Key>r Reset()
512 Meta<Key>u Unselect()
513 Ctrl<Key>u DeleteField()
514 Ctrl<Key>v insert-
515 selection(CLIPBOARD)
516 Ctrl<Key>w DeleteWord()
517 :Meta<Key>asciicircum Key(notsign)
518 Meta is the diamond shaped key on a sun_k4, "Alt" on an NCD, "Extend
520 Char" on an HP. The following xmodmap command must be used on the NCD
521 to allow use the the "Alt" key:
522 xmodmap -e "keysym Alt_L = Meta_L"
524 The left mouse button may be used to make a selection. Clicking once
526 unselects the current selection. Clicking twice selects the word under
527 the mouse cursor. Clicking three times selects the line under the
528 mouse cursor. Clicking and dragging selects a rectangular area of the
529 display.
530 The middle mouse button may be used to paste a selection.
532 The right mouse button may also be used for selections, selecting the
534 rectangular area between the current position and where the left button
535 was last pressed.
536 On color X displays, the "x3270.selectBackground" resource is used to
538 distinguish the selected text from the rest of the screen. On
539 monochrome X displays, selected text is in reverse video. (It can be
540 distinguished from a block cursor because the block cursor covers
541 slightly less than an entire character position on the screen.)
542 The left mouse button, when pressed with the "Shift" key held down,
544 moves the 3270 cursor to the where the mouse cursor is pointing.
545 This is the complete list of keymap-callable actions. Other actions
547 are defined for use by scripts and are documented in x3270-script(1);
548 still others are defined for internal use by x3270 and are not
549 documented here. Note that when an action with no parameters is used
550 in a keymap, the parentheses and empty argument list are still
551 required.
552 Actions marked with an asterisk (*) may block, sending data to the host
555 and possibly waiting for a response.
556 *Attn attention key
558 AltCursor switch between block and
559 underscore cursor
560 BackSpace move cursor left (or send
562 ASCII BS)
563 BackTab tab to start of previous input
564 field
565 CircumNot input "^" in NVT mode, or
566 "notsign" in 3270 mode
567 *Clear clear screen
568 Compose next two keys form a special
569 symbol
570 *Connect(host) connect to host
571 *CursorSelect Cursor Select AID
572 Cut erase selected text
573 Default enter key literally
574 Delete delete character under cursor
575 (or send ASCII DEL)
576 DeleteField delete the entire field
577 DeleteWord delete the current or previous
578 word
579 *Disconnect disconnect from host
580 Down move cursor down
581 Dup duplicate field
582 *Enter Enter AID (or send ASCII CR)
583 Erase erase previous character (or
584 send ASCII BS)
585 EraseEOF erase to end of current field
586 EraseInput erase all input fields
587 Execute(cmd) execute a command in a shell
588 FieldEnd move cursor to end of field
589 FieldMark mark field
590 HandleMenu(name) pop up a menu
591 HexString(hex_digits) insert control-character
592 string
593 Home move cursor to first input
594 field
595 Insert set insert mode
596 *Interrupt send TELNET IP to host
597 Key(keysym) insert key keysym
598 Key(0xxx) insert key with character code
599 xx
600 Keymap(keymap) toggle alternate keymap (or
601 remove with None)
602 KybdSelect(direction[,atom...]) Extend selection by one row or
603 column
604 Left move cursor left
605 Left2 move cursor left 2 positions
606 *Macro(macro) run a macro
607 MonoCase toggle uppercase-only mode
608 MoveCursor move cursor to mouse position
609 MoveCursor(row, col) move cursor to (row,col)
610 *MoveCursorSelect move cursor to mouse position,
611 light pen selection
612 Newline move cursor to first field on
613 next line (or send ASCII LF)
614 NextWord move cursor to next word
615 *PA(n) Program Attention AID (n from
616 1 to 3)
617 *PF(n) Program Function AID (n from 1
618 to 24)
619 PreviousWord move cursor to previous word
620 Printer(Start[,lu]|Stop) start or stop printer session
621 PrintText(command) print screen text on printer
622 PrintWindow(command) print screen image (bitmap) on
623 printer
624 Quit exit x3270
625 *Reconnect reconnect to previous host
626 Redraw redraw window
627 Reset reset locked keyboard
628 Right move cursor right
629 Right2 move cursor right 2 positions
630 *Script(command[,arg...]) run a script
631 SelectAll(atom) select entire screen
633 SetFont(font) change emulator font
634 *String(string) insert string (simple macro
635 facility)
636 *SysReq System Request AID
637 Tab move cursor to next input
638 field
639 Toggle(option[,set|clear]) toggle an option
640 ToggleInsert toggle insert mode
641 ToggleReverse toggle reverse-input mode
642 *Transfer(option=value...) file transfer
643 Unselect release selection
644 Up move cursor up
645 ─────────────────────────────────────────────────────────────────
646 (the following are similar to
647 xterm)
648 ─────────────────────────────────────────────────────────────────
649 ignore do nothing
650 insert- paste selection
651 selection([atom[,atom...]])
652 move-select a combination of MoveCursor
653 and select-start
654 select-end(atom[,atom...]]) complete selection and assign
655 to atom(s)
656 select-extend move the end of a selection
657 select-start mark the beginning of a
658 selection
659 set-select(atom[,atom...]]) assign existing selection to
660 atom(s)
661 start-extend begin marking the end of a
662 selection
663
665 The PrintText produces screen snapshots in a number of different forms.
666 The default form wth no arguments sends a copy of the screen to the
667 default printer. A single argument is the command to use to print,
668 e.g., lpr. Multiple arguments can include keywords to control the
669 output of PrintText:
670 file filename
672 Save the output in a file.
673 html Save the output as HTML. This option implies file.
675 rtf Save the output as RichText. This option implies file. The
677 font defaults to Courier New and the point size defaults to 8.
678 These can be overridden by the printTextFont and printTextSize
679 resources, respectively.
680 string Return the output as a string. This can only be used from
682 scripts.
683 modi Render modified fields in italics.
685 caption text
687 Add the specified text as a caption above the output. Within
688 text, the special sequence %T% will be replaced with a
689 timestamp.
690 secure Disables the pop-up dialog.
692 command command
694 Directs the output to a command. This allows one or more of the
695 other keywords to be specified, while still sending the output
696 to the printer.
697
700 There are several types of macros and script functions available.
701 The String Action
703 The simplest method for macros is provided via the String
704 action. The arguments to String are one or more double-quoted
705 strings which are inserted directly as if typed. The C
706 backslash conventions are honored as follows. (Entries marked *
707 mean that after sending the AID code to the host, x3270 will
708 wait for the host to unlock the keyboard before further
709 processing the string.)
710 \b Left
712 \exxxx EBCDIC character in hex
713 \f Clear*
714 \n Enter*
715 \pan PA(n)*
716 \pfnn PF(nn)*
717 \r Newline
718 \t Tab
719 \T BackTab
720 \uxxxx Unicode character in hex
721 \xxxxx Unicode character in hex
722 Note that the numeric values for the \e, \u and \x sequences can
724 be abbreviated to 2 digits. Note also that EBCDIC codes greater
725 than 255 and some Unicode character codes represent DBCS
726 characters, which will work only if x3270 is built with DBCS
727 support and the host allows DBCS input in the current field.
728 An example keymap entry would be:
730 Meta<Key>p: String("probs clearrdr\n")
731 Note: The strings are in ASCII and converted to EBCDIC, so
733 beware of inserting control codes. Also, a backslash before a p
734 may need to be doubled so it will not be removed when a resource
735 file is read.
736 There is also an alternate form of the String action, HexString,
738 which is used to enter non-printing data. The argument to
739 HexString is a string of hexadecimal digits, two per character.
740 A leading 0x or 0X is optional. In 3270 mode, the hexadecimal
741 data represent EBCDIC characters, which are entered into the
742 current field. In NVT mode, the hexadecimal data represent
743 ASCII characters, which are sent directly to the host.
744 The Script Action
746 This action causes x3270 to start a child process which can
747 execute x3270 actions. Standard input and output from the child
748 process are piped back to x3270. The Script action is fully
749 documented in x3270-script(1).
750 The macros Resource
752 An alternate method of defining macros is the "x3270.macros"
753 resource. This resource is similar to a keymap, but instead of
754 defining keyboard mappings, it associates a list of X actions
755 with a name. These names are displayed on a Macros menu that
756 appears when x3270 is connected to a host. Selecting one of the
757 names on the menu executes the X actions associated with it.
758 Typically the actions are String calls, but any action may be
759 specified. Here is a sample macros resource definition, which
760 would result in a four-entry Macros menu:
761 x3270.macros: \
762 log off: String("logout\n")\n\
763 vtam: String("dial vtam\n")\n\
764 pa1: PA(1)\n\
765 alt printer: PrintText("lpr -Plw2")
766 You can also define a different set of macros for each host. If
768 there is a resource named `x3270.macros.somehost', it defines
769 the macros menu for when x3270 is connected to somehost.
770 The -script Option
772 This facility allows x3270 to operate under the complete control
773 of a script. x3270 accepts actions from standard input, and
774 prints results on standard output. The -script option is fully
775 documented in x3270-script(1).
776
778 x3270 allows the direct entry of accented letters and special symbols.
779 Pressing and releasing the "Compose" key, followed by two other keys,
780 causes entry of the symbol combining those two keys. For example,
781 "Compose" followed by the "C" key and the "," (comma) key, enters the
782 "C-cedilla" symbol. A C on the status line indicates a pending
783 composite character.
784 The mappings between these pairs of ordinary keys and the symbols they
786 represent is controlled by the "x3270.composeMap" resource; it gives
787 the name of the map to use. The maps themselves are named
788 "x3270.composeMap.name". The default is "latin1", which gives mappings
789 for most of the symbols in the ISO 8859-1 Latin-1 character set that
790 are not in the 7-bit ASCII character set.
791 Note: The default keymap defines the "Multi_key" keysym as the
793 "Compose" key. If your keyboard lacks such a key, you may set up your
794 own "Compose" key with a keymap that maps some other keysym onto the
795 Compose action.
796
798 x3270 supports the full APL2 character set and the entry of APL
799 characters from the keyboard.
800 APL characters are supported only in the special 3270 font.
802 Keyboard entry of APL characters is supported through the apl keymap
804 modifier. This modifier defines the "Alt" key as an APL shift key,
805 with a typical APL keyboard layout, e.g., "Alt" pressed with the A key
806 results in the APL "alpha" symbol. Overstruck characters such as
807 "quad-quote" are not defined as single keystrokes; instead they are
808 entered as composites (see COMPOSITE CHARACTERS above). A special
809 composite map, apl, is provided for this purpose.
810 Note: Some keyboards do not define the "Alt" key as a modifier, so
812 keymaps that use the "Alt" key will not function. On a Sun for
813 example, this can be remedied with the command:
814 xmodmap -e "add mod2 = Alt_L"
816 For convenience, an -apl option is defined, which is an abbreviation
818 for the following resource definitions:
819 x3270.keymap: your_keymap_name,apl
820 x3270.charset: apl
821 x3270.composeMap: apl
822 There are a number of APL characters that are similar in appearance to
824 non-APL characters. In particular, the APL "stile", "slope," "tilde"
825 and "quotedot" characters are similar to the EBCDIC "bar", "backslash,"
826 "tilde" and "exclaim" characters. The APL characters are entered with
827 the "Alt" key, and have slightly different appearances.
828 The complete list of special APL keysyms is as follows. Entries marked
830 with an asterisk (*) represent simple aliases for standard EBCDIC
831 characters. Entries marked with an (S) represent Sharp APL charatcers.
832 APL Symbol Hex x3270 Keysym x3270 Key x3270
834 Composed Keys
835 ──────────────────────────────────────────────────────────────────────
836 A underbar 41 apl_Aunderbar Alt-A A + underbar
837 alpha B0 apl_alpha Alt-a
838 B underbar 42 apl_Bunderbar Alt-B B + underbar
839 bar 60* apl_bar -
840 brace left C0 apl_braceleft Alt-{
841 brace right D0 apl_braceright Alt-}
842 C underbar 43 apl_Cunderbar Alt-C C + underbar
843 circle 9D apl_circle Alt-o
844 circle bar ED apl_circlebar circle + bar
845 circle slope CF apl_circleslope circle +
846 slope
847 circle star FD apl_circlestar circle + star
848 circle stile CD apl_circlestile circle +
849 stile
850 colon 7A* apl_colon :
851 comma 6B* apl_comma ,
852 comma bar (S) E5 apl_commabar comma + bar
853 D underbar 44 apl_Dunderbar Alt-D D + underbar
854 del BA apl_del Alt-g
856 del stile DC apl_delstile del + stile
857 del tilde FB apl_deltilde del + tilde
858 delta BB apl_delta Alt-h
859 delta stile DD apl_deltastile delta + stile
860 delta FC apl_deltaunderbar delta +
861 underbar underbar
862 diamond 70 apl_diamond up caret +
863 down caret
864 dieresis 72 apl_dieresis Alt-1
865 dieresis E5 apl_dieresiscircle dieresis +
866 circle (S) circle
867 dieresis dot EC apl_dieresisdot dieresis +
868 dot
869 dieresis jot E4 apl_dieresisjot dieresis +
870 (S) jot
871 divide B8 apl_divide Alt-+
872 dot 4B* apl_dot
873 down arrow 8B apl_downarrow Alt-u
874 down caret 78 apl_downcaret Alt-9
875 down caret CB apl_downcarettilde down caret +
876 tilde tilde
877 down shoe AB apl_downshoe Alt-v
878 down stile 8E apl_downstile Alt-d
879 down tack AC apl_downtack Alt-b
880 down tack jot FE apl_downtackjot down tack +
881 jot
882 down tack up DA apl_downtackuptack down tack +
883 tack up tack
884 E underbar 45 apl_Eunderbar Alt-E E + underbar
885 epsilon B1 apl_epsilon Alt-e
886 epsilon 75 apl_epsilonunderbar epsilon +
887 underbar underbar
888 equal 7E* apl_equal "="
889 equal E1 apl_equalunderbar equal +
890 underbar underbar
891 euro (S) E7 apl_euro C + =
892 F underbar 46 apl_Funderbar Alt-F F + underbar
893 G underbar 47 apl_Gunderbar Alt-G G + underbar
894 greater 6E* apl_greater >
895 H underbar 48 apl_Hunderbar Alt-H H + underbar
896 I underbar 49 apl_Iunderbar Alt-I I + underbar
897 iota B2 apl_iota Alt-i
898 iota underbar 74 apl_iotaunderbar iota +
899 underbar
900 J underbar 51 apl_Junderbar Alt-J J + underbar
901 jot AF apl_jot alt-j
902 K underbar 52 apl_Kunderbar Alt-K K + underbar
903 L underbar 53 apl_Lunderbar Alt-L L + underbar
904 left arrow 9F apl_leftarrow Alt-[
905 left bracket AD apl_leftbracket [
906 left paren 4D* apl_leftparen (
907 left shoe 9B apl_leftshoe Alt-z
908 less 4C* apl_less <
909 M underbar 54 apl_Munderbar Alt-M M + underbar
910 N underbar 55 apl_Nunderbar Alt-N N + underbar
911 not equal BE apl_notequal Alt-8 equal + slash
912 not greater 8C apl_notgreater Alt-4 less + equal
913 not less AE apl_notless Alt-6 greater +
914 equal
915 O underbar 56 apl_Ounderbar Alt-O O + underbar
916 omega B4 apl_omega Alt-w
917 overbar A0 apl_overbar Alt-2
918 P underbar 57 apl_Punderbar Alt-P P + underbar
919 plus 4E* apl_plus +
920 Q underbar 58 apl_Qunderbar Alt-Q Q + underbar
921 quad 90 apl_quad Alt-l
922 quad divide EE apl_quaddivide quad + divide
923 quad jot 73 apl_quadjot quad + jot
924 quad quote DE apl_quadquote quad + quote
925 quad slope CE apl_quadslope quad + slope
926 query 6F* apl_query ?
927 quote 7D* apl_quote
928 quote dot DB apl_quotedot quote + dot
929 R underbar 59 apl_Runderbar Alt-R R + underbar
931 rho B3 apl_rho Alt-r
932 right arrow 8F apl_rightarrow Alt-]
933 right bracket BD apl_rightbracket ]
934 right paren 5D* apl_rightparen )
935 right shoe 9A apl_rightshoe Alt-x
936 S underbar 62 apl_Sunderbar Alt-S S + underbar
937 semicolon 5E* apl_semicolon ;
938 slash 61* apl_slash /
939 slash bar EA apl_slashbar slash + bar
940 slope B7 apl_slope Alt-\
941 slope bar EB apl_slopebar slope + bar
942 squad CC apl_squad quad + quad
943 star 5C* apl_star *
944 stile BF apl_stile Alt-|
945 T underbar 63 apl_Tunderbar Alt-T T + underbar
946 tilde 80 apl_tilde Alt-~
947 times B6 apl_times Alt-=
948 U underbar 64 apl_Uunderbar Alt-U U + underbar
949 underbar 6D* apl_underbar "_"
950 up arrow 8A apl_uparrow Alt-y
951 up caret 71 apl_upcaret Alt-0
952 up caret CA apl_upcarettilde up caret +
953 tilde tilde
954 up shoe AA apl_upshoe Alt-c
955 up shoe jot DF apl_upshoejot up shoe + jot
956 up stile 8D apl_upstile Alt-s
957 up tack BC apl_uptack Alt-n
958 up tack jot EF apl_uptackjot up tack + jot
959 V underbar 65 apl_Vunderbar Alt-V V + underbar
960 W underbar 66 apl_Wunderbar Alt-W W + underbar
961 X underbar 67 apl_Xunderbar Alt-X X + underbar
962 Y underbar 68 apl_Yunderbar Alt-Y Y + underbar
963 Z underbar 69 apl_Zunderbar Alt-Z Z + underbar
964
966 When compiled with DBCS support, x3270 supports multi-byte input
967 methods via the XIM protocol.
968 The input method is selected by the XMODIFIERS environment variable or
970 the -im command-line option.
971 The preedit type is specified by the -pt command-line option, with a
973 default of OverTheSpot+1.
974
976 Screen printing is handled through options on the File menu or by the
977 PrintText and PrintWindow actions. Each results in a pop-up to confirm
978 the print command.
979 The PrintText action (usually assigned to the key <Meta>p) sends the
981 current screen image to the printer as ASCII characters. The default
982 command used to print the data is controlled by the
983 "x3270.printTextCommand" resource; the default is lpr. You may also
984 use a keymap definition to pass a print command the PrintText action
985 itself. The command receives the screen text as its standard input.
986 For example, the following keymap will save the screen text in a file:
987 Meta<Key>f: PrintText("cat >screen.image")
989 Note: HardPrint is an alias for PrintText.
991 The PrintWindow action (usually assigned to the key <Meta>b) sends the
993 current screen image to the printer as a bitmap. The default command
994 used to print the data is controlled by the "x3270.printWindowCommand"
995 resource; the default is
996 xwd -id %d | xpr | lpr.
998 You may also use a keymap definition to pass a print command to the
1000 PrintWindow action itself. If the command contains the text "%d", the
1001 window ID of x3270 will be substituted before it is run. For example,
1002 the following keymap will pop up a duplicate of the current screen
1003 image:
1004 Meta<Key>g: PrintWindow("xwd -id %d | xwud &")
1006 If the command for PrintWindow or PrintText begins with an "@"
1008 character, the initial pop-up menu to confirm the print command is not
1009 displayed and the command cannot be edited.
1010
1012 Cursor highlighting will not work with if you use the NoTitleFocus
1013 option in your .twmrc file.
1014
1017 x3270 supports the Sun telnet-passthru service provided by the
1018 in.telnet-gw server. This allows outbound telnet connections through a
1019 firewall machine. When a p: is prepended to a hostname, x3270 acts
1020 much like the itelnet(1) command. It contacts the machine named
1021 internet-gateway at the port defined in /etc/services as telnet-
1022 passthru (which defaults to 3514). It then passes the requested
1023 hostname and port to the in.telnet-gw server.
1024
1026 The -proxy option or the x3270.proxy resource causes x3270 to use a
1027 proxy server to connect to the host. The syntax of the option or
1028 resource is:
1029 type:host[:port]
1030 The supported values for type are:
1032 Proxy Type Protocol Default Port
1034 ──────────────────────────────────────────────
1035 http RFC 2817 HTTP 3128
1036 tunnel (squid)
1037 passthru Sun in.telnet-gw none
1038 socks4 SOCKS version 4 1080
1039 socks5 SOCKS version 5 1080
1040 (RFC 1928)
1041 telnet No protocol (just none
1042 send connect host
1043 port)
1044 The special types socks4a and socks5d can also be used to force the
1046 proxy server to do the hostname resolution for the SOCKS protocol.
1047
1049 /etc/ibm_hosts
1050 $HOME/.x3270pro
1051
1054 3270PRO Path of profile file, containing resource definitions. Merged
1055 after the system resource database, but before X3270RDB. Defaults to
1056 $HOME/.x3270pro.
1057 NOX3270PRO If set, do not read the profile.
1058 X3270RDB Additional resource definitions, merged after the profile file
1059 but before the command-line options.
1060 KEYMAP Keymap name.
1061 KEYBD Keymap name.
1062
1064 s3270(1), c3270(1), tcl3270(1), ibm_hosts(5), x3270-script(1),
1065 telnet(1), tn3270(1)
1066 X Toolkit Intrinsics
1067 Data Stream Programmer's Reference, IBM GA23-0059
1068 Character Set Reference, IBM GA27-3831
1069 RFC 1576, TN3270 Current Practices
1070 RFC 1646, TN3270 Extensions for LUname and Printer Selection
1071 RFC 2355, TN3270 Enhancements
1072
1074 Copyright 1993-2009, Paul Mattes.
1075 Copyright 2004-2005, Don Russell.
1076 Copyright 2004, Dick Altenbern.
1077 Copyright 1990, Jeff Sparkes.
1078 Copyright 1989, Georgia Tech Research Corporation (GTRC), Atlanta, GA
1079 30332.
1080 All rights reserved.
1081 Redistribution and use in source and binary forms, with or without
1083 modification, are permitted provided that the following conditions are
1084 met:
1085 * Redistributions of source code must retain the above copyright
1088 notice, this list of conditions and the following disclaimer.
1089 * Redistributions in binary form must reproduce the above
1091 copyright notice, this list of conditions and the following
1092 disclaimer in the documentation and/or other materials provided
1093 with the distribution.
1094 * Neither the names of Paul Mattes, Don Russell, Dick Altenbern,
1096 Jeff Sparkes, GTRC nor the names of their contributors may be
1097 used to endorse or promote products derived from this software
1098 without specific prior written permission.
1099 THIS SOFTWARE IS PROVIDED BY PAUL MATTES, DON RUSSELL, DICK ALTENBERN,
1102 JEFF SPARKES AND GTRC "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
1103 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1104 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
1105 NO EVENT SHALL PAUL MATTES, DON RUSSELL, DICK ALTENBERN, JEFF SPARKES
1106 OR GTRC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL
1107 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
1108 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
1109 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
1110 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1111 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
1112 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1113
1115 x3270 3.3.10ga4
1116 02 October 2009 x3270(1)