Citadel/UX Documentation

Overview

Citadel/UX, when installed properly, will do most of its maintenance +

Citadel, when installed properly, will do most of its maintenance by itself. It is intended to be run unattended for extended periods of time, and most installations do just that without any software failures.

The system has seven access levels. Most users are at the bottom and @@ -1410,7 +1410,7 @@ help files to suit whatever is appropriate for your system.

There are several strings that you can put in help files that will be automatically substituted with other strings. They are:

 
 ^nodename    = The node name of your system on a Citadel/UX network
 ^humannode   = Human-readable node name (also your node name on C86Net)
 ^fqdn        = Your system's fully-qualified domain name
 ^username    = The name of the user reading the help file
 ^usernum     = The user number of the user reading the help file
 ^sysadm      = The name of the system administraor (i.e., you)
 ^variantname = The name of the software you're running
 ^bbsdir      = The directory on the host system in which you have
                installed the Citadel system.

 
 ^nodename    = The node name of your system on a Citadel network
 ^humannode   = Human-readable node name (also your node name on C86Net)
 ^fqdn        = Your system's fully-qualified domain name
 ^username    = The name of the user reading the help file
 ^usernum     = The user number of the user reading the help file
 ^sysadm      = The name of the system administraor (i.e., you)
 ^variantname = The name of the software you're running
 ^bbsdir      = The directory on the host system in which you have
                installed the Citadel system.

So, for example, you could create a help file which looked like:

  "Lots of help, of course, is available right here on ^humannode.  Of
course, if you still have trouble, you could always bug ^sysadm about it!"

Site configuration

@@ -1829,7 +1829,7 @@ the server from a shell and watch it load. It might look something like this:

smw @ pixel % ./citserver

Multithreaded message server for Citadel/UX
Copyright (C) 1987-2003 by the Citadel/UX development team.
Citadel/UX is open source, covered by the GNU General Public License, and
you are welcome to change it and/or distribute copies of it under certain
conditions.  There is absolutely no warranty for this software.  Please
read the 'COPYING.txt' file for details.

Loading citadel.config
Opening databases
This is GDBM version 1.8.0, as of May 19, 1999.
Checking floor reference counts
Creating base rooms (if necessary)
Registered a new service (TCP port 504)
Registered a new service (TCP port 0)
Initializing loadable modules
Registered server command CHAT (Begin real-time chat)
Registered server command PEXP (Poll for instant messages)
Registered server command GEXP (Get instant messages)
Registered server command SEXP (Send an instant message)
Registered server command DEXP (Disable instant messages)
Registered a new session function (type 0)
Registered a new x-msg function (priority 0)
Loaded module: $Id$
Registered a new session function (type 1)
Registered a new message function (type 201)
Registered a new message function (type 202)
Registered server command REGI (Enter registration info)
Registered server command GREG (Get registration info)
Registered a new user function (type 100)
Loaded module: $Id$
Server-hosted upgrade level is 5.62
Loaded module: $Id$
Registered server command EXPI (Expire old system objects)
Registered server command FSCK (Check message ref counts)
Loaded module: $Id$
citserver: Can't bind: Address already in use
ERROR: could not bind to TCP port 25.
Registered a new service (TCP port 0)
Registered a new session function (type 50)
Loaded module: $Id$
citserver: Can't bind: Address already in use
ERROR: could not bind to TCP port 110.
Registered a new session function (type 0)
Loaded module: $Id$
Registered a new message function (type 202)Loaded module: $Id$
Registered server command RWHO (Display who is online)
Registered server command HCHG (Masquerade hostname)
Registered server command RCHG (Masquerade roomname)
Registered server command UCHG (Masquerade username)
Registered server command STEL (Enter/exit stealth mode)
Loaded module: $Id$
Changing uid to 513
Starting housekeeper thread

smw @ pixel % ./citserver

Multithreaded message server for Citadel
Copyright (C) 1987-2003 by the Citadel development team.
Citadel is open source, covered by the GNU General Public License, and
you are welcome to change it and/or distribute copies of it under certain
conditions.  There is absolutely no warranty for this software.  Please
read the 'COPYING.txt' file for details.

Loading citadel.config
Opening databases
This is GDBM version 1.8.0, as of May 19, 1999.
Checking floor reference counts
Creating base rooms (if necessary)
Registered a new service (TCP port 504)
Registered a new service (TCP port 0)
Initializing loadable modules
Registered server command CHAT (Begin real-time chat)
Registered server command PEXP (Poll for instant messages)
Registered server command GEXP (Get instant messages)
Registered server command SEXP (Send an instant message)
Registered server command DEXP (Disable instant messages)
Registered a new session function (type 0)
Registered a new x-msg function (priority 0)
Loaded module: $Id$
Registered a new session function (type 1)
Registered a new message function (type 201)
Registered a new message function (type 202)
Registered server command REGI (Enter registration info)
Registered server command GREG (Get registration info)
Registered a new user function (type 100)
Loaded module: $Id$
Server-hosted upgrade level is 5.62
Loaded module: $Id$
Registered server command EXPI (Expire old system objects)
Registered server command FSCK (Check message ref counts)
Loaded module: $Id$
citserver: Can't bind: Address already in use
ERROR: could not bind to TCP port 25.
Registered a new service (TCP port 0)
Registered a new session function (type 50)
Loaded module: $Id$
citserver: Can't bind: Address already in use
ERROR: could not bind to TCP port 110.
Registered a new session function (type 0)
Loaded module: $Id$
Registered a new message function (type 202)Loaded module: $Id$
Registered server command RWHO (Display who is online)
Registered server command HCHG (Masquerade hostname)
Registered server command RCHG (Masquerade roomname)
Registered server command UCHG (Masquerade username)
Registered server command STEL (Enter/exit stealth mode)
Loaded module: $Id$
Changing uid to 513
Starting housekeeper thread

The lines emphasized in boldface in the above log output tell you that Citadel "can't bind" to various ports. The error 'address already in use' generally means that something else is already running on the @@ -2161,7 +2161,7 @@ backup.

Importing/Exporting your Citadel database

Citadel/UX contains an importer/exporter module, affectionately +

Citadel contains an importer/exporter module, affectionately known as the "Art Vandelay" module (a not-so-obscure Seinfeld reference). It allows you to export the entire contents of your Citadel databases to a diff --git a/citadel/docs/windows-readme.txt b/citadel/docs/windows-readme.txt index ae70580de..be5e5e56e 100644 --- a/citadel/docs/windows-readme.txt +++ b/citadel/docs/windows-readme.txt @@ -3,7 +3,7 @@ README for Windows distribution Installation: - To install Citadel/UX for Windows, run the citadel-X.XX.exe file. It is + To install Citadel for Windows, run the citadel-X.XX.exe file. It is recommended that you do not change the installation folder. Unlike the Unix version, you do NOT need to run Citadel's setup utility before starting the server. However, the system operator will be set to the @@ -20,12 +20,12 @@ Installation: Removal: - To remove Citadel/UX for Windows, go to Start > Control Panel > Add/Remove + To remove Citadel for Windows, go to Start > Control Panel > Add/Remove Programs, click Citadel, then click Add/Remove (or Change/Remove). Your server data (users, messages, etc.) will NOT be removed. To remove these files, delete the C:\Program Files\Citadel\data directory. -Known Issues in Citadel/UX for Windows: +Known Issues in Citadel for Windows: * Calendaring support is not included. Status: TO_BE_FIXED diff --git a/citadel/help/mail b/citadel/help/mail index 69225caee..977b515a1 100644 --- a/citadel/help/mail +++ b/citadel/help/mail @@ -11,7 +11,7 @@ user's name, followed by @ and then the system name. For example, Enter Recipient: Joe Schmoe @ citadrool To send mail to a user on the Internet, type their network address -at the recipient prompt. Citadel/UX will send it over the network: +at the recipient prompt. Citadel will send it over the network: Enter Recipient: ajc@herring.fishnet.com diff --git a/citadel/help/software b/citadel/help/software index e98bba752..5a084ad06 100644 --- a/citadel/help/software +++ b/citadel/help/software @@ -1,5 +1,5 @@ - Citadel/UX is the premier "online community" (i.e. Bulletin Board System) + Citadel is the premier "online community" (i.e. Bulletin Board System) software. It runs on all POSIX-compliant systems, including Linux. It is an advanced client/server application, and is being actively maintained. - For more info, visit UNCENSORED! BBS at uncnsrd.mt-kisco.ny.us + For more info, visit UNCENSORED! BBS at uncensored.citadel.org diff --git a/citadel/messages.c b/citadel/messages.c index af01c502e..f29dddfbe 100644 --- a/citadel/messages.c +++ b/citadel/messages.c @@ -1,7 +1,7 @@ /* * $Id$ * - * Citadel/UX message support routines + * Citadel message support routines * see copyright.txt for copyright information */ diff --git a/citadel/msgform.c b/citadel/msgform.c index 26de208eb..ba6f2fdfc 100644 --- a/citadel/msgform.c +++ b/citadel/msgform.c @@ -6,7 +6,7 @@ * * If the -q (quiet or qwk) flag is used, only the message text prints, and * then it stops at the end of the first message it prints. - * This is used by the QWK reader for Citadel/UX during message format + * This is used by the QWK reader for Citadel during message format * translation. * */ diff --git a/citadel/serv_calendar.c b/citadel/serv_calendar.c index f53719234..e60cba927 100644 --- a/citadel/serv_calendar.c +++ b/citadel/serv_calendar.c @@ -2,7 +2,7 @@ * $Id$ * * This module implements iCalendar object processing and the Calendar> - * room on a Citadel/UX server. It handles iCalendar objects using the + * room on a Citadel server. It handles iCalendar objects using the * iTIP protocol. See RFCs 2445 and 2446. * */ diff --git a/citadel/serv_calendar.h b/citadel/serv_calendar.h index dabbaad45..c12b1408a 100644 --- a/citadel/serv_calendar.h +++ b/citadel/serv_calendar.h @@ -1,7 +1,7 @@ /* * $Id$ * - * iCalendar implementation for Citadel/UX + * iCalendar implementation for Citadel * */ diff --git a/citadel/serv_imap.c b/citadel/serv_imap.c index 3db072c92..e456f925f 100644 --- a/citadel/serv_imap.c +++ b/citadel/serv_imap.c @@ -1,7 +1,7 @@ /* * $Id$ * - * IMAP server for the Citadel/UX system + * IMAP server for the Citadel system * Copyright (C) 2000-2002 by Art Cancro and others. * This code is released under the terms of the GNU General Public License. * @@ -343,7 +343,7 @@ void imap_greeting(void) IMAP->cached_fetch = NULL; IMAP->cached_msgnum = (-1); - cprintf("* OK %s Citadel/UX IMAP4rev1 server ready\r\n", + cprintf("* OK %s Citadel IMAP4rev1 server ready\r\n", config.c_fqdn); } diff --git a/citadel/serv_pop3.c b/citadel/serv_pop3.c index c5325d921..8401acc48 100644 --- a/citadel/serv_pop3.c +++ b/citadel/serv_pop3.c @@ -1,7 +1,7 @@ /* * $Id$ * - * POP3 service for the Citadel/UX system + * POP3 service for the Citadel system * Copyright (C) 1998-2001 by Art Cancro and others. * This code is released under the terms of the GNU General Public License. * @@ -100,7 +100,7 @@ void pop3_greeting(void) { POP3->msgs = NULL; POP3->num_msgs = 0; - cprintf("+OK Citadel/UX POP3 server %s\r\n", + cprintf("+OK Citadel POP3 server %s\r\n", CC->cs_nonce); } diff --git a/citadel/serv_smtp.c b/citadel/serv_smtp.c index 914e0ee53..6f23e086a 100644 --- a/citadel/serv_smtp.c +++ b/citadel/serv_smtp.c @@ -135,7 +135,7 @@ void smtp_greeting(void) { snprintf(SMTP_RECPS, SIZ, "%s", ""); snprintf(SMTP_ROOMS, SIZ, "%s", ""); - cprintf("220 %s ESMTP Citadel/UX server ready.\r\n", config.c_fqdn); + cprintf("220 %s ESMTP Citadel server ready.\r\n", config.c_fqdn); } /* diff --git a/citadel/server_main.c b/citadel/server_main.c index a5199b19f..3e51f93ea 100644 --- a/citadel/server_main.c +++ b/citadel/server_main.c @@ -144,10 +144,10 @@ int main(int argc, char **argv) lprintf(CTDL_NOTICE, "\n"); lprintf(CTDL_NOTICE, "\n"); lprintf(CTDL_NOTICE, - "*** Citadel/UX messaging server engine v%d.%02d ***\n", + "*** Citadel server engine v%d.%02d ***\n", (REV_LEVEL/100), (REV_LEVEL%100)); lprintf(CTDL_NOTICE, - "Copyright (C) 1987-2003 by the Citadel/UX development team.\n"); + "Copyright (C) 1987-2004 by the Citadel development team.\n"); lprintf(CTDL_NOTICE, "This program is distributed under the terms of the GNU " "General Public License.\n"); diff --git a/citadel/setup.c b/citadel/setup.c index 02f59123f..038c5c3e2 100644 --- a/citadel/setup.c +++ b/citadel/setup.c @@ -1,7 +1,7 @@ /* * $Id$ * - * Citadel/UX setup utility + * Citadel setup utility * */ @@ -84,7 +84,7 @@ char *setup_text[] = "you run multiple instances of Citadel on the same computer and there's\n" "something else already using port 504.\n", -"Setup has detected that you currently have data files from a Citadel/UX\n" +"Setup has detected that you currently have data files from a Citadel\n" "version 3.2x installation. The program 'conv_32_40' can upgrade your\n" "files to version 4.0x format.\n" " Setup will now exit. Please either run 'conv_32_40' or delete your data\n" @@ -467,7 +467,7 @@ void check_inittab_entry(void) if (infp == NULL) { display_error(strerror(errno)); } else { - fprintf(infp, "# Start the Citadel/UX server...\n"); + fprintf(infp, "# Start the Citadel server...\n"); fprintf(infp, "%s:2345:respawn:%s -h%s -x3 -llocal4\n", entryname, looking_for, setup_directory); fclose(infp); @@ -761,7 +761,7 @@ int discover_ui(void) #ifdef HAVE_NEWT newtInit(); newtCls(); - newtDrawRootText(0, 0, "Citadel/UX Setup"); + newtDrawRootText(0, 0, "Citadel Setup"); return UI_NEWT; #endif return UI_TEXT; @@ -815,7 +815,7 @@ int main(int argc, char *argv[]) setup_type = discover_ui(); } if (info_only == 1) { - important_message("Citadel/UX Setup", CITADEL); + important_message("Citadel Setup", CITADEL); cleanup(0); } @@ -829,7 +829,7 @@ int main(int argc, char *argv[]) } if (chdir(setup_directory) != 0) { - important_message("Citadel/UX Setup", + important_message("Citadel Setup", "The directory you specified does not exist."); cleanup(errno); } @@ -846,7 +846,7 @@ int main(int argc, char *argv[]) /* Make sure it's stopped. */ if (test_server() == 0) { - important_message("Citadel/UX Setup", + important_message("Citadel Setup", "The Citadel service is still running.\n" "Please stop the service manually and run " "setup again."); @@ -858,7 +858,7 @@ int main(int argc, char *argv[]) case UI_TEXT: printf("\n\n\n" - " *** Citadel/UX setup program ***\n\n"); + " *** Citadel setup program ***\n\n"); break; } @@ -979,7 +979,7 @@ int main(int argc, char *argv[]) /* if (setuid(config.c_bbsuid) != 0) { - important_message("Citadel/UX Setup", + important_message("Citadel Setup", "Failed to change the user ID to your Citadel user."); cleanup(errno); } @@ -995,8 +995,8 @@ int main(int argc, char *argv[]) } if (old_setup_level < 555) { - important_message("Citadel/UX Setup", - "This Citadel/UX installation is too old " + important_message("Citadel Setup", + "This Citadel installation is too old " "to be upgraded."); cleanup(1); } diff --git a/citadel/sysconfig.h b/citadel/sysconfig.h index c06f8f5e5..76f2855dc 100644 --- a/citadel/sysconfig.h +++ b/citadel/sysconfig.h @@ -6,7 +6,7 @@ /****************************************************************************/ /* YOUR SYSTEM CONFIGURATION */ /* Set all the values in this file appropriately BEFORE compiling any of the*/ -/* C programs. If you are upgrading from an older version of Citadel/UX, it */ +/* C programs. If you are upgrading from an older version of Citadel, it */ /* is vitally important that the #defines which are labelled "structure size*/ /* variables" are EXACTLY the same as they were in your old system, */ /* otherwise your files will be munged beyond repair. */ diff --git a/citadel/sysdep.c b/citadel/sysdep.c index 1b89cb4d8..9c97ef21d 100644 --- a/citadel/sysdep.c +++ b/citadel/sysdep.c @@ -1,7 +1,7 @@ /* * $Id$ * - * Citadel/UX "system dependent" stuff. + * Citadel "system dependent" stuff. * See copyright.txt for copyright information. * * Here's where we (hopefully) have most parts of the Citadel server that diff --git a/citadel/techdoc/PAM.txt b/citadel/techdoc/PAM.txt index 35f18809e..fb1d277ce 100644 --- a/citadel/techdoc/PAM.txt +++ b/citadel/techdoc/PAM.txt @@ -5,7 +5,7 @@ if you have Red Hat 7.1, you should look at the file anyway and understand how it affects your system security. The original PAM.txt is included below: - Citadel/UX 5.53 and later include support for Pluggable Authentication + Citadel 5.53 and later include support for Pluggable Authentication Modules (PAM.) However, we don't recommend enabling this feature (./configure --with-pam) unless you understand exactly how it will affect your system's security. Specifically, the system administrator must supply a configuration @@ -24,7 +24,7 @@ authentication modules on other platforms to be able to provide secure configurations. That said, the configuration we've provided should work on at least -Red Hat Linux 4.2-5.2, (although we don't recommend building Citadel/UX on Red +Red Hat Linux 4.2-5.2, (although we don't recommend building Citadel on Red Hat 4.x due to libc thread-safety issues) and if you understand PAM -configuration on your system, feel free to build Citadel/UX with PAM support, +configuration on your system, feel free to build Citadel with PAM support, as long as you realize that YOU'RE ON YOUR OWN. diff --git a/citadel/techdoc/citadelapi.txt b/citadel/techdoc/citadelapi.txt index 1aad5fc2a..00dfa1b46 100644 --- a/citadel/techdoc/citadelapi.txt +++ b/citadel/techdoc/citadelapi.txt @@ -1,4 +1,4 @@ - Citadel/UX Server Extension API Documentation + Citadel Server Extension API Documentation --------------------------------------------- This is a VERY INCOMPLETE documentation of the API for extending the diff --git a/citadel/techdoc/developers.txt b/citadel/techdoc/developers.txt index a88b7d879..71a5a01c5 100644 --- a/citadel/techdoc/developers.txt +++ b/citadel/techdoc/developers.txt @@ -1,16 +1,16 @@ -Every client for the Citadel/UX system is capable of identifying itself with +Every client for the Citadel system is capable of identifying itself with a developer code, client code, and client version. Here are the known values for these fields. Developer codes (and where known, client codes) - 0 The Citadel/UX core development team + 0 The Citadel core development team (See copyright.doc for the list of people involved in the project) Here are the client ID's we've used: Client Name Status Description - 0 Citadel in production Citadel/UX text based client + 0 Citadel in production Citadel text based client 1 lcit dead Curses-based text client 2 WinCit deprecated MS Visual Basic client. Version 1.0 is stable but there @@ -27,7 +27,7 @@ Developer codes (and where known, client codes) Client Name Status Description 0 libCxClient in production Client-side API library - 1 Infusion in production Groupware for Citadel/UX + 1 Infusion in production Groupware for Citadel 2 Matthew Scott diff --git a/citadel/techdoc/hack.txt b/citadel/techdoc/hack.txt index 59c9fbf8d..bbcb0acd7 100644 --- a/citadel/techdoc/hack.txt +++ b/citadel/techdoc/hack.txt @@ -1,5 +1,5 @@ ------------------------------------------------------ - The totally incomplete guide to Citadel/UX internals + The totally incomplete guide to Citadel internals ------------------------------------------------------ Citadel has evolved quite a bit since its early days, and the data structures @@ -280,7 +280,7 @@ T Date/Time A 32-bit integer containing the date and time of the message in standard UNIX format (the number of seconds since January 1, 1970 GMT). U Subject Optional. Developers may choose whether they wish to - generate or display subject fields. Citadel/UX does + generate or display subject fields. Citadel does not generate them, but it does print them when found. 0 Error This field is typically never found in a message on disk or in transit. Message scanning modules are @@ -352,7 +352,7 @@ please see network.txt on its operation and functionality (if any). Portability issues - Citadel/UX is 64-bit clean, architecture-independent, and Year 2000 + Citadel is 64-bit clean, architecture-independent, and Year 2000 compliant. The software should compile on any POSIX compliant system with a full pthreads implementation and TCP/IP support. In the future we may try to port it to non-POSIX systems as well. diff --git a/citadel/techdoc/netconfigs.txt b/citadel/techdoc/netconfigs.txt index 53990bda3..e76cbc1c7 100644 --- a/citadel/techdoc/netconfigs.txt +++ b/citadel/techdoc/netconfigs.txt @@ -42,7 +42,7 @@ e-mail address instead of the sender's e-mail address. SYNTAX: ignet_push_share|uncnsrd DESCRIPTION: Specifies that the second argument is the name of a neighboring node on an -IGnet (Citadel/UX networking) network, to which this room should be pushed +IGnet (Citadel networking) network, to which this room should be pushed (spooled). Conceptually, this node will have a corresponding record pushing data in the other direction. diff --git a/citadel/techdoc/session.txt b/citadel/techdoc/session.txt index 3875d3326..8722916e7 100644 --- a/citadel/techdoc/session.txt +++ b/citadel/techdoc/session.txt @@ -1,4 +1,4 @@ - SESSION LAYER PROTOCOL FOR CITADEL/UX + SESSION LAYER PROTOCOL FOR THE CITADEL SYSTEM (c) 1995-2004 by Art Cancro et. al. All Rights Reserved @@ -6,7 +6,7 @@ ------------ This is an attempt to document the session layer protocol used by the -Citadel/UX system, beginning with version 4.00, which is the first version +Citadel system, beginning with version 4.00, which is the first version to implement a client/server paradigm. It is intended as a resource for programmers who intend to develop their own Citadel clients, but it may have other uses as well. @@ -23,7 +23,7 @@ the same name but perform different functions. If you don't coordinate new developments ahead of time, please at least send in an e-mail documenting what you did, so that your new commands can be added to this document. - The coordinator of the Citadel/UX project is Art Cancro + The coordinator of the Citadel project is Art Cancro . @@ -31,9 +31,9 @@ what you did, so that your new commands can be added to this document. ---------------------- The protocols used below the session layer are beyond the scope of this -document, but we will briefly cover the methodology employed by Citadel/UX. +document, but we will briefly cover the methodology employed by Citadel. - Citadel/UX offers Citadel BBS service using TCP/IP. It does so via a + Citadel offers Citadel BBS service using TCP/IP. It does so via a multithreaded server listening on a TCP port. Local connections may also be made using the same protocol using Unix domain sockets. @@ -124,7 +124,7 @@ an OK result code (the '2' in the 200) and three parameters: 80, 24, and COMMANDS -------- - This is a listing of all the commands that a Citadel/UX server can execute. + This is a listing of all the commands that a Citadel server can execute. NOOP (NO OPeration) @@ -453,11 +453,11 @@ which case that many message pointers will be returned, or "first" plus a number, for the corresponding effect. If no parameters are specified, "all" is assumed. - In Citadel/UX 5.00 and above, the client may also specify "gt" plus a number, + In Citadel 5.00 and above, the client may also specify "gt" plus a number, to list all messages in the current room with a message number greater than the one specified. - The third argument, valid only in Citadel/UX 5.60 and above, may be either + The third argument, valid only in Citadel 5.60 and above, may be either 0 or 1. If it is 1, this command behaves differently: before a listing is returned, the client must transmit a list of fields to search for. The field headers are listed below in the writeup for the "MSG0" command. @@ -588,7 +588,7 @@ parts of the listing: Line 2 - The node name of the server BBS Line 3 - Human-readable node name of the server BBS Line 4 - The fully-qualified domain name (FQDN) of the server - Line 5 - The name of the server software, i.e. "Citadel/UX 4.00" + Line 5 - The name of the server software, i.e. "Citadel 4.00" Line 6 - (The revision level of the server code) * 100 Line 7 - The geographical location of the BBS (city and state if in the US) Line 8 - The name of the system administrator @@ -619,7 +619,7 @@ even if your proprietary extensions aren't supported. -> Please contact Art Cancro and obtain a unique server type code, which can be assigned to your server program. -> If you document what you did in detail, perhaps it can be added to a -future release of the Citadel/UX program, so everyone can enjoy it. Better +future release of the Citadel program, so everyone can enjoy it. Better yet, just work with the Citadel development team on the main source tree. If everyone follows this scheme, we can avoid a chaotic situation with lots @@ -758,7 +758,7 @@ always in some room. The opposite of GETA, used to set the Room Aide for the current room. One parameter should be passed, which is the name of the user who is to be the -new Room Aide. Under Citadel/UX, this command may only be executed by Aides +new Room Aide. Under Citadel, this command may only be executed by Aides and by the *current* Room Aide for the room. Return codes possible are: ERROR + NOT_LOGGED_IN (Not logged in.) ERROR + HIGHER_ACCESS_REQUIRED (Higher access required.) @@ -785,7 +785,7 @@ recipient of the message. 2 - Anonymous flag. This argument is ignored unless the room allows anonymous messages. In such rooms, this flag may be set to 1 to flag a message as anonymous, otherwise 0 for a normal message. - 3 - Format type. Any valid Citadel/UX format type may be used (this will + 3 - Format type. Any valid Citadel format type may be used (this will typically be 0; see the MSG0 command above). 4 - Subject. If present, this argument will be used as the subject of the message. @@ -923,7 +923,7 @@ this will be _BASEROOM_ since it is always there). This command is used to display system messages and/or help files. The single argument it accepts is the name of the file to display. IT IS CASE -SENSITIVE. Citadel/UX looks for these files first in the "messages" +SENSITIVE. Citadel looks for these files first in the "messages" subdirectory and then in the "help" subdirectory. If the file is found, LISTING_FOLLOWS is returned, followed by a pathname @@ -947,7 +947,7 @@ may expect most servers to carry: really paranoid, and warns that aides can still see unlisted userlog entries. - Citadel/UX provides these for the Citadel/UX Unix text client. They are + Citadel provides these for the Citadel Unix text client. They are probably not very useful for other clients: mainmenu - Main menu (when in idiot mode). @@ -1126,7 +1126,7 @@ see elsewhere for more details. ever returned. LISTING_FOLLOWS will be returned, followed by zero or more lines containing the following three fields: - 0 - Session ID. Citadel/UX fills this with the pid of a server program. + 0 - Session ID. Citadel fills this with the pid of a server program. 1 - User name. 2 - The name of the room the user is currently in. This field might not be displayed (for example, if the user is in a private room) or it might @@ -1246,7 +1246,7 @@ read as if it were a download file. This implies that an image and a download cannot be opened at the same time. OIMG returns the same result codes as OPEN. All images will be in GIF (Graphics Interchange Format). In the case of -Citadel/UX, the server will convert the supplied filename to all lower case, +Citadel, the server will convert the supplied filename to all lower case, append the characters ".gif" to the filename, and look for it in the "images" subdirectory. As with the MESG command, there are several "well known" images which are likely to exist on most servers: @@ -1255,7 +1255,7 @@ images which are likely to exist on most servers: goodbye - Logoff banner graphics to be displayed alongside MESG "goodbye" background - Background image (usually tiled) for graphical clients - The following "special" image names are defined in Citadel/UX server version + The following "special" image names are defined in Citadel server version 5.00 and above: _userpic_ - Picture of a user (send the username as the second argument) @@ -1435,7 +1435,7 @@ this line, it must immediately exit from chat mode without sending any further traffic to the server. The next transmission sent to the server will be a regular server command. - The Citadel/UX server understands the following commands: + The Citadel server understands the following commands: /quit - Exit from chat mode (causes the server to do an 000 end) /who - List users currently in chat /whobbs - List users currently in chat and on the bbs @@ -1547,7 +1547,7 @@ is returned. MSG2 follows the same calling convention as MSG0. The difference between the two commands is that MSG2 outputs messages in standard RFC822 format -rather than in Citadel/UX proprietary format. +rather than in Citadel proprietary format. This command was implemented in order to make various gateway programs easier to implement, and to provide some sort of multimedia support in the @@ -1620,7 +1620,7 @@ are to be saved. The first parameter supplied to UIMG should be 0 if the client is only checking for permission to upload, or 1 if the client is actually attempting to begin the upload operation. The second argument is the name of the file to be -transmitted. In Citadel/UX, the filename is converted to all lower case, +transmitted. In Citadel, the filename is converted to all lower case, appended with the characters ".gif", and stored in the "images" directory. UIMG returns OK if the client has permission to perform the requested upload, diff --git a/citadel/vcard.c b/citadel/vcard.c index 4c2bcab01..d0c51e177 100644 --- a/citadel/vcard.c +++ b/citadel/vcard.c @@ -1,7 +1,7 @@ /* * $Id$ * - * vCard implementation for Citadel/UX + * vCard implementation for Citadel * * Copyright (C) 1999 by Art Cancro * This code is freely redistributable under the terms of the GNU General diff --git a/citadel/vcard.h b/citadel/vcard.h index 3a1d06b72..e62e7aeae 100644 --- a/citadel/vcard.h +++ b/citadel/vcard.h @@ -1,7 +1,7 @@ /* * $Id$ * - * vCard implementation for Citadel/UX + * vCard implementation for Citadel * * Copyright (C) 1999 by Art Cancro * This code is freely redistributable under the terms of the GNU General -- 2.30.2

Citadel/UX

Citadel

a messaging and collaboration platform for BBS and groupware applications

Overview

Using an external editor for message composition

Printing messages

Overview

Site configuration

Importing/Exporting your Citadel database