\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Libnetpbm PBM Font Function Manual" 3 "April 2018" "netpbm documentation"
.PP
.UR #toc
Table Of Contents
.UE
\&
.SH NAME
libnetpbm_font \e- Libnetpbm PBM Font Function Manual
.SH DESCRIPTION
.PP
This reference manual covers functions in the \fBlibnetpbm\fP library for
accessing fonts to draw text characters, using the PBM image format and the
\fBlibnetpbm\fP in-memory image formats.
.PP
We actually have very little information here; this is mainly a
framework for adding documentation later if someone becomes interested
in this facility.
.PP
Note that the primary known user of this library is the Netpbm program
\fBpbmtext\fP.  You can use that program's source code as an example.


.UN fontobject
.SH Font Object
.PP
\fBlibnetpbm\fP represents a font with an object of type
\fBstruct font\fP.  The library provides functions to create these objects.
  
.PP
The object these functions create is in newly allocated memory and you
can't actually free it.  The memory may be in multiple pieces, pointing to
each other, and \fBlibnetpbm\fP provides no destroy function.  (This is only
because of implementation laziness).


.UN thefunctions
.SH The Functions
.PP
The functions are all declared in the \fBpbmfont.h\fP header file.

.UN pbm_defaultfont
.SS \fBpbm_defaultfont\fP

.B Synopsis

.nf
\f(CW
    struct font *
    pbm_defaultfont(const char * which);
\fP

.fi

.B Description
.PP
This returns a font object representing a font built in to \fBlibnetpbm\fP.
.PP
\fIwhich\fP is the name of the desired built-in font.  There are two:

.TP
bdf
    
A proportional font similar to Adobe's \fBtimR12\fP font
.TP
fixed
    
A fixed space font


.B Copyright
.PP
The provenance of the built-in fonts are not known for sure, but in 2018,
the \fBbdf\fP font was almost identical to a font on which Adobe and
Digital Equipment Corporation once claimed copyright.  That font was
available in the
.UR ftp://ftp.x.org/pub/current/src/font/
X.org source code
.UE
\& in a
collection named 'font-adobe-75dpi', in a file named
\fBtimR12.pcf.gz\fP.
.PP
Ergo, it is likely that the font was copied into Netpbm from that font in
1991.
.PP
You may need a copyright license from the copyright owners of that original
font not only to copy the \fBlibnetpbm\fP code, but to execute it, thus
generating copies of the glyphs of the font.
  
.PP
The X.org files in 2018 indicate the following copyright claims, along
with a license to the public to copy them:
.RS
.PP
  Copyright 1984-1989, 1994 Adobe Systems Incorporated.
  Copyright 1988, 1994 Digital Equipment Corporation.
.PP
  Permission to use, copy, modify, distribute and sell this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notices appear in all
  copies and that both those copyright notices and this permission
  notice appear in supporting documentation, and that the names of
  Adobe Systems and Digital Equipment Corporation not be used in
  advertising or publicity pertaining to distribution of the software
  without specific, written prior permission.  Adobe Systems and
  Digital Equipment Corporation make no representations about the
  suitability of this software for any purpose.  It is provided 'as
  is' without express or implied warranty.
.RE


.UN pbm_dissectfont
.SS \fBpbm_dissectfont\fP

.UN pbm_loadfont
.SS \fBpbm_loadfont\fP
.PP
This function returns a font object for a font described in a file.  The
file may be either a special PBM file or a BDF file.  The function determines
which it is and behaves as either \fBpbm_loadpbmfont\fP
or \fBpbm_loadbdffont\fP accordingly.

.UN pbm_loadpbmfont
.SS \fBpbm_loadpbmfont\fP

.UN pbm_loadbdffont2
.SS \fBpbm_loadbdffont2\fP

.UN pbm_loadbdffont
.SS \fBpbm_loadbdffont\fP
.PP
This is obsolete.  New programs should use \fBpbm_loadbdffont2\fP
instead.
  
.UN pbm_expandbdffont
.SS \fBpbm_expandbdffont\fP

.UN pbm_dumpfont
.SS \fBpbm_dumpfont\fP
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/libnetpbm_font.html
.PP