aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
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 @@
1README for addts
2
3* Overview
4
5Addts is a small UNIX filter that copies its input to the output line by
6line, adding current timestamp at the beginning of each line. It was
7designed for use with Apache forensic log module. The typical usage is:
8
9 ForensicLog "|/usr/bin/addts -a /var/log/httpd/forensic.log"
10
11See the accompanying man page for a detailed discussion.
12
13* Compiling
14
15Run make to build the utility. Run 'make install' as root to install
16it. The following make variables can be used
17
18** PREFIX
19 Installation prefix.
20 Defaults to /usr/local.
21
22** BINDIR
23 Directory to install the addts binary to.
24 Defaults to $(PREFIX)/bin
25
26** MANDIR
27 Root directory for manpage hierarchy.
28 Defaults to $(PREFIX)/share/man
29
30** MAN1DIR
31 Directory for section 1 manpages.
32 Defaults to $(MANDIR)/man1
33
34For example, to install it to /usr, use
35
36 make install PREFIX=/usr
37
38* Downloads
39
40See https://puszcza.gnu.org.ua/projects/addts for download pointers,
41including Git repository URLs.
42
43* License
44
45Copyright (C) 2018, 2019 Sergey Poznyakoff
46
47Addts is free software; you can redistribute it and/or modify
48it under the terms of the GNU General Public License as published by
49the Free Software Foundation; either version 3, or (at your option)
50any later version.
51
52Addts is distributed in the hope that it will be useful,
53but WITHOUT ANY WARRANTY; without even the implied warranty of
54MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
55GNU General Public License for more details.
56
57You should have received a copy of the GNU General Public License
58along with addts. If not, see <http://www.gnu.org/licenses/>.
59
60
61Local variables:
62mode: outline
63paragraph-separate: "[ ]*$"
64end:
65
66
67

Return to:

Send suggestions and report system problems to the System administrator.