home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / O_QWK11.ZIP / SAMPLE.CFG < prev    next >
Text File  |  1993-12-31  |  16KB  |  390 lines
  1. %%%%%%%%%%%%%%%%%%%%%%%%%%%
  2. %                         %
  3. %   Sample O_QWKer.CFG    %
  4. %       version 1.1       %
  5. %                         %
  6. %%%%%%%%%%%%%%%%%%%%%%%%%%%
  7. %
  8. % BBSID          Identification of the  QWK  packet.  This name  is
  9. %                limited to 8 (DOS filename) characters and must be
  10. %                chosen in a way  which can help  users to identify
  11. %                your BBS.  It should be as unique as possible.
  12. %
  13. BBSID  MidiThru
  14. %
  15. % BBSWHERE       Location of your system, to be included in the QWK
  16. % (optional)     packet  header.  This  parameter  is just  to keep
  17. %                compatibility with QWK format definition.
  18. %
  19. BBSWHERE  Aveiro, Portugal
  20. %
  21. % BBSPHONE       Data phone number of your system to be included in
  22. % (optional)     the QWK packet header.  This parameter  is just to
  23. %                keep compatibility with QWK format definition.
  24. %
  25. BBSPHONE  351-34-313554
  26. %
  27. % PRM            .PRM file.  In the  absence of this  command,  the
  28. % (optional)     door uses the  OPUS environment variable  (defined
  29. %                with SET OPUS=xxxx.PRM).
  30. %
  31. % PRM  C:\OPUS\BBS.PRM
  32. %
  33. % NEWS           News file to be included in the QWK packets.
  34. % (optional)
  35. % NEWS  C:\OPUS\QWK\NEWS.TXT
  36. %
  37. % WELCOME        ANSI screen  to be  included  in the  QWK  packets
  38. % (optional)     (it's shown at the beginning of the users off-line
  39. %                reading session).
  40. %
  41. % WELCOME  C:\OPUS\QWK\HELLO.ANS
  42. %
  43. % GOODBYE        ANSI screen  to be  included  in the  QWK  packets
  44. % (optional)     (shown to the users  at the end of their  off-line
  45. %                reading session).
  46. %
  47. % GOODBYE  C:\OPUS\QWK\BYEBYE.ANS
  48. %
  49. % NEWFILES       New files list, to be included in the QWK packets.
  50. % (optional)     This file  must be created by a  separate  program
  51. %                (not included) like Opus-Fam.
  52. %
  53. NEWFILES  C:\OPUS\FILES\NEWFILES.TXT
  54. %
  55. % BULLETINS      Bulletins directory. This directory contains files
  56. % (optional)     with names BLT-*.*,  and the inclusion  in the QWK
  57. %                packets  is based upon  the file date.  This means
  58. %                that  all new bulletins  since the users last call
  59. %                date are included in his/her packet.
  60. %
  61. % BULLETINS  C:\OPUS\BULL\
  62. %
  63. % FORCE          The user may active and deactivate several options
  64. % (optional)     in his/her O_QWKer configuration menu,  to control
  65. %                what is included in their QWK packet. This command
  66. %                exists to control the use of those options  and it
  67. %                is applicable on the following:
  68. %
  69. %                  WELCOME   always include Welcome Screen
  70. %                  GOODBYE   always include Goodbye Screen
  71. %                  NEWS      always include News file
  72. %                  NEWFILES  always include new files list
  73. %                  BULLETINS always include new bulletins
  74. %                  REPLIES   always include messages  originated by
  75. %                            the user
  76. %                  NOVICE    force Novice help level inside O_QWKer
  77. %
  78. % FORCE  NEWS
  79. %
  80. %                There is  another syntax  for this command,  which
  81. %                allows you  to force  the scan of  certain message
  82. %                areas, so that  the user  is  not allowed  to turn
  83. %                them off. That's the AREAS option.
  84. %
  85. % FORCE  AREA  1
  86. %
  87. % EXCLUDE        This command has the opposite effect of FORCE.  In
  88. % (optional)     its first syntax,  it allows you  to deny the user
  89. %                option of  scanning message base  for his/her Opus
  90. %                Alias name. For that you use the option ALIAS.
  91. %
  92. EXCLUDE  ALIAS
  93. %
  94. %                The  second syntax is  AREAS,  and  allows you  to
  95. %                define  message areas  to  be  excluded  from  the
  96. %                available  O_QWKer  areas list  to  any user  with
  97. %                privilege bellow AsstSysop.
  98. %
  99. EXCLUDE  AREAS  0 31 99
  100. %
  101. % FULLSCAN AREA  This command  makes  the message  scanning process
  102. % (optional)     ignore user pointers  and always scan all messages
  103. %                in the areas to which it is applied.
  104. %
  105. %                It  is  useful  in  an  area  where  messages  are
  106. %                frequently deleted,  such as your Local Mail area.
  107. %                In such areas, it is not difficult to have an user
  108. %                pointer directed  beyond  the last message,  which
  109. %                means  no messages will be included in the packet,
  110. %                even if there are some unread. With the full scan,
  111. %                you  guarantee  that  all  eligible  messages  are
  112. %                delivered.
  113. %
  114. %                You should  activate  a  maintenance procedure  to
  115. %                periodically erase received messages  in the areas
  116. %                that you full scan, because even received messages
  117. %                keep being included in the user packets.
  118. %
  119. % FULLSCAN  AREA  1
  120. %
  121. % PACKER TEXT
  122. % PACKER COMPRESS
  123. % PACKER UNCOMPRESS
  124. %                These  three  commands  groups  define  the packet
  125. %                compression scheme available for user selection.
  126. %
  127. %                TEXT - description shown to users
  128. %                COMPRESS -  command used to compress QWK packets
  129. %                UNCOMPRESS - command to uncompress REP packets
  130. %
  131. %                You  may define  up to  eight compression methods.
  132. %                The first one defined is used as default.
  133. %
  134. PACKER  TEXT         Zip 1.10
  135. PACKER  COMPRESS     C:\UTIL\PKZIP.EXE -U
  136. PACKER  UNCOMPRESS   C:\UTIL\PKUNZIP.EXE
  137. %
  138. % REDIRECT COMPRESSORS
  139. % (optional)     This option allows  the redirection  of compressor
  140. %                output  to  the user,  thus giving visual feedback
  141. %                while their QWK packet is being compressed.
  142. %
  143. %                When defined, it is applied to any capable defined
  144. %                compressor, like PKZIP and LHA.
  145. %
  146. %                It is automatically disabled for Local usage.
  147. %
  148. REDIRECT  COMPRESSORS
  149. %
  150. % PROTOCOL TEXT
  151. % PROTOCOL UPLOAD
  152. % PROTOCOL DOWNLOAD
  153. %                These groups of three commands define the transfer
  154. %                options available for user selection.
  155. %
  156. %                TEXT - description shown to users
  157. %                UPLOAD - batch file to upload REP packets
  158. %                DOWNLOAD - batch file to download QWK packets
  159. %
  160. %                You may  define  up to eight protocols.  The first
  161. %                one defined is used as default.
  162. %
  163. %                Please note  you must use  a  batch file,  so that
  164. %                parameters can be passed to the protocol engine.
  165. %
  166. PROTOCOL  TEXT       Zmodem (DSZ)
  167. PROTOCOL  UPLOAD     C:\OPUS\RZ.BAT
  168. PROTOCOL  DOWNLOAD   C:\OPUS\SZ.BAT
  169. %
  170. % NEWLINE        This option defines what character will be used as
  171. % (optional)     CR/LF  in  messages included  in  the packet.  All
  172. %                known off-line readers  expect  the  character "π"
  173. %                (ASCII 227 decimal), so this is the default value.
  174. %
  175. %                Changing the default implies the need of a special
  176. %                reader, but will give the possibility to work with
  177. %                codepages where char 227 may not be made available
  178. %                for separator functions (e.g. Chinese).
  179. %
  180. % NEWLINE  160
  181. %
  182. % MSGID KLUDGE   If this option is defined, all messages entered on
  183. % (optional)     Echomail areas will include a MSGID kludge.
  184. %
  185. % MSGID  KLUDGE
  186. %
  187. % SHOW KLUDGES   If this option is defined, all messages scanned to
  188. % (optional)     Sysop or AsstSysop will include Kludges, Seen-by's
  189. %                and Path lines.
  190. %
  191. % SHOW  KLUDGES
  192. %
  193. % ALTER TEARLINE
  194. % (optional)     According to FTSC documents  and Echomail Policy,
  195. %                only  one  tearline  may  appear  on  an  echomail
  196. %                message.  Nevertheless  it is not uncommon to find
  197. %                messages containing 2 or even 3 of those.  O_QWKer
  198. %                avoids deleting lines from  the  received messages
  199. %                but  will substitute  any  candidate occurrence to
  200. %                -*-
  201. %
  202. %                Going further,  there are many echomail processors
  203. %                which  do not  respect the existence of a tearline
  204. %                in the message and add another one, so this option
  205. %                will avoid the normal inclusion of a tearline, and
  206. %                will rather include:
  207. %
  208. %                 -*- Opus-CBCS x.xx via O_QWKer vxxx
  209. %
  210. %                If you use  the internal  Opus  echomail  scanner,
  211. %                forget about this option,  since you'll never need
  212. %                it.
  213. %
  214. % ALTER TEARLINE
  215. %
  216. % HELPPATH       If this option is defined, it states where O_QWKer
  217. % (optional)     will be looking for the on-line help OEC files. By
  218. %                default,  it  is  used  the path to the executable
  219. %                O_QWKer.EXE.
  220. %
  221. % HELPPATH c:\o_qwker\help
  222. %
  223. %
  224. % STATUS LINE    When this option  is defined,  a  status line will
  225. % (optional)     appear at the console,  allowing the Sysop to know
  226. %                who is using the mail door, the baudrate,  and the
  227. %                caller's remaining time inside O_QWKer.
  228. %
  229. STATUS  LINE
  230. %
  231. % TIMELIMIT      Maximum allowed time  (in minutes)  for an O_QWKer
  232. % (optional)     session. It defaults to 10 (minutes).
  233. %
  234. % TIMELIMIT  15
  235. %
  236. % IDLETIME       Maximum inactivity time (in minutes) allowed while
  237. % (optional)     inside the mail door. It defaults to 3 (minutes).
  238. %
  239. % IDLETIME  2
  240. %
  241. % REFUND         Percentage of  time used  inside  the door  to  be
  242. % (optional)     refunded to the user.  It defaults to 0%  (no time
  243. %                refunded).
  244. %
  245. % REFUND  50
  246. %
  247. % MAXMSGS        Maximum number  of messages which can  be included
  248. % (optional)     in a single QWK packet.
  249. %
  250. %                If used  with  the  PROPORTIONAL  qualifier,  this
  251. %                command refers  to  the number of messages allowed
  252. %                if the user is connected at 1200 baud, so for 2400
  253. %                it's the double the 1200 baud rate, and so on.  By
  254. %                default it assumes the fixed value of 200.
  255. %
  256. %                When O_QWKer is used  in local mode,  PROPORTIONAL
  257. %                resolves  to  2,147,483,647  so  we may say  it is
  258. %                unlimited.
  259. %
  260. MAXMSGS  300
  261. % MAXMSGS  PROPORTIONAL  100
  262. %
  263. % MAXLINES       Maximum number of lines  for each message included
  264. % (optional)     in the QWK packet. If the message is bigger, it is
  265. %                automatically split  in  chunks  (several messages
  266. %                with the same number at the reader). Default is 60
  267. %                lines.
  268. %
  269. MAXLINES  100
  270. %
  271. % LOGMODE        Detail level of the log. The options are:
  272. % (optional)
  273. %                  LOGMODE  TERSE     (light)
  274. %                  LOGMODE  VERBOSE
  275. %                  LOGMODE  TRACE     (lots of info)
  276. %
  277. %                It defaults to VERBOSE.
  278. %
  279. % LOGMODE  TERSE
  280. %
  281. % LOGFILE        O_QWKer log  filename.  It defaults to O_QWKer.LOG
  282. % (optional)     in the executable (O_QWKer.EXE) directory.
  283. %
  284. %                For multi-line  Opus installations  you should use
  285. %                one different file for each task.  You can specify
  286. %                it  by using  the standard  Opus wildcard for task
  287. %                number (##).
  288. %
  289. % LOGFILE  C:\LOG\O_QWKer.LOG
  290. LOGFILE  C:\O_QWKER\LOG##.LOG
  291. %
  292. % TEMPDIR        Directory used by O_QWKer to process packets.  All
  293. %                files in this directory are erased,  so be sure to
  294. %                define it properly.  The  TEMPDIR  value  can also
  295. %                point to a RAMdisk.
  296. %
  297. %                For multi-line Opus installations you should use a
  298. %                different directory for each task. You may specify
  299. %                it  by using  the standard  Opus wildcard for task
  300. %                number (##).
  301. %
  302. %                For security reasons TEMPDIR  defaults to the name
  303. %                \O_QWKER$.TMP  on  the  executable's  volume,  but
  304. %                please  note  this  isn't  an option  but rather a
  305. %                protection to your system.
  306. %
  307. %                A swap directory is also created inside TEMPDIR.
  308. %
  309. %  TEMPDIR  C:\TMPQWK
  310. TEMPDIR  E:\QWK##
  311. %
  312. % KEEPTEMP       By default, all temporary files created during the
  313. % (optional)     message scan process are erased upon generation of
  314. %                the QWK packet.  Use this option  to tell  O_QWKer
  315. %                to keep them  (until the Download messages command
  316. %                is selected again).
  317. %
  318. % KEEPTEMP
  319. %
  320. % QWKAREA        Opus  File Area  number  or Pathname  to where QWK
  321. % (optional)     packets are  to  be moved  in case of  a  Download
  322. %                failure,  so that the user is allowed to perform a
  323. %                deferred download after quitting the mail door.
  324. %
  325. %                In your NERF.BAT file you should check if there is
  326. %                any *.QWK file on the corresponding directory  and
  327. %                erase it  after  each user logs out,  to guarantee
  328. %                that  no  one  will  be  able  to  receive packets
  329. %                belonging to another user.
  330. %
  331. %                If this option is not defined in the configuration
  332. %                file,  O_QWKer  will not try to move the packet to
  333. %                somewhere in case of Download failure.
  334. %
  335. % QWKAREA  10
  336. % QWKAREA  F:\QWKPKT
  337. %
  338. % BADPATH        DOS path where orphaned messages are stored.  This
  339. % (optional)     option  has precedence  over the BAD_ECHO pathname
  340. %                in BBS.CTL.  If neither  exist  (either BADPATH in
  341. %                .CFG file  or  Opus  BAD_ECHO)  then  the orphaned
  342. %                messages are discarded.
  343. %
  344. BADPATH  F:\BADQWK
  345. %
  346. % ASSIGN         This  command  allows  you  to use  O_QWKer across
  347. % (optional)     networks.  Although  it  exists mainly  to support
  348. %                local usage,  it applies to  both local and remote
  349. %                sessions.
  350. %
  351. %                All occurrences of  the path defined  as the first
  352. %                parameter  will be searched in  Opus  system files
  353. %                (SYSMSG.DAT,  SYSFILE.DAT)  and  processed by this
  354. %                door as being the path corresponding to the second
  355. %                parameter, just like DOS Assign command.
  356. %
  357. %                You may declare up to 5 ASSIGN paths.
  358. %
  359. % ASSIGN  C:  O:
  360. % ASSIGN  X:\OPUS\SYSTEM  C:\OPUS
  361. %
  362. % LOCALQWK       Directory  where  QWK  packets  generated in local
  363. %                mode are stored.  This is useful  to a Sysop using
  364. %                his/her off-line reader across a network.
  365. %
  366. %                Default is \O_QWKER$.LOC  on  the volume where the
  367. %                executable is installed.
  368. %
  369. LOCALQWK  N:\SLMR\QWK
  370. %
  371. % LOCALREP       Directory  where  REP packets  to  be processed in
  372. %                local mode are stored.  This is useful  to a Sysop
  373. %                using his/her off-line reader across a network.
  374. %
  375. %                Default is \O_QWKER$.LOC on the binary's volume.
  376. %
  377. LOCALREP  N:\SLMR\REP
  378. %
  379. % LOCALUSER      Name of the LASTUSxx.DAT file  to be used in local
  380. %                mode.  Be aware that if you want to take advantage
  381. %                of the auto-scan O_QWKer feature  in barefoot Opus
  382. %                installations,  you should use the name of correct
  383. %                LASTUSxx.DAT file for your keyboard mode Opus task.
  384. %
  385. LOCALUSER  C:\OPUS\LASTUS02.DAT
  386. %
  387. %%%%%%%%%%%%%%%%%
  388. % END OF Sample %
  389. %%%%%%%%%%%%%%%%%
  390.