* shuffled the docs around
authorArt Cancro <ajc@citadel.org>
Sun, 19 Mar 2000 23:37:59 +0000 (23:37 +0000)
committerArt Cancro <ajc@citadel.org>
Sun, 19 Mar 2000 23:37:59 +0000 (23:37 +0000)
citadel/citadel.h
citadel/copyright.txt [deleted file]
citadel/docs/README.txt [deleted file]
citadel/docs/copyright.txt [new file with mode: 0644]
citadel/docs/install.txt
citadel/docs/upgrading.txt
citadel/techdoc/build.txt
citadel/techdoc/chat.txt
citadel/techdoc/developers.txt
citadel/techdoc/hack.txt

index 6a74b5728a1a0673af04e6bb20836b2cad8b7347..72819f61ee3cd479b8c8e13cab449398bc9a9149 100644 (file)
@@ -8,7 +8,7 @@
 #include "sysdep.h"
 #include "sysconfig.h"
 #include "ipcdef.h"
 #include "sysdep.h"
 #include "sysconfig.h"
 #include "ipcdef.h"
-#define CITADEL        "Citadel/UX 5.70b2"
+#define CITADEL        "Citadel/UX 5.70"
 #define REV_LEVEL 570
 #define SERVER_TYPE 0  /* zero for stock Citadel/UX; other developers please
                           obtain SERVER_TYPE codes for your implementations */
 #define REV_LEVEL 570
 #define SERVER_TYPE 0  /* zero for stock Citadel/UX; other developers please
                           obtain SERVER_TYPE codes for your implementations */
diff --git a/citadel/copyright.txt b/citadel/copyright.txt
deleted file mode 100644 (file)
index 24d1fef..0000000
+++ /dev/null
@@ -1,36 +0,0 @@
-                         -----------------------
-                         Citadel/UX version 5.70
-                         -----------------------
-    
-Copyright (c) 1987-2000 by Art Cancro.
-Portions (c) 1998-2000 by Nathan Bryant, Brian Costello, and Ben Mehlman.
-  
-Documentation (c) 2000 by Steve Williams.
-
-base64 encoding/decoding for MIME parser, public domain by John Walker.
-ICQ client code derived from ICQLIB written by Denis V. Dmitrienko.
-  
-'parsedate' function, public domain by Steven M. Bellovin, et. al.
-  
- ------------------------------------------------------------------------------
-    The entire package is free software; you can redistribute
-    and/or modify it under the terms of the GNU General Public License as
-    published by the Free Software Foundation; either version 2 of the 
-    License, or (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- For more information, visit the Citadel/UX web site at UNCENSORED! BBS
- http://uncnsrd.mt-kisco.ny.us
-
diff --git a/citadel/docs/README.txt b/citadel/docs/README.txt
deleted file mode 100644 (file)
index eeed2c1..0000000
+++ /dev/null
@@ -1,197 +0,0 @@
- Citadel/UX release notes -- version 5.50
-  
- ALL FURTHER CHANGES WILL BE IN THE "ChangeLog" FILE.
- Please view that file for further information.
-
- Citadel/UX release notes -- version 5.01 ("Scooby")
-  
- Major overhaul.  The server is now multithreaded; you run one copy of it
-when you bring up your system, rather than having inetd start a separate
-server process for each session.
-  
- Access level 0, which was formerly "marked for deletion," has been changed
-to "deleted."  When a user record is marked access level 0, it is then 
-considered a vacant space in the userlog rather than a user entry.  When
-new users are added to the system, the server first searches for these vacant
-slots before appending to the end of the file.
- The setup program has been overhauled.  It can now operate in three different
-modes: a curses-based mode, a mode based on Savio Lam's "dialog" program, and
-of course dumb-terminal mode.
- All system messages (hello, newuser, etc.) can now be edited from a client
-program.  We now also have support for graphics images, including graphics
-tied to various system objects (such as pictures of each user).
- Much more support for server graphics is in place.  This is currently used
-in WebCit; expect other clients to do more with graphics in the future.
- There really is too much to list here.  More documentation will be written
-as time permits.
-  
- Citadel/UX release notes -- version 4.11
-  
- Smarter usage of external editors.  EDITOR_EXIT is no longer needed.  Instead,
-the program examines temp files before and after they are edited, in order to
-determine whether the user saved the file.  Modified files are saved, unchanged
-files are aborted.
-  
- External editors work for Bio and Room Info files as well.
- The TCP/IP based client (citatcp, linked against ipc_c_tcp.o) now supports
-connection to a Citadel server from behind a SOCKS v4 firewall without having
-to "socksify" the program first.
- Added a few more commands to the chat server.
- Citadel/UX release notes -- version 4.10
-  
- Floors now fully supported in both client and server.
- Now supports "bio" files for each user - free-form text files in which 
-users may record personal info for others to browse.
- <.G>oto and <.S>kip now have more advanced logic for partial matches.  A
-left-aligned match carries a heavier weight than a mid-string match.  For
-example, <.G> TECH would prefer "Tech Area>" over "Biotech/Ethics>".
- Citadel/UX release notes -- version 4.03
- There are now commands available for users with their own copy of the client
-to upload and download directly to their local disk, without having to use
-a protocol such as Zmodem.  These commands are disabled by default, but can
-easily be enabled by changing citadel.rc.
- Multiuser <C>hat is now fully integrated into both the client and server.
- New <P>aging functionality allows users to send each other near-real-time
-"express" messages.
-
- Citadel/UX release notes -- version 4.02
- The "rnews" program has been renamed to "rcit".  Its usage has not changed;
-it still accepts UseNet-style news by default.  Use the -c option to read in
-Citadel (IGnet) format data.
-  
- The text client now compiles and works on systems using BSD-style <sgtty.h>
-in addition to SysV-style <termio.h>.  This should be a big help for many.
- Citadel/UX release notes -- version 4.01
- Remember to always run setup again when using a new version of the code, to
-bring your data files up to date!  No data will be lost.
- This release is primarily to clean up loose ends and fix assorted small
-bug reports from the users of 4.00.  Also, the code is slowly being reworked
-to compile cleanly under ANSI C compilers even when warning messages are
-set to the highest level.
-  
- -> The client now sends periodic "keep-alive" messages to the server during
-message entry, with both internal and external editors.  This should keep
-sessions from locking up when a user hits <S>ave after typing for a long time.
- -> Stats now has a "-b" option for batch mode (see utils.doc)
-    It also has a "-p" option to only print the post-to-call ratios.
- Citadel/UX release notes -- version 4.00
- This is the long-awaited client/server version of Citadel.  Feedback is
-encouraged!
- NOTE: if you are upgrading to 4.00 from a 3.2x release, you should run setup
-to bring your data files up to date.  Setup will prompt you to run the
-"conv_32_40" program; go ahead and do that.
- If you are upgrading to 4.00 from a 3.1x release, setup will not tell you
-what to do!  Here is the correct procedure:
-  1. Run the "conv_31_32" program
-  2. Run setup
-  3. Run "conv_32_40"
- If you are currently running a version earlier than 3.10, you must erase your
-data files and bring up a new system.
- A new series of commands to manipluate files in a room's directory:
-   <.A>ide <F>ile <D>elete   -- delete it
-   <.A>ide <F>ile <M>ove     -- move it to another room
-   <.A>ide <F>ile <S>end     -- send it over the network
-  
- Changed the way the main Citadel program sends network mail, both to other
-Citadels and through the RFC822 gateway.  Everything now gets fed through
-netproc, which is responsible for figuring out the routing and doing the
-actual processing.  It also gets rid of quite a bit of redundant code.
-  
-  
- Citadel/UX release notes -- version 3.23
- NOTE: if you are upgrading to 3.23 from another 3.2x release, you MUST run
-setup to bring your data files up to date.  Run setup and answer "no" when it
-asks you if you want to create the various files.  It will see your old files
-and bring them up to date.  (If you are doing a new installation, of course,
-you'll be creating all new files anyway.)
- The built-in message editor has been completely rewritten, and is now the
-preferable editor to use.  It generates messages that will be formatted to
-the reader's screen width, as in other implementations of Citadel (and as
-Citadel/UX used to do until a few versions ago -- there was a need to put
-that functionality back in).
- Users are now prompted for their screen width AND height.
- We can now talk to C86NET compliant networks.  Get the "cit86net" package
-if you wish to do this.
- Rooms can now optionally be "read only," which means that only Aides and
-utilities such as the networker and aidepost can post to the room.
- Kernel-based file locking is now fully supported for the purpose of locking
-the message base during writes.  If your kernel supports the flock() system
-call, you can tell the compiler to use it by setting a flag in the Makefile.
-If your kernel supports file locking using fcntl(), this will automatically be
-detected and utilized.  If your kernel supports neither, the program will use
-a fully portable (but less reliable) file locking scheme.
- An external editor is no longer required for the .AI command.
-  
- Citadel/UX release notes -- version 3.22
- The "setup" program is now a curses-based, full-screen utility that's very
-easy to use.  Of course, if you have trouble compiling curses-based programs
-on your system, you can compile it to run the old way.
-  
-   
- Citadel/UX release notes -- version 3.21
-   
- I'm now running my system under Linux, since that seems to be what everyone
-is using these days.  As a result, you'll find that version 3.21 will compile
-very cleanly under Linux.
-  
-    
- Citadel/UX release notes -- version 3.20
-  
- Lots of improvements and new features are here.  It seems that assorted
-hacks and variations of Citadel/UX have percolated around the country --
-this 3.2 release should supersede them and get everyone running (hopefully)
-off the same code.  I've looked around at the various mods people have made
-to Citadel/UX and tried to implement the most-often-added and most-requested
-features to the stock distribution.  If there's a feature you want/need that
-still isn't here, drop me a line and I'll see what I can do about adding it
-to the next release.
-
-
-
-
- For more information, visit the Citadel/UX web site at UNCENSORED! BBS
- http://uncnsrd.mt-kisco.ny.us
-
-
diff --git a/citadel/docs/copyright.txt b/citadel/docs/copyright.txt
new file mode 100644 (file)
index 0000000..24d1fef
--- /dev/null
@@ -0,0 +1,36 @@
+                         -----------------------
+                         Citadel/UX version 5.70
+                         -----------------------
+    
+Copyright (c) 1987-2000 by Art Cancro.
+Portions (c) 1998-2000 by Nathan Bryant, Brian Costello, and Ben Mehlman.
+  
+Documentation (c) 2000 by Steve Williams.
+
+base64 encoding/decoding for MIME parser, public domain by John Walker.
+ICQ client code derived from ICQLIB written by Denis V. Dmitrienko.
+  
+'parsedate' function, public domain by Steven M. Bellovin, et. al.
+  
+ ------------------------------------------------------------------------------
+    The entire package is free software; you can redistribute
+    and/or modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation; either version 2 of the 
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ For more information, visit the Citadel/UX web site at UNCENSORED! BBS
+ http://uncnsrd.mt-kisco.ny.us
+
index c2217fe686d2ce80e30a6958f5dc707143338128..31428435a7ccc653d82e8b1393b93d5071f14df7 100644 (file)
@@ -112,7 +112,7 @@ out your system dependencies and set everything correctly.
    By default, the Citadel system will install in /usr/local/citadel.  If you
 wish to place it in a different directory, you can instead do:
  
    By default, the Citadel system will install in /usr/local/citadel.  If you
 wish to place it in a different directory, you can instead do:
  
-   ./configure --prefix=/opt/citadel      (or whatever)
+   ./configure --prefix=/usr/local/citadel      (or whatever)
    
   
    File permissions are always a bother to work with. You don't want the
    
   
    File permissions are always a bother to work with. You don't want the
@@ -283,8 +283,7 @@ yet, this isn't possible.
  
    *** PLEASE TAKE NOTE!! ***   This function really represents the "old"
 way of doing things, and it doesn't fit in well with the client/server
  
    *** PLEASE TAKE NOTE!! ***   This function really represents the "old"
 way of doing things, and it doesn't fit in well with the client/server
-paradigm.  Please consider it "deprecated" because it may be removed at any
-time.
+paradigm.  Please consider it "deprecated" because it may be removed someday.
  
    The "doorway" feature is just a generic way to add features to the system.
 I called it "Doorway" to make it resemble the doors on non-Unix boards, but as
  
    The "doorway" feature is just a generic way to add features to the system.
 I called it "Doorway" to make it resemble the doors on non-Unix boards, but as
@@ -312,8 +311,8 @@ less every day.
  THE PEANUT GALLERY
   
    That's just about all the information you need to install the system.
  THE PEANUT GALLERY
   
    That's just about all the information you need to install the system.
- For more information, visit the Citadel/UX web site at UNCENSORED! BBS
- http://uncnsrd.mt-kisco.ny.us
+For more information, visit the Citadel/UX web site at UNCENSORED! BBS,
+http://uncnsrd.mt-kisco.ny.us
  
    Please note: if you intend to report a problem getting the Citadel server
 to run, please first check the following:
  
    Please note: if you intend to report a problem getting the Citadel server
 to run, please first check the following:
index 7bde7314db0ae77aa8253ce78815c25333fe15cf..9c706423f77775ecac4f173b5a4ceff7cd264e30 100644 (file)
@@ -28,10 +28,10 @@ a one-step migration path.
  
  
   
  
  
   
- Version 5.5x
- ------------
+ Version 5.5x or 5.6x
+ --------------------
  
  
- Upgrading from 5.5x to 5.60 is easy.  Unpack the source and run the
+ Upgrading from 5.[56]x to 5.60 is easy.  Unpack the source and run the
 configure script using "--with-prefix=/your/citadel/directory" just like you
 had done for the previous version.  After the compile is finished, shut down
 the running copy of citserver and do a "make install-exec".  This command
 configure script using "--with-prefix=/your/citadel/directory" just like you
 had done for the previous version.  After the compile is finished, shut down
 the running copy of citserver and do a "make install-exec".  This command
index cfe4810effc5ae620172b55d5ed9147d803a44b9..ce84257c29b6423d1e94cf91db67035fef4ec9c0 100644 (file)
@@ -1,3 +1,7 @@
+Some notes on the build process...
+  
+  
+  
  Oct 28 01:57 1998 from LoanShark @uncnsrd 
 what i've done with the Makefile.in most recently is to replace all the 
 rules that explicitly generated .o files with a set of suffix rules. these 
  Oct 28 01:57 1998 from LoanShark @uncnsrd 
 what i've done with the Makefile.in most recently is to replace all the 
 rules that explicitly generated .o files with a set of suffix rules. these 
index 878475d314d0fa51d36cc810b0877b34b0358eee..9447778f3113896c5cbd050eb8f591bbad9d7b7d 100644 (file)
@@ -1,6 +1,5 @@
 Chat subsystem information
 Chat subsystem information
-Brian Costello
-btx@calyx.net
+Brian Costello <btx@calyx.net>
 
 Chat / Messaging system
 -----------------------
 
 Chat / Messaging system
 -----------------------
index 8a60d24c092eea529ab393b2c10e46643402a00b..bcaa21415a288b0e6da55bca5a6e90bbe0962261 100644 (file)
@@ -1,10 +1,13 @@
+Every client for the Citadel/UX 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)
 
 Developer codes (and where known, client codes)
 
- 0     The Citadel/UX core development team:
-       Art Cancro <ajc@uncnsrd.mt-kisco.ny.us>
-       Nathan Bryant
-       Brian Costello
-       Nick Grossman
+ 0     The Citadel/UX 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
 
        Client  Name            Status          Description
        0       Citadel         in production   Citadel/UX text based client
index 4028ccecc9e166d1195cb387fda811a724819c2f..a03585c6cb260b21a4f7ec2dfabc2b8ac36678a0 100644 (file)
@@ -1,5 +1,5 @@
  hack.txt for Citadel/UX
  hack.txt for Citadel/UX
- (possibly a little out of date)
+ (some of this stuff is *very* out of date.)
    
    Much of this document is borrowed from the original hack.doc from
 Citadel-CP/M and Citadel-86, because many of the concepts are the same.  Hats
    
    Much of this document is borrowed from the original hack.doc from
 Citadel-CP/M and Citadel-86, because many of the concepts are the same.  Hats