From 7e144ac2a818c32d826ca9b0a24c9ca518d2a33c Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 13 Oct 2024 23:29:03 +0200 Subject: Add overview man pages for the library and for the header MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libparsepcf.7 | 15 +++++++++++++++ libparsepcf.h.0 | 31 +++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 libparsepcf.7 create mode 100644 libparsepcf.h.0 diff --git a/libparsepcf.7 b/libparsepcf.7 new file mode 100644 index 0000000..a62c56d --- /dev/null +++ b/libparsepcf.7 @@ -0,0 +1,15 @@ +.TH LIBPARSEPCF 7 LIBPARSEPCF +.SH NAME +libparsepcf \- Library for interpreting PCF (Portable Compiled Format) font files + +.SH DESCRIPTION +.B libparsepcf +is a C library for interpreting PCF (Portable Compiled Format) font +files. It can be used to examine the contents of a font file. It does not render +text, instead the user is given enough information to implement it's own +rendering; nor is the library capable of creating PCF files. + +.SH SEE ALSO +.BR libparsepcf.h (0), +.BR libparsepcf_get_tables (3), +.BR libparsepcf_preparse_font (3) diff --git a/libparsepcf.h.0 b/libparsepcf.h.0 new file mode 100644 index 0000000..c384f78 --- /dev/null +++ b/libparsepcf.h.0 @@ -0,0 +1,31 @@ +.TH LIBPARSEPCF.H 0 LIBPARSEPCF +.SH NAME +libparsepcf.h \- Header file for interpreting PCF (Portable Compiled Format) font files + +.SH YNOPSIS +.nf +#include +.fi +.PP +Link with +.IR -lparsepcf . + +.SH DESCRIPTION +The +.B +header defines structures, constants, and functions for +interpreting PCF (Portable Compiled Format) font files. +.PP +There are two primary ways to parse the files, either +by reading their tables one by one manually using the +.BR libparsepcf_get_tables (3) +function, or letting the library put all tables into +an organised structure using the +.BR libparsepcf_preparse_font (3) +function. These two man pages will provide further +information for to interpret PCF files. + +.SH SEE ALSO +.BR libparsepcf (7), +.BR libparsepcf_get_tables (3), +.BR libparsepcf_preparse_font.3 (3) -- cgit v1.2.3-70-g09d2