aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Voss <thomasvoss@live.com> 2022-09-21 00:13:33 +0200
committerThomas Voss <thomasvoss@live.com> 2022-09-21 00:13:33 +0200
commit9a2b957f93d89b32d14a43998b9bb3aef362d7f3 (patch)
tree1044d48c90bc910d401194de13ce4e09d6651f0c
parent97cf3eb4685f5c5396f16736eb6afc9827fe7593 (diff)
Add a LIBRARY section to manuals
-rw-r--r--Makefile3
-rw-r--r--man/Lb-desc.tmac5
-rw-r--r--man/luxget.35
-rw-r--r--man/luxinit.35
-rw-r--r--man/luxset.35
5 files changed, 20 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index f862452..37f1d66 100644
--- a/Makefile
+++ b/Makefile
@@ -22,6 +22,9 @@ install:
cp ${outputs} ${PREFIX}/lib
cp lux.h ${PREFIX}/include
cp man/* ${MANDIR}/man3
+ file=/usr/share/groff/current/tmac/mdoc/doc-syms; \
+ grep '^\.ds doc-str-Lb-liblux' $$file > /dev/null || \
+ cat man/Lb-desc.tmac >> $$file
clean:
rm -f ${outputs} liblux.o
diff --git a/man/Lb-desc.tmac b/man/Lb-desc.tmac
new file mode 100644
index 0000000..1290ab5
--- /dev/null
+++ b/man/Lb-desc.tmac
@@ -0,0 +1,5 @@
+.\" This is the description that is printed when the .Lb macro is invoked with
+.\" “liblux” as an argument. The general format for the output of the .Lb macro
+.\" is:
+.\" ‹Description› (‹Library Name›, ‹Linker Flag›)
+.ds doc-str-Lb-liblux Display Brightness Library (liblux, \-llux)
diff --git a/man/luxget.3 b/man/luxget.3
index 1216a21..0dc259f 100644
--- a/man/luxget.3
+++ b/man/luxget.3
@@ -15,7 +15,7 @@
.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: September 9 2022 $
+.Dd $Mdocdate: September 20 2022 $
.Dt LUXGET 3
.Os
.Sh NAME
@@ -23,6 +23,8 @@
.Nm luxmax ,
.Nm luxgetp
.Nd query the current or maximum brightness of a display
+.Sh LIBRARY
+.Lb liblux
.Sh SYNOPSIS
.In lux.h
.Ft int
@@ -135,6 +137,7 @@ can fail with any of the errors specified for
or
.Fn openat .
.Sh SEE ALSO
+.Xr lux.h 0 ,
.Xr luxdec 3 ,
.Xr luxdecp 3 ,
.Xr luxfree 3 ,
diff --git a/man/luxinit.3 b/man/luxinit.3
index 62be99f..5f7cc8d 100644
--- a/man/luxinit.3
+++ b/man/luxinit.3
@@ -15,13 +15,15 @@
.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: September 9 2022 $
+.Dd $Mdocdate: September 20 2022 $
.Dt LUXINIT 3
.Os
.Sh NAME
.Nm luxinit ,
.Nm luxfree
.Nd initialise and destroy a luxdisp struct
+.Sh LIBRARY
+.Lb liblux
.Sh SYNOPSIS
.In lux.h
.Ft int
@@ -104,6 +106,7 @@ can fail with any of the errors specified for
or
.Fn readdir .
.Sh SEE ALSO
+.Xr lux.h 0 ,
.Xr luxdec 3 ,
.Xr luxdecp 3 ,
.Xr luxget 3 ,
diff --git a/man/luxset.3 b/man/luxset.3
index 1aa620f..e64b977 100644
--- a/man/luxset.3
+++ b/man/luxset.3
@@ -15,7 +15,7 @@
.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: September 9 2022 $
+.Dd $Mdocdate: September 20 2022 $
.Dt LUXSET 3
.Os
.Sh NAME
@@ -26,6 +26,8 @@
.Nm luxincp ,
.Nm luxdecp
.Nd modify display brightness levels
+.Sh LIBRARY
+.Lb liblux
.Sh SYNOPSIS
.In lux.h
.Ft int
@@ -160,6 +162,7 @@ can fail with any of the errors specified for
or
.Fn openat .
.Sh SEE ALSO
+.Xr lux.h 0 ,
.Xr luxfree 3 ,
.Xr luxget 3 ,
.Xr luxgetp 3 ,