From faea593f8916f6d1a3b8979baf2d375948e86961 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 19 Oct 2024 13:10:45 -0700 Subject: Add syslog RFCs to see also --- docs/ref/api/index.md | 15 ++++++++++++++- docs/ref/api/logging.md | 10 ++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/ref/api/index.md b/docs/ref/api/index.md index 11192e62..f2e01a08 100644 --- a/docs/ref/api/index.md +++ b/docs/ref/api/index.md @@ -1,7 +1,20 @@ # API Reference -This section is a reference guide for the NNG programming interfaces. +This section is a reference guide for the _NNG_ programming interfaces. +It is meant to serve as a refernce, rather than as a tutorial. + +The material here is organized by major areas of functionality. + +Note that unless indicated otherwise, consumers of these interfaces must +include the `nng/nng.h` header file like so: + +```c +#include +``` + +## Chapters - [Messages](msg/) - [Threading and Synchronization](thr/) +- [Logging](logging.md) - [Utility Functions](util/) diff --git a/docs/ref/api/logging.md b/docs/ref/api/logging.md index cbed636c..d695e482 100644 --- a/docs/ref/api/logging.md +++ b/docs/ref/api/logging.md @@ -170,6 +170,16 @@ The {{i:`nng_system_logger`}} attempts to use an appropriate system facility to For POSIX systems, this means using `syslog` to process the messages. For other systems the defauilt behavior may be the same as `nng_stderr_logger`. +## See Also + +The Syslog Protocol upon which this is based is documented in the following two IETF +RFCS, + +- R. Gerhards, [RFC 5424](https://datatracker.ietf.org/doc/html/rfc5424), _The Syslog Protocol_, + March 2009 +- C. Lonvick, [RFC 3164](https://datatracker.ietf.org/doc/html/rfc3164), _The BSD syslog Protocol_, + August 2001 + [log_level]: #log-levels [log_facility]: #log-facilities [log_logger]: #log-handlers -- cgit v1.2.3-70-g09d2