From 3f0d0495b964b8a285b46c48d840aa8285e9c834 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Wed, 10 Aug 2005 08:42:33 +0000 Subject: working on optimizing the build environment - still sub-optimal --- INSTALL | 44 +++++++++++++++++++++++-------------- MANIFEST | 9 ++++++++ Makefile | 10 ++++----- NEWS | 7 +++++- README.linux | 67 +++----------------------------------------------------- freebsd/Makefile | 2 +- linux/Makefile | 4 ++-- version.h | 2 +- 8 files changed, 55 insertions(+), 90 deletions(-) diff --git a/INSTALL b/INSTALL index bace363a..494eb748 100644 --- a/INSTALL +++ b/INSTALL @@ -1,13 +1,25 @@ +There is an additional install HOWTO available under + + doc/install.html + +Probably this HOWTO is easier to follow then the steps here +below. + + 1.) READ the README.linux file and the accompanying man pages. It will save you some frustration. Be sure to review sample.conf it has a lot of information and samples on templates. If you want to do all the cool things, this is what you need to know. -2.) Edit the Makefile for your installation. NOTE that if you have not +2.) The actual build process is done from a distro-specific + subdirectory. If in doubt, use the "linux" directory. CD + into it. We assume you stay in it for the rest of the process. + +3.) Edit the Makefile for your installation. NOTE that if you have not carried out step 1 you may make choices which could render your system and/or these utilities unusable. Compile the utilities. -3.) The FSSTND makes suggestions as to appropriate locations for +4.) The FSSTND makes suggestions as to appropriate locations for system binaries. Since not everyone agrees with standards it is up to the system administrator installing the utilities to choose the most appropriate locations for the binaries and their @@ -18,13 +30,13 @@ influenced by the choice of conformance with the FSSTND or site preferences. -4.) For proper functioning the daemon is best run as root. +5.) For proper functioning the daemon is best run as root. This is probably not much of a problem since it will probably be started either by init or as part of the rc.* startup process. There may be security concerns with running it as root. Please repeat step 1 if you are unsure of why this may be the case. -5.) Contrary to previous releases, this release does NOT replace the +6.) Contrary to previous releases, this release does NOT replace the standard syslogd in your system. Instead, the tool is installed under the name rsyslogd. Similarily, it does NOT automatically read syslog.conf, but rsyslog.conf instead. This was done based on user @@ -32,15 +44,15 @@ probably save you a lot of hassle. On the other hand, if you used previous versions of rsyslog, you need to change some things now! -6) If you would like to use database logging, you need a database ;) - The default configuration requires a MonitorWare schema. To do this, you - can follow this advise: - How to create the database for rsyslog? - It is really easy. Simply run the following command in your shell. Be sure - that the mysql user you are using have permission to create a database. - mysql -u username -p < /path/to/createDB.sql - Enter the password if requested. The database "Syslog" with the necessary - tables is created. - If you would like to use a different schema, you can do so ;) Just create - your schema and database and then create a matching template in rsyslog.conf. - See sample.conf for a description on how templates work. +7.) If you would like to use database logging, you need a database ;) + The default configuration requires a MonitorWare schema. To do this, you + can follow this advise: + How to create the database for rsyslog? + It is really easy. Simply run the following command in your shell. Be sure + that the mysql user you are using have permission to create a database. + mysql -u username -p < /path/to/createDB.sql + Enter the password if requested. The database "Syslog" with the necessary + tables is created. + If you would like to use a different schema, you can do so ;) Just create + your schema and database and then create a matching template in rsyslog.conf. + See sample.conf for a description on how templates work. diff --git a/MANIFEST b/MANIFEST index e779b9ec..6cfb0d3a 100644 --- a/MANIFEST +++ b/MANIFEST @@ -1,3 +1,12 @@ +This file basically stems back to the sysklog package. It is currently not +being maintained and is considered to be replaced by some other method +in the future. We have not yet removed it, because it still contains some +helpful information. When using it, keep in mind that it is not up to date. +However, what is written here still applies, but often is not the +sole truth ;) + +Rainer Gerhards, 2005-08-10 + A virgin copy of these sources should include 12 files: MANIFEST: This file. diff --git a/Makefile b/Makefile index 6bf960ec..5201c170 100644 --- a/Makefile +++ b/Makefile @@ -33,7 +33,7 @@ SYSLOGD_FLAGS= -DSYSLOG_INET -DSYSLOG_UNIXAF ${FSSTND} \ SYSLOG_FLAGS= -DALLOW_KERNEL_LOGGING .c.o: - ${CC} ${CFLAGS} -c $(VPATH)/$*.c + ${CC} ${CFLAGS} -c $(VPATH)$*.c all: syslogd @@ -50,10 +50,10 @@ template.o: template.c template.h stringbuf.h liblogging-stub.h outchannel.o: outchannel.c outchannel.h stringbuf.h liblogging-stub.h syslogd.h syslogd.o: syslogd.c version.h template.h outchannel.h syslogd.h - ${CC} ${CFLAGS} ${SYSLOGD_FLAGS} -c $(VPATH)/syslogd.c + ${CC} ${CFLAGS} ${SYSLOGD_FLAGS} -c $(VPATH)syslogd.c syslog.o: syslog.c - ${CC} ${CFLAGS} ${SYSLOG_FLAGS} -c $(VPATH)/syslog.c + ${CC} ${CFLAGS} ${SYSLOG_FLAGS} -c $(VPATH)syslog.c clean: rm -f *.o *.log *~ *.orig syslogd @@ -65,8 +65,8 @@ install_exec: syslogd ${INSTALL} -b -s syslogd ${DESTDIR}${BINDIR}/rsyslogd install_man: - ${INSTALL} $(VPATH)/rsyslogd.8 ${DESTDIR}${MANDIR}/man8/rsyslogd.8 - ${INSTALL} $(VPATH)/rsyslog.conf.5 ${DESTDIR}${MANDIR}/man5/rsyslog.conf.5 + ${INSTALL} $(VPATH)rsyslogd.8 ${DESTDIR}${MANDIR}/man8/rsyslogd.8 + ${INSTALL} $(VPATH)rsyslog.conf.5 ${DESTDIR}${MANDIR}/man5/rsyslog.conf.5 # The following lines are some legacy from sysklogd, which we might need # again in the future. So it is just commented out for now, eventually diff --git a/NEWS b/NEWS index 7cd3aaa5..9b411d91 100644 --- a/NEWS +++ b/NEWS @@ -1,7 +1,12 @@ --------------------------------------------------------------------------- +Version 0.9.7 (RGer), 2005-08-15 +- some of the previous doc files (like INSTALL) did not properly + reflect the changes to the build process and the new doc. Fixed + that. +--------------------------------------------------------------------------- Version 0.9.6 (RGer), 2005-08-09 - greatly enhanced documentation. Now available in html format in - the "doc" folder and FreeBSD. Finally includes a install howto. + the "doc" folder and FreeBSD. Finally includes an install howto. - improved MySQL error messages a little - they now show up as log messages, too (formerly only in debug mode) - added the ability to specify the listen port for udp syslog. diff --git a/README.linux b/README.linux index e247f200..d4cf24e1 100644 --- a/README.linux +++ b/README.linux @@ -1,64 +1,3 @@ -Welcome to the rsyslog package for Linux. This package has -been forked from the sysklogd standard package. The goal of the -rsyslog project is to provide a more configurable and reliable -syslog deamon. By "reliable", we mean support for reliable transmission -modes like TCP or RFC 3195 (syslog-reliable). -We do NOT imply that the sysklogd package is unreliable. In fact, the -opposite is the case and we assume that for the time being the well- -used sysklogd package offers better program reliability than our -brand-new modifications to it. The name "rsyslog" stems back to the -planned support for syslog-reliable. Ironically, all releases -of rsyslog up to now do NEITHER support syslog-reliable NOR tcp based syslog. -Instead, it contains enhanced configurability and other enhancements -(like database support). The reason for this is that full support for -RFC 3195 would require even more changes and especially fundamental architectural -changes. Also, questions asked on the loganalysis list and at other -places indicated that RFC3195 is NOT a prime priority for users, but -rather better control over the output format. So here we are, with -a rsyslogd that covers a lot of enhancements, but not a single one -of these that made its name ;) - -The next enhancement scheduled is support for the new syslog-protocol -internet draft format, not the least to see how easy/compliated it is -to implement. We already know that some subleties of syslog-protocol will -require at least one considerable architectural change to the syslogd -and this might delay things a little. Our immediate goal is to receive -feedback and get the bugs out of the current release. Only after that -we intend to advance the code and introduce new features. - -The database support was included so that our web-based syslog interface -can be used. This is another open source project which can be found -under http://www.liblogging.org . We highly recommend having a look at -it. It might not work for you if you expect thousands of messages per -second (because your database won't be able to provide adequate performace), -but in many cases it is a very handy analysis and troubleshooting tool. - -The utility (rsyslogd) can be either run from init or started -as part of the rc.* sequence. Caution should be used when starting -it from init since the default configuration is for it -is to auto-background itself. Depending on the -version of init being used this could either result in the process -table being filled or at least 10 copies of the daemon being started. -If auto-backgrounding is NOT desired the command line option -n should -be used to disable the auto-fork feature. - -There is a mailing list covering this package and syslog in general. -The lists address is rsyslog@lists.adiscon.com . - -New versions of this package and additional information will be available -under www.monitorware.com/rsyslog as well as under the rsyslog project -on sourceforge.net. - -IMPORTANT -Starting with version 0.9.0, rsyslogd supports files larger than 2gb. -This was added simply by some c compiler definitions which ask the run -time library to include different code. Depending on your file system, -glibc, kernel or whatever, you might not be able to use this support. If -so, rsyslogd might be terminated by the operating system when a file -reaches 2gb of size. To guard against this, use the output channel -file size limitation (see man rsyslog.conf for details). - -Best regards, -Rainer Gerhards -Adiscon -2005-06-22 +This file has been superseeded by the fils in the doc folder. +Please see doc/manual.html for futher details. If you are +looking for install informaton doc/install.html is for you! diff --git a/freebsd/Makefile b/freebsd/Makefile index 2ac01f22..05368dc7 100644 --- a/freebsd/Makefile +++ b/freebsd/Makefile @@ -50,5 +50,5 @@ MANDIR = /usr/share/man LIBS = -lmysqlclient -L/usr/local/lib/mysql .endif -VPATH = .. +VPATH = ../ .include "../Makefile" diff --git a/linux/Makefile b/linux/Makefile index 3a94267c..f75ccf49 100644 --- a/linux/Makefile +++ b/linux/Makefile @@ -19,7 +19,7 @@ # before any other command! # ############################################################# -# Enable large file support (typically on, not needed on +# Enable large file support (typically on, not needed for # 64 bit operating systems) FEATURE_LARGEFILE=1 @@ -51,5 +51,5 @@ ifdef WITHDB LIBS = -lmysqlclient -L/usr/local/lib/mysql endif -VPATH = .. +VPATH = ../ include ../Makefile diff --git a/version.h b/version.h index f928d729..74973f0e 100644 --- a/version.h +++ b/version.h @@ -1,2 +1,2 @@ #define VERSION "0.9" -#define PATCHLEVEL "6" +#define PATCHLEVEL "7" -- cgit