 
                 Citadel/UX distribution client release 4.11.3
                 ---------------------------------------------
 
         (c) 1987-1997 by Art Cancro, Uncensored Communications Group
   Use, duplication, or disclosure subject to the terms of the GNU General
                 Public License.  All other rights reserved.
 
  
 WHAT THIS DISTRIBUTION CONTAINS
 
 This is a standalone client that you can compile on any Unix or Unix-like
system for easy access to BBS's running the Citadel/UX software.  It's better
than using telnet because:
 
 -> There's less netlag
 -> It's configurable to your liking
 -> It eases the processing burden on the host system
 
 
 IF YOU HAVE A SOURCE CODE DISTRIBUTION...
 
 If you downloaded source code, simply edit the Makefile to reflect whatever
operating system you're running it on, and run 'make'.  It should run a couple
of tests on your system and generate the 'citadel' and 'whobbs' executables.
 
 
 WHAT IS ALL THIS STUFF?
 
 citadel    - the executable client program
 whobbs     - a program to see who's logged in, without logging in yourself
 citadel.rc - the customizable settings file for your client program
 
 So where do you put it?  If you're setting up the client just for yourself,
there's no need to move it around.  Just keep it all in one directory and
it'll work fine.  If you're setting up the Citadel client for use by multiple
people on the same system, you'll want to put the 'citadel' and 'whobbs'
executables in a public executables directory (such as /usr/local/bin) and
put the 'citadel.rc' in /usr/local/lib.  In the latter case, any user may
place a .citadelrc file in his/her home directory, and its settings will
override the settings in the public citadel.rc file.
 
 
 HOW DO I CUSTOMIZE CITADEL.RC?
 
 It's sufficiently self-documented; just edit whatever you feel like editing
and try it out.  If you're setting up a personal .citadelrc for yourself,
do keep in mind that you must start by copying a working citadel.rc and
making changes to it.  It will *not* look in a public file for settings
missing from your private file.
 
 Some of the things you can customize:
 
 -> You can set it up to use the text editor of your choice for entering
messages, and optionally choose to edit via this method by default
 -> You can customize the action of a <P>rint command
 -> You can arrange for it to automatically transmit your user name and
password to the host system
 -> You can even fully customize the available command set
 
 
 HOW DO I RUN IT?
 
 The usage of the citadel command is:
 
 citadel [host name] [port number] [-s socks_server]
 
 If the port number is missing, it will use port 504, which is the standard
number assigned by the IANA for Citadel servers.  If the host name is missing,
it will connect to uncnsrd.mt-kisco.ny.us, which is the host name for
UNCENSORED! BBS, the home of Citadel/UX.
 
 If you're sitting behind a firewall that's running SOCKS v4, you can specify
its address using the -s parameter.
 
 The usage of the whobbs command is identical.
 
 
 FREQUENTLY ASKED QUESTIONS
 
 Q: I can't connect to <some particular BBS> using the client, but I know
there's a Citadel there, I can telnet to it!  What's wrong?
 
 A: The BBS you are connecting to must be running Citadel/UX version 4.00 or
above, or a variant of Citadel/UX which is based on it.  There are a number
of variants, such as DaveCode, Citadel/DC, and DOC, which are based on
Citadel/UX version 3.xx which did not support client/server access.  (DOC
supports client/server, but it uses a vastly less sophisticated protocol which
is incompatible with the one your client software uses.)  If you wish to
connect to one of these BBS's you must telnet to them.
 
 Q: I downloaded the source code version, and I edited the Makefile, but when
I tried to compile it I got several pages of "undefined reference" errors.
How do I fix them?
 
 A: This is usually symptomatic of having accidentally removed a trailing
backslash somewhere in the Makefile.  Any multi-line compile command must
contain backslashes at the end of all lines except the last one.  Fix the
Makefile and compile again.
 
 Q: What does "commands: cannot open citadel.rc" mean?
 
 A: It can't find your citadel.rc file.  The client program will look in
the following order for its configuration file:
  1. $HOME/.citadelrc
  2. /usr/local/lib/citadel.rc
  3. ./citadel.rc
   Make sure your configuration file can be found in one of these locations.
 
 
 
 Comments and suggestions are welcome.  Please send feedback to
ajc@uncnsrd.mt-kisco.ny.us or visit UNCENSORED! BBS (use the client!).
