From: schwarze@mandoc.bsd.lv
To: source@mandoc.bsd.lv
Subject: mandoc: Mention the requirement to link against zlib.
Date: Tue, 25 Feb 2025 17:04:25 +0000 (UTC) [thread overview]
Message-ID: <4dfedc6f5a11ceae@mandoc.bsd.lv> (raw)
Log Message:
-----------
Mention the requirement to link against zlib.
Suggested by James K. Lowden <jklowden at schemamania dot org>.
While here, mention that API stability is not a goal.
Modified Files:
--------------
mandoc:
mandoc.3
Revision Data
-------------
Index: mandoc.3
===================================================================
RCS file: /home/cvs/mandoc/mandoc/mandoc.3,v
diff -Lmandoc.3 -Lmandoc.3 -u -p -r1.45 -r1.46
--- mandoc.3
+++ mandoc.3
@@ -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
--
To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv
reply other threads:[~2025-02-25 17:04 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4dfedc6f5a11ceae@mandoc.bsd.lv \
--to=schwarze@mandoc.bsd.lv \
--cc=source@mandoc.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).