~ubuntu-branches/ubuntu/natty/ibm-3270/natty

« back to all changes in this revision

Viewing changes to wc3270/html/wc3270-man.html

  • Committer: Bazaar Package Importer
  • Author(s): Bastian Blank
  • Date: 2009-12-14 11:48:53 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20091214114853-mywixml32hct9jr1
Tags: 3.3.10ga4-2
* Fix section to match override.
* Use debhelper compat level 7.
* Use 3.0 (quilt) source format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
<a HREF="#Actions">Actions</a><br>
20
20
<a HREF="#Keymaps">Keymaps</a><br>
21
21
<a HREF="#File-Transfer">File Transfer</a><br>
 
22
<a HREF="#The-PrintText-Action">The PrintText Action</a><br>
22
23
<a HREF="#Nested-Scripts">Nested Scripts</a><br>
23
24
<a HREF="#Printer-Support">Printer Support</a><br>
24
25
<a HREF="#Proxy">Proxy</a><br>
36
37
[<i>host</i>]
37
38
 
38
39
<br>
39
 
<b>wc3270</b> <i>session-file</i>.wc3270
 
40
<b>wc3270</b> [<i>options</i>] <i>session-file</i>.wc3270
 
41
 
40
42
<a NAME="Description"></a><h2>Description</h2>
41
43
<b>wc3270</b> opens
42
44
a telnet connection to an <font size=-1>IBM</font>
121
123
<tr><td ><center>Model Number</center></td>     <td ><center>Columns</center></td>      <td ><center>Rows</center></td></tr>
122
124
 
123
125
<tr><td ><center>2</center></td>        <td ><center>80</center></td>   <td ><center>24</center></td></tr>
124
 
<tr><td ><center>3</center></td>        <td ><center>80</center></td>   <td ><center>30</center></td></tr>
 
126
<tr><td ><center>3</center></td>        <td ><center>80</center></td>   <td ><center>32</center></td></tr>
125
127
<tr><td ><center>4</center></td>        <td ><center>80</center></td>   <td ><center>43</center></td></tr>
126
128
<tr><td ><center>5</center></td>        <td ><center>132</center></td>  <td ><center>27</center></td></tr>
127
129
</table>
131
133
<p>
132
134
The default model
133
135
is <b>3278-4</b>.
 
136
<dt><b>-mono</b></dt><dd>
 
137
Prevents <b>wc3270</b> from using color, ignoring any color capabilities
 
138
reported by the terminal.
 
139
<dt><b>-noprompt</b></dt><dd>
 
140
Disables command-prompt mode.
134
141
<dt><b>-oversize</b> <i>cols</i><b>x</b><i>rows</i></dt><dd>
135
142
Makes the screen larger than the default for the chosen model number.
136
143
This option has effect only in combination with extended data stream support
138
145
supports the Query Reply structured field.
139
146
The number of columns multiplied by the number of rows must not exceed
140
147
16383 (3fff hex), the limit of 14-bit 3270 buffer addressing.
 
148
<p>
 
149
It can also be specified as <b>auto</b>, which causes <b>wc3270</b> to fill
 
150
the entire terminal or console window.
141
151
<dt><b>-port</b> <i>n</i></dt><dd>
142
152
Specifies a different <font size=-1>TCP</font> port to connect to.
143
153
<i>n</i> can be a name from <b>/etc/services</b> like <b>telnet</b>, or a
151
161
The optional <i>port</i> can be a number or a service name.
152
162
For a list of supported proxy <i>types</i>, see <a HREF="#Proxy"><font size=-1>PROXY</font></a>
153
163
below.
 
164
<dt><b>-reconnect</b></dt><dd>
 
165
Causes <b>wc3270</b>
 
166
to automatically reconnect to the host if it ever disconnects.
 
167
This option has effect only if a hostname is specified on the command line.
 
168
<dt><b>-S</b></dt><dd>
 
169
Runs wc3270 in auto-shortcut mode.
 
170
wc3270 will create a temporary shorcut (.LNK file) that matches the
 
171
parameters in the session file (model number, characterset, etc.) and re-run
 
172
itself from the shortcut.
 
173
<dt><b>+S</b></dt><dd>
 
174
Disables auto-shortcut mode.
 
175
It is generally a good idea to put this option on the command lines of all
 
176
shortcuts, to avoid infinite looping.
 
177
<dt><b>-scriptport</b> <i>port</i></dt><dd>
 
178
Causes wc3270 to listen for scripting connections on local TCP
 
179
port <i>port</i>.
154
180
<dt><b>-set</b> <i>toggle</i></dt><dd>
155
181
Sets the initial value of <i>toggle</i> to <b>true</b>.
156
182
The list of toggle names is under <a HREF="#Toggles"><font size=-1>TOGGLES</font></a>
190
216
minimum size is 64 Kbytes.
191
217
The value of <i>size</i> can have a <b>K</b> or <b>M</b> suffix, indicating
192
218
kilobytes or megabytes respectively.
 
219
<dt><b>-v</b>
 
220
Display the version and build options for <b>wc3270</b></dt><dd> and exit.
193
221
<dt><b>-xrm</b> "wc3270.<i>resource</i>: <i>value</i>"</dt><dd>
194
222
Sets the value of the named <i>resource</i> to <i>value</i>.
195
223
Resources control less common <b>wc3270</b>
221
249
Available sets include:
222
250
<p>
223
251
<table BORDER cols=3 width="75%">
224
 
<tr><td ><center>Charset Name</center></td>     <td ><center>Host Code Page</center></td>       <td ><center>Windows Code Page</center></td></tr>
 
252
<tr><td ><center>Charset Name</center></td>     <td ><center>Host Code Page</center></td>       <td ><center></center></td></tr>
225
253
 
226
 
<tr><td ><center>belgian</center></td>  <td ><center>500</center></td>  <td ><center>  28591</center></td></tr>
227
 
<tr><td ><center>belgian-euro</center></td>     <td ><center>1148</center></td> <td ><center>  28605</center></td></tr>
228
 
<tr><td ><center>bracket</center></td>  <td ><center>37</center></td>   <td ><center>  28591</center></td></tr>
229
 
<tr><td ><center>brazilian</center></td>        <td ><center>275</center></td>  <td ><center>  28591</center></td></tr>
230
 
<tr><td ><center>cp1047</center></td>   <td ><center>1047</center></td> <td ><center>  28591</center></td></tr>
231
 
<tr><td ><center>cp1153</center></td>   <td ><center>1153</center></td> <td ><center>1250</center></td></tr>
232
 
<tr><td ><center>cp870</center></td>    <td ><center>870</center></td>  <td ><center>  28592</center></td></tr>
233
 
<tr><td ><center>finnish</center></td>  <td ><center>278</center></td>  <td ><center>  28591</center></td></tr>
234
 
<tr><td ><center>finnish-euro</center></td>     <td ><center>1143</center></td> <td ><center>  28605</center></td></tr>
235
 
<tr><td ><center>french</center></td>   <td ><center>297</center></td>  <td ><center>  28591</center></td></tr>
236
 
<tr><td ><center>french-euro</center></td>      <td ><center>1147</center></td> <td ><center>  28605</center></td></tr>
237
 
<tr><td ><center>german</center></td>   <td ><center>273</center></td>  <td ><center>  28591</center></td></tr>
238
 
<tr><td ><center>german-euro</center></td>      <td ><center>1141</center></td> <td ><center>  28605</center></td></tr>
239
 
<tr><td ><center>greek</center></td>    <td ><center>423</center></td>  <td ><center> 28597</center></td></tr>
240
 
<tr><td ><center>hebrew</center></td>   <td ><center>424</center></td>  <td ><center> 28598</center></td></tr>
241
 
<tr><td ><center>icelandic</center></td>        <td ><center>871</center></td>  <td ><center>  28591</center></td></tr>
242
 
<tr><td ><center>icelandic-euro</center></td>   <td ><center>1149</center></td> <td ><center>  28605</center></td></tr>
243
 
<tr><td ><center>italian</center></td>  <td ><center>280</center></td>  <td ><center>  28591</center></td></tr>
244
 
<tr><td ><center>italian-euro</center></td>     <td ><center>1144</center></td> <td ><center>  28605</center></td></tr>
245
 
<tr><td ><center>norwegian</center></td>        <td ><center>277</center></td>  <td ><center>  28591</center></td></tr>
246
 
<tr><td ><center>norwegian-euro</center></td>   <td ><center>1142</center></td> <td ><center>  28605</center></td></tr>
247
 
<tr><td ><center>russian</center></td>  <td ><center>880</center></td>  <td ><center>20866</center></td></tr>
248
 
<tr><td ><center>slovenian</center></td>        <td ><center>870</center></td>  <td ><center>28592</center></td></tr>
249
 
<tr><td ><center>spanish</center></td>  <td ><center>284</center></td>  <td ><center>  28591</center></td></tr>
250
 
<tr><td ><center>spanish-euro</center></td>     <td ><center>1145</center></td> <td ><center>  28605</center></td></tr>
251
 
<tr><td ><center>thai</center></td>     <td ><center>838</center></td>  <td ><center>28601 </center></td></tr>
252
 
<tr><td ><center>turkish</center></td>  <td ><center>1026</center></td> <td ><center>28599</center></td></tr>
253
 
<tr><td ><center>uk</center></td>       <td ><center>285</center></td>  <td ><center>  28591</center></td></tr>
254
 
<tr><td ><center>uk-euro</center></td>  <td ><center>1146</center></td> <td ><center>  28605</center></td></tr>
255
 
<tr><td ><center>us-euro</center></td>  <td ><center>1140</center></td> <td ><center>  28605</center></td></tr>
256
 
<tr><td ><center>us-intl</center></td>  <td ><center>37</center></td>   <td ><center>  28591</center></td></tr>
 
254
<tr><td ><center>belgian</center></td>  <td ><center>500</center></td>  <td ><center>  </center></td></tr>
 
255
<tr><td ><center>belgian-euro</center></td>     <td ><center>1148</center></td> <td ><center>  </center></td></tr>
 
256
<tr><td ><center>bracket</center></td>  <td ><center>037</center></td>  <td ><center>  </center></td></tr>
 
257
<tr><td ><center>brazilian</center></td>        <td ><center>275</center></td>  <td ><center>  </center></td></tr>
 
258
<tr><td ><center>chinese-gb18030</center></td>  <td ><center>1388</center></td> <td ><center></center></td></tr>
 
259
<tr><td ><center>cp1047</center></td>   <td ><center>1047</center></td> <td ><center>  </center></td></tr>
 
260
<tr><td ><center>cp870</center></td>    <td ><center>870</center></td>  <td ><center>  </center></td></tr>
 
261
<tr><td ><center>finnish</center></td>  <td ><center>278</center></td>  <td ><center>  </center></td></tr>
 
262
<tr><td ><center>finnish-euro</center></td>     <td ><center>1143</center></td> <td ><center>  </center></td></tr>
 
263
<tr><td ><center>french</center></td>   <td ><center>297</center></td>  <td ><center>  </center></td></tr>
 
264
<tr><td ><center>french-euro</center></td>      <td ><center>1147</center></td> <td ><center>  </center></td></tr>
 
265
<tr><td ><center>german</center></td>   <td ><center>273</center></td>  <td ><center>  </center></td></tr>
 
266
<tr><td ><center>german-euro</center></td>      <td ><center>1141</center></td> <td ><center>  </center></td></tr>
 
267
<tr><td ><center>greek</center></td>    <td ><center>423</center></td>  <td ><center> </center></td></tr>
 
268
<tr><td ><center>hebrew</center></td>   <td ><center>424</center></td>  <td ><center> </center></td></tr>
 
269
<tr><td ><center>icelandic</center></td>        <td ><center>871</center></td>  <td ><center>  </center></td></tr>
 
270
<tr><td ><center>icelandic-euro</center></td>   <td ><center>1149</center></td> <td ><center>  </center></td></tr>
 
271
<tr><td ><center>italian</center></td>  <td ><center>280</center></td>  <td ><center>  </center></td></tr>
 
272
<tr><td ><center>italian-euro</center></td>     <td ><center>1144</center></td> <td ><center>  </center></td></tr>
 
273
<tr><td ><center>japanese-kana</center></td>    <td ><center>930</center></td>  <td ><center></center></td></tr>
 
274
<tr><td ><center>japanese-latin</center></td>   <td ><center>939</center></td>  <td ><center></center></td></tr>
 
275
<tr><td ><center>norwegian</center></td>        <td ><center>277</center></td>  <td ><center>  </center></td></tr>
 
276
<tr><td ><center>norwegian-euro</center></td>   <td ><center>1142</center></td> <td ><center>  </center></td></tr>
 
277
<tr><td ><center>russian</center></td>  <td ><center>880</center></td>  <td ><center></center></td></tr>
 
278
<tr><td ><center>simplified-chinese</center></td>       <td ><center>935</center></td>  <td ><center></center></td></tr>
 
279
<tr><td ><center>slovenian</center></td>        <td ><center>870</center></td>  <td ><center></center></td></tr>
 
280
<tr><td ><center>spanish</center></td>  <td ><center>284</center></td>  <td ><center>  </center></td></tr>
 
281
<tr><td ><center>spanish-euro</center></td>     <td ><center>1145</center></td> <td ><center>  </center></td></tr>
 
282
<tr><td ><center>thai</center></td>     <td ><center>1160</center></td> <td ><center> </center></td></tr>
 
283
<tr><td ><center>traditional-chinese</center></td>      <td ><center>937</center></td>  <td ><center></center></td></tr>
 
284
<tr><td ><center>turkish</center></td>  <td ><center>1026</center></td> <td ><center></center></td></tr>
 
285
<tr><td ><center>uk</center></td>       <td ><center>285</center></td>  <td ><center>  </center></td></tr>
 
286
<tr><td ><center>uk-euro</center></td>  <td ><center>1146</center></td> <td ><center>  </center></td></tr>
 
287
<tr><td ><center>us-euro</center></td>  <td ><center>1140</center></td> <td ><center>  </center></td></tr>
 
288
<tr><td ><center>us-intl</center></td>  <td ><center>037</center></td>  <td ><center>  </center></td></tr>
257
289
</table>
258
290
<p>
259
291
The default character set is
260
292
<b>bracket</b>,
261
 
which is useful for common <font size=-1>IBM</font> hosts which use <font size=-1>EBCDIC</font>
262
 
codes 0xAD and 0xBD for the `[' and `]' characters,
 
293
which is useful for common U.S. <font size=-1>IBM</font> hosts which use <font size=-1>EBCDIC</font>
 
294
codes AD and BD for the `[' and `]' characters,
263
295
respectively.
 
296
<p>
 
297
Note that any of the host code pages listed above can be specified by adding
 
298
<b>cp</b> to the host code page, e.g., <b>cp037</b> for host code page 037.
 
299
Also note that the code pages available for a given version of <b>wc3270</b>
 
300
are displayed by the <b>-v</b> command-line option.
 
301
<p>
 
302
Note that DBCS character sets (Chinese, Japanese) display properly only on
 
303
32-bit Windows XP.  Work is proceeding on other platforms.
264
304
<a NAME="NVT-ANSI-Mode"></a><h2>NVT (ANSI) Mode</h2>
265
305
Some hosts use an <font size=-1>ASCII</font> front-end to do initial login negotiation,
266
306
then later switch to 3270 mode.
315
355
If set, pasting multi-line input via the <b>Paste</b> action will maintain a
316
356
left margin (it will not move the cursor further left than where the paste
317
357
begins).
 
358
<dt><b>underscore</b></dt><dd>
 
359
If set, wc3270 will display underlined fields by substituting
 
360
underscore `_' characters for blanks or nulls in the field.
 
361
Otherwise, these fields will be displayed
 
362
with a highlighted background.
 
363
Note that setting <b>underscore</b> also disables the highlighted background
 
364
for blinking fields.
 
365
<b>underscore</b> is set by default.
318
366
</dl>
319
367
<p>
320
368
The names of the toggles for use with the <b>-set</b>
332
380
<tr><td >Save Screen(s) in File</td>    <td >screenTrace</td></tr>
333
381
<tr><td >Wraparound</td>        <td >lineWrap</td></tr>
334
382
<tr><td >Paste with Left Margin</td>    <td >marginedPaste</td></tr>
 
383
<tr><td >Underscore Mode</td>   <td >underscore</td></tr>
335
384
</table>
336
385
<p>
337
386
These names are also used as the first parameter to the <b>Toggle</b>
371
420
 
372
421
<a NAME="actions"></a><a NAME="Actions"></a><h2>Actions</h2>
373
422
Here is a complete list of basic wc3270 actions.
 
423
Script-specific actions are described on the
 
424
<a HREF="x3270-script.html"><i>x3270-script</i>(1)</a> manual page.
374
425
<p>
375
426
Actions marked with an asterisk (*) may block, sending data to the host and
376
427
possibly waiting for a response.
414
465
<tr><td >*PF(<i>n</i>)</td>     <td >Program Function <font size=-1>AID</font> (<i>n</i> from 1 to 24)</td></tr>
415
466
<tr><td >PreviousWord</td>      <td >move cursor to previous word</td></tr>
416
467
<tr><td >Paste</td>     <td >insert clipboard contents</td></tr><tr><td >Printer(Start[,<i>lu</i>]|Stop)</td>   <td >start or stop printer session</td></tr>
417
 
<tr><td >PrintText(<i>command</i>)</td> <td >print screen text on printer</td></tr>
 
468
<tr><td >PrintText(<i>[printer-name]</i>)</td>  <td >print screen text on printer</td></tr>
418
469
<tr><td >Quit</td>      <td >exit <b>wc3270</b></td></tr>
419
470
<tr><td >Redraw</td>    <td >redraw window</td></tr>
420
471
<tr><td >Reset</td>     <td >reset locked keyboard</td></tr>
421
472
<tr><td >Right</td>     <td >move cursor right</td></tr>
422
473
<tr><td >Right2</td>    <td >move cursor right 2 positions</td></tr>
423
474
<tr><td >Rows</td>      <td >report screen size</td></tr>
 
475
<tr><td >*Script(<i>command</i>[,<i>arg</i>...])</td>   <td >run a script</td></tr>
424
476
<tr><td >*String(<i>string</i>)</td>    <td >insert string (simple macro facility)</td></tr>
425
477
<tr><td >*SysReq</td>   <td >System Request <font size=-1>AID</font></td></tr>
426
478
<tr><td >Tab</td>       <td >move cursor to next input field</td></tr>
430
482
<tr><td >*Transfer(<i>option</i>=<i>value</i>...)</td>  <td >file transfer</td></tr>
431
483
<tr><td >Up</td>        <td >move cursor up</td></tr>
432
484
</table>
 
485
<p>
 
486
Any of the above actions may be entered at the <b>wc3270></b> prompt;
 
487
these commands are also available for use in keymaps
 
488
(see <a HREF="#Keymaps"><font size=-1>KEYMAPS</font></a>).
 
489
Command names are case-insensitive.
 
490
Parameters can be specified with parentheses and commas, e.g.:
 
491
<blockquote>PF(1)</blockquote>
 
492
or with spaces, e.g.:
 
493
<blockquote>PF 1</blockquote>
 
494
Parameters can be quoted with double-quote characters, to allow spaces,
 
495
commas, and parentheses to be used.
 
496
<p>
 
497
<b>wc3270</b> also supports the following interactive commands:
 
498
<dl><dt><b>Help</b></dt><dd>
 
499
Displays a list of available commands.
 
500
<dt><b>Show</b></dt><dd>
 
501
Displays statistics and settings.
 
502
<dt><b>Trace</b></dt><dd>
 
503
Turns tracing on or off.
 
504
The command <b>trace on</b> enables data stream and keyboard event tracing;
 
505
the command <b>trace off</b> disables it.
 
506
The qualifier <b>data</b> or <b>keyboard</b> can be specified
 
507
before <b>on</b> or <b>off</b> to enable or disable a particular trace.
 
508
After <b>on</b>, a filename may be specified to override the default
 
509
trace file name of <b>/tmp/x3trc.</b><i>pid</i>.
 
510
</dl>
433
511
<a NAME="Keymaps"></a><h2>Keymaps</h2>
434
512
The <b>-keymap</b> option
435
513
or the <b>wc3270.keymap</b> resource
524
602
specified <i>key</i>, respectively.
525
603
The <b>LeftCtrl</b>, <b>RightCtrl</b>, <b>LeftAlt</b>, and <b>RightAlt</b>
526
604
modifiers specifify a particular <b>Ctrl</b> or <b>Alt</b> key.
 
605
The <b>Enhanced</b> modifier is also available;
 
606
<b>Enhanced &lt;Key>ENTER</b> is the keypad <b>Enter</b> key.
527
607
<i>Key</i> is either an <font size=-1>ISO</font> 8859-1 symbol name, such as <b>equal</b>
528
608
for `=' and <b>a</b> for `a', or a symbolic
529
609
Windows key name,
552
632
<b>DIVIDE</b>,
553
633
<b>DOWN</b>,
554
634
<b>END</b>,
 
635
<b>Enter</b> (alias for RETURN),
555
636
<b>ESCAPE</b>,
556
637
<b>EXECUTE</b>,
557
638
<b>F1</b>,
597
678
<b>NUMPAD7</b>,
598
679
<b>NUMPAD8</b>,
599
680
<b>NUMPAD9</b>,
 
681
<b>PageUp</b> (alias for PRIOR),
 
682
<b>PageDown</b> (alias for Next),
600
683
<b>PAUSE</b>,
601
684
<b>PRINT</b>,
602
685
<b>PRIOR</b> (Page Up),
629
712
<tr><td >Alt&lt;Key>c</td>      <td >Clear</td></tr>
630
713
<tr><td >Alt&lt;Key>l</td>      <td >Redraw</td></tr>
631
714
<tr><td >Alt&lt;Key>m</td>      <td >Compose</td></tr>
 
715
<tr><td >Alt&lt;Key>p</td>      <td >PrintText</td></tr>
632
716
<tr><td >Shift&lt;Key>F<i>n</i></td>    <td >PF(<i>n</i>+12)</td></tr>
633
717
</table>
634
718
<p>
662
746
<tr><td >&lt;Key>END</td>       <td >FieldEnd</td></tr>
663
747
<tr><td >Shift&lt;Key>LEFT</td> <td >PreviousWord</td></tr>
664
748
<tr><td >Shift&lt;Key>RIGHT</td>        <td >NextWord</td></tr>
 
749
<tr><td >&lt;Key>PRIOR</td>     <td >PF(7)</td></tr>
 
750
<tr><td >&lt;Key>NEXT</td>      <td >PF(8)</td></tr>
665
751
</table>
666
752
 
667
753
<a NAME="File-Transfer"></a><h2>File Transfer</h2>
685
771
<table BORDER cols=4 width="75%">
686
772
<tr><td >Option</td>    <td >Required?</td>     <td >Default</td>       <td >Other Values</td></tr>
687
773
 
688
 
<tr><td >Direction</td> <td >No</td>    <td >send</td>  <td >receive</td></tr>
 
774
<tr><td >Direction</td> <td >No</td>    <td >receive</td>       <td >send</td></tr>
689
775
<tr><td >HostFile</td>  <td >Yes</td>   <td >&nbsp;</td>        <td >&nbsp;</td></tr>
690
776
<tr><td >LocalFile</td> <td >Yes</td>   <td >&nbsp;</td>        <td >&nbsp;</td></tr>
691
777
<tr><td >Host</td>      <td >No</td>    <td >tso</td>   <td >vm</td></tr>
692
778
<tr><td >Mode</td>      <td >No</td>    <td >ascii</td> <td >binary</td></tr>
693
779
<tr><td >Cr</td>        <td >No</td>    <td >remove</td>        <td >add, keep</td></tr>
 
780
<tr><td >Remap</td>     <td >No</td>    <td >yes</td>   <td >no</td></tr>
694
781
<tr><td >Exist</td>     <td >No</td>    <td >keep</td>  <td >replace, append</td></tr>
695
782
<tr><td >Recfm</td>     <td >No</td>    <td >&nbsp;</td>        <td >fixed, variable, undefined</td></tr>
696
783
<tr><td >Lrecl</td>     <td >No</td>    <td >&nbsp;</td>        <td >&nbsp;</td></tr>
703
790
<p>
704
791
The option details are as follows.
705
792
<dl><dt><b>Direction</b></dt><dd>
706
 
<b>send</b> (the default) to send a file to the host,
 
793
<b>send</b> to send a file to the host,
707
794
<b>receive</b> to receive a file from the host.
708
795
<dt><b>HostFile</b></dt><dd>
709
796
The name of the file on the host.
725
812
transferring it to the local workstation.
726
813
<b>keep</b> preserves <b>Newline</b> characters when transferring a local file
727
814
to the host.
 
815
<dt><b>Remap</b></dt><dd>
 
816
Controls text translation for <b>Mode=ascii</b> files.
 
817
The value <b>yes</b> (the default) causes wc3270 to remap the text to ensure
 
818
maximum compatibility between the workstation's character set and encoding
 
819
and the host's EBCDIC code page.
 
820
The value <b>no</b> causes wc3270 to pass the text to or from the host
 
821
as-is, leaving all translation to the <b>IND$FILE</b> program on the host.
728
822
<dt><b>Exist</b></dt><dd>
729
823
Controls what happens when the destination file already exists.
730
824
<b>keep</b> (the default) preserves the file, causing the
732
826
<b>replace</b> overwrites the destination file with the source file.
733
827
<b>append</b> appends the source file to the destination file.
734
828
<dt><b>Recfm</b></dt><dd>
735
 
Controls the record  of files created on the host.
 
829
Controls the record format of files created on the host.
736
830
<b>fixed</b> creates a file with fixed-length records.
737
831
<b>variable</b> creates a file with variable-length records.
738
832
<b>undefined</b> creates a file with undefined-length records (<font size=-1>TSO</font> hosts only).
760
854
support them.
761
855
</dl>
762
856
 
 
857
<a NAME="The-PrintText-Action"></a><h2>The PrintText Action</h2>
 
858
The <b>PrintText</b> produces screen snapshots in a number of different
 
859
forms.
 
860
The default form wth no arguments sends a copy of the screen to the default
 
861
printer.
 
862
A single argument is
 
863
the name of the printer to use.
 
864
The font defaults to <b>Courier New</b> and the
 
865
point size defaults to 8.
 
866
These can be overridden by the <b>printTextFont</b> and <b>printTextSize</b>
 
867
resources, respectively.
 
868
Multiple arguments can include keywords to control the output of
 
869
<b>PrintText</b>:
 
870
<dl><dt><b>file</b> <i>filename</i></dt><dd>
 
871
Save the output in a file.
 
872
<dt><b>html</b></dt><dd>
 
873
Save the output as HTML.  This option implies <b>file</b>.
 
874
<dt><b>rtf</b></dt><dd>
 
875
Save the output as RichText.  This option implies <b>file</b>.
 
876
The font defaults to <b>Courier New</b> and the
 
877
point size defaults to 8.
 
878
These can be overridden by the <b>printTextFont</b> and <b>printTextSize</b>
 
879
resources, respectively.
 
880
<dt><b>modi</b></dt><dd>
 
881
Render modified fields in italics.
 
882
<dt><b>caption</b> <i>text</i></dt><dd>
 
883
Add the specified <i>text</i> as a caption above the output.
 
884
Within <i>text</i>, the special sequence <b>%T%</b> will be replaced with
 
885
a timestamp.
 
886
</dl>
 
887
 
763
888
<a NAME="Nested-Scripts"></a><h2>Nested Scripts</h2>
764
889
<dl><dt><b>The String Action</b></dt><dd>
765
890
The simplest method for
773
898
processing the string.)
774
899
<table BORDER cols=2 width="75%">
775
900
<tr><td >\b</td>        <td >Left</td></tr>
776
 
<tr><td >\e<i>xx</i></td>       <td >EBCDIC character in hex</td></tr>
 
901
<tr><td >\e<i>xxxx</i></td>     <td >EBCDIC character in hex</td></tr>
777
902
<tr><td >\f</td>        <td >Clear*</td></tr>
778
903
<tr><td >\n</td>        <td >Enter*</td></tr>
779
904
<tr><td >\pa<i>n</i></td>       <td >PA(<i>n</i>)*</td></tr>
781
906
<tr><td >\r</td>        <td >Newline</td></tr>
782
907
<tr><td >\t</td>        <td >Tab</td></tr>
783
908
<tr><td >\T</td>        <td >BackTab</td></tr>
784
 
<tr><td >\x<i>xx</i></td>       <td >ASCII character in hex</td></tr>
 
909
<tr><td >\u<i>xxxx</i></td>     <td >Unicode character in hex</td></tr>
 
910
<tr><td >\x<i>xxxx</i></td>     <td >Unicode character in hex</td></tr>
785
911
</table>
786
912
<p>
 
913
Note that the numeric values for the \e, \u and \x sequences
 
914
can be abbreviated to 2 digits.
 
915
Note also that EBCDIC codes greater than 255 and some Unicode character codes
 
916
represent DBCS characters, which will work only if wc3270 is built with
 
917
DBCS support and the host allows DBCS input in the current field.
 
918
<p>
787
919
An example keymap entry would be:
788
920
<blockquote>Alt&lt;Key>p: String("probs clearrdr\n")</blockquote>
789
921
<p>
800
932
are entered into the current field.
801
933
In <font size=-1>NVT</font> mode, the hexadecimal data represent <font size=-1>ASCII</font> characters,
802
934
which are sent directly to the host.
 
935
<dt><b>The Script Action</b></dt><dd>
 
936
This action causes <b>wc3270</b> to start a child process which can
 
937
execute <b>wc3270</b> actions.
 
938
<b>wc3270</b> listens for connections from the child process on a
 
939
dynamically-generated TCP port.
 
940
The <b>Script</b> action is fully documented in
 
941
<a HREF="x3270-script.html"><i>x3270-script</i>(1)</a>.
803
942
</dl>
804
943
<a NAME="Printer-Support"></a><h2>Printer Support</h2>
805
944
wc3270 supports associated printer sessions via the <i>wpr3287</i>(1)
819
958
It defaults to the value of the <b>$PRINTER</b> environment
820
959
variable, if set.
821
960
Otherwise the default system printer is used.
 
961
This resource also controls the printer used by the <b>PrintText</b> action.
822
962
<p>
823
963
The resource <b>wc3270.printer.assocCommandLine</b> specifies the command
824
964
used to start an associated printer session.  It defaults to:
866
1006
<p>
867
1007
The special types <b>socks4a</b> and <b>socks5d</b> can also be used to force
868
1008
the proxy server to do the hostname resolution for the SOCKS protocol.
869
 
snl Copyright 2000, 2001, 2002, 2007 by Paul Mattes.
870
1009
<a NAME="Resources"></a><h2>Resources</h2>
871
1010
Certain <b>wc3270</b>
872
1011
options can be configured via resources.
881
1020
 
882
1021
<tr><td >blankFill</td> <td >False</td> <td >-set blankFill</td>        <td >Blank Fill mode</td></tr>
883
1022
<tr><td >charset</td>   <td >bracket</td>       <td >-charset</td>      <td ><font size=-1>EBCDIC</font> character set</td></tr>
884
 
<tr><td >charset.<i>foo</i></td>        <td >&nbsp;</td>        <td >&nbsp;</td>        <td >Definition of character set <i>foo</i></td></tr>
885
 
<tr><td >consoleColorForHostColor<i>n</i></td>  <td ><a HREF="#rn4">(note 6)</a></td>   <td >&nbsp;</td>        <td >Color mapping</td></tr><tr><td >dsTrace</td>       <td >False</td> <td >-trace</td>        <td >Data stream tracing</td></tr>
 
1023
<tr><td >consoleColorForHostColor<i>n</i></td>  <td ><a HREF="#rn4">(note 6)</a></td>   <td >&nbsp;</td>        <td >Color mapping</td></tr><tr><td >dbcsCgcsgid</td>   <td >&nbsp;</td>        <td >&nbsp;</td>        <td >Override DBCS CGCSGID</td></tr>
 
1024
<tr><td >dsTrace</td>   <td >False</td> <td >-trace</td>        <td >Data stream tracing</td></tr>
886
1025
<tr><td >eof</td>       <td >^D</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode <font size=-1>EOF</font> character</td></tr>
887
1026
<tr><td >erase</td>     <td >^H</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode erase character</td></tr>
888
1027
<tr><td >extended</td>  <td >True</td>  <td >&nbsp;</td>        <td >Use 3270 extended data stream</td></tr>
889
1028
<tr><td >eventTrace</td>        <td >False</td> <td >-trace</td>        <td >Event tracing</td></tr>
890
 
<tr><td >ftCommand</td> <td >ind$file</td>      <td >&nbsp;</td>        <td >Host file transfer command</td></tr>
891
1029
<tr><td >hostColorForDefault</td>       <td >green</td> <td >&nbsp;</td>        <td >Default color mapping</td></tr><tr><td >hostColorForIntensified</td>       <td >red</td>   <td >&nbsp;</td>        <td >Default color mapping</td></tr><tr><td >hostColorForProtected</td> <td >blue</td>  <td >&nbsp;</td>        <td >Default color mapping</td></tr><tr><td >hostColorForProtectedIntensified</td>      <td >neutralWhite</td>  <td >&nbsp;</td>        <td >Default color mapping</td></tr><tr><td >icrnl</td> <td >False</td> <td >&nbsp;</td>        <td >Map <font size=-1>CR</font> to <font size=-1>NL</font> on <font size=-1>NVT</font>-mode input</td></tr>
892
1030
<tr><td >inlcr</td>     <td >False</td> <td >&nbsp;</td>        <td >Map <font size=-1>NL</font> to <font size=-1>CR</font> in <font size=-1>NVT</font>-mode input</td></tr>
893
1031
<tr><td >intr</td>      <td >^C</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode interrupt character</td></tr>
894
1032
<tr><td >kill</td>      <td >^U</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode kill character</td></tr>
895
1033
<tr><td >lineWrap</td>  <td >False</td> <td >-set lineWrap</td> <td ><font size=-1>NVT</font> line wrap mode</td></tr>
896
1034
<tr><td >lnext</td>     <td >^V</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode lnext character</td></tr>
 
1035
<tr><td >localCp</td>   <td >(system ANSI code page)</td>       <td >-localcp</td>      <td >Windows code page for local I/O</td></tr>
897
1036
<tr><td >m3279</td>     <td ><a HREF="#rn1">(note 1)</a></td>   <td >-model</td>        <td >3279 (color) emulation</td></tr>
898
1037
<tr><td >marginedPaste</td>     <td >False</td> <td >-set marginedPaste</td>    <td >Keep left margin when pasting</td></tr>
899
1038
<tr><td >monoCase</td>  <td >False</td> <td >-set monoCase</td> <td >Mono-case mode</td></tr>
 
1039
<tr><td >noPrompt</td>  <td >False</td> <td >-noprompt</td>     <td >Disable command-prompt mode</td></tr>
900
1040
<tr><td >numericLock</td>       <td >False</td> <td >&nbsp;</td>        <td >Lock keyboard for numeric field error</td></tr>
901
1041
<tr><td >oerrLock</td>  <td >False</td> <td >&nbsp;</td>        <td >Lock keyboard for input error</td></tr>
902
1042
<tr><td >oversize</td>  <td >&nbsp;</td>        <td >-oversize</td>     <td >Oversize screen dimensions</td></tr>
903
1043
<tr><td >port</td>      <td >telnet</td>        <td >-port</td> <td >Non-default TCP port</td></tr>
904
1044
<tr><td >printer.*</td> <td ><a HREF="#rn4">(note 4)</a></td>   <td >&nbsp;</td>        <td >Printer session config</td></tr>
905
1045
<tr><td >printerLu</td> <td ><a HREF="#rn4">(note 4)</a></td>   <td >&nbsp;</td>        <td >Printer session config</td></tr>
 
1046
<tr><td >printTextFont</td>     <td >Courier New</td>   <td >&nbsp;</td>        <td >PrintText font name</td></tr>
 
1047
<tr><td >printTextSize</td>     <td >8</td>     <td >&nbsp;</td>        <td >PrintText font size</td></tr>
906
1048
<tr><td >quit</td>      <td >^\</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode quit character</td></tr>
 
1049
<tr><td >reconnect</td> <td >False</td> <td >-reconnect</td>    <td >Automatically reconnect to host</td></tr>
907
1050
<tr><td >rprnt</td>     <td >^R</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode reprint character</td></tr>
 
1051
<tr><td >sbcsCgcsgid</td>       <td >&nbsp;</td>        <td >&nbsp;</td>        <td >Override SBCS CGCSGID</td></tr>
908
1052
<tr><td >secure</td>    <td >False</td> <td >&nbsp;</td>        <td >Disable "dangerous" options</td></tr>
909
1053
<tr><td >termName</td>  <td ><a HREF="#rn2">(note 2)</a></td>   <td >-tn</td>   <td ><font size=-1>TELNET</font> terminal type string</td></tr>
910
1054
<tr><td >title</td>     <td >&nbsp;</td>        <td >&nbsp;</td>        <td >Console window title</td></tr>
911
1055
<tr><td >traceFile</td> <td ><a HREF="#rn3">(note 3)</a></td>   <td >-tracefile</td>    <td >File for trace output</td></tr>
 
1056
<tr><td >visualBell</td>        <td >False</td> <td >&nbsp;</td>        <td >Disable bell sound</td></tr>
912
1057
<tr><td >werase</td>    <td >^W</td>    <td >&nbsp;</td>        <td ><font size=-1>NVT</font>-mode word-erase character</td></tr>
913
1058
</table>
914
1059
<p>
940
1085
If more than one <b>-xrm</b> option is given for the same resource,
941
1086
the last one on the command line is used.
942
1087
<a NAME="See-Also"></a><h2>See Also</h2>
943
 
<a HREF="wpr3287-man.html">wpr3287(1)</a>
 
1088
<a HREF="wpr3287-man.html">wpr3287(1)</a>,
 
1089
<a HREF="x3270-script.html">x3270-script(1)</a>
944
1090
<br>
945
1091
Data Stream Programmer's Reference, IBM GA23-0059
946
1092
<br>
952
1098
<br>
953
1099
RFC 2355, TN3270 Enhancements
954
1100
<a NAME="Copyrights"></a><h2>Copyrights</h2>
955
 
<p>
956
 
Modifications and original code Copyright &copy; 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Paul Mattes.
957
 
<br>
958
 
DFT File Transfer Code Copyright  &copy; October 1995 by Dick Altenbern.
959
 
<br>
960
 
RPQNAMES Code Copyright  &copy; 2004, 2005 by Don Russell.
961
 
<br>
962
 
Original X11 Port Copyright &copy; 1990 by Jeff Sparkes.
963
 
<blockquote>Permission to use, copy, modify, and distribute this software and its
964
 
documentation for any purpose and without fee is hereby granted,
965
 
provided that the above copyright notice appear in all copies and that
966
 
both that copyright notice and this permission notice appear in
967
 
supporting documentation.</blockquote>
968
 
Copyright &copy; 1989 by Georgia Tech Research Corporation, Atlanta, GA 30332.
969
 
<blockquote>All Rights Reserved.  GTRC hereby grants public use of this software.
970
 
Derivative works based on this software must incorporate this copyright
971
 
notice.</blockquote>
972
 
<br>
973
 
wc3270 is distributed in the hope that it will be useful, but WITHOUT ANY
974
 
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
975
 
FOR A PARTICULAR PURPOSE.  See the file LICENSE for more details.
 
1101
Copyright &copy; 1993-2009, Paul Mattes.
 
1102
<br>
 
1103
Copyright &copy; 2004-2005, Don Russell.
 
1104
<br>
 
1105
Copyright &copy; 2004, Dick Altenbern.
 
1106
<br>
 
1107
Copyright &copy; 1990, Jeff Sparkes.
 
1108
<br>
 
1109
Copyright &copy; 1989, Georgia Tech Research Corporation (GTRC), Atlanta, GA
 
1110
 30332.
 
1111
<br>
 
1112
All rights reserved.
 
1113
<p>
 
1114
Redistribution and use in source and binary forms, with or without
 
1115
modification, are permitted provided that the following conditions are met:
 
1116
<dl>
 
1117
<dt>*</dt><dd>
 
1118
Redistributions of source code must retain the above copyright notice, this
 
1119
list of conditions and the following disclaimer.
 
1120
<dt>*</dt><dd>
 
1121
Redistributions in binary form must reproduce the above copyright
 
1122
notice, this list of conditions and the following disclaimer in the
 
1123
documentation and/or other materials provided with the distribution.
 
1124
<dt>*</dt><dd>
 
1125
Neither the names of Paul Mattes, Don Russell, Dick Altenbern, Jeff Sparkes,
 
1126
GTRC nor
 
1127
the names of their contributors may be used to endorse or promote
 
1128
products derived from this software without specific prior written
 
1129
permission.
 
1130
</dl>
 
1131
 
 
1132
<p>
 
1133
THIS SOFTWARE IS PROVIDED BY PAUL MATTES, DON RUSSELL, DICK ALTENBERN, JEFF
 
1134
SPARKES AND GTRC
 
1135
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 
1136
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 
1137
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PAUL MATTES, DON RUSSELL, DICK
 
1138
ALTENBERN, JEFF
 
1139
SPARKES OR GTRC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL
 
1140
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
1141
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
1142
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
1143
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 
1144
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 
1145
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
976
1146
<a NAME="Version"></a><h2>Version</h2>
977
 
wc3270 3.3.7p7
 
1147
wc3270 3.3.10ga4
978
1148
<hr>
979
1149
<i>
980
1150
This HTML document and the accompanying troff document were generated with
981
1151
a set of write-only <b>m4</b> macros and the powerful <b>vi</b> editor.
982
 
<br>Last modified 04 July 2008.
 
1152
<br>Last modified 02 October 2009.
983
1153
</i>
984
1154
</body>
985
1155
</html>