home *** CD-ROM | disk | FTP | other *** search
/ Stars of Shareware: DFÜ und Kommunikation / SOS-DFUE.ISO / programm / dos / utility / pcucp101 / config.doc next >
Encoding:
Text File  |  1993-04-01  |  8.1 KB  |  271 lines
  1. Configuration files
  2. ---------------------------------------------------------------------
  3.  
  4. The configuration files are located in the pcucp directory
  5. specified by the environment variable PCUCPDIR. The filename
  6. suffix for the configuration files is ".cfg".
  7.  
  8. Pcucp always attempts to read the default configuration file
  9. "pcucp.cfg". In addition to this, a configuration file can
  10. be specified in the command line, in which case the settings
  11. in the default configuration file are overridden by the
  12. settings in the explicitly specified configuration file.
  13.  
  14. If the default configuration file does not exist, a
  15. configuration file must be explicitly defined on the command
  16. line.
  17.  
  18. If there is no need for multiple setups, the default
  19. configuration file may be the only configuration file. With
  20. multiple setups, the default settings can be placed in the
  21. default configuration file.
  22.  
  23. The configuration files are plain ascii-text files, which
  24. can be created and modified with any text editor such as
  25. MicroEmacs or Windows Notepad.
  26.  
  27. The settings in a configuration file consist of lines
  28. containing a keyword and arguments. The following sections
  29. "Settings common to unix and dos" and "Settings unique to dos"
  30. list the keywords and the related arguments.
  31.  
  32. Comments are prefixed by the character '#'. This character
  33. and any remaining characters on the same line are ignored.
  34.  
  35. The keywords are not case sensitive.
  36.  
  37. The following escape sequences can be used in string arguments
  38. of the keywords PADSTR, SALVSTR, XLAT and KEY :
  39.  
  40.     \r   : cr
  41.     \n   : nl
  42.     \t   : tab
  43.     \\   : \
  44.     \^   : ^
  45.     \xNN : hexadecimal escape for the number NN
  46.     ^X   : control code corresponding to character X
  47.  
  48.  
  49. Settings common to unix and dos
  50. ---------------------------------------------------------------------
  51.  
  52. PACKETSIZE <n>
  53.  
  54. Sets the packet size to n bytes. There is no default for
  55. this setting. Packet size must be equal in the remote
  56. and the local end for pcucp to function at all.
  57.  
  58. The 'optimum' value for this setting is about 20 - 25 % of 
  59. the line transmit capacity in bytes/s. In general, a bigger 
  60. value increases transmit efficency, but decreases interactivity. 
  61.  
  62. If bitcoding is used, the program adjusts the actual packet
  63. size to be evenly divisible by 8 (if either of BIT5 or BIT7
  64. is used) or 4 (if both BIT5 and BIT7 are used).
  65.  
  66. As an example, lets assume that the line parameters are 
  67. 2400,N,8,1. Now one byte takes 1 start bit, no parity bit,
  68. 8 data bits and 1 stop bit, a total of 10 bits. Hence, the 
  69. line can transmit 2400 / 10 = 240 bytes / s. This suggests
  70. a packet size of 48 - 60 bytes. In the typical case, in which
  71. bitcoding for bit 5 is used a packet size of 56, being evenly
  72. divisible by 8 would seem appropriate.
  73.  
  74.  
  75. BITCODE <NONE> | <BIT5> | <BIT7> | <BIT5 BIT7>
  76.  
  77. Sets the bit coding scheme used. This setting must equal in 
  78. the remote and the local end for pcucp to function at all.
  79.  
  80. NONE      : no coding (default)
  81. BIT5      : bit #5 not used, always 1 (no ctrl-codes)
  82. BIT7      : bit #7 not used, always 0
  83. BIT5 BIT7 : only printable characters used (0x20 - 0x5f)
  84.  
  85. Since all bits in a byte cannot be used, the effective line speed
  86. is decremented by 12.5 % if one of BIT5 or BIT7 is used and 25 %
  87. if both BIT5 and BIT7 are used, assuming that 8 data bits are 
  88. available. With 7 data bits, the loss is 14.2 % or 28.6 % 
  89. respectively.
  90.  
  91. If pcucp does not work, try setting both BIT5 and BIT7. This makes
  92. pcucp use only printable characters and should work where kermit
  93. can be used. In most cases only BIT5 is sufficent though, since
  94. the problem (if any) usually lies in 'disappearing' conrol codes
  95. (ascii 0 - 31).
  96.  
  97.  
  98. PADSTR <string>
  99.  
  100. Sets the pad string sent after each packet to <string> (max. 8 bytes).
  101.  
  102. A pad string is not usually required.
  103.  
  104.  
  105. SALVSTR <string>
  106.  
  107. Sets the 'salvage string' to <string> (max. 64 bytes).
  108.  
  109. This string is sent over the communication line when no
  110. incoming packets have been received in five seconds. It can
  111. be useful when e.g. a ^S generated by line noise has stopped
  112. input from the line. In this specific case a ^Q as SALVSTR
  113. would salvage the connection.
  114.  
  115.  
  116. INDIR <path>
  117.  
  118. Sets the incoming files directory to <path>. The default is
  119. directory "in" in the directory specified by the environment
  120. variable PCUCPDIR. Do not set INDIR equal to OUTDIR (!).
  121.  
  122.  
  123. OUTDIR <path>
  124.  
  125. Sets the outgoing files directory to <path> The default is
  126. directory "out" in the directory specified by the environment
  127. variable PCUCPDIR. Do not set OUTDIR equal to INDIR (!).
  128.  
  129.  
  130.  
  131. Settings unique to DOS
  132. ---------------------------------------------------------------------
  133.  
  134. LINEPARAMS COM<n>:<bps>,<parity>,<databits>,<stopbits>
  135.  
  136. Sets the com-port and line parameters used. There is no default
  137. for this setting.
  138.  
  139. <n>        : com-port number (1 - 4)
  140. <bps>      : communication speed (e.g. 1200,2400,4800,9600,19200)
  141. <parity>   : parity (N/E/O)
  142. <databits> : databits (7/8)
  143. <stopbits> : stopbits (1/2)
  144.  
  145. The argument has the same format as the DOS's mode command argument
  146. for com-ports.
  147.  
  148. The highest speed supported by the Windows com-driver is currently
  149. 19200 bps. The dos-version supports also speeds 38400, 57600 and
  150. 115200 bps. These may not work with all machines / serial hardware,
  151. however.
  152.  
  153.  
  154. XLAT <in> <out>
  155.  
  156. Sets a translate table entry for the emulated terminal.
  157.  
  158. If the a character to be displayed on the terminal is
  159. <in> it is displayed as <out>. If a character typed is
  160. <out> it is sent as <in>.
  161.  
  162. Note : the special international character codes in a Windows
  163. font probably differ from IBM native ones. Using Windows
  164. Notepad to edit the configuration file might help, since it
  165. uses the Windows codes.
  166.  
  167.  
  168. KEY <string> <key> [SHIFT] [CTRL]
  169.  
  170. Sets a special key mapping, that is, sets the key specified 
  171. by <key> to emit <string>. The strings set here bypass the
  172. translations specified with XLAT-keywords.
  173.  
  174. <key> can be any of the following :
  175.  
  176. BS       : backspace
  177. HOME     : Home
  178. UP       : up arrow
  179. PGUP     : PgUp
  180. LEFT     : left arrow
  181. RIGHT    : right arrow
  182. END      : End
  183. DOWN     : down arrow
  184. PGDN     : PgDn
  185. F1 - F12 : function keys (Note that F1 is a Windows system key.)
  186.  
  187. SHIFT and CTRL can be used to specify a key combination involving
  188. the Shift- or/and Ctrl-keys.
  189.  
  190.  
  191. FONT <name> [y] [x] [BOLD] [ITALIC]
  192.  
  193. Sets the font used in Pcucp windows (Windows version only).
  194.  
  195. <name>   : font name
  196. [y]      : y-size (pixels)
  197. [x]      : x-size (pixels)
  198. [BOLD]   : use bold-attribute
  199. [ITALIC] : use italic-attribute
  200.  
  201. Use this setting only if you are not satisfied with the default
  202. font used.
  203.  
  204. The font must be of a fixed type to work correctly with pcucp. 
  205. Most of Windows fonts are not fixed, and hence the set of fonts 
  206. that can be used with this setting is usually very limited. 
  207. Also note that the parameters of this keyword are fed 'as is' 
  208. to the Windows font selection function which ultimately selects 
  209. the font used, hence the actual font can differ from the one 
  210. requested.
  211.  
  212. 'Fixedsys' and 'Terminal' are genrally available fixed fonts 
  213. under Windows 3.1. 
  214.  
  215.  
  216.  
  217. Sample dos configuration file
  218. ---------------------------------------------------------------------
  219.  
  220. # Basic settings
  221. packetsize 56 
  222. bitcode BIT5
  223. lineparams COM2:2400,N,8,1 # as with MODE
  224.  
  225. # Translations for the scandinavian special characters
  226. # (Windows - typical case)
  227. xlat {  \xE4 # ä
  228. xlat }  \xE5 # å
  229. xlat |  \xF6 # ö
  230. xlat [  \xC4 # Ä
  231. xlat ]  \xC5 # Å
  232. xlat \\ \xD6 # Ö
  233.  
  234. # (DOS - native IBM-codes)
  235. #xlat {  ä
  236. #xlat }  å
  237. #xlat |  ö
  238. #xlat [  Ä
  239. #xlat ]  Å
  240. #xlat \\ Ö
  241.  
  242. # Key mappings useful with emacs
  243. key \x7f BS
  244. key ^A   HOME
  245. key ^P   UP
  246. key ^B   LEFT
  247. key ^F   RIGHT
  248. key ^E   END
  249. key ^N   DOWN
  250. key ^D   DEL
  251.  
  252. # I have the impression that Fixedsys is 
  253. # generally available with Windows 3.1
  254. # and can be used as an alternate font.
  255. #FONT Fixedsys
  256.  
  257.  
  258.  
  259. Sample unix configuration file
  260. ---------------------------------------------------------------------
  261.  
  262. # Basic settings
  263. packetsize 56
  264. bitcode bit5
  265.  
  266.  
  267.  
  268. ---------------------------------------------------------------------
  269. This file is part of pcucp, Copyright (C) 1992 Jouni Leppäjärvi
  270. ---------------------------------------------------------------------
  271.