aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org>2019-07-31 15:43:43 +0300
committerSergey Poznyakoff <gray@gnu.org>2019-07-31 15:47:22 +0300
commit492f8fabc828f286b3b6b12ed3396bde026c663a (patch)
tree8428e4636035def5eaa5cf4acde1bdd3937b17ff /README
parenta954b80eb5f01bf96946c28a07b3648650bfae16 (diff)
downloadaddts-492f8fabc828f286b3b6b12ed3396bde026c663a.tar.gz
addts-492f8fabc828f286b3b6b12ed3396bde026c663a.tar.bz2
Version 1.0HEADv1.0master
Diffstat (limited to 'README')
-rw-r--r--README67
1 files changed, 67 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a55adb9
--- /dev/null
+++ b/README
@@ -0,0 +1,67 @@
+README for addts
+
+* Overview
+
+Addts is a small UNIX filter that copies its input to the output line by
+line, adding current timestamp at the beginning of each line. It was
+designed for use with Apache forensic log module. The typical usage is:
+
+ ForensicLog "|/usr/bin/addts -a /var/log/httpd/forensic.log"
+
+See the accompanying man page for a detailed discussion.
+
+* Compiling
+
+Run make to build the utility. Run 'make install' as root to install
+it. The following make variables can be used
+
+** PREFIX
+ Installation prefix.
+ Defaults to /usr/local.
+
+** BINDIR
+ Directory to install the addts binary to.
+ Defaults to $(PREFIX)/bin
+
+** MANDIR
+ Root directory for manpage hierarchy.
+ Defaults to $(PREFIX)/share/man
+
+** MAN1DIR
+ Directory for section 1 manpages.
+ Defaults to $(MANDIR)/man1
+
+For example, to install it to /usr, use
+
+ make install PREFIX=/usr
+
+* Downloads
+
+See https://puszcza.gnu.org.ua/projects/addts for download pointers,
+including Git repository URLs.
+
+* License
+
+Copyright (C) 2018, 2019 Sergey Poznyakoff
+
+Addts 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 3, or (at your option)
+any later version.
+
+Addts 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 addts. If not, see <http://www.gnu.org/licenses/>.
+
+
+Local variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+end:
+
+
+

Return to:

Send suggestions and report system problems to the System administrator.