summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2013-04-06 13:14:41 +0200
committerPaul Buetow <paul@buetow.org>2013-04-06 13:14:41 +0200
commitae4e87df37ed8904de92c7cf2f3a11128cda2a21 (patch)
tree5333f2930165cc6e4083ce15154799626ddb3d03 /README
parent9cd3ccffd5372dfde3af478e3f832f18db4be3f1 (diff)
tagging ychat-0.7.4.1ychat-0.7.4.1
Diffstat (limited to 'README')
-rwxr-xr-x[-rw-r--r--]README498
1 files changed, 139 insertions, 359 deletions
diff --git a/README b/README
index 2c2851c..b7bf61e 100644..100755
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
-yChat; Homepage: www.yChat.org; Version 0.8.3-CURRENT
+yChat; Homepage: www.yChat.org; Version 0.7.4.1-RELEASE
Copyright (C) 2003 Paul C. Buetow, Volker Richter
-Copyright (C) 2005 EXA Digital Solutions GbR
-Copyright (C) 2004, 2006 Paul C. Buetow
+Copyright (C) 2004, 2005 Paul C. Buetow
-----------------------------------------------------------------
+
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
@@ -21,125 +21,27 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
YCHAT TABLE OF CONTENTS:
-1.0.0 GENERAL
-1.1.0 ABOUT RELEASES
-1.2.0 YCHAT FEATURES //<<
-2.0.0 INSTALLATION AND SETUP
-2.1.0 REQUIREMENTS
-2.2.0 TESTED PLATFORMS
-2.3.0 HOW TO OBTAIN YCHAT
-2.4.0 INSTALLATION QUICK-START
-2.4.1 INSTALLATION
-2.5.0 HOW TO USE OPENSSL WITH YCHAT
-2.5.1 HOW TO USE SCREEN WITH YCHAT
-2.5.2 HOW TO USE SIGNALS WITH YCHAT
-2.5.3 HOW TO USE GNU READLINE WITH YCHAT
-2.5.4 HOW TO USE MYSQL WITH YCHAT //<<
-2.6.0 CUSTOMIZING YCHAT
-2.7.0 YHTTPD CODE BASE GENERATION //<<
-3.0.0 EXTENDING YCHAT
-3.1.0 SOURCE FILES
-4.0.0 DIVERSE
-4.1.0 WRITING BUG REPORTS
-4.2.0 CONTACT ADDRESSES
-4.3.0 CREDITS
-
-1.0.0 GENERAL
-
-1.1.0 ABOUT RELEASES
-
-There are several projects involved:
-
-- The chat -
-Its a HTTP based chat server written in C++. Clients are normal web browsers
-such as MSIE or Gecko based browsers using only CSS, HTML and JavaScript.
-
-- The httpd -
-Its a small http server based on the chat's socket and threading engine.
-yhttpd does not have as much features but is easy to use and faster than
-apache. yhttpd is a subset of the chat. It can be generated using the
-srcipts/yhttpdbase.pl script in the chat's source tree.
-
-- The ycurses -
-ycurses is a easy to use and small C++ wrapper around the C ncurses API.
-
-There are different branches:
-
-- CURRENT -
-The CURRENT branch is unstable, this is the bleeding developing edge with
-all the new experimental features.
-
-A RELEASE of CURRENT can be referred as CURRENTRELEASE.
-
-- STABLE -
-The STABLE branch is more stable than CURRENT. This branch may get new
-features as well. But those will be more conservative compared to
-CURRENT.
-
-A RELEASE of STABLE can be referred as STABLERELEASE.
-
-- BASIC -
-The BASIC branch is a very minimal one. This branch may get bugfixes and
-updates and might get minor improvements. This is a version of yChat
-with only very few features.
-
-A RELEASE of BASIC can be referred as BASICRELEASE.
-
-- LEGACY -
-The LEGACY branch has no real support. This branch may get bugfixes and
-updates and might get minor improvements. But there is no garuantee to
-be bug free and stable at all. LEGACY versions are of historic meaning.
-
-- DEVEL -
-DEVEL is only a meta name. If a version is labeled with DEVEL, then its
-currently undefined if this is a CURRENT, STABLE or LEGACY branch. It
-can be everything. Commonly DEVEL versions are CURRENT.
-
-There are also releases made:
-
-- RELEASE -
-There can be RELEASEs made out of each branch. While a branch can get
-new features, a RELEASE can not. A RELEASE of a branch is just like
-a snapshot. RELEASEs are complete versions to test and use. But keep
-in mind, that a RELEASE of the STABLE branch is recommended over a
-RELEASE of a CURRENT or a LEGACY branch in a production environment.
-RELEASEs of CURRENT are still the bleeding edge and RELEASEs of LEGACY
-may be out of date.
-
-- Short names -
-
-In addition, each description also has short names: (short names are needed
-if your text space is limited which happens very fast in IRC channel topics)
-
-CURRENT aka CUR aka C
-RELEASE aka REL aka R
-LEGACY aka LEG aka L
-STABLE aka SBL aka S
-BASIC aka BSC aka B
-DEVEL aka DEV aka D
-PRE aka P
-
-STABLERELEASE aka STBREL aka SR
-PRERELEASE aka PREREL aka PR
-PRELEGACYRELEASE aka PRELEGREL aka PLR
-etc...
-
-The short name of the chat is "yC"
-The short name of the httpd is "yh"
-The short name of ycurses is "yu"
-
-- Versioning -
-In general, versions are made up like X.Y.Z.W. X specifies the major version,
-Y specifies the branch of the major version, Z specifies a sub revision
-of a specific branch. The optional W can be used to specify a maintenance
-revision which only changes small issues.
+0.0.0 YCHAT FEATURES //<<
+1.0.0 REQUIREMENTS
+1.1.0 TESTED PLATFORMS
+1.2.0 IMPORTANT NOTICES
+1.3.0 HOW TO OBTAIN YCHAT
+1.3.1 INSTALLATION
+1.3.2 INSTALLATION QUICK-START
+1.3.3 MYSQL SETUP //<<
+1.4.0 HOW TO USE SCREEN WITH YCHAT
+1.5.0 CUSTOMIZATION
+1.6.0 FILES
+1.7.0 WRITING BUG REPORTS
+1.8.0 CONTACT
+1.9.0 YHTTPD CODE BASE GENERATION //<<
//<<*
-1.2.0 YCHAT FEATURES
+0.0.0 YCHAT FEATURES
- Its free & portable -
yChat is developed under the GNU general public license and is based on GNU
-tools (gcc, gmake), other open source library stuff (such as GNU Readline etc.)
+tools (gcc, gmake), other open source library stuff (such as libncurses etc.)
and should run on any POSIX capable operating system (such as all Linux based
systems, FreeBSD, NetBSD, OpenBSD and other BSD-Systems and on UNICES like
IRIX, HP-UX, Solaris etc.).
@@ -165,16 +67,14 @@ yChat is written in C++ which is faster than any Java based Chat-Server or any
server written in a scripting language like PHP, Python or Perl. As the
internal data structures hash maps are used to garuantee searching certain
values in O(1) amount of time. If a hash maps gets full, it will be rehashed.
-Currently, yChat has been measured providing over 1000 hits/requests per second
-on a FreeBSD based server box while using less than 2% of CPU usage
+The maximum usage in % can be redefined too (standard is 90%). Currently, yChat
+has been measured providing over 5000 hits/requests per second (chat message
+postings) on a FreeBSD based server box while using less than 2% of CPU usage
on a Athlon XP 1900+. Performance seems to be limited by your bandwith only.
Also, each user gets its own session id (random string) with a standard length
of 50 chars to authenticate each logged in user. The length of the session id
can be redefined as well. Also, the session id will get md5-hashed optionally
so thats even harder to reverse engineering the session ids of other users.
-Also, yChat supports secure hypertext transfer protocol (HTTPS) connections
-using the OpenSSL library. Then, all chat messages will be encrypted in a
-secure manner. HTTPS is optional to HTTP (unsecured connections).
- Its HTML template based and easy to customize via XML based configuration -
All HTML sites are predefined as HTML-Template files and can be easily modified
@@ -197,13 +97,13 @@ to use other databases such as PostgreSQL, SQLite or a text based database etc.
If wished, you can disable database support in the pre-compile options.
- It has an administration interface -
-yChat includes an libreadline based administration interface which tracks some
+yChat includes an ncurses based administration interface which tracks some
interesting statistics and system messages and enables you to do certain
administrative tasks. In addition, you can switch to the CLI (command line
interface) mode of the administration interface in order to be provided with
more available functions (like keeping track of the current system usage etc.).
-If you dont like libreadline and/or the CLI you can disable both options in the
-pre- compile options.
+If you dont like ncurses and/or the CLI you can disable both options in the pre-
+compile options.
- It has logging capabilities -
The logging manager keeps track to all yChat system messages (such as users
@@ -215,7 +115,7 @@ well . To improve performance, you can define the logging puffer (standardly
new logs will be written to disk after each 20 lines). If you want to log
everything immediately, you can reset this option to 1 in ychat.conf.
-- Its modular through own command and dynamic HTML engine -
+- Its modular -
All chat commands are realized through dynamic loadable module files which can
be recompiled and reloaded without restarting the whole yChat server. Also
HTML-Sites with certain tasks can be compiled as a module like
@@ -246,12 +146,10 @@ options. This improves overall performance on heavily loaded yChat servers if a
lot of user and room objects are created and destroyed frequently.
//*>>
-2.0.0 INSTALLATION AND SETUP
-
-2.1.0 REQUIREMENTS:
+1.0.0 REQUIREMENTS:
-- GNU GCC G++
- The GNU C++ compiler version 3.1 or up.
+- GNU GCC G++ 3.4 or 3.3 or 3.2 or 3.1
+ The GNU C++ compiler. G++ version 3.0 or 2.x does NOT work.
- GNU make 3.80 (gmake) or higher
If you dont have a gmake executable but make is gnu make then you need
@@ -259,44 +157,31 @@ lot of user and room objects are created and destroyed frequently.
yChat Makefiles only have been tested with GNU make and may not work with
other make versions.
-- SGI STL extension
- Includes ext/hash_map which may be already default on every Linux distro.
- On *BSD you have to install it first before compiling. On FreeBSD
- /usr/ports/devel/stlport is your friend.
-
-- OpenSSL (optional)
- Includes libssl and the ssl header files of the open source SSL library.
- OpenSSL is only needed if you chose to compile yChat w/OpenSSL support.
-
-- GNU Readline (optional)
- This library can be used with the command line interface (CLI) of
- ychat to make the editing easier.
-
//<<*
-- mysql-client 4.x (optional) [3.x may do too but is not supported]
- Includes libmysqlclient and the mysql.h header files. mysql-client is only
- needed if you chose to compile yChat w/database support.
+- mysql-client 4.x (3.x may do too but is not supported)
+ Includes libmysqlclient and the mysql.h header files.
+
//*>>
+- ncurses 5.x
+ Includes libncurses and the ncurses.h header files.
-- Screen (optional)
+- Screen
Only needed if yChat should run in background with
- the CLI enabled.
+ ncurses or CLI enabled.
- Perl 5.x
Is needed for some scripts. Is not needed if you use precompiled binaries.
-2.2.0 TESTED PLATFORMS:
+1.1.0 TESTED PLATFORMS:
The following platforms have been tested with success. If you find out that
a listed platform did not work at all please contact me:
Operating system (arch) GNU G++ GNU make
-- FreeBSD 6.0-RELEASE (i386) 3.4.4 3.80
- FreeBSD 5.3-RELEASE (i386) 3.4.2 3.80
-
- Tested longer time before:
-- FreeBSD 5.4-RELEASE (i386) 3.4.2 3.80
+- FreeBSD 5.2.1-RELEASE (i386) 3.3.3 3.80
- FreeBSD 4.10-RELEASE (i386) 3.4.1 3.80
+- FreeBSD 4.9-RELEASE (i386) 3.3.4 3.80
- Gentoo Linux 2004 (i386) 3.3.2 3.80
- OpenBSD 3.6 SMP (i386) 3.3.2 3.80
- Red Hat Linux 8.0 SMP (i386) 3.2-7 3.79
@@ -307,181 +192,93 @@ a listed platform did not work at all please contact me:
Other platforms like Linux based systems, other BSD-Systems or UNICES
are very likely to work too.
-2.3.0 HOW TO OBTAIN YCHAT:
+1.2.0 IMPORTANT NOTICES:
+
+Before you compile the source you have to be sure to use at least GCC
+version 3.1 with pthreads enabled. ( Type gcc -v to check it ).
+GCC 2.95 and 3.0 did not work while testing and WON'T BE SUPPORTED!
+If you like to support yChat, please write us an email and tell what
+you can/like/would help ;-]. Please also take a look at the yChat
+homepage which is located at http://www.yChat.org.
+
+1.3.0 HOW TO OBTAIN YCHAT:
yChat can be downloaded as a source package or through CVS.
-The packages are located at http://www.yChat.org -> Release Versions
+The packages are located at http://www.yChat.org -> Sourcecode ->
+Packages or go to http://pub.buetow.org/yChat/CPP-yChat .
For CVS download type:
-cvs -d:pserver:anonymous@buetow.org:/cvs/cvsroot login
+cvs -d:pserver:anonymous@buetow.org:/usr/home/cvs/cvsroot login
( You will be asked for a password. Use "just enter" ).
-cvs -z3 -d:pserver:anonymous@buetow.org:/cvs/cvsroot co BRANCH
+vs -z3 -d:pserver:anonymous@buetow.org:/usr/home/cvs/cvsroot co ychat
( The sources will be copied into your local folder )
-cvs -d:pserver:anonymous@buetow.org:/cvs/cvsroot logout
+cvs -d:pserver:anonymous@buetow.org:/usr/home/cvs/cvsroot logout
( Logs your CVS session out ).
Now you may continue with the installation.
-There are different branches in the CVS:
-
-ychat: This is the latest CURRENT branch of yChat.
-ychat-stable: This is the latest STABLE branch of yChat.
-ychat-X.Y: This is the branch with the specified version prefix.
-yhttpd: This is the latest CURRENT snapshot of yhttpd.
-
-The CURRENT branch of ychat is mostly untested and unstable, so don't
-cry if you get errors.
-
-2.4.0 INSTALLATION QUICK START
+1.3.1 INSTALLATION:
-If you in hury, then you may just run the following commands:
-
- sh -c 'CXXFLAGS="" ./configure'
- gmake install clean
-
-yChat will get compiled without debugging symbols and its default values.
-Afterwards yChat will get installed into the default prefix which is
-/usr/local. Afterwards it is ready to run with the '/usr/local/bin/ychat'
-command!
-
-2.4.1 INSTALLATION
-
-If you wanna quick start, then please refer to section 2.4.0 instead.
-
-Invoke './configure --help'. Afterwards you will get prompted with all the
-possible compile options. Take a closer look at the --enable-FEATURE and the
---disable-FEATURE options. Afterwards run configure with your wanted options.
-Now, you can run 'gmake'. See below what gmake is doing. By default yChat uses
-loosy debugging symbols. To disable them, then run configure this way:
-
- sh -c 'CXXFLAGS="" ./configure --options'
-
-Dont forget to replace --options with your desired values. You can read more
-about debugging symbols in section '4.1.0 WRITING BUG REPORTS'.
+Invoke "./configure". Afterwards you will get prompted with the before-compile
+options of yChat. After choosing those options you are ready to type "gmake"
+afterwards. See below what gmake is doing.
//<<*
If you have choosen MySQL database support, then take a look at section 1.3.2
how to setup a valid database table. Be also sure to enter the valid MySQL
accessing data in the yChat configuration file which is normally located in
-the etc/ychat.conf file.
+the etc/ychat.conf file if not changed by you with the yChat configurator.
//*>>
-You may also invoke gmake with the following options:
+You may also invoke gmake with the following options (the PREFIX can be set
+in the yChat configurator which will be launched by the top configure script
+or gmake config):
gmake or gmake all (compiles everything, also modules and runs "gmake mail")
gmake base (only compiles the base)
gmake base_start (only compiles the base and starts the server)
- gmake build (increments the current build number by one)
gmake clean (cleans everything)
gmake clean_base (only cleans the base obj and rpo files)
gmake clean_modules (only cleans the modules .so files)
- gmake confdebug (runs the configure with strong debugging symboles enabled)
- gmake debug (runs gdb on ./ychat.core)
- gmake deinstall (same as gmake uninstall)
- gmake dist (creates a .tar.bz2 ball)
- gmake headers (rewrites the source file headers using doc/header.txt)
- gmake help (shows all available yChat gmake targets)
- gmake install (removes debugging symbols and installs yChat into the PREFIX)
- gmake license (shows the GNU General Public License)
+ gmake config (runs yChat configurator)
+ gmake deinstall (deinstalls ychat from PREFIX)
+ gmake gpl (shows the GNU General Public License)
+ gmake help (shows all available ychat gmake targets)
+ gmake install (installs ychat to PREFIX)
+ gmake mail (sends a mail to the yChat developers containing build opts.)
gmake modules (only compiles modules)
gmake mrproper (same as gmake clean plus removing all temp files)
- gmake quick (runs all configure scripts and afterwards gmake all)
- gmake replace (replace in the source the content of $FROM into $INTO)
- gmake stats (generates yChat statistics)
- gmake strip (removes debugging symbols from binary)
- gmake ssltest (generates a self signed ssl test certificate)
- gmake touch (resets the date of each file in the source tree)
- gmake uninstall (uninstalls yChat from the current default PREFIX)
+ gmake setup (runs all configure scripts and afterwards gmake all)
+ gmake start (compiles everything and starts the server)
+ gmake stats (generates ychat statistics)
+ gmake uninstall (same as deinstall)
gmake version (shows the current version of yChat)
//<<*
gmake yhttpdbase (generates an yhttpd code base)
//*>> (See section 1.9 to read about this marks)
-Example: 'gmake all install clean' compiles everything, installs it to PREFIX
+Example: "gmake all install clean" compiles everything, installs it to PREFIX
and cleans the source directories.
-Now its time to run the server with './bin/ychat'.
+Now its time to run the server with ./bin/ychat.
Aferwards point your webbrowser to http://yourip:port !
... have fun :-).
-2.5.0 HOW TO USE OPENSSL WITH YCHAT
-
-If you chose to use OpenSSL support you have to have a valid SSL private and
-public key. If you are in hurry, use the gmake ssltest command from the top
-source tree directory and follow the instructions. Otherwise type the
-following commands manually:
-
-The private key can be created w/the following command:
-
- openssl genrsa -des3 -out privkey.pem 2048
-
-Afterwards, you can create a self-signed test certificate using the following
-command:
-
- openssl req -new -x509 -key privkey.pem -out cert.pem -days 1095
-
-Be sure to move the privkey.pem and cert.pem files into the ./etc directory
-or edit the path names in the ./etc/ychat.conf file. yChat wont start if there
-are no valid files found.
-
-To learn more about SSL certificates, visit http://www.openssl.org/docs/HOWTO/.
-
-Now use https:// and NOT http:// to connect to the yChat server.
-
-2.5.1 HOW TO USE SCREEN WITH YCHAT:
-
-If you are running yChat in CLI mode you might want to install
-the tool which is called "screen". This will enable you putting the
-CLI interface into the background, closing the terminal session
-and reusing the interface later through another terminal.
-
-Just do:
-
- screen -S ychat ./bin/ychat ( creates a new session and starts yChat in it )
- ctrl+d+a ( will detach the yChat session )
- ( closing the terminal )
- ( opening a new terminal )
- screen -r ychat ( will return you to the yChat process )
-
-Screen will terminate automaticaly if all processes in its sessions are
-terminated.
-
-For a closer look read the screen manual page ( man screen ).
-
-2.5.2 HOW TO USE SIGNALS WITH YCHAT:
+1.3.2 INSTALLATION QUICK START:
-You can send UNIX signals to yChat. This becomes very interesting if you
-don't use the command line interface and you don't have access to the options
-below.
+If you in hury, then you may just type gmake setup. In the yChat configurator
+you may just choose all the default values. If done, yChat will get compiled
+and is ready to run with ./bin/ychat!
-Run one of the following commands to send the signal you want:
-($PID is here the process id of the current yChat process)
-
-kill -USR1 $PID # yChat clears the HTML template cache
-kill -USR2 $PID # yChat reloads all dynamic loadable modules //<<
-kill -HUP $PID # yChat will shutdown savely
-
-2.5.3 HOW TO USE GNU READLINE WITH YCHAT:
-
-This library can be used with the command line interface (CLI) of ychat. To
-use it, yChat has to be compiled with readline support (which is the default
-setting).
-
-Readline offers editing capabilities while the user is entering the line.
-By default, the line editing commands are similar to those of emacs. A vi-style
-line editing interface is also available.
-
-For configuration and usage of the yChat readline CLI prompt, read the readline
-manpage. :)
//<<*
-2.5.4 HOW TO USE MYSQL WITH YCHAT
+1.3.3 MYSQL SETUP
If you chose to use MySQL database support you have to create a valid database
to use with yChat.
@@ -509,18 +306,38 @@ This database uses the default MySQL access informations which are stored in the
ychat.conf file.
//*>>
-2.6.0 CUSTOMIZING YCHAT:
+1.4.0 HOW TO USE SCREEN WITH YCHAT:
+
+If you are running yChat in ncurses mode you might want to install
+the tool which is called "screen". This will enable you putting the
+ncurses interface into the background, closing the terminal session
+and reusing the interface later through another terminal.
+
+Just do:
+
+ screen -S ychat ./bin/ychat ( creates a new session and starts yChat in it )
+ ctrl+d+a ( will detach the yChat session )
+ ( closing the terminal )
+ ( opening a new terminal )
+ screen -r ychat ( will return you to the yChat process )
+
+Screen will terminate automaticaly if all processes in its sessions are
+terminated.
+
+For a closer look read the screen manual page ( man screen ).
+
+1.5.0 CUSTOMIZATION:
If you like to customize the design/layout/language of yChat, you will have
-to edit ./src/msgs.h and ./src/glob.h before you compile the sources. Afterwards
-you can change the html-template files which are placed in the ./html/
+to edit src/msgs.h and src/glob.h before you compile the sources. Afterwards
+you can change the html-template files which are placed in the html/
subdirectory and the language-templates which are placed in the XML config
file (etc/ychat.conf).
-Notice, that you dont have to edit the ./src/glob.h file by hand any more, its
-already done by the top ./configure script for you (See './configure --help').
+Notice, that you dont have to edit the src/glob.h file by hand any more, its
+already done by the top ./configure script for you.
-You can edit the ./etc/ychat.conf to fit your needs. If you dont want to change
+You can edit the etc/ychat.conf to fit your needs. If you dont want to change
the config file, then you also can use ychat start parameters.
Exmpl: ./bin/ychat -o chat.database.password secretpassword
@@ -533,53 +350,38 @@ will overwrite the default database password value of the ychat.conf. You can
do this with every configuration element by adding several -o option value
arguments to the start command.
-Dynamic loadable modules can be found in the ./mods/ subdirectory. (chat
+Dynamic loadable modules can be found in the mods/ subdirectory. (chat
commands are realized through modules too). Sources of modules can be found
-in ./src/mods instead. If you want to create a new module just create a new
-.cpp file and run in ./src/mods the ./configure script again. Next time
-you run 'gmake' or 'gmake modules' your new module gets compiled.
+in src/mods instead. If you want to create a new module just create a new
+.cpp file and run in src/mods the ./configure script again. Next time
+you run gmake your new module gets compiled.
-All messages defined in the ./src/msgs.h file contain server messages only (a chat
-user never wont read them, only the administrator will get to see them).
+All messages defined in the msgs.h file contain server messages only ( a chat
+user never wont read them, only the administrator will get to see them ).
-Read also section 3.0.0 of this README.
+1.6.0 FILES:
-//<<*
-2.7.0 YHTTPD CODE BASE GENERATION
-
-See docs/yhttpd.txt
-//*>>
-
-3.0.0 EXTENDING YCHAT
-
-3.1.0 SOURCE FILES
-
-This list is not complete. Only the most important files are listed here!
-
-./etc/ychat.conf - The yChat configuration file
-./html/* - The html template files
-./src/* - The yChat base sources
-./src/mods/* - The dynamic loadable modules sources
-./scripts/* - Some nice scripts needed for building & co.
+etc/ychat.conf - The yChat configuration file
+html/* - The html template files
+src/* - The yChat base sources
+src/mods/* - The dynamic loadable modules sources
+scripts/* - Some nice scripts needed for building & co.
The following is created by building yChat:
-./obj/* - The object files of the compiled yChat base
-./mods/* - The compiled dynamic loadable modules
-./bin/ychat - The yChat binary (linked by the object files)
-./bin/ychat.bak - An yChat binary of a previous build process
+obj/* - The object files of the compiled yChat base
+mods/* - The compiled dynamic loadable modules
+bin/ychat - The yChat binary (linked by the object files)
Customizable source files (if changed you need to run gmake clean all)
-./src/glob.h - Contains some global building options
-./src/msgs.h - Defines some server side messages
-
+src/glob.h - Contains some global building options
+src/msgs.h - Defines some server side messages
-4.0.0 DIVERSE
-4.1.0 WRITING BUG REPORTS
+1.7 WRITING BUG REPORTS
How to submit a good bug report?
-Send them to Mail at yChat dot org.
+Send them to Bug@yChat.org.
First you should give the following information:
- yChat version, if CVS (or devel. tarball) then which day?
@@ -591,8 +393,8 @@ randomly. If after crash you see text:
"segmentation fault (core dumped)"
-It writes a file named 'core' or 'ychat.core' depending on your OS to directory
-where you started yChat. If it doesn't print the '(core dumped)' or you can't
+It writes a file named "core" or "ychat.core" depending on your OS to directory
+where you started yChat. If it doesn't print the "(core dumped)" or you can't
find the core file, you'll have to raise the limit for max. core file size
before running yChat. To do this, say:
@@ -601,7 +403,7 @@ before running yChat. To do this, say:
So, if you have the core file and GNU debugger (gdb), you can get the
backtrace with:
- gdb ./bin/ychat ychat.core (or gmake debug instead)
+ gdb ./bin/ychat ychat.core
bt
Paste all the lines starting from line having #0 at the beginning.
@@ -624,39 +426,22 @@ Here's an example session:
If you dont get such a gdb output, you need to recompile the yChat using
debuggig symbols. You can do it this way:
- gmake clean_base base run
-
-By default, ychat gets compiled with loosy debugging symbols. If you want to
-get strong debugging symbols, then type:
-
- gmake confdebug clean_base base run
+cd ychat
+gmake mrproper
+./configure -g3 -ggdb
+gmake start
-or if you didnt run a ./configure before, then type:
-
- sh -c 'CXXFLAGS="-g3 -ggdb" ./configure'; gmake clean_base base run
-
-instead.
-
-In order to remove all the debugging symbols, then just type 'gmake strip'
-afterwards. If you use 'gmake install', then the binary will be stripped
-automatically.
-
-If you dont wanna compile with debugging symbols by default, then use this
-command:
-
- sh -c 'CXXFLAGS="" ./configure'; gmake clean_base base run
-
-4.2.0 CONTACT ADDRESSES
+1.8 CONTACT:
You may contact us through the following addresses:
- Homepage
The yChat homepage is located at http://www.yChat.org
- The EXA Digital Solutions homepage is located at http://www.exa-ds.com
- E-Mail
- Paul C. Buetow: buetow at yChat point org (core developer)
- Mail at yChat dot org (reaches everybody of yChat)
+ Paul C. Buetow: Snooper at yChat point org ( core developer )
+ Volker Richter: Rover at yChat dot org ( core developer )
+ Mail at yChat dot org ( reaches everybody of yChat )
- ICQ
Paul C. Buetow: 11655527
@@ -664,13 +449,8 @@ You may contact us through the following addresses:
- IRC
#Ychat and #Coding at irc.german-elite.net
-4.2.0 CREDITS
-
-Thanks to the following persons. Without them yChat would not be like today:
-
-- Volker Richter <volker at exa-ds dot de> of EXA Digital Solutions GbR
- for adding initial MySQL support and lots of more code.
+//<<*
+1.9 YHTTPD CODE BASE GENERATION
-- Joshua Teitelbaum <joshuat at cryptomail.org> of CryptpMail.org for adding
- initial OpenSSL support and lots of security patches in the HTTP header
- handling.
+See docs/yhttpd.txt
+//*>>