home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / tserve11.zip / TSERVE1.CFG < prev    next >
Text File  |  1996-01-24  |  10KB  |  233 lines
  1. TSERVE1.CFG
  2. This is a sample configuration file for the TSERVE program.
  3. In fact, it's the very one I use on my first dial-in node!
  4. Each parameter in this file begins with a parameter name which
  5. includes a colon. That name must be the first thing on the line.
  6. Everything after it on the same line is considered to be the
  7. value of that parameter. If a line begins with something other
  8. than a parameter name, the line is considered to be a comment.
  9.  
  10. The first thing to define for a TSERVE node is the COM port.
  11. This can be any valid OS/2 port name. I use a digiboard and
  12. reserve my lower com ports for SIO & VMODEM. You should put
  13. your com port here.
  14.  
  15. PORT: com6
  16.  
  17. Next, specify the task number for this node. Each node must
  18. have it's own unique task number and configuration file. It is
  19. typical to use the same task number as would normally be the
  20. maximus task number. However, this value will be stored as a
  21. string so it is possible to use something other than a number
  22. provided you find another way to give a unique task number to
  23. maximus when it starts.
  24.  
  25. TASK: 1
  26.  
  27. Next, identify the fixed baud rate for the modem. This will be
  28. passed to the PPP program, and is usually passed to maximus in
  29. the -s command line option.
  30.  
  31. BAUD: 57600
  32.  
  33. Next, set up the modem initialization string. It is important
  34. to set this string so that the modem will return result codes
  35. in words, will return the callers connection baud rate, and
  36. will not automatically answer the phone. The modem MUST return
  37. the word RING when there is a caller. If your modem doesn't
  38. return the caller's baud rate (ie. CONNECT 24000) then the
  39. connect speed macro below (%C) will default to the locked rate.
  40. This init string is for my Multi-tech ZDX modems. Note that the
  41. M0 option keeps the modem from making a lot of noise when it's
  42. negotiating a connection. If you prefer to hear the negotiation,
  43. then leave the M0 out.
  44.  
  45. INIT: AT&FH0X1M0S0=0$SB57600X1$R1&E15
  46.  
  47. You'll probably want to use a more generic init string so you
  48. might try this one...(TAKE THE SEMICOLON OUT OF THE FRONT OF
  49. THE ONE YOU WANT TO USE AND PUT IT IN FRONT OF THE ONE YOU
  50. DON'T WANT TO USE.)
  51.  
  52. ; INIT: AT&FH0X1M0S0=0
  53.  
  54. Next, set up the default host IP address for this node. Each
  55. TSERVER node that is running must have a unique IP address
  56. within your domain. If you don't know what I mean by this, you
  57. probably shouldn't be fiddling with this program! The default
  58. host IP address can be over-ridden by a specific caller if
  59. necessary, however it is typical to leave a node's HOST IP
  60. address constant. It is also typical for this address to end
  61. in something less than 10 as it is customary for routers to
  62. have low IP addresses. You cannot use 0 as the final byte!
  63. Replace the address below with your own host address!! DON'T
  64. USE THE ADDRESS BELOW, IT IS ONLY AN EXAMPLE!
  65.  
  66. HOST: 206.239.24.3
  67.  
  68. Next, set up the default user IP address. This address will
  69. usually be assigned to the caller when PPP establishes it's
  70. connection with them. However, the default IP address can be
  71. over-ridden by the user's record in the user file if it is
  72. required. This would normally only happen if you wanted to
  73. assign fixed IP addresses to remote callers.
  74. Replace the address below with your own remote address!!
  75. DON'T USE THE ADDRESS BELOW, IT IS ONLY AN EXAMPLE!
  76.  
  77. USER: 206.239.24.103
  78.  
  79. Next, set the idle timeout number. This value is usually
  80. passed to the PPP program so that it can disconnect the user
  81. after a period (in minutes) of inactivity. Unless you want
  82. to allow people to connect and never leave, you must set and
  83. use this option. I use a setting of 15 minutes which is long
  84. enough for people to relax while browsing the web, but not
  85. long enough for them to go on a lunch break and tie up the
  86. line.
  87.  
  88. IDLE: 15
  89.  
  90. The last seven parameters relate to special macros. Each macro
  91. represents one of the above parameters or a special message
  92. from the tserver program. The following parameters are read
  93. exactly as they are written until the end of the line, and
  94. the macros are expanded without any additional leading or
  95. trailing spaces. All macros begin with a % sign. If you wish
  96. to have a % sign as part of your string then you need to
  97. double it. For example, %P will expand to the port name from
  98. the PORT: parameter above. %%P will expand to a % sign followed
  99. by the capital letter P. The following is a list of the macros
  100. which are available and their meanings.
  101.  
  102. %P    Port name from PORT:
  103. %O    Open port handle.
  104. %T    Task number from TASK:
  105. %H    Host (Local) IP address.
  106. %U    User (Remote) IP address.
  107. %B    Fixed baud rate from BAUD:
  108. %C    Connect speed (read from the modem's connect message.)
  109. %I    Idle time from IDLE:
  110. %L    Login name entered by user.
  111. %S    Password entered by user (secret).
  112. %K    Current Time (clocK).
  113. %A    Current Date (cAlander).
  114. %E    Event string.. (Start, Connect, Close, Error,...)
  115.  
  116. It is very important to remember that these parameters must
  117. fit onto one line. If the parameter is written on more than
  118. one line, only the first line will be expanded. The remaining
  119. lines will be ignored. It is best to use e.exe to edit these
  120. files so that the lines can be as long as needed. However,
  121. in practice, I've never had to edit a line much longer than the
  122. usual 80 characters.
  123.  
  124. The next parameter to set is the name of the log file and it's
  125. options. The log file can be left blank if no logging is
  126. needed, however, it's a good idea to keep one around so that
  127. you can find out about problems before a user has to tell you.
  128. The first part of the parameter is the file name. It can be
  129. any valid path and it can contain any of the expanding macros
  130. from above. It is customary to use the task number %T in the
  131. log file to distinguish it from others. The second part of
  132. the log file parameter determines which events you want to
  133. see stored in the file. This is done by including a list of
  134. capital letters, each corresponding to a specific even that
  135. you want included in the log file. These letters are:
  136.  
  137. B    Begin,... When the program starts.
  138. E    End,... When the program ends.
  139. R    Ring,... when a ring is detected.
  140. N    No caller,... when a connection fails after RING.
  141. L    Login,... Reports the login code entered.
  142. O    No Login,... Reports when no login code is entered.
  143. P    Password,... Reports the password entered.
  144. Q    No Password,... Reports when reqd password not entered.
  145. S    Security,... Reports when a bad password is entered.
  146. I    Link,... Reports when PPP link started.
  147. J    End Link,... Reports when PPP link ended.
  148. M    Maximus,... Reports when BBS is started.
  149. Z    Z End,... Reports when BBS is ended.
  150. X    Xray,... Repoorts when an error occurs.
  151.  
  152. The following log file string works well for billing and most
  153. trouble shooting. If you're really a glutton for punnishemnt,
  154. turn them all on.
  155.  
  156. FILE: tserve%T.log
  157.  
  158. INCL: BLIJX
  159.  
  160. The next parameter tells tserver how to format the log entries
  161. that are created. It produces the output you'll find in the
  162. sample log.
  163.  
  164. LOGS: %A %K %L - %E
  165.  
  166. The next line is the file name of the user list. Please see the
  167. documentation for the format of that file. The user list file can
  168. be specified differently for each node, or set of nodes... It's
  169. entirely up to you.
  170.  
  171. LIST: tserve.usr
  172.  
  173. The next two lines are file names for greeting and passing the user
  174. to the BBS program. The HELO: file is what the user sees when they
  175. first get connected.. This file should identify the system and maybe
  176. the node, as well as give some instructions about how to proceed. If
  177. you haven't registered your tserver package yet, this file will be
  178. followed by a NAG message about the software being unregistered.
  179.  
  180. HELO: tserve.hlo
  181.  
  182. The POST: file is displayed after the tserver program determines that
  183. the user is to be passed to the BBS system. It's really just there to
  184. make the presentation more friendly to the user. If you don't need it
  185. then leave it out or leave it blank.
  186.  
  187. POST: tserve.seg
  188.  
  189. The next two parameter lines really get the work done. The PPP: line
  190. expands into the command line for starting a PPP link. The MAX: line
  191. expands into the command line for starting a BBS session. It is
  192. typical for the entire command line to be set in this file, but if
  193. you really want to get experimental, you could make these lines call
  194. external .CMD or .RXX files. I see no reason why it wouldn't work,
  195. but it's not been tested and it's a lot more overhead.
  196.  
  197. The following PPP line is pretty vanilla and usually works. You can
  198. get really fancy if you like and set up validation and other options
  199. but it's probably not needed in most cases.
  200.  
  201.  
  202. PPP: PPP %P %B mru 1500 rtscts %H:%U netmask 255.255.255.0 modem reneg priority 1 idle %I exit
  203.  
  204. The following BBS line is fairly reliable on multi-node maximus
  205. systems. There is nothing to say that you couldn't put any program
  206. here if you like. If you leave this line out, or leave it blank, then
  207. tserver will end when a user puts in an unknown password or login
  208. code.
  209.  
  210. Notice the "-j%L" parameter. This one lets maximus pick up as if the
  211. user had already typed in their name (which they would have) giving
  212. the appearance that maximus was answering the phone.
  213.  
  214. Notice also that the open port handle is passed to maximus with the
  215. command line option -p%O. Maximus will not be happy about opening the
  216. port by name, it must be passed a "hot" file handle. This is not the
  217. case for the above PPP command since PPP will happily share a com
  218. port that was opened in a share mode. 
  219.  
  220. BBS: MAXP -p%O -n%T -s%B -b%C -ld:\max\max%T.log "-j%L"
  221.  
  222. That's really the end of the file. Of course, you should create your
  223. own configuration files without all of the extra ramblings. If you
  224. have any comments, or if you have an idea to improve the product,
  225. please send e-mail to: peter.mcneil@micro-neil.com or if you'd like
  226. to see this program in action, call the Think Pub at 703-406-8820.
  227. Please report any bugs as well, and be as detailed as you can! We
  228. don't think there are any bugs in here, but anything's possible.
  229. Thanks!
  230.  
  231. More info about Micro-Neil and this product at http://www.micro-neil.com
  232.  
  233.