=================================================================== RCS file: /cvs/mandoc/mandoc.3,v retrieving revision 1.45 retrieving revision 1.46 diff -u -p -r1.45 -r1.46 --- mandoc/mandoc.3 2025/02/25 16:17:09 1.45 +++ mandoc/mandoc.3 2025/02/25 17:03:54 1.46 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.3,v 1.45 2025/02/25 16:17:09 schwarze Exp $ +.\" $Id: mandoc.3,v 1.46 2025/02/25 17:03:54 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2010-2017 Ingo Schwarze @@ -143,6 +143,37 @@ or invoke .Fn mparse_reset and go back to step 2 to parse new files. .El +.Pp +The design goals of the +.Nm mandoc +library are limited to providing the functionality required by the +.Xr mandoc 1 +program. +Consequently, the functions documented in the present manual page +do not aim for API stability. +Any third-party program using them typically requires adjustments after every +.Nm mandoc +release. +Linking such a program requires +.Fl lz +because +.Fn mparse_readfd +calls +.Xr gzdopen 3 , +.Xr gzread 3 , +.Xr gzerror 3 , +and +.Xr gzclose 3 . +For +.Xr mandoc 1 +itself, the +.Pa ./configure +script automatically adds +.Fl lz +to the +.Ev LDADD +.Xr make 1 +variable. .Sh REFERENCE This section documents the functions, types, and variables available via