]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/defines.h
ngircd: change MOTD file handling
[ngircd-alex.git] / src / ngircd / defines.h
index a5e5834ad3d1b4abeebec66ade043a99ce5fd99a..579d5521d02772afcf76e65a8ca132c521d98b0f 100644 (file)
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
  *
- * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
- * der GNU General Public License (GPL), wie von der Free Software Foundation
- * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
- * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
- * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
- * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
- *
- * $Id: defines.h,v 1.36 2002/11/23 16:08:18 alex Exp $
- *
- * defines.h: (globale) Konstanten
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * Please read the file COPYING, README and AUTHORS for more information.
  */
 
+
 #ifndef __defines_h__
 #define __defines_h__
 
+/**
+ * @file
+ * Global constants ("#defines") used by the ngIRCd.
+ */
 
 #define NONE -1
 
-#define TIME_RES 2                     /* Zeit-Aufloesung des Servers in Sekunden */
-
-#define FNAME_LEN 256                  /* max. Laenge eines Dateinamen */
-
-#define LINE_LEN 256                   /* max. Laenge einer Konfigurationszeile */
-
-#define HOST_LEN 256                   /* max. Laenge eines Hostnamen */
-
-#define MAX_LISTEN_PORTS 16            /* max. Anzahl von Listen-Ports */
-
-#define MAX_OPERATORS 16               /* max. Anzahl konfigurierbarer Operatoren */
+#define FNAME_LEN 256                  /* Max. length of file name */
+
+#define LINE_LEN 256                   /* Max. length of a line in the
+                                          configuration file */
+
+#define HOST_LEN 256                   /* Max. lenght of fully qualified host
+                                          names (e. g. "abc.domain.tld") */
+
+#define MAX_SERVERS 16                 /* Max. count of configurable servers */
+
+#define MAX_WHOWAS 64                  /* Max. number of WHOWAS items */
+#define DEFAULT_WHOWAS 5               /* default count for WHOWAS command */
+
+#define CONNECTION_POOL 100            /* Size of default connection pool */
+
+#define CLIENT_ID_LEN 64               /* Max. length of an IRC ID; see RFC
+                                          RFC 2812 section 1.1 and 1.2.1 */
+#define CLIENT_NICK_LEN_DEFAULT 10     /* Default nick length, see. RFC 2812
+                                        * section 1.2.1 */
+#define CLIENT_NICK_LEN 32             /* Maximum nick name length */
+#define CLIENT_PASS_LEN 21             /* Max. password length */
+#define CLIENT_USER_LEN 10             /* Max. length of user name ("login")
+                                          see RFC 2812, section 1.2.1 */
+#define CLIENT_NAME_LEN 32             /* Max. length of "real names" */
+#define CLIENT_HOST_LEN 64             /* Max. host name length */
+#define CLIENT_MODE_LEN 9              /* Max. lenth of all client modes */
+#define CLIENT_INFO_LEN 64             /* Max. length of server info texts */
+#define CLIENT_AWAY_LEN 128            /* Max. length of away messages */
+#define CLIENT_FLAGS_LEN 100           /* Max. length of client flags */
+
+#define CHANNEL_NAME_LEN 51            /* Max. length of a channel name, see
+                                          RFC 2812 section 1.3 */
+#define CHANNEL_MODE_LEN 9             /* Max. length of channel modes */
+
+#define COMMAND_LEN 513                        /* Max. IRC command length, see. RFC
+                                          2812 section 3.2 */
+
+#define READBUFFER_LEN 2048            /* Size of the read buffer of a
+                                          connection in bytes. */
+#define WRITEBUFFER_LEN 4096           /* Size of the write buffer of a
+                                          connection in bytes. */
+#define WRITEBUFFER_SLINK_LEN 51200    /* Size of the write buffer of a
+                                          server link connection in bytes. */
+
+#define PROTOVER "0210"                        /* Implemented IRC protocol version,
+                                          see RFC 2813 section 4.1.1. */
+#define PROTOIRC "-IRC"                        /* Protocol suffix, see RFC 2813
+                                          section 4.1.1 */
+#define PROTOIRCPLUS "-IRC+"           /* Protocol suffix used by the IRC+
+                                          protocol, see doc/Protocol.txt */
 
-#define MAX_SERVERS 16                 /* max. Anzahl konfigurierbarer Server ("Peers") */
-
-#define MAX_DEFCHANNELS 16             /* max. Anzahl vorkonfigurierbarerr Channels */
+#ifdef IRCPLUS
+# define IRCPLUSFLAGS "CHLS"           /* Standard IRC+ flags */
+#endif
 
-#define CONNECTION_POOL 100            /* Anzahl Verbindungs-Strukturen, die blockweise alloziert werden */
+#define STARTUP_DELAY 1                        /* Delay outgoing connections n seconds
+                                          after startup. */
+#define RECONNECT_DELAY 3              /* Time to delay re-connect attempts
+                                          in seconds. */
 
-#define CLIENT_ID_LEN 64               /* max. ID-Laenge; vgl. RFC 2812, 1.1 und 1.2.1 */
-#define CLIENT_NICK_LEN 10             /* max. Nick-Laenge; vgl. RFC 2812, 1.2.1 */
-#define CLIENT_PASS_LEN 9              /* max. Laenge des Passwortes */
-#define CLIENT_USER_LEN 9              /* max. Laenge des Benutzernamen ("Login") */
-#define CLIENT_NAME_LEN 32             /* max. Laenge des "langen Benutzernamen" */
-#define CLIENT_HOST_LEN 64             /* max. Laenge des Hostname */
-#define CLIENT_MODE_LEN 8              /* max. Laenge der Client-Modes */
-#define CLIENT_INFO_LEN 64             /* max. Infotext-Laenge (Server) */
-#define CLIENT_AWAY_LEN 128            /* max. Laenger der AWAY-Nachricht */
-#define CLIENT_FLAGS_LEN 100           /* max. Laenger der Client-Flags */
+#define USERMODES "aciorsw"            /* Supported user modes. */
+#define CHANMODES "biIklmnoPstvz"      /* Supported channel modes. */
 
-#define CHANNEL_NAME_LEN 51            /* max. Laenge eines Channel-Namens, vgl. RFC 2812, 1.3 */
-#define CHANNEL_MODE_LEN 8             /* max. Laenge der Channel-Modes */
-#define CHANNEL_TOPIC_LEN 128          /* max. Laenge eines Channel-Topics */
+#define CONNECTED true                 /* Internal status codes. */
+#define DISCONNECTED false
 
-#define COMMAND_LEN 513                        /* max. Laenge eines Befehls, vgl. RFC 2812, 3.2 */
+#define DEFAULT_AWAY_MSG "Away"                /* Away message for users connected to
+                                          linked servers. */
 
-#define READBUFFER_LEN 2 * COMMAND_LEN /* Laenge des Lesepuffers je Verbindung (Bytes) */
-#define WRITEBUFFER_LEN 4096           /* Laenge des Schreibpuffers je Verbindung (Bytes) */
+#define DEFAULT_TOPIC_ID "-Server-"    /* Default ID for "topic owner". */
 
-#define PROTOVER "0210"                        /* implementierte Protokoll-Version (RFC 2813, 4.1.1) */
-#define PROTOIRC "-IRC"                        /* Protokoll-Suffix (RFC 2813, 4.1.1) */
-#define PROTOIRCPLUS "-IRC+"           /* Protokoll-Suffix f\9fr IRC+-Protokoll */
+#define CONFIG_FILE "/ngircd.conf"     /* Configuration file name. */
+#define MOTD_FILE "/ngircd.motd"       /* Name of the MOTD file. */
+#define CHROOT_DIR ""                  /* Default chroot() directory. */
+#define PID_FILE ""                    /* Default file for the process ID. */
 
-#ifdef IRCPLUS
-# define IRCPLUSFLAGS "C"              /* IRC+-Flags, die immer zutreffen */
-#endif
+#define ERROR_DIR "/tmp"               /* Error directory used in debug mode */
 
-#define STARTUP_DELAY 1                        /* Erst n Sek. nach Start zu anderen Servern verbinden */
-#define RECONNECT_DELAY 3              /* Server-Links erst nach 3 Sekunden versuchen, wieder aufzubauen */
+#define MAX_LOG_MSG_LEN 256            /* Max. length of a log message. */
 
-#define USERMODES "aios"               /* unterstuetzte User-Modes */
-#define CHANMODES "biImnoPtv"          /* unterstuetzte Channel-Modes */
+#define TOKEN_OUTBOUND -2              /* Tag for outbound server links. */
 
-#define CONNECTED TRUE                 /* fuer die irc-xxx-Module */
-#define DISCONNECTED FALSE
+#define NOTICE_TXTPREFIX ""            /* Prefix for NOTICEs from the server
+                                          to users. Some servers use '*'. */
 
-#define DEFAULT_AWAY_MSG "Away"                /* Away-Meldung fuer User von anderen Servern */
+#define CUT_TXTSUFFIX "[CUT]"          /* Suffix for oversized messages that
+                                          have been shortened and cut off. */
 
-#ifdef PROTOTYPES
-# define CONFIG_FILE SYSCONFDIR"/ngircd.conf"
-# define MOTD_FILE SYSCONFDIR"/ngircd.motd"
-#else
-# define CONFIG_FILE "ngircd.conf"
-# define MOTD_FILE "ngircd.motd"
+#ifdef ZEROCONF
+#define MDNS_TYPE "_ircu._tcp."                /* Service type to register with mDNS */
 #endif
-#define ERROR_DIR "/tmp"
-
-#define MAX_LOG_MSG_LEN 256            /* max. Laenge einer Log-Meldung */
-
-#define TOKEN_OUTBOUND -2              /* Kennzeichnung fuer ausgehende Server-Links im Aufbau */
-
-#define NOTICE_TXTPREFIX "*** "                /* Kennzeichnung fuer Server-NOTICEs an User */
 
 
 #endif