home *** CD-ROM | disk | FTP | other *** search
/ The Net: Ultimate Internet Guide / WWLCD1.ISO / pc / java / in4wjcxu / other / irc / doc / m4macros < prev    next >
Encoding:
Text File  |  1996-08-14  |  2.1 KB  |  48 lines
  1.  
  2. The following macros are included in "ircd.m4" for use with the m4 text
  3. preprocessor.  "ircd.m4" is parsed before the IRC server conf file so they
  4. are all available for use with that.
  5.  
  6. NOTE:  The "ircd.m4" file is *ONLY* created by a "make install".
  7.  
  8. VERSION - current version string as in patchlevel.h
  9. DEBUGMODE - if DEBUGMODE is define in config.h, is also defined for m4.
  10. HOSTNAME - taken from hostname(1)
  11. USER - username of person doing the "make install"
  12. PORT - default port number as in config.h
  13. PFREQ - default ping frequency as in config.h
  14. CFREQ - default connect frequency as in config.h
  15. MAXSENDQ - default max sendq as in config.h
  16. CL - use this to wrap a class number
  17. HOST - use this to wrap a hostname
  18. HOSTM - use this to wrap the hostmask number in N-lines
  19. ID - when wrapping the host field in an I-line, causes ident string return
  20.      to be used instead of user supplised username.
  21. PASS - use this to wrap passwords in C/N/I/O lines
  22. PING - use this to wrap the ping value in Y-lines
  23. APORT - use this to wrap the port number in I-lines
  24. CPORT - use this to wrap the port number in C-lines
  25. SERV - use this to wrap server names
  26.  
  27. You might use some of these as
  28. C:foo.bar.edu:PASS(boo):foo.bar.edu:APORT(6667)
  29. I:ID(128.250.*)::ID(*.mu.oz.au):CPORT(6667)
  30.  
  31. In addition to these (rather weak macros), some more complete ones are
  32. defined which already perform the above.
  33.  
  34. ADMIN - provide fields to it as you would an A-line
  35. ALLOW - provide fields to it as you would an N-line
  36. BAN - provide fields to it as you would an K-line
  37. CLASS - provide fields to it as you would an Y-line
  38. CLIENT - provide fields to it as you would an I-line
  39. CONNECT - provide fields to it as you would an C-line
  40. ME - provide fields to it as you would an M-line
  41. HUB - first parameter is server you want to hub, second is optional and is
  42.       a mask against which other servers introduced must match against.
  43. LEAF - works like HUB, except that the mask is matched against server names
  44.        to check if the link should be dropped.
  45. SERVER - uses 6 fields, the first 4 as are found in an N-line, the last two
  46.          should be as you would use in a C-line.  It expands out to provide
  47.          both a C and N line.
  48.