* Changed the comments at the beginning of each file to a consistent format
[citadel.git] / citadel / sysconfig.h
1 /*
2  * $Id$
3  *
4  */
5
6 /****************************************************************************/
7 /*                  YOUR SYSTEM CONFIGURATION                               */
8 /* Set all the values in this file appropriately BEFORE compiling any of the*/
9 /* C programs. If you are upgrading from an older version of Citadel/UX, it */
10 /* is vitally important that the #defines which are labelled "structure size*/
11 /* variables" are EXACTLY the same as they were in your old system,         */
12 /* otherwise your files will be munged beyond repair.                       */
13 /****************************************************************************/
14
15 /* $Id$ */
16
17 /* NOTE THAT THIS FILE IS MUCH, MUCH SMALLER THAN IT USED TO BE.
18  * That's because the setup program now creates a citadel.config file with
19  * all of the settings that don't really need to be in a header file.
20  * You can now run setup whenever you want, and change lots of parameters
21  * without having to recompile the whole system!
22  */
23
24 /*
25  * If you want to keep a transcript of all multiuser chats that go across
26  * your system, define CHATLOG to the filename to be saved to.  Otherwise,
27  * set CHATLOG to "/dev/null".
28  */
29 #define CHATLOG         "chat.log"
30
31 /*
32  * SLEEPING refers to the watchdog timer.  If a user sits idle without typing
33  * anything for this number of seconds, the session will automatically be
34  * logged out.  Set it to zero to disable this feature.
35  * Note: the watchdog timer only functions when the parent is 1 (init) - in
36  * other words, only if Citadel is the login shell. 
37  */
38 #define SLEEPING        180
39
40 /* 
41  * S_KEEPALIVE is also a watchdog timer, except it is used to send "keep
42  * alive" messages to the server to prevent the server from assuming the
43  * client is dead and terminating the session.  30 seconds is the recommended
44  * value; I can't think of any good reason to change it.
45  */
46 #define S_KEEPALIVE     30
47
48 /*
49  * This is the command that gets executed when a user hits <E>nter message:
50  * presses the <E>nter message key.  The possible values are:
51  *   46 - .<E>nter message with <E>ditor
52  *   4  - .<E>nter <M>essage
53  *   36 - .<E>nter message with <A>scii
54  * Normally, this value will be set to 4, to cause the <E>nter message
55  * command to run Citadel's built-in editor.  However, if you have an external
56  * editor installed, and you want to make it the default, set this to 46
57  * to make it use your editor by default.
58  */
59 #define DEFAULT_ENTRY           4
60
61
62 /*
63  * Logging level to use if none is specified on the command line.
64  */
65 #define DEFAULT_VERBOSITY       9
66
67
68 /*
69  * HOUSEKEEPING_WAKEUP is the number of seconds which pass between each pass
70  * of the housekeeping thread.  This normally happens once per minute and there
71  * isn't any good reason to change it.
72  */
73 #define HOUSEKEEPING_WAKEUP     60
74
75
76 /*
77  * NLI is the string that shows up in a <W>ho's online listing for sessions
78  * that are active, but for which no user has yet authenticated.
79  */
80 #define NLI     "(not logged in)"
81
82 /*
83  * Maximum number of floors on the system.
84  * WARNING!  *Never* change this value once your system is up; THINGS WILL DIE!
85  * Also, do not set it higher than 127.
86  */
87 #define MAXFLOORS       16
88
89
90 /*
91  * SMTP delivery retry and give-up times
92  */
93 #define SMTP_RETRY_INTERVAL     900     /* retry sends every 15 minutes */
94 #define SMTP_GIVE_UP            432000  /* give up after 5 days */
95
96
97 /*
98  * The names of rooms which are automatically created by the system
99  */
100 #define BASEROOM                "Lobby"
101 #define MAILROOM                "Mail"
102 #define AIDEROOM                "Aide"
103 #define USERCONFIGROOM          "My Citadel Config"
104 #define PAGELOGROOM             "Sent/Received Pages"
105 #define SYSCONFIGROOM           "Local System Configuration"
106 #define SMTP_SPOOLOUT_ROOM      "__CitadelSMTPspoolout__"