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