File: ft.inc

package info (click to toggle)
ibm-3270 4.0ga12-3
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 17,740 kB
  • sloc: ansic: 120,111; sh: 4,284; makefile: 822; pascal: 798; perl: 344; exp: 184; tcl: 94
file content (129 lines) | stat: -rw-r--r-- 6,144 bytes parent folder | download | duplicates (18)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
XX_SH(File Transfer)
The XX_FB(Transfer()) action implements XX_FB(IND$FILE) file transfer.
This action requires that the XX_FB(IND$FILE)
program be installed on the XX_SM(IBM) host, and that the 3270 cursor
be located in a field that will accept a XX_SM(TSO) or XX_SM(VM/CMS) command.
XX_LP
ifelse(XX_PRODUCT,x3270,,XX_PRODUCT,s3270,,XX_PRODUCT,tcl3270,,`The XX_FB(Transfer()) action
can be entered at the XX_FB(XX_PRODUCT>) prompt with no parameters, which will cause it
to prompt interactively for the file names and options.
It can also be invoked with parameters to define the entire transfer.
')dnl
XX_LP
Because of the complexity and number of options for file transfer, the
parameters to the XX_FB(Transfer()) action can take the unique form
of XX_FI(option)=XX_FI(value).
They can also be given with their parameters separately.
Options can appear in any order.
Note that if the XX_FI(value) contains spaces (such as a VM/CMS file name),
then the entire parameter must be quoted, e.g., XX_FB("hostfile=xxx foo a").
With sequential options, this would be XX_FB(`hostfile,"xxx foo a"').
The options are:
XX_LP
XX_TS(4,l c l l.)
XX_TR(XX_TD(Option)	XX_TD(Required?)	XX_TD(Default)	XX_TD(Other Values))
XX_T_()
XX_TR(XX_TD(direction)	XX_TD(No)	XX_TD(receive)	XX_TD(send))
XX_TR(XX_TD(hostfile)	XX_TD(Yes)	XX_TD(XX_NBSP)	XX_TD(XX_NBSP))
XX_TR(XX_TD(localfile)	XX_TD(Yes)	XX_TD(XX_NBSP)	XX_TD(XX_NBSP))
XX_TR(XX_TD(host)	XX_TD(No)	XX_TD(tso)	`XX_TD(`vm, cics')')
XX_TR(XX_TD(mode)	XX_TD(No)	XX_TD(ascii)	XX_TD(binary))
XX_TR(XX_TD(cr)	XX_TD(No)	XX_TD(remove)	`XX_TD(`add, keep')')
XX_TR(XX_TD(remap)	XX_TD(No)	XX_TD(yes)	XX_TD(no))
XX_TR(XX_TD(exist)	XX_TD(No)	XX_TD(keep)	`XX_TD(`replace, append')')
XX_TR(XX_TD(recfm)	XX_TD(No)	XX_TD(XX_NBSP)	`XX_TD(`fixed, variable, undefined')')
XX_TR(XX_TD(lrecl)	XX_TD(No)	XX_TD(XX_NBSP)	XX_TD(XX_NBSP))
XX_TR(XX_TD(blksize)	XX_TD(No)	XX_TD(XX_NBSP)	XX_TD(XX_NBSP))
XX_TR(XX_TD(allocation)	XX_TD(No)	XX_TD(XX_NBSP)	`XX_TD(`tracks, cylinders, avblock')')
XX_TR(XX_TD(primaryspace)	XX_TD(Sometimes)	XX_TD(XX_NBSP)	XX_TD(XX_NBSP))
XX_TR(XX_TD(secondaryspace)	XX_TD(No)	XX_TD(XX_NBSP)	XX_TD(XX_NBSP))
XX_TR(XX_TD(avblock)	XX_TD(Sometimes)	XX_TD(XX_NBSP)	XX_TD(XX_NBSP))
XX_TR(XX_TD(buffersize)	XX_TD(No)	XX_TD(4096)	XX_TD(XX_NBSP))
XX_TE()
XX_LP
The option details are as follows.
XX_TPS()dnl
XX_TP(XX_FB(direction))
XX_FB(send) to send a file to the host,
XX_FB(receive) to receive a file from the host.
XX_TP(XX_FB(hostfile))
The name of the file on the host.
XX_TP(XX_FB(localfile))
The name of the file on the local workstation.
XX_TP(XX_FB(host))
The type of host (which dictates the form of the XX_FB(IND$FILE) command):
XX_FB(tso) (the default), XX_FB(vm) or XX_FB(cics).
XX_TP(XX_FB(mode))
Use XX_FB(ascii) (the default) for a text file, which will be translated
between XX_SM(EBCDIC) and XX_SM(ASCII) as necessary.
Use XX_FB(binary) for non-text files.
XX_TP(XX_FB(cr))
Controls how newline characters are handled when transferring
XX_FB(mode=ascii) files.
XX_FB(remove) (the default) strips newline characters in local files
before transferring them to the host.
XX_FB(add) adds newline characters to each host file record before
transferring it to the local workstation.
XX_FB(keep) preserves newline characters when transferring a local file
to the host.
XX_TP(XX_FB(remap))
Controls text translation for XX_FB(mode=ascii) files.
The value XX_FB(yes) (the default) causes XX_PRODUCT to remap the text to ensure
maximum compatibility between the workstation's character set and encoding
and the host's XX_SM(EBCDIC) code page.
The value XX_FB(no) causes XX_PRODUCT to pass the text to or from the host
as-is, leaving all translation to the XX_FB(IND$FILE) program on the host.
XX_TP(XX_FB(exist))
Controls what happens when the destination file already exists.
XX_FB(keep) (the default) preserves the file, causing the
XX_FB(Transfer()) action to fail.
XX_FB(replace) overwrites the destination file with the source file.
XX_FB(append) appends the source file to the destination file.
XX_TP(XX_FB(recfm))
Controls the record format of files created on the host.
(XX_SM(TSO) and XX_SM(VM) hosts only.)
XX_FB(fixed) creates a file with fixed-length records.
XX_FB(variable) creates a file with variable-length records.
XX_FB(undefined) creates a file with undefined-length records (XX_SM(TSO) hosts
only).
The XX_FB(lrecl) option controls the record length or maximum record length for
XX_FB(recfm=fixed) and XX_FB(recfm=variable) files, respectively.
XX_TP(XX_FB(lrecl))
Specifies the record length (or maximum record length) for files created on
the host.
(XX_SM(TSO) and XX_SM(VM) hosts only.)
XX_TP(XX_FB(blksize))
Specifies the block size for files created on the host.
(XX_SM(TSO) and XX_SM(VM) hosts only.)
XX_TP(XX_FB(allocation))
Specifies the units for the XX_FB(primaryspace) and
XX_FB(secondaryspace) options: XX_FB(tracks), XX_FB(cylinders) or
XX_FB(avblock). (XX_SM(TSO) hosts only.)
XX_TP(XX_FB(primaryspace))
Primary allocation for a file.
The units are given by the XX_FB(allocation) option.
Required when the XX_FB(allocation) is specified as something other than
XX_FB(default).
(XX_SM(TSO) hosts only.)
XX_TP(XX_FB(secondaryspace))
Secondary allocation for a file.
The units are given by the XX_FB(allocation) option. (XX_SM(TSO) hosts only.) 
XX_TP(XX_FB(avblock))
Average block size, required when XX_FB(allocation) specifies XX_FB(avblock).
(XX_SM(TSO) hosts only.)
XX_TP(XX_FB(buffersize))
Buffer size for DFT-mode transfers.
Can range from 256 to 32768.
Larger values give better performance, but some hosts may not be able to
support them.
ifelse(XX_PLATFORM,windows,`XX_TP(XX_FB(windowscodepage))
Overrides the workstation code page used for XX_SM(ASCII) file transfers.
By default, the system XX_SM(ANSI) code page is used.
')dnl
XX_TPE()dnl
XX_LP
There are also resources that control the default values for each of the
file transfer parameters.
These resources have the same names as the XX_FB(Transfer()) keywords, but with
XX_FB(ft) prepended and the option name capitalized. E.g., the default for the XX_FB(mode) keyword is the
XX_FB(XX_PRODUCT.ftMode) resource.