bulbb/
lib.rs

1/*
2Copyright 2021 David Karrick
3
4Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
5https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6<LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
7option. This file may not be copied, modified, or distributed
8except according to those terms.
9*/
10
11#![deny(rustdoc::broken_intra_doc_links)]
12
13//! # Bulbb
14//!
15//! Boldly Universal Library for managing Backlight Brightness
16//! This library allows the user to change the brightness of backlit devices in Linux.
17//!
18//! ## Goals
19//!
20//! * [ ] Mac Support
21//! * [ ] Windows Support
22//! * [ ] FreeBSD Support
23//!
24//! ## License
25//!
26//! This software is distributed under the terms of both the MIT license and the
27//! Apache License (Version 2.0).
28//!
29//! See [LICENSE-APACHE](https://github.com/Th3Whit3Wolf/bulbb/blob/main/LICENSE-APACHE)(or <https://www.apache.org/licenses/LICENSE-2.0>) and
30//! [LICENSE-MIT](https://github.com/Th3Whit3Wolf/bulbb/blob/main/LICENSE-MIT)(or <https://opensource.org/licenses/MIT>) for license details.
31//!
32//! ### Contribution
33//!
34//! Unless you explicitly state otherwise, any contribution intentionally
35//! submitted for inclusion in the work by you, as defined in the
36//! Apache-2.0 license, shall be dual licensed as above, without any
37//! additional terms or conditions.
38//!
39//! ## References
40//!
41//! Below is some of the reference material I used (stole from)
42//! while writing the documentation for this crate.
43//!
44//! ### Linux
45//!
46//! * [Backlight (Linux ABI description)](https://www.kernel.org/doc/html/latest/admin-guide/abi-testing.html#file-srv-docbuild-lib-git-linux-testing-sysfs-class-led)
47//! * [LEDs (Linux ABI description)](https://www.kernel.org/doc/html/latest/admin-guide/abi-stable.html#abi-file-stable-sysfs-class-backlight)
48//!
49//!
50
51mod utils;
52
53/// Possible errors for this crate.
54pub mod error;
55/// Get lighting of led(s)
56pub mod misc;
57/// Get backlighting of monitor(s)
58pub mod monitor;
bulbb/lib.rs

bulbb/
lib.rs
