Skip to content

Commit da40146

Browse files
committed
Update to mention new TCP, TLS, and signed log message support
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
1 parent eaf543b commit da40146

1 file changed

Lines changed: 30 additions & 20 deletions

File tree

README.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,38 @@
1313
Table of Contents
1414
-----------------
1515

16-
* [Introduction](#introduction)
17-
* [Using -lsyslog](#using--lsyslog)
18-
* [Build & Install](#build--install)
19-
* [Building from GIT](#building-from-git)
20-
* [Origin & References](#origin--references)
21-
22-
> **Tip:** the Gentoo project has a very nice article detailing sysklogd
16+
- [Introduction](#introduction)
17+
- [Using -lsyslog](#using--lsyslog)
18+
- [Build & Install](#build--install)
19+
- [Building from GIT](#building-from-git)
20+
- [Origin & References](#origin--references)
21+
22+
> [!TIP]
23+
> The Gentoo project has a very nice article detailing sysklogd
2324
> <https://wiki.gentoo.org/wiki/Sysklogd>
2425
25-
2626
Introduction
2727
------------
2828

29-
This is the continuation of the original Debian/Ubuntu syslog daemon,
30-
updated with full [RFC3164][] and [RFC5424][] support from NetBSD and
31-
FreeBSD. The package includes the `libsyslog.{a,so}` library with a
32-
`syslog.h` header replacement, the `syslogd` daemon, and a command
33-
line tool called `logger`.
29+
This is the continuation of the original Debian/Ubuntu syslog daemon, updated to
30+
full RFC compliance according to syslog standards [RFC3164][] and [RFC5424][],
31+
derived from NetBSD and FreeBSD. It also supports TCP ([RFC6587][]) and TLS
32+
encrypted transport ([RFC5425][]), as well as cryptographically signed log
33+
messages ([RFC5848][]).
3434

35-
- https://man.troglobit.com/man1/logger.1.html
36-
- https://man.troglobit.com/man8/syslogd.8.html
37-
- https://man.troglobit.com/man5/syslog.conf.5.html
35+
The package includes the `libsyslog.{a,so}` library with a `syslog.h` header
36+
replacement, the `syslogd` daemon, and a command line tool called `logger`.
37+
`libsyslog` and `syslog/syslog.h` are derived directly from NetBSD and expose
38+
`syslogp()` and other new features available only in [RFC5424][] (not yet
39+
available in GLIBC).
3840

39-
`libsyslog` and `syslog/syslog.h`, derived directly from NetBSD, expose
40-
`syslogp()` and other new features available only in [RFC5424][]:
41+
Read more about each component and the APIs:
4142

42-
- https://man.troglobit.com/man3/syslogp.3.html
43-
- https://netbsd.gw.com/cgi-bin/man-cgi?syslog+3+NetBSD-current
43+
- <https://man.troglobit.com/man1/logger.1.html>
44+
- <https://man.troglobit.com/man8/syslogd.8.html>
45+
- <https://man.troglobit.com/man5/syslog.conf.5.html>
46+
- <https://man.troglobit.com/man3/syslogp.3.html>
47+
- <https://netbsd.gw.com/cgi-bin/man-cgi?syslog+3+NetBSD-current>
4448

4549
The `syslogd` daemon is an enhanced version of the standard Berkeley
4650
utility program, updated with DNA from FreeBSD. It provides logging of
@@ -88,6 +92,9 @@ Main differences from the original sysklogd package are:
8892
- Touch PID file on `SIGHUP`, for integration with [Finit][]
8993
- GNU configure & build system to ease porting/cross-compiling
9094
- Support for configuring remote syslog timeout
95+
- Support for [RFC6587][] TCP syslog transport, for sender and receiver
96+
- Support for [RFC5425][] TLS encrypted syslog transport (only if built with OpenSSL support)
97+
- Support for [RFC5848][] cryptographically signed log messages (only if built with OpenSSL support)
9198

9299
Please file bug reports, or send pull requests for bug fixes and/or
93100
proposed extensions at [GitHub][Home].
@@ -208,6 +215,9 @@ now [3-clause BSD][BSD License] licensed.
208215

209216
[RFC3164]: https://tools.ietf.org/html/rfc3164
210217
[RFC5424]: https://tools.ietf.org/html/rfc5424
218+
[RFC5425]: https://tools.ietf.org/html/rfc5425
219+
[RFC5848]: https://tools.ietf.org/html/rfc5848
220+
[RFC6587]: https://tools.ietf.org/html/rfc6587
211221
[Martin Schulze]: http://www.infodrom.org/projects/sysklogd/
212222
[Joachim Wiberg]: https://troglobit.com
213223
[Finit]: https://github.com/troglobit/finit

0 commit comments

Comments
 (0)