X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fdocs%2Fcitadel.html;h=227a2219d7b7c02f81ad5c7c8d459a46474750f1;hb=d7d893c0cd64ca92ff93457094ec151d106342e9;hp=d564b2a5b7df8fdbf0c279607bb54c36da1ab9a4;hpb=c0a3e8894b0d554b73d404ea496a1836db6e0ed9;p=citadel.git diff --git a/citadel/docs/citadel.html b/citadel/docs/citadel.html index d564b2a5b..227a2219d 100644 --- a/citadel/docs/citadel.html +++ b/citadel/docs/citadel.html @@ -1,13 +1,13 @@ - Citadel/UX Documentation + Citadel Documentation
-

Citadel/UX

+

Citadel

a messaging and collaboration platform for BBS and groupware applications

Copyright ©1987-2004 by the Citadel development team:
@@ -552,7 +552,7 @@ DAMAGES.

Overview

-

Citadel/UX is an advanced, multiuser, client/server messaging system +

Citadel is an advanced, multiuser, client/server messaging system suitable for BBS, e-mail, and groupware applications. It is designed to handle the needs of both small dialup systems and large-scale Internet-connected systems. It was originally developed on an Altos @@ -561,7 +561,7 @@ and Unix-like platforms. The current development environment (and public BBS) is an ordinary Linux system. The current distribution includes:

Some knowledge of the Unix system is necessary to install and manage the system. It is mandatory that the sysop have "root" access to the -operating system. The following are required to install Citadel/UX:

+operating system. The following are required to install Citadel:

-

If you are running Citadel/UX on a Linux system, it is STRONGLY +

If you are running Citadel on a Linux system, it is STRONGLY recommended that you run it on a recent distribution (such as Red Hat 7.3 or newer). A new-ish distribution will have most or all of the prerequisite tools and @@ -751,7 +751,7 @@ The next couple of sections deal with client-side configuration.

Using an external editor for message composition

-

Citadel/UX has a built-in message editor. However, you can also use +

Citadel has a built-in message editor. However, you can also use your favorite text editor to write messages. To do this you simply put a line in your citadel.rc file like this:

editor=/usr/bin/vi
@@ -771,7 +771,7 @@ as' commands disabled, as well as any other functions which a destructive user could use to gain unauthorized access to your host system.

Printing messages

-

Citadel/UX can send messages to a printer, or just about anywhere +

Citadel can send messages to a printer, or just about anywhere else in your system. The variable PRINTCMD in citadel.rc specifies what command you use to print. Text is sent to the standard input (stdin) of the print command.

@@ -841,7 +841,7 @@ this section and do what you need to in order to get things configured.

Before you can use Citadel, you must define the "citadel" service to your system. This is accomplished by adding a line to your /etc/services file that looks something like this:

-
citadel		504/tcp			# Citadel/UX Server
+
citadel		504/tcp			# Citadel Server

504 is the port number officially designated by the IANA for use by Citadel. There should not be any need to use a different port number, unless you are running multiple Citadels on the same computer and @@ -982,7 +982,7 @@ install ??

To report a problem, you can log on to UNCENSORED! or any other BBS -on the Citadel network which carries the Citadel/UX> room. +on the Citadel network which carries the Citadel> room. Please DO NOT e-mail the developers directly. Post a request for help on the BBS, with all of the following information:

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