Add a library manual

1 files changed, 106 insertions, 0 deletions

diff --git a/man/lux.h.0 b/man/lux.h.0
new file mode 100644
index 0000000..eaa441f
--- /dev/null
+++ b/man/lux.h.0
@@ -0,0 +1,106 @@
+.\" vi: tw=80 ft=nroff
+.\"
+.\" BSD Zero Clause License
+.\" 
+.\" Copyright (c) 2022 Thomas Voss
+.\" 
+.\" Permission to use, copy, modify, and/or distribute this software for any
+.\" purpose with or without fee is hereby granted.
+.\" 
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+.\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+.\" AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+.\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+.\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+.\" PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: September 20 2022 $
+.Dt lux.h 0
+.Os
+.Sh NAME
+.Nm lux.h
+.Nd query and manipulate screen brightness
+.Sh SYNOPSIS
+.In lux.h
+.Sh DESCRIPTION
+The
+.Nm liblux
+library is a C library
+.Pq C++ compatible
+that allows you to query information about and modify the state of the systems
+display brightness.
+The library defines a
+.Vt struct luxdisp
+type which is used as an argument to all the library functions.
+This struct contains relevant file descriptors and other cacheable information;
+it’s fields are not intended to be accessed directly by the library user but
+only by library functions.
+.Pp
+The
+.Nm liblux
+library offers three sets of functions, each with their own manual.
+These sets of functions are used to allocate and free the
+.Vt struct luxdisp
+structure, to query brightness information, and to modify brightness
+information.
+.Pp
+The following functions deal with the allocation of library structures:
+.Bl -bullet
+.It
+.Ft int
+.Fn luxinit "struct luxdisp *"
+.It
+.Ft void
+.Fn luxfree "struct luxdisp *"
+.El
+.Pp
+The following functions deal with querying information regarding display
+brightness:
+.Bl -bullet
+.It
+.Ft int
+.Fn luxget "struct luxdisp *"
+.It
+.Ft int
+.Fn luxmax "struct luxdisp *"
+.It
+.Ft double
+.Fn luxgetp "struct luxdisp *"
+.El
+.Pp
+The following functions deal with modifying display brightness:
+.Bl -bullet
+.It
+.Ft int
+.Fn luxset "struct luxdisp *" int
+.It
+.Ft int
+.Fn luxinc "struct luxdisp *" int
+.It
+.Ft int
+.Fn luxdec "struct luxdisp *" int
+.It
+.Ft double
+.Fn luxsetp "struct luxdisp *" double
+.It
+.Ft double
+.Fn luxincp "struct luxdisp *" double
+.It
+.Ft double
+.Fn luxdecp "struct luxdisp *" double
+.El
+.Sh SEE ALSO
+.Xr luxdec 3 ,
+.Xr luxdecp 3 ,
+.Xr luxfree 3 ,
+.Xr luxget 3 ,
+.Xr luxgetp 3 ,
+.Xr luxinc 3 ,
+.Xr luxincp 3 ,
+.Xr luxinit 3 ,
+.Xr luxmax 3 ,
+.Xr luxset 3 ,
+.Xr luxsetp 3
+.Sh AUTHORS
+.An Thomas Voss Aq Mt thomasvoss@live.com