1x3270(1)                    General Commands Manual                   x3270(1)
2
3
4

NAME

6       x3270 - IBM host access tool
7

SYNOPSIS

9       x3270 [options] [host]
10
11       x3270 [options] session-file.x3270
12
13

DESCRIPTION

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
22       The full syntax for host is:
23              [prefix:]...[LUname@]hostname[:port]
24
25       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
29       Prepending an S: onto  hostname  removes  the  "extended  data  stream"
30       option reported to the host.  See -tn below for further information.
31
32       Prepending  an  N: onto hostname turns off TN3270E support for the ses‐
33       sion.
34
35       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
42       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
49       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
54       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
58       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
64

OPTIONS

66       x3270 is a toolkit based program, so it understands standard Xt options
67       and resources.  It also understands the following options:
68
69       -activeicon
70              Specifies that the icon should be a  miniature  version  of  the
71              screen image.  See ICONS below.
72
73       -apl   Sets  up APL mode.  This is actually an abbreviation for several
74              options.  See APL SUPPORT below.
75
76       -cadir directory
77              Specifies a directory containing CA (root) certificates  to  use
78              when verifying a certificate provided by the host.
79
80       -cafile filename
81              Specifies a PEM-format file containing CA (root) certificates to
82              use when verifying a certificate provided by the host.
83
84       -cc range:value[,...]
85              Sets character classes.
86
87       -certfile filename
88              Specifies a file containing a  certificate  to  provide  to  the
89              host, if requested.  The default file type is PEM.
90
91       -certfiletype type
92              Specifies  the  type of the certificate file specified by -cert‐
93              file.  Type can be pem or asn1.
94
95       -chainfile filename
96              Specifies a certificate chain file in PEM format,  containing  a
97              certificate  to provide to the host if requested, as well as one
98              or more intermediate certificates and the CA certificate used to
99              sign that certificate.  If -chainfile is specified, it overrides
100              -certfile.
101
102       -charset name
103              Specifies an EBCDIC host character set.
104
105       -clear toggle
106              Sets the initial value of toggle to false.  The list  of  toggle
107              names is under MENUS below.
108
109       -devname name
110              Specifies a device name (workstation ID) for RFC 4777 support.
111
112       -efont name
113              Specifies a font for the emulator window.
114
115       -hostsfile file
116              Uses file as the hosts file, which allows aliases for host names
117              and scripts to be  executed  at  login.   See  ibm_hosts(1)  for
118              details.
119
120       -iconname name
121              Specifies an alternate title for the program icon.
122
123       -iconx x
124              Specifies the initial x coordinate for the program icon.
125
126       -icony y
127              Specifies the initial y coordinate for the program icon.
128
129       -im method
130              Specifies  the  name  of  the input method to use for multi-byte
131              input.  (Supported only when x3270 is compiled  with  DBCS  sup‐
132              port.)
133
134       -keyfile filename
135              Specifies  a file containing the private key for the certificate
136              file (specified via -certfile or -chainfile).  The default  file
137              type is PEM.
138
139       -keyfiletype type
140              Specifies  the  type  of the private key file specified by -key‐
141              file.  Type can be pem or asn1.
142
143       -keypasswd type:value
144              Specifies the password for  the  private  key  file,  if  it  is
145              encrypted.   The  argument can be file:filename, specifying that
146              the password is in a  file,  or  string:string,  specifying  the
147              password  on the command-line directly.  If the private key file
148              is encrypted and no -keypasswd option  is  given,  the  password
149              will be prompted for interactively.
150
151       -keymap name
152              Specifies  a  keymap  name  and optional modifiers.  See KEYMAPS
153              below.
154
155       -keypad
156              Turns on the keypad as soon as x3270 starts.
157
158       -km name
159              Specifies the local encoding method for multi-byte  text.   name
160              is  an  encoding name recognized by the ICU library.  (Supported
161              only when x3270 is compiled with  DBCS  support,  and  necessary
162              only when x3270 cannot figure it out from the locale.)
163
164       -model name
165              The  model of 3270 display to be emulated.  The model name is in
166              two parts, either of which may be omitted:
167
168              The first part is the base model, which is either 3278 or  3279.
169              3278  specifies a monochrome (green on black) 3270 display; 3279
170              specifies a color 3270 display.
171
172              The second part is the model number, which specifies the  number
173              of rows and columns.  Model 4 is the default.
174
175                            Model Number   Columns   Rows
176                            ──────────────────────────────
177                                 2           80       24
178                                 3           80       32
179                                 4           80       43
180                                 5           132      27
181
182              Note:  Technically, there is no such 3270 display as a 3279-4 or
183              3279-5, but most hosts seem to work with them anyway.
184
185              The default model for a  color  X  display  is  3279-4.   For  a
186              monochrome X display, it is 3278-4.
187
188       -mono  Forces x3270 to believe it is running on a monochrome X display.
189
190       -once  Causes  x3270 to exit after a host disconnects.  This option has
191              effect only if a hostname is specified on the command line.
192
193       -oversize colsxrows
194              Makes the screen larger than the default for  the  chosen  model
195              number.   This  option  has  effect  only  in  combination  with
196              extended data stream support (controlled by the "x3270.extended"
197              resource),  and  only  if  the  host  supports  the  Query Reply
198              structured field.  The  number  of  columns  multiplied  by  the
199              number  of  rows  must not exceed 16383 (3fff hex), the limit of
200              14-bit 3270 buffer addressing.
201
202       -port n
203              Specifies a different TCP port to connect to.  n can be  a  name
204              from  /etc/services  like  telnet,  or  a  number.   This option
205              changes the default port number used for all connections.   (The
206              positional parameter affects only the initial connection.)
207
208       -printerlu luname
209              Causes  x3270  to  automatically start a pr3287 printer session.
210              If luname is ".", then the printer session  will  be  associated
211              with  the  interactive  terminal session (this requires that the
212              host support TN3270E).  Otherwise, the  value  is  used  as  the
213              explicit LU name to associate with the printer session.
214
215       -proxy type:host[:port]
216              Causes  x3270  to  connect  via  the specified proxy, instead of
217              using a direct connection.  The host can be  an  IP  address  or
218              hostname.   The optional port can be a number or a service name.
219              For a list of supported proxy types, see PROXY below.
220
221       -pt type
222              Specifies the preedit type  for  the  multi-byte  input  method.
223              Valid  values  are  OverTheSpot, OffTheSpot, Root and OnTheSpot.
224              The value for OverTheSpot can  include  an  optional  suffix,  a
225              signed  number  indicating  the vertical distance in rows of the
226              preedit window from the cursor position, e.g.  OverTheSpot+1  or
227              OverTheSpot-2.   The default value is OverTheSpot+1.  (Supported
228              only when x3270 is compiled with DBCS support.)
229
230       -reconnect
231              Causes x3270 to automatically reconnect to the host if  it  ever
232              disconnects.   This  option  has  effect  only  if a hostname is
233              specified on the command line.
234
235       -sb    Turns on the scrollbar.
236
237       +sb    Turns the scrollbar off.
238
239       -scheme name
240              Specifes a color scheme to use in 3279 mode.   This  option  has
241              effect only in combination with 3279 emulation.
242
243       -script
244              Causes  x3270  to  read  commands  from standard input, with the
245              results written to standard  output.   The  protocol  for  these
246              commands is documented in x3270-script(1).
247
248       -sl n  Specifies  that n lines should be saved for scrolling back.  The
249              default is 64.
250
251       -scriptport port
252              Causes x3270 to listen for scripting connections  on  local  TCP
253              port port.
254
255       -set toggle
256              Sets  the  initial  value of toggle to true.  The list of toggle
257              names is under MENUS below.
258
259       -socket
260              Causes the emulator to  create  a  Unix-domain  socket  when  it
261              starts,  for  use  by  script  processes to send commands to the
262              emulator.  The socket is named  /tmp/x3sck.process_id.   The  -p
263              option of x3270if causes it to use this socket, instead of pipes
264              specified by environment variables.
265
266       -tn name
267              Specifies the terminal name to be transmitted  over  the  telnet
268              connection.   The default name is IBM-model_name-E, for example,
269              IBM-3279-4-E for a  color  X  display,  or  IBM-3278-4-E  for  a
270              monochrome X display.
271
272              Some  hosts  are confused by the -E suffix on the terminal name,
273              and will ignore the extra screen area on  models  3,  4  and  5.
274              Prepending   an   s:   on   the   hostname,   or   setting   the
275              "x3270.extended" resource to "false", removes the  -E  from  the
276              terminal name when connecting to such hosts.
277
278              The  name  can  also  be  specified  with  the  "x3270.termName"
279              resource.
280
281       -trace Turns on data stream tracing at startup.  Unlike turning  it  on
282              from a menu option, there is no pop-up to confirm the file name,
283              which defaults to /tmp/x3trc.process_id.
284
285       -tracefile file
286              Specifies a file to save data stream and event traces into.   If
287              the  name  starts  with `>>', data will be appended to the file.
288              If the value stdout is given, then traces  will  be  written  to
289              standard  output.   If the value none is given, then traces will
290              be piped directly to the monitor window, and  no  file  will  be
291              created.
292
293       -tracefilesize size
294              Places  a  limit on the size of a trace file.  If this option is
295              not specified, or is specified as 0 or none, the trace file size
296              will be unlimited.  The minimum size is 64 Kbytes.  The value of
297              size can have a K or M suffix, indicating kilobytes or megabytes
298              respectively.   When  the  trace file reaches the size limit, it
299              will be renamed with a `-' appended and a new file started.
300
301       -user name
302              Specifies the user name for RFC 4777 support.
303
304       -v     Display the version and build options for x3270 and exit.
305
306       -verifycert
307              For SSL or SSL/TLS connections, verify the host certificate, and
308              do  not  allow  the  connection  to  complete  unless  it can be
309              validated.
310
311       After  reading  resource  definitions  from  the  X  server   and   any
312       standandard  X11  resource  definition  files ($HOME/.Xdefaults, etc.),
313       x3270 will read definitions from the file $HOME/.x3270pro.   This  file
314       contains  local customizations and is also used to save changed options
315       by the Save Changed Options in File menu option.
316
317       Note that -xrm options override any definitions in the .x3270pro file.
318
319       In addition, the toggle altCursor can be  used  to  select  the  cursor
320       type.   If set, an underline cursor will be used.  If clear, the normal
321       block cursor will be used.
322
323       These names also represent resources that can be set in your .Xdefaults
324       or  .x3270pro  file.   For  example,  if  you  always  want to have the
325       scrollbar  on,  you  can  add  the  following  to  your  .Xdefaults  or
326       .x3270pro:
327              x3270.scrollBar:    true
328
329       These names are also used as the first parameter to the Toggle action.
330

STATUS LINE

332       The  x3270 status line contains a variety of information.  From left to
333       right, the fields are:
334
335       comm status
336              The first symbol is always a 4.  If x3270 is  in  TN3270E  mode,
337              the  second  symbol  is  a B; otherwise it is an A.  If x3270 is
338              disconnected, the third symbol is a question  mark.   Otherwise,
339              if  x3270  is  in  SSCP-LU  mode,  the  third  symbol  is  an S.
340              Otherwise it is blank.
341
342       keyboard lock
343              If the keyboard is locked, an "X" symbol  and  a  message  field
344              indicate the reason for the keyboard lock.
345
346       shift  Three  characters  indicate  the  keyboard modifier status.  "M"
347              indicates the Meta key, "A" the Alt key, and an up-arrow or  "^"
348              indicates the Shift key.
349
350       compose
351              The  letter  "C"  indicates  that  a  composite  character is in
352              progress.  If another symbol follows the "C", it  is  the  first
353              character of the composite.
354
355       typeahead
356              The  letter "T" indicates that one or more keystrokes are in the
357              typeahead buffer.
358
359       temporary keymap
360              The letter "K" indicates that a temporary keymap is in effect.
361
362       reverse
363              The letter "R" indicates that the keyboard is in  reverse  field
364              entry mode.
365
366       insert mode
367              A  thick caret "^" or the letter "I" indicates that the keyboard
368              is in insert mode.
369
370       printer session
371              The letter "P" indicates that a pr3287 session is active.
372
373       script The letter "S" indicates that a script is active.
374
375       LU name
376              The LU name associated with the session, if there is one.
377
378       timing A clock symbol and a time in seconds indicate the time  it  took
379              to  process the last AID or the time to connect to a host.  This
380              display is optional.
381
382       cursor position
383              The cursor row and column are optionally displayed, separated by
384              a "/".
385

ICONS

387       If  the -activeicon option is given (or the "x3270.activeIcon" resource
388       is set to true), x3270 will  attempt  to  make  its  icon  a  miniature
389       version of the current screen image.  This function is highly dependent
390       on your window manager:
391
392       mwm    The size of the icon is limited  by  the  "Mwm.iconImageMaximum"
393              resource, which defaults to 50x50.  The image will be clipped at
394              the bottom and right.  The icon cannot accept keyboard input.
395
396       olwm   The full screen image of all 3270 models can be displayed on the
397              icon.   However,  the icon cannot be resized, so if the model is
398              later changed with an x3270 menu option, the icon image will  be
399              corrupted.  The icon cannot accept keyboard input.
400
401       twm and tvtwm
402              The full screen image of all 3270 models can be displayed on the
403              icon, and the icon can be resized.  The icon can accept keyboard
404              input.
405
406              However,  twm  does  not put labels on application-supplied icon
407              windows.  You can have x3270 add its own label to  the  icon  by
408              setting  the  "x3270.labelIcon"  resource  to true.  The default
409              font for icon labels  is  8x13;  you  may  change  it  with  the
410              "x3270.iconLabelFont" resource.
411

KEYMAPS

413       The  type of keyboard may be specified with the -keymap switch or using
414       either the  KEYMAP  or  KEYBD  environment  variables.   The  types  of
415       supported  keyboards  include  sun_k3, sun_k4, sun_k5, hp-k1, hp-pc and
416       ncd.
417
418       The keymap may also be specified as a comma-separated  list  of  names.
419       Later  definitions override earlier ones.  This is used to specify both
420       a primary keyboard type and a set of modifiers.  The modifiers  defined
421       include:
422
423       ow     (OpenWindows)   Swaps   the   middle   and  right  mouse  button
424              definitions, so the middle button performs the "Extend" function
425              and  the  right-hand button performs the "Paste" function.  Also
426              changes the  cut  and  paste  actions  to  use  the  OpenWindows
427              CLIPBOARD.
428
429       apl    Allows entry of APL characters (see APL SUPPORT below).
430
431       finnish7
432              Replaces  the  bracket,  brace  and bar keys with common Finnish
433              characters.
434
435       norwegian7
436              Replaces the bracket, brace and bar keys with  common  Norwegian
437              characters.
438
439       A  temporary  keymap  can also be specified while x3270 is running with
440       the Keymap action.  When the action Keymap(n)  is  executed,  temporary
441       keymap  n  is  added  to  or deleted from the current keymap.  Multiple
442       temporary  keymaps  can   be   active   simultaneously.    The   action
443       Keymap(None)  restores  the  original  keymap.   Note: When Keymap() is
444       specified as part of a list of multiple actions in a keymap, it must be
445       the last action in the list.
446
447       The  temporary  keymap  hebrew  is  provided  to  allow entry of Hebrew
448       characters.
449
450       The X  Toolkit  translation  mechanism  is  used  to  provide  keyboard
451       emulation.  It maps events into actions.  The best documentation can be
452       found with X toolkit documents, but the following  should  suffice  for
453       simple customization.
454
455       An  Xt event consists of (at least) four fields.  The first is called a
456       modifier.  It may be any combination of Meta, Shift and Ctrl.  If it is
457       prefaced  by !, it means those modifiers only.  The second field is the
458       specific event, in x3270 usually just <Key>.  The third  field  is  the
459       detail  field,  which gives the actual key.  The name of the key may be
460       determined using the xev program or with  the  "Trace  X  Events"  menu
461       option.   The  last field is the action, which is the internal emulator
462       function.  A complete list of actions may be found later in the manual.
463
464       There are three levels of translation tables in x3270.  The first is  a
465       defined  by  the  resource  x3270.keymap.base.   It defines alphabetic,
466       numeric, function keys, and such basic functions as Enter  and  Delete.
467       It  allows a minimal useful functionality.  It is generally compiled in
468       x3270, but can be overridden.
469
470       The second level is a keyboard specific table, which is selected by the
471       x3270.keymap  resource,  and  defined by the x3270.keymap.name resource
472       (where name is the value of the x3270.keymap  resource).   This  keymap
473       defines  actions  for  such  things  as keypad keys, and keys unique to
474       certain keyboards.  Several predefined keymaps are included with x3270.
475
476       The third level is a user customizable  table  which  may  be  used  to
477       augment  or  override  key  definitions.  This keymap is defined by the
478       x3270.keymap.name.user resource.
479
480       In addition, keymaps may be defined for use in 3270 mode  or  NVT  mode
481       only.   These  keymaps  use the suffixes .3270 and .nvt in their names,
482       respectively.  If a keymap x3270.keymap.name.mode is defined,  it  will
483       augment  the  keymap x3270.keymap.name when x3270 is in the given mode.
484       If a keymap x3270.keymap.name.user.mode is defined, it will augment the
485       keymap x3270.keymap.name.user when x3270 is in the given mode.
486
487       The default translation table x3270.keymap.base is:
488
489       <Key>Multi_key    Compose()
490       Shift<Key>Left    KybdSelect(Left,PRIMARY)
491       <Key>Left         Left()
492       Meta<Key>Right    NextWord()
493       Shift<Key>Right   KybdSelect(Right,PRIMARY)
494       <Key>Right        Right()
495       Shift<Key>Up      KybdSelect(Up,PRIMARY)
496       <Key>Up           Up()
497       Shift<Key>Down    KybdSelect(Down,PRIMARY)
498       <Key>Down         Down()
499       Ctrl<Btn1Down>    HandleMenu(quitMenu)
500       Ctrl<Btn2Down>    HandleMenu(optionsMenu)
501       Ctrl<Btn3Down>    HandleMenu(hostMenu)
502       Shift<Btn1Down>   MoveCursor()
503       <Btn1Down>        select-start()
504       <Btn1Motion>      select-extend()
505       <Btn2Down>        ignore()
506       <Btn2Motion>      ignore()
507       <Btn2Up>          insert-selection(PRIMARY)
508       <Btn3Down>        start-extend()
509       <Btn3Motion>      select-extend()
510       <BtnUp>           select-end(PRIMARY)
511       Meta<Key>F1       PF(13)
512       Meta<Key>F2       PF(14)
513       Meta<Key>F3       PF(15)
514       Meta<Key>F4       PF(16)
515       Meta<Key>F5       PF(17)
516       Meta<Key>F6       PF(18)
517       Meta<Key>F7       PF(19)
518       Meta<Key>F8       PF(20)
519       Meta<Key>F9       PF(21)
520       Meta<Key>F10      PF(22)
521       Meta<Key>F11      PF(23)
522       Meta<Key>F12      PF(24)
523       <Key>F1           PF(1)
524       <Key>F2           PF(2)
525       <Key>F3           PF(3)
526       <Key>F4           PF(4)
527       <Key>F5           PF(5)
528       <Key>F6           PF(6)
529       <Key>F7           PF(7)
530       <Key>F8           PF(8)
531       <Key>F9           PF(9)
532       <Key>F10          PF(10)
533       <Key>F11          PF(11)
534       <Key>F12          PF(12)
535       Alt<Key>q         Quit()
536       :<Key>            Default()
537
538       The  default  3270-mode table x3270.keymap.base.3270 adds the following
539       definitions:
540
541       Shift<Key>Return        Newline()
542       <Key>Return             Enter()
543       <Key>Linefeed           Newline()
544       Shift<Key>Tab           BackTab()
545       <Key>Tab                Tab()
546       <Key>Home               Home()
547       Meta<Key>Left           PreviousWord()
548       Meta<Key>Right          NextWord()
549       <Key>Insert             Insert()
550       <Key>Delete             Delete()
551       <Key>BackSpace          BackSpace()
552       Ctrl Shift<Btn1Down>    MouseSelect()
553       Shift<Btn1Down>         MoveCursor()
554
555       Meta<Key>1              PA(1)
556       Meta<Key>2              PA(2)
557       Meta<Key>3              PA(3)
558       Ctrl<Key>a              SelectAll(PRIMARY)
559       Meta<Key>a              Attn()
560       Meta<Key>b              PrintWindow()
561       Ctrl<Key>c              set-select(CLIPBOARD)
562       Meta<Key>c              Clear()
563       Meta<Key>d              Delete()
564       Meta<Key>h              Home()
565       Meta<Key>i              Insert()
566       Meta<Key>l              Redraw()
567       Meta<Key>p              PrintText()
568       Meta<Key>r              Reset()
569       Meta<Key>u              Unselect()
570       Ctrl<Key>u              DeleteField()
571       Ctrl<Key>v              insert-
572                               selection(CLIPBOARD)
573       Ctrl<Key>w              DeleteWord()
574       :Meta<Key>asciicircum   Key(notsign)
575
576       Meta  is  the  diamond shaped key on a sun_k4, "Alt" on an NCD, "Extend
577       Char" on an HP.  The following xmodmap command must be used on the  NCD
578       to allow use the the "Alt" key:
579
580              xmodmap -e "keysym Alt_L = Meta_L"
581
582       The  left  mouse button may be used to make a selection.  Clicking once
583       unselects the current selection.  Clicking twice selects the word under
584       the  mouse  cursor.   Clicking  three  times selects the line under the
585       mouse cursor.  Clicking and dragging selects a rectangular area of  the
586       display.
587
588       The middle mouse button may be used to paste a selection.
589
590       The  right  mouse button may also be used for selections, selecting the
591       rectangular area between the current position and where the left button
592       was last pressed.
593
594       On  color  X displays, the "x3270.selectBackground" resource is used to
595       distinguish the  selected  text  from  the  rest  of  the  screen.   On
596       monochrome  X  displays, selected text is in reverse video.  (It can be
597       distinguished from a block  cursor  because  the  block  cursor  covers
598       slightly less than an entire character position on the screen.)
599
600       The  left  mouse  button,  when pressed with the "Shift" key held down,
601       moves the 3270 cursor to the where the mouse cursor is pointing.
602
603       This is the complete list of keymap-callable  actions.   Other  actions
604       are  defined  for use by scripts and are documented in x3270-script(1);
605       still others are  defined  for  internal  use  by  x3270  and  are  not
606       documented  here.   Note that when an action with no parameters is used
607       in a  keymap,  the  parentheses  and  empty  argument  list  are  still
608       required.
609
610
611       Actions marked with an asterisk (*) may block, sending data to the host
612       and possibly waiting for a response.
613
614           *Attn                            attention key
615           AltCursor                        switch between block and
616                                            underscore cursor
617           BackSpace                        move cursor left (or send
618                                            ASCII BS)
619           BackTab                          tab to start of previous input
620                                            field
621           CircumNot                        input "^" in NVT mode, or
622                                            "notsign" in 3270 mode
623           *Clear                           clear screen
624
625           Compose                          next two keys form a special
626                                            symbol
627           *Connect(host)                   connect to host
628           *CursorSelect                    Cursor Select AID
629           Cut                              erase selected text
630           Default                          enter key literally
631           Delete                           delete character under cursor
632                                            (or send ASCII DEL)
633           DeleteField                      delete the entire field
634           DeleteWord                       delete the current or previous
635                                            word
636           *Disconnect                      disconnect from host
637           Down                             move cursor down
638           Dup                              duplicate field
639           *Enter                           Enter AID (or send ASCII CR)
640           Erase                            erase previous character (or
641                                            send ASCII BS)
642           EraseEOF                         erase to end of current field
643           EraseInput                       erase all input fields
644           Execute(cmd)                     execute a command in a shell
645           FieldEnd                         move cursor to end of field
646           FieldMark                        mark field
647           HandleMenu(name)                 pop up a menu
648           HexString(hex_digits)            insert control-character
649                                            string
650           Home                             move cursor to first input
651                                            field
652           Insert                           set insert mode
653           *Interrupt                       send TELNET IP to host
654           Key(keysym)                      insert key keysym
655           Key(0xxx)                        insert key with character code
656                                            xx
657           Keymap(keymap)                   toggle alternate keymap (or
658                                            remove with None)
659           KybdSelect(direction             Extend selection by one row or
660             [,atom...])                    column
661           Left                             move cursor left
662           Left2                            move cursor left 2 positions
663           *Macro(macro)                    run a macro
664           MonoCase                         toggle uppercase-only mode
665           MoveCursor                       move cursor to mouse position
666           MoveCursor(row, col)             move cursor to (row,col)
667           *MoveCursorSelect                move cursor to mouse position,
668                                            light pen selection
669           Newline                          move cursor to first field on
670                                            next line (or send ASCII LF)
671           NextWord                         move cursor to next word
672           *PA(n)                           Program Attention AID (n from
673                                            1 to 3)
674           *PF(n)                           Program Function AID (n from 1
675                                            to 24)
676           PreviousWord                     move cursor to previous word
677           Printer(Start[,lu]|Stop)         start or stop printer session
678           PrintText(command)               print screen text on printer
679           PrintWindow(command)             print screen image (bitmap) on
680                                            printer
681           Quit                             exit x3270
682           *Reconnect                       reconnect to previous host
683           Redraw                           redraw window
684           Reset                            reset locked keyboard
685           Right                            move cursor right
686           Right2                           move cursor right 2 positions
687           *Script(command[,arg...])        run a script
688           SelectAll(atom)                  select entire screen
689           SetFont(font)                    change emulator font
690           *String(string)                  insert string (simple macro
691                                            facility)
692           *SysReq                          System Request AID
693
694
695           Tab                              move cursor to next input
696                                            field
697           Toggle(option[,set|clear])       toggle an option
698           ToggleInsert                     toggle insert mode
699           ToggleReverse                    toggle reverse-input mode
700           *Transfer(option=value...)       file transfer
701           Unselect                         release selection
702           Up                               move cursor up
703           ────────────────────────────────────────────────────────────────
704           (the following are similar to
705             xterm)
706           ────────────────────────────────────────────────────────────────
707           ignore                           do nothing
708           insert-                          paste selection
709             selection([atom[,atom...]])
710           move-select                      a combination of MoveCursor
711                                            and select-start
712           select-end(atom[,atom...]])      complete selection and assign
713                                            to atom(s)
714           select-extend                    move the end of a selection
715           select-start                     mark the beginning of a
716                                            selection
717           set-select(atom[,atom...]])      assign existing selection to
718                                            atom(s)
719           start-extend                     begin marking the end of a
720                                            selection
721

THE PRINTTEXT ACTION

723       The PrintText produces screen snapshots in a number of different forms.
724       The  default  form  wth  no arguments sends a copy of the screen to the
725       default printer.  A single argument is the command  to  use  to  print,
726       e.g.,  lpr.   Multiple  arguments  can  include keywords to control the
727       output of PrintText:
728
729       file filename
730              Save the output in a file.
731
732       html   Save the output as HTML.  This option implies file.
733
734       rtf    Save the output as RichText.  This  option  implies  file.   The
735              font  defaults  to Courier New and the point size defaults to 8.
736              These can be overridden by the printTextFont  and  printTextSize
737              resources, respectively.
738
739       string Return  the  output  as  a  string.   This can only be used from
740              scripts.
741
742       modi   Render modified fields in italics.
743
744       caption text
745              Add the specified text as a caption above  the  output.   Within
746              text,   the  special  sequence  %T%  will  be  replaced  with  a
747              timestamp.
748
749       secure Disables the pop-up dialog.
750
751       command command
752              Directs the output to a command.  This allows one or more of the
753              other  keywords  to be specified, while still sending the output
754              to the printer.
755
756

MACROS AND SCRIPTS

758       There are several types of macros and script functions available.
759
760       The String Action
761              The simplest method  for  macros  is  provided  via  the  String
762              action.   The  arguments to String are one or more double-quoted
763              strings  which  are  inserted  directly  as  if  typed.   The  C
764              backslash conventions are honored as follows.  (Entries marked *
765              mean that after sending the AID code to  the  host,  x3270  will
766              wait  for  the  host  to  unlock  the  keyboard  before  further
767              processing the string.)
768
769              \b       Left
770              \exxxx   EBCDIC character in hex
771              \f       Clear*
772              \n       Enter*
773              \pan     PA(n)*
774              \pfnn    PF(nn)*
775              \r       Newline
776              \t       Tab
777              \T       BackTab
778              \uxxxx   Unicode character in hex
779              \xxxxx   Unicode character in hex
780
781              Note that the numeric values for the \e, \u and \x sequences can
782              be abbreviated to 2 digits.  Note also that EBCDIC codes greater
783              than  255  and  some  Unicode  character  codes  represent  DBCS
784              characters,  which  will  work  only if x3270 is built with DBCS
785              support and the host allows DBCS input in the current field.
786
787              An example keymap entry would be:
788              Meta<Key>p: String("probs clearrdr\n")
789
790              Note: The strings are in  ASCII  and  converted  to  EBCDIC,  so
791              beware of inserting control codes.  Also, a backslash before a p
792              may need to be doubled so it will not be removed when a resource
793              file is read.
794
795              There is also an alternate form of the String action, HexString,
796              which is used to  enter  non-printing  data.   The  argument  to
797              HexString  is a string of hexadecimal digits, two per character.
798              A leading 0x or 0X is optional.  In 3270 mode,  the  hexadecimal
799              data  represent  EBCDIC  characters,  which are entered into the
800              current field.  In NVT  mode,  the  hexadecimal  data  represent
801              ASCII characters, which are sent directly to the host.
802
803       The Script Action
804              This  action  causes  x3270  to  start a child process which can
805              execute x3270 actions.  Standard input and output from the child
806              process  are  piped  back  to x3270.  The Script action is fully
807              documented in x3270-script(1).
808
809       The macros Resource
810              An alternate method of defining  macros  is  the  "x3270.macros"
811              resource.   This resource is similar to a keymap, but instead of
812              defining keyboard mappings, it associates a list  of  X  actions
813              with  a  name.   These names are displayed on a Macros menu that
814              appears when x3270 is connected to a host.  Selecting one of the
815              names  on  the  menu  executes the X actions associated with it.
816              Typically the actions are String calls, but any  action  may  be
817              specified.   Here  is a sample macros resource definition, which
818              would result in a four-entry Macros menu:
819              x3270.macros: \
820              log off: String("logout\n")\n\
821              vtam: String("dial vtam\n")\n\
822              pa1: PA(1)\n\
823              alt printer: PrintText("lpr -Plw2")
824
825              You can also define a different set of macros for each host.  If
826              there  is  a  resource named `x3270.macros.somehost', it defines
827              the macros menu for when x3270 is connected to somehost.
828
829       The -script Option
830              This facility allows x3270 to operate under the complete control
831              of  a  script.   x3270  accepts actions from standard input, and
832              prints results on standard output.  The -script option is  fully
833              documented in x3270-script(1).
834

COMPOSITE CHARACTERS

836       x3270  allows the direct entry of accented letters and special symbols.
837       Pressing and releasing the "Compose" key, followed by two  other  keys,
838       causes  entry  of  the  symbol  combining those two keys.  For example,
839       "Compose" followed by the "C" key and the "," (comma) key,  enters  the
840       "C-cedilla"  symbol.   A  C  on  the  status  line  indicates a pending
841       composite character.
842
843       The mappings between these pairs of ordinary keys and the symbols  they
844       represent  is  controlled  by the "x3270.composeMap" resource; it gives
845       the  name  of  the  map  to  use.   The  maps  themselves   are   named
846       "x3270.composeMap.name".  The default is "latin1", which gives mappings
847       for most of the symbols in the ISO 8859-1 Latin-1  character  set  that
848       are not in the 7-bit ASCII character set.
849
850       Note:  The  default  keymap  defines  the  "Multi_key"  keysym  as  the
851       "Compose" key.  If your keyboard lacks such a key, you may set up  your
852       own  "Compose"  key  with a keymap that maps some other keysym onto the
853       Compose action.
854

APL SUPPORT

856       x3270 supports the full  APL2  character  set  and  the  entry  of  APL
857       characters from the keyboard.
858
859       APL characters are supported only in the special 3270 font.
860
861       Keyboard  entry  of  APL characters is supported through the apl keymap
862       modifier.  This modifier defines the "Alt" key as  an  APL  shift  key,
863       with  a typical APL keyboard layout, e.g., "Alt" pressed with the A key
864       results in the APL  "alpha"  symbol.   Overstruck  characters  such  as
865       "quad-quote"  are  not  defined  as single keystrokes; instead they are
866       entered as composites (see  COMPOSITE  CHARACTERS  above).   A  special
867       composite map, apl, is provided for this purpose.
868
869       Note:  Some  keyboards  do  not  define the "Alt" key as a modifier, so
870       keymaps that use the "Alt"  key  will  not  function.   On  a  Sun  for
871       example, this can be remedied with the command:
872
873              xmodmap -e "add mod2 = Alt_L"
874
875       For  convenience,  an  -apl option is defined, which is an abbreviation
876       for the following resource definitions:
877              x3270.keymap: your_keymap_name,apl
878              x3270.charset: apl
879              x3270.composeMap: apl
880
881       There are a number of APL characters that are similar in appearance  to
882       non-APL  characters.   In particular, the APL "stile", "slope," "tilde"
883       and "quotedot" characters are similar to the EBCDIC "bar", "backslash,"
884       "tilde"  and "exclaim" characters.  The APL characters are entered with
885       the "Alt" key, and have slightly different appearances.
886
887       The complete list of special APL keysyms is as follows.  Entries marked
888       with  an  asterisk  (*)  represent  simple  aliases for standard EBCDIC
889       characters.  Entries marked with an (S) represent Sharp APL charatcers.
890
891       APL Symbol      Hex   x3270 apl_      x3270 Key   x3270
892                             Keysym                      Composed Keys
893       ────────────────────────────────────────────────────────────────
894       A underbar      41    Aunderbar       Alt-A       A + underbar
895       alpha           B0    alpha           Alt-a
896       B underbar      42    Bunderbar       Alt-B       B + underbar
897       bar             60*   bar             -
898       brace left      C0    braceleft       Alt-{
899       brace right     D0    braceright      Alt-}
900       C underbar      43    Cunderbar       Alt-C       C + underbar
901       circle          9D    circle          Alt-o
902       circle bar      ED    circlebar                   circle + bar
903
904
905       circle slope    CF    circleslope                 circle +
906                                                         slope
907       circle star     FD    circlestar                  circle + star
908       circle stile    CD    circlestile                 circle +
909                                                         stile
910       colon           7A*   colon           :
911       comma           6B*   comma           ,
912       comma bar (S)   E5    commabar                    comma + bar
913       D underbar      44    Dunderbar       Alt-D       D + underbar
914       del             BA    del             Alt-g
915       del stile       DC    delstile                    del + stile
916       del tilde       FB    deltilde                    del + tilde
917       delta           BB    delta           Alt-h
918       delta stile     DD    deltastile                  delta + stile
919       delta           FC    deltaunderbar               delta +
920       underbar                                          underbar
921       diamond         70    diamond                     up caret +
922                                                         down caret
923       dieresis        72    dieresis        Alt-1
924       dieresis        E5    dieresis‐                   dieresis +
925       circle (S)            circle                      circle
926       dieresis dot    EC    dieresisdot                 dieresis +
927                                                         dot
928       dieresis jot    E4    dieresisjot                 dieresis +
929       (S)                                               jot
930       divide          B8    divide          Alt-+
931       dot             4B*   dot
932       down arrow      8B    downarrow       Alt-u
933       down caret      78    downcaret       Alt-9
934       down caret      CB    downcaret‐                  down caret +
935       tilde                 tilde                       tilde
936       down shoe       AB    downshoe        Alt-v
937       down stile      8E    downstile       Alt-d
938       down tack       AC    downtack        Alt-b
939       down tack jot   FE    downtackjot                 down tack +
940                                                         jot
941       down tack up    DA    downtack‐                   down tack +
942       tack                  uptack                      up tack
943       E underbar      45    Eunderbar       Alt-E       E + underbar
944       epsilon         B1    epsilon         Alt-e
945       epsilon         75    epsilon‐                    epsilon +
946       underbar              underbar                    underbar
947       equal           7E*   equal           "="
948       equal           E1    equalunderbar               equal +
949       underbar                                          underbar
950       euro (S)        E7    euro                        C + =
951       F underbar      46    Funderbar       Alt-F       F + underbar
952       G underbar      47    Gunderbar       Alt-G       G + underbar
953       greater         6E*   greater         >
954       H underbar      48    Hunderbar       Alt-H       H + underbar
955       I underbar      49    Iunderbar       Alt-I       I + underbar
956       iota            B2    iota            Alt-i
957       iota underbar   74    iotaunderbar                iota +
958                                                         underbar
959       J underbar      51    Junderbar       Alt-J       J + underbar
960       jot             AF    jot             alt-j
961       K underbar      52    Kunderbar       Alt-K       K + underbar
962       L underbar      53    Lunderbar       Alt-L       L + underbar
963       left arrow      9F    leftarrow       Alt-[
964       left bracket    AD    leftbracket     [
965       left paren      4D*   leftparen       (
966       left shoe       9B    leftshoe        Alt-z
967       less            4C*   less            <
968       M underbar      54    Munderbar       Alt-M       M + underbar
969       N underbar      55    Nunderbar       Alt-N       N + underbar
970       not equal       BE    notequal        Alt-8       equal + slash
971       not greater     8C    notgreater      Alt-4       less + equal
972       not less        AE    notless         Alt-6       greater +
973                                                         equal
974
975       O underbar      56    Ounderbar       Alt-O       O + underbar
976       omega           B4    omega           Alt-w
977       overbar         A0    overbar         Alt-2
978       P underbar      57    Punderbar       Alt-P       P + underbar
979       plus            4E*   plus            +
980       Q underbar      58    Qunderbar       Alt-Q       Q + underbar
981       quad            90    quad            Alt-l
982       quad divide     EE    quaddivide                  quad + divide
983       quad jot        73    quadjot                     quad + jot
984       quad quote      DE    quadquote                   quad + quote
985       quad slope      CE    quadslope                   quad + slope
986       query           6F*   query           ?
987       quote           7D*   quote
988       quote dot       DB    quotedot                    quote + dot
989       R underbar      59    Runderbar       Alt-R       R + underbar
990       rho             B3    rho             Alt-r
991       right arrow     8F    rightarrow      Alt-]
992       right bracket   BD    rightbracket    ]
993       right paren     5D*   rightparen      )
994       right shoe      9A    rightshoe       Alt-x
995       S underbar      62    Sunderbar       Alt-S       S + underbar
996       semicolon       5E*   semicolon       ;
997       slash           61*   slash           /
998       slash bar       EA    slashbar                    slash + bar
999       slope           B7    slope           Alt-\
1000       slope bar       EB    slopebar                    slope + bar
1001       squad           CC    squad                       quad + quad
1002       star            5C*   star            *
1003       stile           BF    stile           Alt-|
1004       T underbar      63    Tunderbar       Alt-T       T + underbar
1005       tilde           80    tilde           Alt-~
1006       times           B6    times           Alt-=
1007       U underbar      64    Uunderbar       Alt-U       U + underbar
1008       underbar        6D*   underbar        "_"
1009       up arrow        8A    uparrow         Alt-y
1010       up caret        71    upcaret         Alt-0
1011       up caret        CA    upcarettilde                up caret +
1012       tilde                                             tilde
1013       up shoe         AA    upshoe          Alt-c
1014       up shoe jot     DF    upshoejot                   up shoe + jot
1015       up stile        8D    upstile         Alt-s
1016       up tack         BC    uptack          Alt-n
1017       up tack jot     EF    uptackjot                   up tack + jot
1018       V underbar      65    Vunderbar       Alt-V       V + underbar
1019       W underbar      66    Wunderbar       Alt-W       W + underbar
1020       X underbar      67    Xunderbar       Alt-X       X + underbar
1021       Y underbar      68    Yunderbar       Alt-Y       Y + underbar
1022       Z underbar      69    Zunderbar       Alt-Z       Z + underbar
1023

XIM SUPPORT

1025       When  compiled  with  DBCS  support,  x3270  supports  multi-byte input
1026       methods via the XIM protocol.
1027
1028       The input method is selected by the XMODIFIERS environment variable  or
1029       the -im command-line option.
1030
1031       The  preedit  type  is specified by the -pt command-line option, with a
1032       default of OverTheSpot+1.
1033

SCREEN PRINTING

1035       Screen printing is handled through options on the File menu or  by  the
1036       PrintText and PrintWindow actions.  Each results in a pop-up to confirm
1037       the print command.
1038
1039       The PrintText action (usually assigned to the key  <Meta>p)  sends  the
1040       current  screen  image to the printer as ASCII characters.  The default
1041       command   used   to   print   the   data   is   controlled    by    the
1042       "x3270.printTextCommand"  resource;  the  default is lpr.  You may also
1043       use a keymap definition to pass a print command  the  PrintText  action
1044       itself.   The  command  receives the screen text as its standard input.
1045       For example, the following keymap will save the screen text in a file:
1046
1047              Meta<Key>f: PrintText("cat >screen.image")
1048
1049       Note: HardPrint is an alias for PrintText.
1050
1051       The PrintWindow action (usually assigned to the key <Meta>b) sends  the
1052       current  screen  image to the printer as a bitmap.  The default command
1053       used to print the data is controlled by the  "x3270.printWindowCommand"
1054       resource; the default is
1055
1056              xwd -id %d | xpr | lpr.
1057
1058       You  may  also  use  a keymap definition to pass a print command to the
1059       PrintWindow action itself.  If the command contains the text "%d",  the
1060       window  ID of x3270 will be substituted before it is run.  For example,
1061       the following keymap will pop up a  duplicate  of  the  current  screen
1062       image:
1063
1064              Meta<Key>g: PrintWindow("xwd -id %d | xwud &")
1065
1066       If  the  command  for  PrintWindow  or  PrintText  begins  with  an "@"
1067       character, the initial pop-up menu to confirm the print command is  not
1068       displayed and the command cannot be edited.
1069

BUGS

1071       Cursor  highlighting  will  not  work  with if you use the NoTitleFocus
1072       option in your .twmrc file.
1073
1074

PASSTHRU

1076       x3270  supports  the  Sun  telnet-passthru  service  provided  by   the
1077       in.telnet-gw server.  This allows outbound telnet connections through a
1078       firewall machine.  When a p: is prepended to  a  hostname,  x3270  acts
1079       much  like  the  itelnet(1)  command.   It  contacts  the machine named
1080       internet-gateway at  the  port  defined  in  /etc/services  as  telnet-
1081       passthru  (which  defaults  to  3514).   It  then  passes the requested
1082       hostname and port to the in.telnet-gw server.
1083

PROXY

1085       The -proxy option or the x3270.proxy resource causes  x3270  to  use  a
1086       proxy  server  to  connect  to  the  host.  The syntax of the option or
1087       resource is:
1088              type:host[:port]
1089
1090       The supported values for type are:
1091
1092                    Proxy Type   Protocol            Default Port
1093                    ──────────────────────────────────────────────
1094                       http      RFC 2817 HTTP           3128
1095                                 tunnel (squid)
1096                     passthru    Sun in.telnet-gw        none
1097                      socks4     SOCKS version 4         1080
1098                      socks5     SOCKS version 5         1080
1099                                 (RFC 1928)
1100                      telnet     No protocol (just       none
1101                                 send connect host
1102                                 port)
1103
1104       The special types socks4a and socks5d can also be  used  to  force  the
1105       proxy server to do the hostname resolution for the SOCKS protocol.
1106

FILES

1108       /etc/ibm_hosts
1109       $HOME/.x3270pro
1110
1111

ENVIRONMENT VARIABLES

1113       3270PRO  Path of profile file, containing resource definitions.  Merged
1114       after the system resource database, but before X3270RDB.   Defaults  to
1115       $HOME/.x3270pro.
1116       NOX3270PRO If set, do not read the profile.
1117       X3270RDB Additional resource definitions, merged after the profile file
1118       but before the command-line options.
1119       KEYMAP Keymap name.
1120       KEYBD Keymap name.
1121

SEE ALSO

1123       s3270(1),   c3270(1),   tcl3270(1),   ibm_hosts(5),    x3270-script(1),
1124       telnet(1), tn3270(1)
1125       X Toolkit Intrinsics
1126       Data Stream Programmer's Reference, IBM GA23-0059
1127       Character Set Reference, IBM GA27-3831
1128       RFC 1576, TN3270 Current Practices
1129       RFC 1646, TN3270 Extensions for LUname and Printer Selection
1130       RFC 2355, TN3270 Enhancements
1131

COPYRIGHTS

1133       Copyright 1993-2013, Paul Mattes.
1134       Copyright 2004-2005, Don Russell.
1135       Copyright 2004, Dick Altenbern.
1136       Copyright 1990, Jeff Sparkes.
1137       Copyright 1989, Georgia Tech Research Corporation (GTRC), Atlanta, GA
1138        30332.
1139       All rights reserved.
1140
1141       Redistribution  and  use  in  source  and binary forms, with or without
1142       modification, are permitted provided that the following conditions  are
1143       met:
1144
1145
1146       *      Redistributions  of  source code must retain the above copyright
1147              notice, this list of conditions and the following disclaimer.
1148
1149       *      Redistributions  in  binary  form  must  reproduce   the   above
1150              copyright  notice,  this  list  of  conditions and the following
1151              disclaimer in the documentation and/or other materials  provided
1152              with the distribution.
1153
1154       *      Neither  the  names of Paul Mattes, Don Russell, Dick Altenbern,
1155              Jeff Sparkes, GTRC nor the names of their  contributors  may  be
1156              used  to  endorse or promote products derived from this software
1157              without specific prior written permission.
1158
1159
1160       THIS SOFTWARE IS PROVIDED BY PAUL MATTES, DON RUSSELL, DICK  ALTENBERN,
1161       JEFF  SPARKES  AND  GTRC "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
1162       INCLUDING,  BUT   NOT   LIMITED   TO,   THE   IMPLIED   WARRANTIES   OF
1163       MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
1164       NO EVENT SHALL PAUL MATTES, DON RUSSELL, DICK ALTENBERN,  JEFF  SPARKES
1165       OR  GTRC  BE  LIABLE  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL
1166       EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,  BUT  NOT  LIMITED  TO,
1167       PROCUREMENT  OF  SUBSTITUTE  GOODS  OR  SERVICES; LOSS OF USE, DATA, OR
1168       PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY  OF
1169       LIABILITY,  WHETHER  IN  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1170       NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT  OF  THE  USE  OF  THIS
1171       SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1172

VERSION

1174       x3270 3.3.12ga12
1175
1176
1177
1178                               26 February 2013                       x3270(1)
Impressum