From: Art Cancro Date: Tue, 28 Jun 2005 02:58:23 +0000 (+0000) Subject: * docs update X-Git-Tag: v7.86~4811 X-Git-Url: https://code.citadel.org/?a=commitdiff_plain;h=1ca55db39d4593b925c27952b8e32434110becdb;p=citadel.git * docs update --- diff --git a/citadel/ChangeLog b/citadel/ChangeLog index 825481a34..5cc0803ed 100644 --- a/citadel/ChangeLog +++ b/citadel/ChangeLog @@ -1,4 +1,7 @@ $Log$ +Revision 651.5 2005/06/28 02:58:19 ajc +* docs update + Revision 651.4 2005/06/26 22:19:20 ajc * auth.c: applied fleeb's patch to validpw() to clean up FreeBSD compatibility @@ -6891,3 +6894,4 @@ Sat Jul 11 00:20:48 EDT 1998 Nathan Bryant Fri Jul 10 1998 Art Cancro * Initial CVS import + diff --git a/citadel/docs/citadel.html b/citadel/docs/citadel.html index a9d668acb..9d7315d71 100644 --- a/citadel/docs/citadel.html +++ b/citadel/docs/citadel.html @@ -588,7 +588,7 @@ processing) the system. It is mandatory that the sysop have "root" access to the operating system. The following are required to install Citadel:

    -
  • A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX)
    • +
  • A unix-like operating system (Linux, FreeBSD, Solaris, etc.)
  • C compiler (GCC with gmake is the recommended build environment)
    • @@ -601,22 +601,26 @@ newer (if you want the calendar service to work)
  • Enough disk space to hold all of the programs and data

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 +recommended that you run it on a recent distribution (such as Fedora +Core 3 or newer). A new-ish distribution will have most or all of the prerequisite tools and libraries already integrated for you.

-

Now available:

+

Other pieces which complete the Citadel system:

  • "WebCit", a gateway program to allow full access to Citadel via the World Wide Web. Interactive access through any Web browser.
  • Access to Citadel via any standards-compliant e-mail program, thanks to Citadel's built-in SMTP, POP, and IMAP services. You can use Mozilla, Netscape, Evolution, Eudora, Pine, Outlook, etc. -with Citadel.
    • +with Citadel. +
  • Access to Citadel's calendar and address book functions using any +GroupDAV-enabled PIM client (requires WebCit).
    +

Coming soon:

    -
  • Newer and better GUI-based clients.
    • +
  • More integration with third-party software.
    +

Everything in its place...

Hopefully you've unpacked the distribution archive into its own @@ -648,11 +652,11 @@ will use /usr/local/citadel) and the shell should be either "citadel" in that directory, or a script that will start up the citadel client. Example:

-
bbs::100:1:Citadel Login:/usr/local/citadel:/usr/local/citadel/citadel
+
citadel::100:1:Citadel Login:/usr/local/citadel:/usr/local/citadel/citadel

When you run setup later, you will be required to tell it the username or user ID of the account you created is, so it knows what -user to run as. If you create an account called bbs, guest, -or citadel, the setup program will automatically pick up the +user to run as. If you create an account called citadel, bbs, +or guest, the setup program will automatically pick up the user ID by default.

For all other users in /etc/passwd (or in some other name service such as NIS), Citadel will automatically set up @@ -791,8 +795,9 @@ 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.

So if you did this:

-
printcmd="nl|pr|lpr -Plocal"
-

...that would add line numbers, then paginate, then print on the +

printcmd="a2ps -o - |lpr -Plocal"
+

...that would convert the printed text to PostScript, then print on +the printer named "local". There's tons of stuff you can do with this feature. For example, you could use a command like cat <<$HOME/archive to save copies of important messages in a @@ -997,7 +1002,7 @@ install ??

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

    @@ -1750,7 +1755,10 @@ day.

    build and maintain a searchable index of all messages on the system.  This is a time and resource intensive process -- it could take days to build the index if you enable it on a large -database.  Once enabled, however, it will be updated incrementally +database.  It is also fairly memory intensive; we do not recommend +that you enable the index unless your host system has at least 512 MB +of memory.  Once enabled, however, it will be updated +incrementally and will not have any noticeable impact on the interactive response time of your system.  The full text index is currently only searchable when using IMAP clients; other search facilities will be @@ -2281,7 +2289,8 @@ alphabetical and on-disk ordering of the After verifying that your backup completed successfully, delete the committed log files with a command like this: -/usr/local/citadel/sendcommand "CULL"
    +/usr/local/citadel/sendcommand +"CULL"

    Advantage: Citadel continues to run normally during backups.
    @@ -2679,10 +2688,7 @@ require textual input will read it from stdin. Commands which generate textual output will be sent to stdout.

    This utility is intended to be used to enable Citadel server commands to -be executed from shell scripts. Review the script called weekly -which ships with the Citadel distribution for an example of how this -can -be used.

    +be executed from shell scripts.

    NOTE: be sure that this utility is not world-executable. It connects to the server in privileged mode, and therefore could present a security hole