diff options
| author | Mattias Andrée <m@maandree.se> | 2024-10-13 23:29:03 +0200 |
|---|---|---|
| committer | Mattias Andrée <m@maandree.se> | 2024-10-13 23:29:03 +0200 |
| commit | 7e144ac2a818c32d826ca9b0a24c9ca518d2a33c (patch) | |
| tree | 118cdd5ee68cec789e819bde414191b1b51ad6a5 | |
| parent | Add section 3 man pages (diff) | |
| download | libparsepcf-7e144ac2a818c32d826ca9b0a24c9ca518d2a33c.tar.gz libparsepcf-7e144ac2a818c32d826ca9b0a24c9ca518d2a33c.tar.bz2 libparsepcf-7e144ac2a818c32d826ca9b0a24c9ca518d2a33c.tar.xz | |
Add overview man pages for the library and for the header
Signed-off-by: Mattias Andrée <m@maandree.se>
| -rw-r--r-- | libparsepcf.7 | 15 | ||||
| -rw-r--r-- | libparsepcf.h.0 | 31 |
2 files changed, 46 insertions, 0 deletions
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 <libparsepcf.h> +.fi +.PP +Link with +.IR -lparsepcf . + +.SH DESCRIPTION +The +.B <libparsepcf.h> +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) |