libsyslog_sys/lib.rs
1#![allow(non_upper_case_globals)]
2#![allow(non_camel_case_types)]
3#![allow(non_snake_case)]
4
5//! The code in this crate contains the raw bindings for syslog, automatically
6//! generated by [bindgen][]. Before continuing any further, please make sure
7//! [libsyslog][] is not the crate you really are looking for.
8//!
9//! See [The Open Group Base Specifications Issue 7, 2018 edition][0] for
10//! actual API documentation or [Wikipedia][1] for general context.
11//!
12//! Implementation specific documentation: (verified working platforms)
13//!
14//! * [FreeBSD][]
15//! * [Haiku][]
16//! * [illumos][]
17//! * [Linux][] (with glibc)
18//! * [NetBSD][]
19//! * [OpenBSD][]
20//!
21//! [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=syslog
22//! [Haiku]: https://www.haiku-os.org/documents/dev/system_logging
23//! [illumos]: https://illumos.org/man/3C/syslog
24//! [Linux]: https://www.man7.org/linux/man-pages/man3/syslog.3.html
25//! [NetBSD]: https://man.netbsd.org/syslog.3
26//! [OpenBSD]: https://man.openbsd.org/syslog.3
27//!
28//! Apple Inc. is advising to no longer use syslog on [macOS][] 10.12 and
29//! later, yet this crate compiles and messages produced by it do appear in the
30//! output of `log stream` on such platforms.
31//!
32//! [macOS]: https://developer.apple.com/documentation/os/logging
33//!
34//! [bindgen]: https://docs.rs/bindgen/latest/bindgen/
35//! [libsyslog]: https://docs.rs/bindgen/latest/libsyslog/
36//! [0]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/syslog.html
37//! [1]: https://en.wikipedia.org/wiki/Syslog
38//
39// Rust tiers are at: <https://doc.rust-lang.org/rustc/platform-support.html>
40// It appears at least AIX and QNX should likely support syslog. Please get in
41// touch if having access to such systems.
42//
43// [AIX]: https://www.ibm.com/docs/en/aix/latest?topic=s-syslog-openlog-closelog-setlogmask-subroutine
44// [QNX]: https://www.qnx.com/developers/docs/7.1/com.qnx.doc.neutrino.lib_ref/topic/s/syslog.html
45
46include!(concat!(env!("OUT_DIR"), "/bindings.rs"));