summaryrefslogtreecommitdiff
path: root/libsyslog-sys/src/lib.rs
blob: ed4ef3d481ee3685c652b02cebcac41132569104 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]

//! The code in this crate contains the raw bindings for syslog, automatically
//! generated by [bindgen][]. Before continuing any further, please make sure
//! [libsyslog][] is not the crate you really are looking for.
//!
//! See [The Open Group Base Specifications Issue 7, 2018 edition][0] for
//! actual API documentation or [Wikipedia][1] for general context.
//!
//! Implementation specific documentation: (verified working platforms)
//!
//!  * [FreeBSD][]
//!  * [Haiku][]
//!  * [illumos][]
//!  * [Linux][] (with glibc)
//!  * [NetBSD][]
//!  * [OpenBSD][]
//!
//! [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=syslog
//! [Haiku]: https://www.haiku-os.org/documents/dev/system_logging
//! [illumos]: https://illumos.org/man/3C/syslog
//! [Linux]: https://www.man7.org/linux/man-pages/man3/syslog.3.html
//! [NetBSD]: https://man.netbsd.org/syslog.3
//! [OpenBSD]: https://man.openbsd.org/syslog.3
//!
//! Apple Inc. is advising to no longer use syslog on [macOS][] 10.12 and
//! later, yet this crate compiles and messages produced by it do appear in the
//! output of `log stream` on such platforms.
//!
//! [macOS]: https://developer.apple.com/documentation/os/logging
//!
//! [bindgen]: https://docs.rs/bindgen/latest/bindgen/
//! [libsyslog]: https://docs.rs/bindgen/latest/libsyslog/
//! [0]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/syslog.html
//! [1]: https://en.wikipedia.org/wiki/Syslog
//
// Rust tiers are at: <https://doc.rust-lang.org/rustc/platform-support.html>
// It appears at least AIX and QNX should likely support syslog. Please get in
// touch if having access to such systems.
//
// [AIX]: https://www.ibm.com/docs/en/aix/latest?topic=s-syslog-openlog-closelog-setlogmask-subroutine
// [QNX]: https://www.qnx.com/developers/docs/7.1/com.qnx.doc.neutrino.lib_ref/topic/s/syslog.html

include!(concat!(env!("OUT_DIR"), "/bindings.rs"));