source: trunk/third/x3270/x3270.man @ 11123

Revision 11123, 40.2 KB checked in by ghudson, 27 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r11122, which included commits to RCS files with non-trunk default branches.
Line 
1'\" t
2.TH X3270 1 "13 February 1997"
3.SH NAME
4x3270 \-
5.SM IBM
6host access tool
7.SH SYNOPSIS
8.B x3270
9[
10.I options
11] [ [
12.IB prefix:
13]
14.I hostname
15[
16.I port
17] ]
18.SH DESCRIPTION
19.B x3270
20opens a telnet connection to an
21.SM IBM
22host in an X window.
23The window created by
24.B x3270
25can use its own font for displaying characters, so it is a fairly accurate
26representation of an
27.SM IBM
283278 or 3279.
29It is similar to
30.IR tn3270 (1)
31except that it is X-based, not curses-based.
32.LP
33Prepending a
34.B p:
35onto
36.I hostname
37causes the connection to go through the
38.I telnet-passthru
39service rather than directly to the host.
40See PASSTHRU below.
41.LP
42Prepending an
43.B s:
44onto
45.I hostname
46removes the "extended data stream" option reported to the host.
47See
48.B \-tn
49below for further information.
50.LP
51The port to connect to defaults to
52.BR telnet .
53This can be overridden with the
54.RI \- port
55option, or by specifying a
56.I port
57on the command line.
58.SH OPTIONS
59.B x3270
60is a toolkit based program, so it understands standard options and resources.
61It also understands the following options:
62.TP
63.B \-activeicon
64Specifies that the icon should be a miniature version of the screen image.
65See
66.SM ICONS
67below.
68.TP
69.B \-apl
70Sets up
71.SM APL
72mode.
73This is actually an abbreviation for several options.
74See
75.SM "APL SUPPORT"
76below.
77.TP
78.BI \-cc " range" : "value" "[,...]
79Sets character classes.
80See CHARACTER CLASSES, below.
81.TP
82.BI \-charset " name"
83Specifies an
84.SM EBCDIC
85national character set.
86See
87.SM CHARACTER SETS
88below.
89.TP
90.BI \-clear " toggle"
91Sets the initial value of
92.I toggle
93to
94.B false.
95The list of toggle names is under
96.SM MENUS
97below.
98.TP
99.BI \-efont " name"
100Specifies a font for the emulator window.
101See
102.SM FONTS
103below.
104.TP
105.BI \-iconname " name"
106Specifies an alternate title for the program icon.
107.TP
108.BI \-iconx " x"
109Specifies the initial x coordinate for the program icon.
110.TP
111.BI \-icony " y"
112Specifies the initial y coordinate for the program icon.
113.TP
114.BI \-keymap " name"
115Specifies a keymap name and optional modifiers.
116See
117.SM KEYMAPS
118below.
119.TP
120.B \-keypad
121Turns on the keypad as soon as
122.B x3270
123starts.
124.TP
125.BI \-model " name"
126The model of 3270 display to be emulated.
127The model name is in three parts, any of which may be omitted:
128.IP
129The first part is the
130.BR "base model" ,
131which is either
132.B 3278
133or
134.BR 3279 .
135.B 3278
136specifies a monochrome 3270 display;
137.B 3279
138specifies a color 3270 display.
139When 3278 emulation is specified for a color X display, fields are displayed
140using pseudo-colors; see
141.SM PSEUDO-COLOR
142below.
143.IP
144The second part is the
145.BR "model number" ,
146which specifies the number of rows and columns.
147Model 4 is the default.
148.PP
149.RS
150.TS
151center;
152c c c .
153Model Number    Columns Rows
154_
1552       80      24
1563       80      30
1574       80      43
1585       132     27
159.TE
160.RE
161.IP
162Note: Technically, there is no such 3270 display as a 3279-4 or 3279-5, but
163most hosts seem to work with them anyway.
164.IP
165The third part specifies the Extended 3270 Data Stream, and is given as
166.B \-E.
167It signals the host that the 3270 display is capable of displaying
168extended field attributes, and supports structured fields and query replies.
169A 3279 always uses the Extended Data Stream (whether or not
170.B \-E
171is specified); for a 3278 it is optional.
172.IP
173The default model for a color X display is
174.B 3279\-4\-E.
175For a monochrome X display, it is
176.BR 3278\-4\-E .
177(The behavior of previous versions of
178.B x3270
179on color X displays can be specified as
180.BR 3278\-4 ).
181.TP
182.B \-mono
183Forces
184.B x3270
185to believe it is running on a monochrome X display.
186.TP
187.B \-once
188Causes
189.B x3270
190to exit after a host disconnects.
191This option has effect only if a hostname is specified on the command line.
192.TP
193.BI \-oversize " cols" x rows
194Makes the screen larger than the default for the chosen model number.
195This option has effect only in combination with extended data stream support
196(the
197.B \-E
198suffix on the model), and only if the host supports the Query Reply structured
199field.
200The number of columns multiplied by the number of rows must not exceed
20116383 (3fff hex), the limit of 14-bit 3270 buffer addressing.
202.TP
203.BI \-port " n"
204Specifies a different
205.SM TCP
206port to connect to.
207.I n
208can be a name from
209.B /etc/services
210like
211.BR telnet ,
212or a number.
213This option changes the default port number used for all connections.
214(The positional parameter affects only the initial connection.)
215.TP
216.B \-reconnect
217Causes
218.B x3270
219to automatically reconnect to the host if it ever disconnects.
220This option has effect only if a hostname is specified on the command line.
221.TP
222.B \-sb
223Turns on the scrollbar.
224.B +sb turns the scrollbar off.
225.TP
226.BI \-scheme " name"
227Specifes a color scheme to use in 3279 mode.
228This option has effect only in combination with 3279 emulation.
229See
230.SM "COLOR SCHEMES"
231below.
232.TP
233.B \-script
234Causes
235.B x3270
236to read commands from standard input, with the results written to standard
237output.
238The protocol for these commands is documented in
239.IR x3270-script (1).
240.TP
241.BI \-sl " n"
242Specifies that
243.I n
244lines should be saved for scrolling back.
245The default is 64.
246.TP
247.BI \-set " toggle"
248Sets the initial value of
249.I toggle
250to
251.B true.
252The list of toggle names is under
253.SM MENUS
254below.
255.TP
256.BI \-tn " name"
257Specifies the terminal name to be transmitted over the telnet connection.
258The default name is
259.BI IBM\- model_name,
260for example,
261.B IBM\-3279\-4\-E
262for a color X display, or
263.B IBM\-3278\-4\-E
264for a monochrome X display.
265.IP
266Some hosts are confused by the
267.B \-E
268suffix on the terminal name, and will ignore the extra screen area on
269models 3, 4 and 5.
270Prepending an
271.B :s
272on the hostname removes the
273.B \-E
274from the terminal name when connecting to such hosts.
275.IP
276The name can also be specified with the "x3270.termName" resource.
277.TP
278.B \-trace
279Turns on data stream tracing at startup.
280Unlike turning it on from a menu option, there is no pop-up to confirm the
281file name, which defaults to
282.BI /tmp/x3trc. process_id.
283.SH FONTS
284By default,
285.B x3270
286does not use the "*font" resource for its main window.
287Instead, it uses a custom 14-point font called
288.BR 3270 ,
289which is a close
290approximation of a real 3270 display and allows
291.B x3270
292to display a complete
293.SM EBCDIC
294character set and special status-line symbols.
295A more compact font,
296.BR 3270\-12 ,
297is also supported, as are the various sized fonts
298.BR 3270gt8 ,
299.BR 3270gt12 ,
300.BR 3270gt16 ,
301.BR 3270-20 ,
302.BR 3270gt24 ,
303and
304.BR 3270gt32 .
305The font
306.B 3270h
307is also included to allow display of Hebrew text.
308.LP
309The font may be specified with the
310.B \-efont
311option or the "x3270.emulatorFont" resource.
312.LP
313.B x3270
314can also use any constant-spaced X font, but unless the font implements the
315entire
316.SM ISO
3178859\-1 (Latin-\1) character set,
318.B x3270
319may not properly display several
320.SM EBCDIC
321graphics that do not have
322.SM ASCII
323equivalents.
324.PP
325One additional font,
326.BR 3270d ,
327is supplied.
328This font is identical to the default
329.B 3270
330font, except that it has bitmaps defined for field attribute characters.
331This means that field attributes, which are normally displayed as blanks,
332are now visible on the screen.
333The characters displayed are hexadecimal codes, which can be translated
334using a document provided with the
335.B x3270
336sources.
337.LP
338The font can be changed at any time through a menu option.
339It can also be implicitly changed by changing the size of the
340.B x3270
341window with the mouse: if the window is made larger, x3270 will try to
342change to a larger font, and vice-versa.
343.SH "CHARACTER SETS"
344The
345.B \-charset
346option or the "x3270.charset" resource controls the
347.SM EBCDIC
348national character set used by
349.B x3270.
350Available sets include:
351.PP
352.TS
353center;
354l c
355lfB c.
356Charset Name    Q121 Code
357_
358bracket \-
359us-intl 01
360german  03
361finnish 09
362uk      22
363norwegian       23
364french  30
365hebrew* \-
366.TE
367.IP
368(*) requires a special font,
369.B 3270h
370.PP
371The default character set is
372.BR bracket ,
373which is useful for common
374.SM IBM
375hosts which use
376.SM EBCDIC
377codes 0xAD and 0xBD for the `[' and `]' characters, respectively.
378.PP
379You can also specify national-language translations for your keyboard; see
380.SM KEYMAPS
381below.
382.SH "CHARACTER CLASSES"
383.B x3270
384supports character classes (groupings of characters chosen with a double
385mouse click) in the same manner as
386.IR xterm (1).
387The "x3270.charClass" resource or the
388.B \-cc
389option can be used to alter the character class table.
390The default table is the same as
391.IR xterm "'s;"
392It groups letters together, and puts most punctuation characters in individual
393classes.
394To put all non-whitespace characters together in the same class (and
395duplicate the behavior of some early versions of
396.BR x3270 ),
397use the following value:
398.PP
399.nf
400    33-127:48,161-255:48
401.fi
402.PP
403See
404.IR xterm (1)
405for further syntax details.
406.SH KEYPAD
407A keypad may optionally be displayed, with a mouse-clickable button for each
4083270 function key (these functions are also available from the keyboard).
409The keypad can be turned on and off by clicking on the "keypad" button in the
410upper-right-hand corner of the window.
411The "x3270.keypad" resource controls where it is displayed.
412Options are:
413.PP
414.TS
415center;
416l l.
417left    in a separate window, to the left of the screen
418right   in a separate window, to the right of the screen
419bottom  in a separate window, below the screen
420integral        in the same window as the screen, below it
421.TE
422.PP
423The default is
424.B right.
425.PP
426If the "x3270.keypadOn" resource is set to
427.BR true ,
428the keypad will be displayed at startup.
429.SH "HOSTS DATABASE"
430.B x3270
431uses the
432.I ibm_hosts
433database to construct a pull-down menu of hosts to connect to.
434It supports the
435.B loginstring
436function, which allows you to specify a macro to be sent to the host when the
437connection is first made.
438See
439.IR ibm_hosts (5)
440for details.
441.LP
442You may specify a different
443.I ibm_hosts
444database with the "x3270.hostsFile" resource.
445.SH "COLOR SCHEMES"
446When emulating a 3279 display, the X colors used to draw the display
447are selected by two resources: the "x3270.colorScheme" resource, which gives
448the name of the color scheme to use, and the
449individual "x3270.colorScheme.\fIxxx\fP" resources, which
450give the actual definitions.
451The color scheme resources are documented in the
452.B Docs/Resources
453file with the
454.B x3270
455source.
456.LP
457The color scheme may also be changed while
458.B x3270
459is running with a selection from the
460.B Options
461menu.
462.SH PSEUDO-COLOR
463When emulating a 3278 display on a color X display,
464.B x3270
465does not understand
466.SM IBM
4673270 color protocols.
468Instead, it draws text in one of three colors depending on the field attributes.
469Those colors may be customized using the following resources (shown with their
470default values):
471.nf
472        x3270.normalColor:      green
473        x3270.boldColor:        cyan
474        x3270.inputColor:       orange
475        x3270.colorBackground:  black
476        x3270.selectBackground: dim gray
477.fi
478.SH "ANSI MODE"
479Some hosts use an
480.SM ASCII
481front-end to do initial login negotiation, then later switch to 3270 mode.
482.B x3270
483will emulate an
484.SM ANSI
485X.64 terminal until the host places it in 3270 mode (telnet
486.SM BINARY
487and
488.SM "SEND EOR"
489modes).
490The emulation is fairly complete; however, it is not intended to make
491.B x3270
492a replacement for
493.IR xterm (1).
494.PP
495If the host later negotiates to stop functioning in 3270 mode,
496.B x3270
497will return to
498.SM ANSI
499emulation.
500.PP
501When emulating an
502.SM ANSI
503terminal,
504.B x3270
505supports both character-at-a-time mode and line mode operation.
506You may select the mode with a menu option.
507When in line mode, the special characters and operational characteristics are
508defined by resources:
509.PP
510.TS
511center;
512l c c.
513Mode/Character  Resource        Default
514_
515Translate CR to NL      x3270.icrnl     true
516Translate NL to CR      x3270.inlcr     false
517Erase previous character        x3270.erase     ^?
518Erase entire line       x3270.kill      ^U
519Erase previous word     x3270.werase    ^W
520Redisplay line  x3270.rprnt     ^R
521Ignore special meaning of next character        x3270.lnext     ^V
522Interrupt       x3270.intr      ^C
523Quit    x3270.quit      ^\\\\
524End of file     x3270.eof       ^D
525.TE
526.SH MENUS
527.B x3270
528has a menu bar with three pull-down menus (File, Options, and
529Connect) and a button to turn the keypad on and off.
530The pull-down menus are also available as pop-up menus by using the "Ctrl"
531key and the left, middle and right mouse buttons, respectively.
532.PP
533The menu bar can be turned off by setting the "x3270.menuBar" resource to
534.B false.
535.PP
536Many sections of the File and Options menus are toggles,
537options that may be either on or off.
538The entries under the File menu are as follows:
539.TP
540.B File Transfer
541Initiates transferring a file between the IBM host and the local workstation,
542using the
543.B IND$FILE
544protocol.
545A pop-up menu allows specifying the file names and other attributes of the
546transfer.
547.br
548The IND$FILE program must be installed on the IBM host, and the 3270 cursor
549must be located in a field that will accept a TSO or VM/CMS command.
550.TP
551.B Trace Data Stream
552If set, network traffic (both a hexadecimal representation and its
553interpretation) are logged to the file
554.BI /tmp/x3trc. process_id,
555and a window is popped up to monitor the data.
556The file name is confirmed with a pop-up; the default directory name for the
557trace file can be changed with the "x3270.traceDir" resource.
558.TP
559.B Trace X Events
560If set, information about X events and the actions that
561.B x3270
562takes in response are logged to a file.
563This is the same file as used for tracing the data stream, above.
564X event tracing is useful for creating and debugging custom keymaps, macros
565and scripts.
566For example, it will tell you precisely what action was taken in response to
567pressing a particular key.
568If the key is not mapped, it will tell you the keysym name and keycode so you
569can add it to a custom keymap.
570.TP
571.B Save Screen(s) in File
572If set, saves an
573.SM ASCII
574representation of the current screen image in the file
575.BI /tmp/x3scr. process_id.
576A pop-up allows the file name to be changed; the default directory name can be
577changed with the "x3270.traceDir" resource.
578The pop-up also has buttons to choose between saving just the current image,
579or continuously saving it as it is redrawn.
580.TP
581.B Save Changed Options in File
582Saves into a file the values of all options that have been changed since
583.B x3270
584was started.
585A pop-up allows the file name to be changed; the default file is
586.B .x3270pro
587in the user's home directory.
588If the file already exists, it is appended to.
589.B x3270
590will read the contents of this file the next time it starts up.
591The options settings in the file override any resources defined
592with
593.B xrdb
594or in the user's
595.B .Xdefaults
596file; command-line switches override the file.
597A different options file can be specified by the
598.B X3270PRO
599environment variable.
600If the environment variable
601.B NOX3270PRO
602is set, no options file will be read.
603.TP
604.B Execute an Action
605Allows an action name and parameters to be entered from the keyboard.
606This allows experimentation with actions without having to edit keymaps
607and repeatedly restart
608.B x3270.
609.LP
610The toggles under the Options menu are as follows:
611.TP
612.B Monocase
613If set,
614.B x3270
615operates in uppercase-only mode.
616.TP
617.B Blinking Cursor
618If set, the cursor blinks once per second.
619.TP
620.B Blank Fill
621If set,
622.B x3270
623behaves in some un-3270-like ways.
624First, when a character is typed into a field, all nulls in the field to the
625left of that character are changed to blanks.
626This eliminates a common 3270 data-entry surprise.
627Second, in insert mode, trailing blanks in a field are treated like nulls,
628eliminating the annoying ``lock-up'' that often occurs when inserting into an
629field with (apparent) space at the end.
630.TP
631.B Show Timing
632If set, the time taken by the host to process an
633.SM AID
634is displayed on the status line.
635.TP
636.B Track Cursor
637If set, the cursor position is displayed on the status line.
638.TP
639.B Scrollbar
640If set, the scrollbar appears.
641.TP
642.B Wraparound
643If set, the
644.SM ANSI
645terminal emulator automatically assumes a
646.SM NEWLINE
647character when it reaches the end of a line.
648.TP
649.B "Paste with Left Margin"
650If set, puts restrictions on how pasted text is placed on the screen.
651The position of the cursor at the time the paste operation is begun is
652used as a left margin.
653No pasted text will fill any area of the screen to the left of that
654position.
655This option is useful for pasting into certain
656.SM IBM
657editors that use the left side of the screen for control information.
658.TP
659.B "Select by Rectangles"
660If set,
661.B x3270
662will always select rectangular areas of the screen.
663Otherwise,
664.B x3270
665selects by rectangles when in 3270 mode, but in
666.SM ANSI
667mode it selects continuous regions of the screen like
668.IR xterm (1).
669.PP
670The names of the toggles for use with the
671.B -set
672and
673.B -clear
674options are as follows:
675.LP
676.TS
677center;
678l l .
679Menu Option     Name
680_
681Monocase        monoCase
682Blinking Cursor cursorBlink
683Blank Fill      blankFill
684Show Timing     showTiming
685Track Cursor    cursorPos
686Trace Data Stream       dsTrace
687Trace X Events  eventTrace
688Save Screen(s) in File  screenTrace
689Scrollbar       scrollBar
690Wraparound      lineWrap
691Paste with Left Margin  marginedPaste
692Select by Rectangles    rectangleSelect
693.TE
694.LP
695In addition, the toggle
696.B altCursor
697can be used to select the cursor type.
698If set, an underline cursor will be used.
699If clear, the normal block cursor will be used.
700.LP
701These names also represent resources that can be set in your .Xdefaults
702file.
703For example, if you always want to have the scrollbar on, you can add
704the following to your .Xdefaults:
705.br
706    x3270.scrollBar:    true
707.br
708.SH "STATUS LINE"
709The
710.B x3270
711status line contains a variety of information.
712From left to right, the fields are:
713.TP
714.B "comm status"
715Three symbols indicate the state of the connection to the host.
716If connected, the right-hand symbol is a solid box; if not, it is a
717question mark.
718.TP
719.B "keyboard lock"
720If the keyboard is locked, an "X" symbol and a message field indicate the
721reason for the keyboard lock.
722.TP
723.B "shift"
724Three characters indicate the keyboard modifier status.
725"M" indicates the Meta key, "A" the Alt key, and an up-arrow or "^"
726indicates the Shift key.
727.TP
728.B "compose"
729The letter "C" indicates that a composite character is in progress.
730If another symbol follows the "C", it is the first character of the
731composite.
732.TP
733.B "typeahead"
734The letter "T" indicates that one or more keystrokes are in the typeahead
735buffer.
736.TP
737.B "temporary keymap"
738The letter "K" indicates that a temporary keymap is in effect.
739.TP
740.B "reverse"
741The letter "R" indicates that the keyboard is in reverse field entry mode.
742.TP
743.B "insert mode"
744A thick caret "^" or the letter "I" indicates that the keyboard is in insert
745mode.
746.TP
747.B "timing"
748A clock symbol and a time in seconds indicate the time it took to process
749the last
750.SM AID
751or the time to connect to a host.
752This display is optional.
753.TP
754.B "cursor position"
755The cursor row and column are optionally displayed, separated by a "/".
756.SH ICONS
757If the
758.B \-activeicon
759option is given (or the "x3270.activeIcon" resource is set to
760.BR true ),
761.B x3270
762will attempt to make its icon a miniature version of the current screen image.
763This function is highly dependent on your window manager:
764.TP
765.B mwm
766The size of the icon is limited by the "Mwm.iconImageMaximum" resource, which
767defaults to
768.B 50x50.
769The image will be clipped at the bottom and right.
770The icon cannot accept keyboard input.
771.TP
772.B olwm
773The full screen image of all 3270 models can be displayed on the icon.
774However, the icon cannot be resized, so if the model is later changed with an
775.B x3270
776menu option, the icon image will be corrupted.
777The icon cannot accept keyboard input.
778.TP
779.BR twm " and " tvtwm
780The full screen image of all 3270 models can be displayed on the icon, and the
781icon can be resized.
782The icon can accept keyboard input.
783.IP
784However,
785.B twm
786does not put labels on application-supplied icon windows.
787You can have
788.B x3270
789add its own label to the icon by setting the "x3270.labelIcon" resource to
790.B true.
791The default font for icon labels is
792.BR 8x13 ;
793you may change it with the "x3270.iconLabelFont" resource.
794.SH KEYMAPS
795.PP
796The type of keyboard may be specified with the
797.B \-keymap
798switch or using either the
799.SM KEYMAP
800or
801.SM KEYBD
802environment variables.
803The types of supported keyboards include
804.BR sun_k3 ,
805.BR sun_k4 ,
806.BR sun_k5 ,
807.BR hp\-k1 ,
808.B hp\-pc
809and
810.BR ncd .
811.PP
812The keymap may also be specified as a comma-separated list of names.
813Later definitions override earlier ones.
814This is used to specify both a primary keyboard type and a set of modifiers.
815The modifiers defined include:
816.TP
817.B ow
818(OpenWindows) Swaps the middle and right mouse button definitions, so the
819middle button performs the "Extend" function and the right-hand button
820performs the "Paste" function.
821Also changes the cut and paste actions to use the OpenWindows
822.SM CLIPBOARD.
823.TP
824.B alt
825Replaces the default "Meta" key definitions with "Alt" definitions,
826for keyboards which do not have a "Meta" key.
827.TP
828.B apl
829Allows entry of
830.SM APL
831characters (see
832.SM "APL SUPPORT"
833below).
834.TP
835.B finnish7
836Replaces the bracket, brace and bar keys with common Finnish characters.
837.TP
838.B norwegian7
839Replaces the bracket, brace and bar keys with common Norwegian characters.
840.PP
841A temporary keymap can also be specified while
842.B x3270
843is running with the Keymap() action.
844When the action Keymap(\fIn\fP) is executed, temporary keymap
845.I n
846is added to or deleted from the current keymap.
847Multiple temporary keymaps can be active simultaneously.
848The action Keymap(None) restores the original keymap.
849.B Note:
850When Keymap() is specified as part of a list of multiple actions in a keymap,
851it must be the last action in the list.
852.PP
853The temporary keymap
854.B hebrew
855is provided to allow entry of Hebrew characters.
856.PP
857The X Toolkit translation mechanism is used to provide keyboard emulation.
858It maps
859.B events
860into
861.B actions.
862The best documentation can be found with X toolkit documents, but the
863following should suffice for simple customization.
864.PP
865An Xt event consists of (at least) four fields.  The first is called a
866.B modifier.
867It may be any combination of meta, shift and ctrl.  If it is prefaced by !,
868it means those modifiers only.  The second field is the specific event,
869in
870.B x3270
871usually just <Key>.  The third field is the detail field, which gives the
872actual key.  The name of the key may be determined using the
873.I xev
874program or with the "Trace X Events" menu option.
875The last field is the action, which is the internal emulator function.
876A complete list of actions may be found later in the manual.
877.PP
878There are three levels of translation tables in
879.B x3270.
880The first is a default, compiled in table. It defines alphabetic, numeric,
881function keys, and such basic functions as Enter and Delete.  It allows a
882minimal useful functionality.
883.PP
884The second level is a keyboard specific table, which is found in the
885application default file, which defines actions for such things as keypad
886keys, and keys unique to certain keyboards.
887.PP
888The third level is a user customizable table which may be used to augment or
889override key definitions.  This will typically be found in the users
890.B .Xdefaults
891file.
892The naming for a sun4 keyboard would be:
893.RS
894x3270.keymap.default:
895.br
896x3270.keymap.sun_k4:
897.br
898x3270.keymap.sun_k4.user:
899.RE
900.PP
901The basic default translation table is:
902.RS
903.TS
904l l .
905<Key>Multi_key  Compose()
906Shift<Key>Return        Newline()
907<Key>Return     Enter()
908<Key>Linefeed   Newline()
909Shift<Key>Tab   BackTab()
910<Key>Tab        Tab()
911<Key>Home       Home()
912Meta<Key>Left   PreviousWord()
913<Key>Left       Left()
914Meta<Key>Right  NextWord()
915<Key>Right      Right()
916<Key>Up Up()
917<Key>Down       Down()
918<Key>Insert     Insert()
919<Key>Delete     Delete()
920<Key>BackSpace  BackSpace()
921Ctrl<Btn1Down>  HandleMenu(quitMenu)
922Ctrl<Btn2Down>  HandleMenu(optionsMenu)
923Ctrl<Btn3Down>  HandleMenu(hostMenu)
924Shift<Btn1Down> MoveCursor()
925<Btn1Down>      select\-start()
926<Btn1Motion>    select\-extend()
927<Btn2Down>      ignore()
928<Btn2Motion>    ignore()
929<Btn2Up>        insert\-selection(PRIMARY)
930<Btn3Down>      start\-extend()
931<Btn3Motion>    select\-extend()
932<BtnUp> select\-end(PRIMARY)
933Meta<Key>F1     PF(13)
934Meta<Key>F2     PF(14)
935Meta<Key>F3     PF(15)
936Meta<Key>F4     PF(16)
937Meta<Key>F5     PF(17)
938Meta<Key>F6     PF(18)
939Meta<Key>F7     PF(19)
940Meta<Key>F8     PF(20)
941Meta<Key>F9     PF(21)
942Meta<Key>F10    PF(22)
943Meta<Key>F11    PF(23)
944Meta<Key>F12    PF(24)
945<Key>F1 PF(1)
946<Key>F2 PF(2)
947<Key>F3 PF(3)
948<Key>F4 PF(4)
949<Key>F5 PF(5)
950<Key>F6 PF(6)
951<Key>F7 PF(7)
952<Key>F8 PF(8)
953<Key>F9 PF(9)
954<Key>F10        PF(10)
955<Key>F11        PF(11)
956<Key>F12        PF(12)
957Meta<Key>1      PA(1)
958Meta<Key>2      PA(2)
959Meta<Key>3      PA(3)
960Meta<Key>a      Attn()
961Meta<Key>b      PrintWindow()
962Meta<Key>c      Clear()
963Meta<Key>d      Delete()
964Meta<Key>h      Home()
965Meta<Key>i      Insert()
966Meta<Key>l      Redraw()
967Meta<Key>p      PrintText()
968Meta<Key>q      Quit()
969Meta<Key>r      Reset()
970Ctrl<Key>u      DeleteField()
971Ctrl<Key>w      DeleteWord()
972:<Key>asciicircum       CircumNot()
973:<Key>  Default()
974.TE
975.RE
976.PP
977Meta is the diamond shaped key on a sun_k4, "Alt" on an
978.SM NCD,
979"Extend Char" on an
980.SM HP.
981The following
982.I xmodmap
983command must be used on the
984.SM NCD
985to allow use the the "Alt"
986key:
987.PP
988.RS
989xmodmap \-e "keysym Alt_L = Meta_L"
990.RE
991.PP
992The left mouse button may be used to make a selection.
993Clicking once unselects the current selection.
994Clicking twice selects the word under the mouse cursor.
995Clicking three times selects the line under the mouse cursor.
996Clicking and dragging selects a rectangular area of the display.
997.PP
998The middle mouse button may be used to paste a selection.
999.PP
1000The right mouse button may also be used for selections, selecting the
1001rectangular area between the current position and where the left button was
1002last pressed.
1003.PP
1004.PP
1005On color X displays, the "x3270.selectBackground" resource is used to
1006distinguish the selected text from the rest of the screen.
1007On monochrome X displays, selected text is in reverse video.
1008(It can be distinguished from a block cursor because the block cursor covers
1009slightly less than an entire character position on the screen.)
1010.PP
1011The left mouse button, when pressed with the "Shift" key held down, moves the
10123270 cursor to the where the mouse cursor is pointing.
1013.PP
1014This is the complete list of keymap-callable actions.
1015Other actions are defined for use by scripts and are documented in
1016.IR x3270-script (1);
1017still others actions are defined for internal use by
1018.B x3270
1019and are not documented here.
1020.PP
1021.RS
1022.TS
1023l l
1024.
1025Attn    attention key
1026AltCursor       switch between block and underscore cursor
1027BackSpace       move cursor left (or send ASCII BS)
1028BackTab tab to start of previous input field
1029CircumNot       input "^" in ANSI mode, or "notsign" in 3270 mode
1030Clear   clear screen
1031Compose next two keys form a special symbol
1032CursorSelect    Cursor Select AID
1033Cut     erase selected text
1034Default enter key literally
1035Delete  delete character under cursor (or send ASCII DEL)
1036DeleteField     delete the entire field
1037DeleteWord      delete the current or previous word
1038Down    move cursor down
1039Dup     duplicate field
1040Enter   Enter AID (or send ASCII CR)
1041Erase   erase previous character (or send ASCII BS)
1042EraseEOF        erase to end of current field
1043EraseInput      erase all input fields
1044Execute(\fIcmd\fP)      execute a command in a shell
1045FieldEnd        move cursor to end of field
1046FieldMark       mark field
1047HandleMenu(\fIname\fP)  pop up a menu
1048Home    move cursor to first input field
1049Insert  set insert mode
1050Key(\fIkeysym\fP)       insert key \fIkeysym\fP
1051Keymap(\fIkeymap\fP)    toggle alternate \fIkeymap\fP (or remove with \fBNone\fP)
1052Left    move cursor left
1053Left2   move cursor left 2 positions
1054Macro(\fImacro\fP)      run a macro
1055MoveCursor      move cursor to mouse position
1056MonoCase        toggle uppercase-only mode
1057Newline move cursor to first field on next line (or send ASCII LF)
1058NextWord        move cursor to next word
1059PA(\fIn\fP)     Program Attention AID (\fIn\fP from 1 to 3)
1060PF(\fIn\fP)     Program Function AID (\fIn\fP from 1 to 24)
1061PreviousWord    move cursor to previous word
1062PrintText(\fIcommand\fP)        print screen text on printer
1063PrintWindow(\fIcommand\fP)      print screen image (bitmap) on printer
1064Quit    exit \fBx3270\fP
1065Reconnect       reconnect to previous host
1066Redraw  redraw window
1067Reset   reset locked keyboard
1068Right   move cursor right
1069Right2  move cursor right 2 positions
1070SetFont(\fIfont\fP)     change emulator font
1071Script(\fIcommand\fP[,\fIarg\fP...])    run a script
1072String(\fIstring\fP)    insert string (simple macro facility)
1073SysReq  System Request AID
1074Tab     move cursor to next input field
1075ToggleInsert    toggle insert mode
1076Up      move cursor up
1077_
1078(the following are similar to xterm)
1079_
1080ignore  do nothing
1081insert\-selection([\fIatom\fP[\fI,atom...\fP]]) paste selection
1082move\-select    a combination of \fBMoveCursor\fP and \fBselect\-start\fP
1083select\-end(\fIatom\fP[\fI,atom...\fP]])        complete selection and assign to atom(s)
1084select\-extend  move the end of a selection
1085select\-start   mark the beginning of a selection
1086set\-select(\fIatom\fP[\fI,atom...\fP]])        assign exsting selection to atom(s)
1087start\-extend   begin marking the end of a selection
1088.TE
1089.RE
1090.SH "MACROS AND SCRIPTS"
1091There are several types of macros and script functions available.
1092.TP
1093.B The String() Action
1094The simplest method for macros is provided via the String action, which can
1095be bound to any key in a keymap.
1096The arguments to String() are one or more double-quoted strings which are
1097inserted directly as if typed.
1098Hex constants may be entered in the form 0xff, and the C backslash conventions
1099are honored as follows.
1100(Entries marked * mean that after sending the
1101.SM AID
1102code to the host,
1103.B x3270
1104will wait for the host to unlock the keyboard before further processing the
1105string.)
1106.RS 1i
1107.TS
1108l l.
1109\eb     Left
1110\ef     Clear*
1111\en     Enter*
1112\e\epa\fIn\fP   PA key \fIn\fP*
1113\e\epf\fInn\fP  PF key \fInn\fP*
1114\er     Newline
1115\et     Tab
1116.TE
1117.RE
1118.IP
1119An example action would be:
1120.RS 1i
1121Meta<Key>p: String("probs clearrdr\en")
1122.RE
1123.IP
1124.B Note:
1125The strings are in
1126.SM ASCII
1127and converted to
1128.SM EBCDIC,
1129so beware of inserting
1130control codes.
1131Also, a backslash before a
1132.B p
1133must be doubled so it will not be removed when resource files are read.
1134.TP
1135The Script() Action
1136This facility causes
1137.B x3270
1138to start a child process which can execute
1139.B x3270
1140actions.
1141The child process' standard input and output are piped back to
1142.BR x3270 .
1143The
1144.B Script()
1145action is fully documented in
1146.IR x3270-script (1).
1147.TP
1148.B The macros Resource
1149An alternate method of defining macros is the "x3270.macros" resource.
1150This resource is similar to a keymap, but instead of defining keyboard
1151mappings, it associates a list of X actions with a name.
1152These names are displayed on a Macros menu that appears when
1153.B x3270
1154is connected to a host.
1155Selecting one of the names on the menu executes the X actions associated with
1156it.
1157Typically the actions are String() calls, but any action may be specified.
1158Here is a sample macros resource definition, which would result in a four-entry
1159Macros menu:
1160.RS 1i
1161x3270.macros: \\
1162.br
1163        log off: String("logout\\n")\\n\\
1164.br
1165        vtam: String("dial vtam\\n")\\n\\
1166.br
1167        pa1: PA(1)\\n\\
1168.br
1169        alt printer: PrintText("lpr -Plw2")
1170.RE
1171.IP
1172You can also define a different set of macros for each host.
1173If there is a resource named
1174.RI ``x3270.macros. somehost '',
1175it defines the macros menu for when
1176.B x3270
1177is connected to
1178.I somehost.
1179.TP
1180.B The \-script Switch
1181This facility allows
1182.B x3270
1183to operate under the complete control of a script.
1184.B x3270
1185accepts actions from standard input, and prints results on standard output.
1186The \-script switch is fully documented in
1187.IR x3270-script (1).
1188.B
1189.SH "COMPOSITE CHARACTERS"
1190If your keyboard has a "Compose" key,
1191.B x3270
1192allows the direct entry of accented letters and special symbols.
1193Pressing and releasing the "Compose" key, followed by two other keys, causes
1194entry of the symbol combining those two keys.
1195For example, "Compose" followed by the "C" key and the "," (comma) key, enters
1196the "C-cedilla" symbol.
1197A `C' on the status line indicates a pending composite character.
1198.PP
1199The mappings between these pairs of ordinary keys and the symbols they
1200represent is controlled by the "x3270.composeMap" resource; it gives the
1201name of the map to use.
1202The maps themselves are named "x3270.composeMap.\fIname\fR".
1203The default is "latin1", which gives mappings for most of the symbols in the
1204.SM ISO
12058859\-1 Latin\-1 character set that are not in the 7-bit
1206.SM ASCII
1207character set.
1208.PP
1209.B Note:
1210The default keymap defines the "Multi_key" keysym as the "Compose" key.
1211If your keyboard lacks such a key, you may set up your own "Compose" key with
1212a keymap that maps some other keysym onto the "Compose" action.
1213.SH "APL SUPPORT"
1214.B x3270
1215supports the full
1216.SM APL2
1217character set and the entry of
1218.SM APL
1219characters from the keyboard.
1220.PP
1221.SM APL
1222characters are supported only in the special
1223.B 3270 font.
1224.PP
1225Keyboard entry of
1226.SM APL
1227characters is supported through the
1228.B apl
1229keymap modifier.
1230This modifier defines the "Alt" key as an
1231.SM APL
1232shift key, with a typical
1233.SM APL
1234keyboard layout,
1235.IR e . g .,
1236"Alt" pressed with the
1237.B A
1238key results in the \s-1APL\s+1 `alpha' symbol.
1239Overstruck characters such as `quad-quote' are not defined as single
1240keystrokes; instead they are entered as composites (see
1241.SM "COMPOSITE CHARACTERS"
1242above).
1243A special composite map,
1244.BR apl ,
1245is provided for this purpose.
1246.PP
1247.B Note:
1248Some keyboards do not define the "Alt" key as a modifier, so keymaps that use
1249the "Alt" key will not function.
1250On a Sun for example, this can be remedied with the command:
1251.IP
1252xmodmap \-e "add mod2 = Alt_L"
1253.PP
1254For convenience, an
1255.B \-apl
1256option is defined, which is an abbreviation for the following resource
1257definitions:
1258.RS
1259.RI x3270.keymap: " your_keymap_name" ,apl
1260.br
1261x3270.charset: apl
1262.br
1263x3270.composeMap: apl
1264.RE
1265.PP
1266There are a number of
1267.SM APL
1268characters that are similar in appearance to non-\s-1APL\s+1 characters.
1269In particular, the \s-1APL\s+1 `stile', `slope,' `tilde' and `quotedot'
1270characters are similar to the \s-1EBCDIC\s+1 `bar', `backslash,' `tilde'
1271and `exclaim' characters.
1272The
1273.SM APL
1274characters are entered with the "Alt" key, and have slightly different
1275appearances.
1276.PP
1277The complete list of special
1278.SM APL
1279keysyms is as follows.  Entries marked with an asterisk (*) represent
1280simple aliases for standard \s-1EBCDIC\s+1 characters.
1281.PP
1282.RS
1283.TS
1284l c l l l.
1285\s-1APL\s+1 Symbol      Hex     x3270 Keysym    x3270 Key       x3270 Composed Keys
1286_
1287A underbar      41      apl_Aunderbar   Alt-A   A + underbar
1288alpha   B0      apl_alpha       Alt-a
1289B underbar      42      apl_Bunderbar   Alt-B   B + underbar
1290bar     60*     apl_bar -
1291C underbar      43      apl_Cunderbar   Alt-C   C + underbar
1292circle  9D      apl_circle      Alt-o
1293circle bar      ED      apl_circlebar           circle + bar
1294circle slope    CF      apl_circleslope         circle + slope
1295circle star     FD      apl_circlestar          circle + star
1296circle stile    CD      apl_circlestile         circle + stile
1297colon   7A*     apl_colon       :
1298comma   6B*     apl_comma       ,
1299D underbar      44      apl_Dunderbar   Alt-D   D + underbar
1300del     BA      apl_del Alt-g
1301del stile       DC      apl_delstile            del + stile
1302del tilde       FB      apl_deltilde            del + tilde
1303delta   BB      apl_delta       Alt-h
1304delta stile     DD      apl_deltastile          delta + stile
1305delta underbar  FC      apl_deltaunderbar               delta + underbar
1306diamond 70      apl_diamond             up caret + down caret
1307dieresis        72      apl_dieresis    Alt-1
1308dieresis dot    EC      apl_dieresisdot         dieresis + dot
1309divide  B8      apl_divide      Alt-+
1310dot     4B*     apl_dot .
1311down arrow      8B      apl_downarrow   Alt-u
1312down caret      78      apl_downcaret   Alt-9
1313down caret tilde        CB      apl_downcarettilde              down caret + tilde
1314down shoe       AB      apl_downshoe    Alt-v
1315down stile      8E      apl_downstile   Alt-d
1316down tack       AC      apl_downtack    Alt-b
1317down tack jot   FE      apl_downtackjot         down tack + jot
1318down tack up tack       DA      apl_downtackuptack              down tack + up tack
1319E underbar      45      apl_Eunderbar   Alt-E   E + underbar
1320epsilon B1      apl_epsilon     Alt-e
1321epsilon underbar        75      apl_epsilonunderbar             epsilon + underbar
1322equal   7E*     apl_equal       '='
1323equal underbar  E1      apl_equalunderbar               equal + underbar
1324F underbar      46      apl_Funderbar   Alt-F   F + underbar
1325G underbar      47      apl_Gunderbar   Alt-G   G + underbar
1326greater 6E*     apl_greater     >
1327H underbar      48      apl_Hunderbar   Alt-H   H + underbar
1328I underbar      49      apl_Iunderbar   Alt-I   I + underbar
1329iota    B2      apl_iota        Alt-i
1330iota underbar   74      apl_iotaunderbar                iota + underbar
1331J underbar      51      apl_Junderbar   Alt-J   J + underbar
1332jot     AF      apl_jot alt-j
1333K underbar      52      apl_Kunderbar   Alt-K   K + underbar
1334L underbar      53      apl_Lunderbar   Alt-L   L + underbar
1335left arrow      9F      apl_leftarrow   Alt-[
1336left bracket    AD      apl_leftbracket [
1337left paren      4D*     apl_leftparen   (
1338left shoe       9B      apl_leftshoe    Alt-z
1339less    4C*     apl_less        <
1340M underbar      54      apl_Munderbar   Alt-M   M + underbar
1341N underbar      55      apl_Nunderbar   Alt-N   N + underbar
1342not equal       BE      apl_notequal    Alt-8   equal + slash
1343not greater     8C      apl_notgreater  Alt-4   less + equal
1344not less        AE      apl_notless     Alt-6   greater + equal
1345O underbar      56      apl_Ounderbar   Alt-O   O + underbar
1346omega   B4      apl_omega       Alt-w
1347overbar A0      apl_overbar     Alt-2
1348P underbar      57      apl_Punderbar   Alt-P   P + underbar
1349plus    4E*     apl_plus        +
1350Q underbar      58      apl_Qunderbar   Alt-Q   Q + underbar
1351quad    90      apl_quad        Alt-l
1352quad divide     EE      apl_quaddivide          quad + divide
1353quad jot        73      apl_quadjot             quad + jot
1354quad quote      DE      apl_quadquote           quad + quote
1355quad slope      CE      apl_quadslope           quad + slope
1356query   6F*     apl_query       ?
1357quote   7D*     apl_quote       '
1358quote dot       DB      apl_quotedot            quote + dot
1359R underbar      59      apl_Runderbar   Alt-R   R + underbar
1360rho     B3      apl_rho Alt-r
1361right arrow     8F      apl_rightarrow  Alt-]
1362right bracket   BD      apl_rightbracket        ]
1363right paren     5D*     apl_rightparen  )
1364right shoe      9A      apl_rightshoe   Alt-x
1365S underbar      62      apl_Sunderbar   Alt-S   S + underbar
1366semicolon       5E*     apl_semicolon   ;
1367slash   61*     apl_slash       /
1368slash bar       EA      apl_slashbar            slash + bar
1369slope   B7      apl_slope       Alt-\\\\
1370slope bar       EB      apl_slopebar            slope + bar
1371squad   CC      apl_squad               quad + quad
1372star    5C*     apl_star        *
1373stile   BF      apl_stile       Alt-|
1374T underbar      63      apl_Tunderbar   Alt-T   T + underbar
1375tilde   80      apl_tilde       Alt-~
1376times   B6      apl_times       Alt-=
1377U underbar      64      apl_Uunderbar   Alt-U   U + underbar
1378underbar        6D*     apl_underbar    '_'
1379up arrow        8A      apl_uparrow     Alt-y
1380up caret        71      apl_upcaret     Alt-0
1381up caret tilde  CA      apl_upcarettilde                up caret + tilde
1382up shoe AA      apl_upshoe      Alt-c
1383up shoe jot     DF      apl_upshoejot           up shoe + jot
1384up stile        8D      apl_upstile     Alt-s
1385up tack BC      apl_uptack      Alt-n
1386up tack jot     EF      apl_uptackjot           up tack + jot
1387V underbar      65      apl_Vunderbar   Alt-V   V + underbar
1388W underbar      66      apl_Wunderbar   Alt-W   W + underbar
1389X underbar      67      apl_Xunderbar   Alt-X   X + underbar
1390Y underbar      68      apl_Yunderbar   Alt-Y   Y + underbar
1391Z underbar      69      apl_Zunderbar   Alt-Z   Z + underbar
1392.TE
1393.SH "SCREEN PRINTING"
1394Screen printing is handled through options on the File menu or by the
1395PrintText and PrintWindow keyboard actions.
1396Each results in a pop-up to confirm the print command.
1397.PP
1398The PrintText action (usually assigned to the key <Meta>p) sends the current
1399screen image to the printer as
1400.SM ASCII
1401characters.
1402The default command used to print the data is controlled by
1403the "x3270.printTextCommand" resource; the default is
1404.BR lpr .
1405You may also use a keymap definition to pass a print command the PrintText
1406action itself.
1407The command receives the screen text as its standard input.
1408For example, the following keymap will save the screen text in a file:
1409.IP
1410Meta<Key>f: PrintText("cat >screen.image")
1411.PP
1412Note: HardPrint is an alias for PrintText.
1413.PP
1414The PrintWindow action (usually assigned to the key <Meta>b) sends the current
1415screen image to the printer as a bitmap.
1416The default command used to print the data is controlled by
1417the "x3270.printWindowCommand" resource; the default is
1418.IP
1419.BR "xwd \-id %d | xpr | lpr" .
1420.PP
1421You may also use a keymap definition to pass a print command to the
1422PrintWindow action itself.
1423If the command contains the text "%d", the window ID of
1424.B x3270
1425will be substituted before it is run.
1426For example, the following keymap will pop up a duplicate of the current
1427screen image:
1428.IP
1429Meta<Key>g: PrintWindow("xwd \-id %d | xwud &")
1430.LP
1431If the command for PrintWindow or PrintText begins with an "@" character,
1432the initial pop-up menu to confirm the print command is not displayed and
1433the command cannot be edited.
1434.SH BUGS
1435Cursor highlighting will not work with if you use the
1436.B NoTitleFocus
1437option in your .twmrc file.
1438.LP
1439Pull-down menus may not work properly if the Caps Lock, Num Lock, Shift, Alt
1440or Meta keys are pressed.
1441This is a bug in the Athena menu widget and affects several other X
1442applications as well.
1443.SH PASSTHRU
1444.B x3270
1445supports the Sun
1446.I telnet-passthru
1447service provided by the
1448.I in.telnet-gw
1449server.
1450This allows outbound telnet connections through a firewall machine.
1451When a
1452.B p:
1453is prepended to a hostname,
1454.B x3270
1455acts much like the
1456.IR itelnet(1)
1457command.
1458It contacts the machine named
1459.B internet-gateway
1460at the port defined in
1461.B /etc/services
1462as
1463.B telnet-passthru
1464(which defaults to 3514).
1465It then passes the requested hostname and port to the
1466.B in.telnet-gw
1467server.
1468.SH FILES
1469.nf
1470/usr/lib/X11/x3270/ibm_hosts
1471.SH "SEE ALSO"
1472telnet(1), tn3270(1), ibm_hosts(5), x3270-script(1)
1473.br
1474X Toolkit Intrinsics
1475.br
1476Data Stream Programmer's Reference, IBM GA23\-0059
1477.br
1478Character Set Reference, IBM GA27\-3831
1479.SH COPYRIGHTS
1480.LP
1481Modifications Copyright 1993, 1994, 1995, 1996, 1997 by Paul Mattes.
1482.br
1483Original X11 Port Copyright 1990 by Jeff Sparkes.
1484.RS
1485Permission to use, copy, modify, and distribute this software and its
1486documentation for any purpose and without fee is hereby granted,
1487provided that the above copyright notice appear in all copies and that
1488both that copyright notice and this permission notice appear in
1489supporting documentation.
1490.RE
1491Copyright 1989 by Georgia Tech Research Corporation, Atlanta, GA 30332.
1492.RS
1493All Rights Reserved.  GTRC hereby grants public use of this software.
1494Derivative works based on this software must incorporate this copyright
1495notice.
1496.RE
1497.SH VERSION
1498x3270 3.1.1.6
Note: See TracBrowser for help on using the repository browser.