added basic ssl support to ircu

[ircu2.10.12-pk.git] / include / ircd_defs.h

diff --git a/include/ircd_defs.h b/include/ircd_defs.h
index e6ad7202dca607336230964b1b39df79989f1451..c3138233d911977d25152f0b7fae135539f4a55b 100644 (file)
--- a/include/ircd_defs.h
+++ b/include/ircd_defs.h
@@ -18,46 +18,34 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  *
  * Commentary by Bleep (Thomas Helvey)
- *
- * $Id$
  */
 #ifndef INCLUDED_ircd_defs_h
 #define INCLUDED_ircd_defs_h
-/*
- * Definitions used everywhere in the server
- * NOTE: Changing any of these definitions is equivalent to a protocol
- * revision. Every server on a given network must also use the same sizes.
- */
-
-/*
- * NETWORK is the name the server claims the network is
- */
-#define NETWORK "UnderNet"
-
-/* 
- * URL_CLIENTS is a URL to where to find compatible clients
+/** @file
+ * @brief Definitions used everywhere in the server.
+ *
+ * NOTE: Changing any of these definitions (except for the
+ * target-related ones at the bottom) is equivalent to a protocol
+ * revision. Every server on a given network must use the same values.
+ * @version $Id$
  */
-#define URL_CLIENTS "ftp://ftp.undernet.org/pub/irc/clients"
 
-/*
- * NICKLEN is the maximum length allowed for a nickname
- *
+/** Maximum length allowed for a nickname.
  * Because certain networks are very helpful in finding bugs, the below
- * is a default that can easily be overridden in CFLAGS.  Just add 
- * -DNICKLEN=15 to CFLAGS and save your config in .., and you can forget about
+ * is a default that can easily be overridden in CFLAGS.  Just add
+ * -DNICKLEN=15 to CFLAGS during configure, and you can forget about
  * it.  Thanks for helping debug guys.
+ * See also F:NICKLEN in ircd.conf.
  */
 #ifndef NICKLEN
-#define NICKLEN         9
+#define NICKLEN         15
 #endif
-/*
- * USERLEN is the maximum length allowed of a user name including an optional
+/** Maximum length allowed of a user name, including an optional
  * leading '~' if the user name has not been authenticated by an auth (RFC 931)
  * server query.
  */
 #define USERLEN         10
-/*
- * HOSTLEN is exactly long enough to hold one (1) segment of FQDN or hostname.
+/** Exactly long enough to hold one (1) segment of FQDN or hostname.
  * This is due to an historical misinterpretation of RFC 1034.
  * 3.1. Name space specifications and terminology
  *
@@ -76,35 +64,39 @@
  * are shorter. It is possible to have a valid FQDN longer than 63 characters.
  */
 #define HOSTLEN         63
-/*
- * REALLEN is the maximum length for user supplied information about a client
+/** Maximum length for the account name, which can be set
+ * with the ACCOUNT (AC) command.  This is used for keeping track of who's
+ * logged into which account, for the benefit of irc services.
+ */
+#define ACCOUNTLEN      12
+/** Maximum length for user supplied information about a client
  * connection (gcos). This information is set at client/server registration
  * time.
  */
 #define REALLEN         50
-/*
- * PASSWDLEN is the maximum length for a password used for connecting servers
- * and clients.
+/** Maximum length for a password used for connecting servers and clients.
  */
 #define PASSWDLEN       20
-/*
- * SOCKIPLEN is the length of a dotted quad ip address "XXX.XXX.XXX.XXX"
+/** Maximum length of a numeric IP (v4 or v6) address.
+ * "ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255"
  */
-#define SOCKIPLEN 15
-/*
- * TOPICLEN is the maximum length for channel topics, kill comments,
- * and quit comments
+#define SOCKIPLEN 45
+/** Maximum length for channel topics and kill comments.
  */
 #define TOPICLEN        160
-/*
- * BUFSIZE is exactly long enough to hold one protocol message (RFC 1459)
- * including the line termination (\r\n).
+/** Maximum length for away messages.
  */
-#define BUFSIZE         512     /* WARNING: *DONT* CHANGE THIS!!!! */
+#define AWAYLEN                160
+/** Exactly long enough to hold one protocol message (RFC 1459)
+ * including the line termination (\\r\\n).  DO NOT CHANGE THIS!!!!
+ */
+#define BUFSIZE         512
 
+/** Maximum available targets for a user. */
 #define MAXTARGETS      20
+/** Starting free targets for a user. */
 #define STARTTARGETS    10
+/** Target number to start assigning new targets. */
 #define RESERVEDTARGETS 12
 
 #endif /* INCLUDED_ircd_defs_h */
-