home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / windows3 / pcucp15.zip / config.doc next >
Text File  |  1993-11-10  |  9KB  |  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. the MS-DOS editor (edit) 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 efficiency, 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
  86. speed is decremented by 12.5 % if one of BIT5 or BIT7 is used
  87. and by 25 % if both BIT5 and BIT7 are used, assuming that
  88. 8 data bits are available. With 7 data bits, the loss is
  89. 14.2 % or 28.6 % respectively.
  90.  
  91. If Pcucp does not work, try setting both BIT5 and BIT7. This
  92. makes Pcucp use only printable characters and should work
  93. where kermit does. In most cases only BIT5 is sufficient
  94. though, since the problem (if any) usually lies in
  95. 'disappearing' control codes (ascii 0 - 31).
  96.  
  97.  
  98. PADSTR <string>
  99.  
  100. Sets the pad string sent after each packet to <string>
  101. (max. 8 bytes).
  102.  
  103. A pad string is not usually required.
  104.  
  105.  
  106. SALVSTR <string>
  107.  
  108. Sets the 'salvage string' to <string> (max. 64 bytes).
  109.  
  110. This string is sent over the communication line when no
  111. incoming packets have been received in five seconds. It can
  112. be useful when e.g. a ^S generated by line noise has stopped
  113. input from the line. In this specific case a ^Q as SALVSTR
  114. would salvage the connection.
  115.  
  116.  
  117. INDIR <path>
  118.  
  119. Sets the incoming files directory to <path>. The default is
  120. directory "in" in the directory specified by the environment
  121. variable PCUCPDIR. Do not set INDIR equal to OUTDIR (!).
  122.  
  123.  
  124. OUTDIR <path>
  125.  
  126. Sets the outgoing files directory to <path> The default is
  127. directory "out" in the directory specified by the
  128. environment variable PCUCPDIR. Do not set OUTDIR equal to
  129. INDIR (!).
  130.  
  131.  
  132.  
  133. Settings unique to DOS
  134. ---------------------------------------------------------------------
  135.  
  136. LINEPARAMS COM<n>:<bps>,<parity>,<databits>,<stopbits>
  137.  
  138. Sets the com-port and line parameters used. There is no
  139. default for this setting.
  140.  
  141. <n>        : com-port number (1 - 4)
  142. <bps>      : communication speed (e.g. 1200,2400,9600,19200,38400,57600)
  143. <parity>   : parity (N/E/O)
  144. <databits> : databits (7/8)
  145. <stopbits> : stopbits (1/2)
  146.  
  147. The argument has the same format as the DOS's mode command
  148. argument for com-ports.
  149.  
  150. If you have a data compressing modem it is usually a good
  151. idea to set the line speed higher than the nominal line
  152. (modem) speed. Note, however, that the higher speeds (>9600) 
  153. may not be useful without an UART like the 16550 with 
  154. extented line buffers.
  155.  
  156.  
  157. XLAT <in> <out>
  158.  
  159. Sets a translate table entry for the emulated terminal.
  160.  
  161. If the a character to be displayed on the terminal is
  162. <in> it is displayed as <out>. If a character typed is
  163. <out> it is sent as <in>.
  164.  
  165. Note : the special international character codes in a Windows
  166. font probably differ from IBM native ones. Using Windows
  167. Notepad to edit the configuration file might help, since it
  168. uses the Windows codes.
  169.  
  170.  
  171. KEY <string> <key> [SHIFT] [CTRL]
  172.  
  173. Sets a special key mapping, that is, sets the key specified
  174. by <key> to emit <string>. The strings set here bypass the
  175. translations specified with XLAT-keywords.
  176.  
  177. <key> can be any of the following :
  178.  
  179. BS       : backspace
  180. HOME     : Home
  181. UP       : up arrow
  182. PGUP     : PgUp
  183. LEFT     : left arrow
  184. MID      : middle (5)
  185. RIGHT    : right arrow
  186. END      : End
  187. DOWN     : down arrow
  188. PGDN     : PgDn
  189. F1 - F12 : function keys
  190.  
  191. SHIFT and CTRL can be used to specify a key combination
  192. involving these keys.
  193.  
  194.  
  195. FONT <name> [y] [x] [BOLD] [ITALIC]
  196.  
  197. Sets the font used in Pcucp windows (Windows version only).
  198.  
  199. <name>   : font name
  200. [y]      : y-size (pixels)
  201. [x]      : x-size (pixels)
  202. [BOLD]   : use bold-attribute
  203. [ITALIC] : use italic-attribute
  204.  
  205. Use this setting if you are not satisfied with the default
  206. font used.
  207.  
  208. The font must be of a fixed type to work correctly with Pcucp.
  209. Most of Windows fonts are not fixed, and hence the set of
  210. fonts that can be used with this setting is usually very
  211. limited. Also note that the parameters of this keyword are
  212. fed 'as is' to the Windows font selection function which
  213. ultimately selects the font used, hence the actual font can
  214. differ from the one requested.
  215.  
  216. 'Fixedsys' and 'Terminal' are generally available fixed fonts
  217. under Windows 3.1.
  218.  
  219.  
  220. AUTOWRAP <ON | OFF>
  221.  
  222. Controls whether lines longer than the current terminal width
  223. are continued on the next line (ON) or truncated (OFF). The
  224. default value for this setting is ON.
  225.  
  226.  
  227. SCRBUFSIZE <kbytes>
  228.  
  229. Sets the display buffer size in kbytes (characters).
  230.  
  231. <kbytes> : size in kbytes (1 - 32, default 8)
  232.  
  233. Space not needed to store actual screen contents is used for
  234. the scrollback buffer. Note that the amount of memory
  235. actually allocated is twice as much as set with SCRBUFSIZE,
  236. since every character takes two bytes to store, one for the
  237. character itself and one for the related attribute (such as
  238. standout, underline..). Also note that a larger buffer also
  239. means greater cpu overhead when scrolling the buffer contents.
  240.  
  241.  
  242. BGCOLOR <r> <g> <b>
  243. FGCOLOR <r> <g> <b>
  244. STCOLOR <r> <g> <b>
  245.  
  246. BGCOLOR sets the background color used in Pcucp windows.
  247. FGCOLOR sets the foregroung (text) color used in Pcucp windows.
  248. STCOLOR sets the standout (highlight) color used in Pcucp windows.
  249.  
  250. The colors are specified using the RGB-color scheme, where :
  251.  
  252. <r> : red component   (0-255)
  253. <g> : green component (0-255)
  254. <b> : blue component  (0-255)
  255.  
  256. The default colors are :
  257.  
  258. BGCOLOR : 255 255 255 : white
  259. FGCOLOR :   0   0   0 : black
  260. STCOLOR : 128 128 128 : gray
  261.  
  262. Note that your display adapter might not be capable of displaying
  263. all possible RGB-combinations and so Windows might try to mimic a
  264. color by dithering (creating a bit pattern instead of a solid
  265. color). While this may be useful in other contexts it tends to
  266. make text on Pcucp windows unreadable.
  267.  
  268. ---------------------------------------------------------------------
  269. This file is part of Pcucp, Copyright (C) 1992, 1993 Jouni Leppäjärvi
  270. ---------------------------------------------------------------------
  271.