summaryrefslogtreecommitdiff
path: root/libsyslog/README.md
blob: 360f56f2fe0110710f75cbce40534a7786a45507 (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
libsyslog
=========
The code in this crate provides an API implementing the standard Rust logging
facade using the system's syslog. That is, it implements the [Log][] trait of
the [log crate][] for native syslog, typically implemented in C and residing in
libc.

Why?
----
How does this differ from the handful of other pre-existing syslog crates? This
one uses the system library implementation rather than attempting to rewrite it
in Rust. The hope is thus to have a crate that works on pretty much any
platform with syslog, avoiding bugs from making assumptions on implementation
specific details.

The need arose from a desire to use syslog on illumos, a platform where most of
the other syslog crates fail to even build and other(s) instead fail at
runtime.

A list of attempted platforms is maintained in [libsyslog-sys][api]. Reports on
success or failures to use it on other platforms are most welcome.

Contact
-------
Please see <https://www.netizen.se/#contact>.

Copyright and License
---------------------
This crate is Copyright 2023 Martin Samuelsson. It is licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

[api]: https://docs.rs/libsyslog-sys/latest/libsyslog_sys/
[Log]: https://docs.rs/log/latest/log/trait.Log.html
[log crate]: https://lib.rs/crates/log