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