From c7122811fbdefa0d7323bee6805dba590210a88f Mon Sep 17 00:00:00 2001 From: Joachim Nilsson Date: Fri, 15 Nov 2019 10:08:14 +0100 Subject: [PATCH] Remove files that are no longer needed Signed-off-by: Joachim Nilsson --- docs/README.1st | 95 ----------------------------------------------- docs/README.linux | 77 -------------------------------------- docs/TODO.org | 28 -------------- 3 files changed, 200 deletions(-) delete mode 100644 docs/README.1st delete mode 100644 docs/README.linux delete mode 100644 docs/TODO.org diff --git a/docs/README.1st b/docs/README.1st deleted file mode 100644 index f511cf2..0000000 --- a/docs/README.1st +++ /dev/null @@ -1,95 +0,0 @@ -Important information ---------------------- - -The included version of syslogd behaves in a slightly different manner -to the one in former releases. Please review the following important -differences: - -* By default the syslog daemon doesn't accept any message from the - syslog/udp port. To enable this add "-r" to the command-line - arguments. You _have to_ add this on every host that should run as a - centralized network log server. - - You also should take a look at other new command-line arguments: - "-l" and "-s". - - The syslog daemon by default does not forward to a remote host any - log messages which it received from a remote host. This is an - attempt to prevent syslog loops. If you desire this behavior the - -h command-line switch can be used to enable this behavior. - -* Syslogd was designed to strip off the local domain from every - message that comes from any host in the same domain. Unfortunately - this feature didn't work in every cases. This is now corrected. So - you might not get the fqdn anymore. - - If you use any scripts that analyze logfiles, please bare this in - mind. - -* Syslogd doesn't touch the filemode of any logfile. If it has to - create one, it will be world-readable. If you do not want this - (i.e. if auth.* is logged) you have to create the file by hand and - change permissions. - -* If you notice that some of your programs make heavy use of the - syslog facility and your disks get loud you might want to turn - fsync()ing after each line off. But note that in doing so you - increase the likelihood of lost information in the event of a - system crash. - -* If you're going to start klogd or syslogd by init(8), you don't have - to hack the code anymore. Instead add "-n" to the command-line - arguments. - -* Klogd can now be used to decode EIP addresses if it can determine a - System.map file (command-line argument "-k"). This is a very useful - feature if your system crashes, but its usability depends on an - actual and correct System.map file. - -* Both system utilities now check for and respect the existence of .pid - files. If the utilities are started by configuration scripts on - stable systems there is the potential that the process ID numbers of - the utilities will be identical from one system boot to another. - This will cause both klogd and syslogd to terminate. - - Both klogd and syslogd will attempt to remove their .pid files when - they receive termination signals. The difficulty noted above - typically occurs when a system crash occurs or an uncatchable signal - (kill -9) is used to stop the daemons. - - The cleanest solution to this problem is to insure that the system - configuration scripts (rc.*) provide a clean working environment for - a freshly booted system. As part of the initialization process - these scripts should remove all old .pid files found in /var/run. - This will insure that klogd and syslogd start properly even if prior - executions have been terminated harshly. - -* Large file support, i.e. support to write to log files that are - larger than 2 GB is not part of syslogd, but a matter of the glibc - emitting different system calls to the kernel interface. To support - large files you'll have to compile syslogd with the compiler defines - commented out in the main Makefile so that glibc adjusts the system - calls. - -Modifying the kernel console log level --------------------------------------- - - There are two ways to alter the kernel console log level. This - setting controls whether log messages from the kernel should appear - on the system console or not. - - In the past, klogd had to do this with the -c parameter. Using '-c - 4' will set the log level of console messages to 4 and only display - warnings and errors but not regular debug or information messages. - - This behaviour is deprecated and hencely not enforced anymore via - the RC script of klogd. Instead sysctl(8) should be used as - interface to various kernel variables. These can be stored - non-volatile in /etc/sysctl.conf. - - The prevent the kernel to flood the system console and to achieve - the same behaviour of '-c 4' simply add the following to the - configuration file and let sysctl set this kernel parameter upon - system boot. - - kernel/printk = 4 4 1 7 diff --git a/docs/README.linux b/docs/README.linux deleted file mode 100644 index ba3b4d0..0000000 --- a/docs/README.linux +++ /dev/null @@ -1,77 +0,0 @@ -Welcome to the sysklogd package for Linux. All the utility -documentation has now been moved into the man pages. Please review -these carefully before proceeding. - -Version 1.3 of the package is the culmination of about two years of -experience and bug reports on the 1.2 version from both the INTERNET -and our corporate Linux networks. The utilities in this package should -provide VERY reliable system logging. Klogd and syslogd have both -been stress tested in kernel development environments where literally -hundreds of megabytes of kernel messages have been blasted through -them. If either utility should fail the development team would -appreciate debug information so that the bug can be reproduced and -squashed. - -Both utilities (syslogd, klogd) can be either run from init or started -as part of the rc.* sequence. Caution should be used when starting -these utilities from init since the default configuration is for both of -these utilities to auto-background themselves. 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. - -I have found work on the sysklogd package to be an interesting example -of the powers of the INTERNET. Stephen, Juha, Shane, Martin and -myself have successfully collaborated on the development of this -package without ever having met each other, in fact we could pass on -the street without realizing it. What I have developed is a profound -respect for the personal capabilities of each one of these -individuals. Perhaps the greatest `Linux Legacy' will be that its -development/enhancement is truly an example of the powers of -international cooperation through the worldwide INTERNET. - -We would be interested in keeping track of any and all bug -fixes/changes that are made. At the time that work was started on the -sysklogd package the syslog(d) sources seemed to have fallen into -neglect. This work started with and continues the believe that it is -important to maintain consistent standardized system utilities -sources. Hopefully the Linux community will find these sources to be -a useful addition to the software gene pool. - -There is a mailing list covering this package and syslog in general. -The lists address is infodrom-sysklogd@lists.infodrom.org . To subscribe send a -mail to majordomo@lists.infodrom.org with a line "subscribe infodrom-sysklogd" -in the message body. - -A second mailing list exists as infodrom-sysklogd-cvs@lists.infodrom.org. Only -CVS messages and diffs are distributed there. Whenever new code is added to -sysklogd, CVS generates a mail from these changes which will be sent to -this list. Discussions will take place on the first list. - -The latest version of this software can be found at: -http://www.infodrom.org/projects/sysklogd/download.php3 - -Best regards, - -Dr. Wettstein -Oncology Research Division Computing Facility -Roger Maris Cancer Center -Fargo, ND -greg@wind.enjellic.com - -Stephen Tweedie -Department of Computer Science -Edinburgh University, Scotland - -Juha Virtanen -jiivee@hut.fi - -Shane Alderton -shane@ion.apana.org.au - -Martin Schulze -Infodrom Oldenburg -joey@infodrom.org - -And a number of bug reporters whose contributions cannot be underestimated. diff --git a/docs/TODO.org b/docs/TODO.org deleted file mode 100644 index b628ed2..0000000 --- a/docs/TODO.org +++ /dev/null @@ -1,28 +0,0 @@ -#+STARTUP: showall -* TODO - -** sysklogd v2.0 - -*** DONE Add support for @host:port, i.e. custom remote port to send to -*** DONE Add example application, test building and running it from Travis-CI -*** DONE Check for memory/descriptor leaks, valgrind/Coverity - -Most interesting so far is the -fsanitize=address option to GCC/clang :) - -*** DONE Drop strlcpy() from libsyslog, make built-in? (marked as weak alias) -*** DONE Document, and add examle of, how to use libsyslog -*** DONE Separate libsylog.{a,so} and syslog/syslog.h with NetBSD API -*** DONE Add syslogp() and vsyslogp() to libsyslog -*** DONE Add support for =/etc/syslog.d/*.conf= to syslogd -*** DONE Test support of =/etc/syslog.d/*.conf= to syslogd -*** DONE Test SIGHUP of syslogd -*** DONE Custom facilities! -*** DONE Fix option parsing in syslog.conf, e.g. ;RFC5424 and log rotation -*** DONE Test with/without openlog() -*** DONE Test custom facilities -*** DONE Test setlogmask() -*** DONE Test v1 API, syslogp() -*** DONE Add RFC5424 parsing of incoming msgs to syslogd -*** DONE Local `stdout | stdin` unit testing -*** DONE Rewrite man pages do mandoc format -