summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas E. Dickey <dickey@invisible-island.net>2022-06-06 04:14:55 -0400
committerThomas E. Dickey <dickey@invisible-island.net>2022-06-11 11:09:55 -0400
commit04d5b339f42d90f51b9294552558fae181bc48d8 (patch)
treec58dc78f45a52f22dad127bcdb1d436ad71d02c7
parent18c74d39dd202e385d57415007ba6e803ac6f89a (diff)
downloadxorg-lib-libXft-04d5b339f42d90f51b9294552558fae181bc48d8.tar.gz
consistently bold "Xft"
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
-rw-r--r--man/Xft.man88
1 files changed, 63 insertions, 25 deletions
diff --git a/man/Xft.man b/man/Xft.man
index 6ae98d5..6ee5584 100644
--- a/man/Xft.man
+++ b/man/Xft.man
@@ -77,7 +77,8 @@ is a simple library which draws text and graphics:
.bP
using information provided by the Fontconfig library,
.bP
-Xft converts font glyphs using the FreeType rasterizer, and
+.B Xft
+converts font glyphs using the FreeType rasterizer, and
.bP
displays the converted font data using the X Rendering Extension.
.PP
@@ -125,7 +126,6 @@ version constants might be used:
#endif
.QE
.\" I don't understand what these are for. -- BR, 2005-04-02
-.\" XFT_CORE used in xftname.c
.\" XFT_XLFD used in xftname.c, xftxlfd.c
.\" XFT_NMISSING used in xftcore.c, xftextent.c, xftglyphs.c,
.\" xftrender.c
@@ -449,10 +449,14 @@ data type is defined by the FreeType library.
.SH FUNCTIONS
.\" *************************************************************************
.SS "Initialization"
-A typical application using Xft does not explicitly initialize the library.
+A typical application using
+.B Xft
+does not explicitly initialize the library.
That is usually done as a side-effect of opening a font.
.PP
-When Xft initializes, it collects information about the display,
+When
+.B Xft
+initializes, it collects information about the display,
and stores some of that information in a FontConfig pattern
(essentially a collection of properties with typed values).
The calling application can modify that pattern
@@ -460,7 +464,8 @@ to change the library's behavior.
.PP
Not all of the collected information is stored in a pattern.
The remainer is stored in internal data structures.
-Xft makes some of that available to the application via functions.
+.B Xft
+makes some of that available to the application via functions.
.PS
\fBBool\fP \fBXftDefaultHasRender\fP (
\fBDisplay\fP *\fIdpy\fP);
@@ -468,7 +473,9 @@ Xft makes some of that available to the application via functions.
Obtain information about the display
.I dpy
if not done already, and
-return true if Xft found that the display supports the X Render extension,
+return true if
+.B Xft
+found that the display supports the X Render extension,
and if it is able to find a suitable
.B XRenderPictFormat
(X Render's datatype which is analogous to Xlib's Visual)
@@ -482,14 +489,18 @@ Obtain information about the display
.I dpy
if not done already, and
set the Fontconfig pattern holding default properties
-which Xft will use for this display.
+which
+.B Xft
+will use for this display.
.IP
-Xft uses those properties initially to obtain these limits:
+.B Xft
+uses those properties initially to obtain these limits:
.RS 10
.TP 5
XFT_MAX_GLYPH_MEMORY
(maxglyphmemory).
-This is the maximum amount of glyph memory for all fonts used by Xft
+This is the maximum amount of glyph memory for all fonts used by
+.B Xft
(default: 4*1024*1024).
.TP 5
XFT_MAX_UNREF_FONTS
@@ -498,7 +509,8 @@ This is the maximum number of unreferenced fonts
(default: 16).
.RE
.IP
-Xft also uses these default properties in
+.B Xft
+also uses these default properties in
.BR XftDefaultSubstitute ().
.PS
\fBvoid\fP \fBXftDefaultSubstitute\fP (
@@ -506,14 +518,17 @@ Xft also uses these default properties in
\fBint\fP \fIscreen\fP,
\fBFcPattern\fP *\fIpattern\fP);
.PE
-Xft fills in missing properties in the given
+.B Xft
+fills in missing properties in the given
.I pattern
using default properties for the specified display
.IR dpy ,
e.g., as set in
.BR XftDefaultSet ().
.IP
-Typical Xft applications use this function to help Fontconfig
+Typical
+.B Xft
+applications use this function to help Fontconfig
choose a suitable font.
These properties are substituted before calling
.BR FcDefaultSubstitute ():
@@ -583,7 +598,8 @@ Initializes the Fontconfig library (calling
.IP
The \fIconfig\fP parameter is unused.
.IP
-Xft does not deinitialize the Fontconfig library when it is done.
+.B Xft
+does not deinitialize the Fontconfig library when it is done.
.PS
\fBFcBool\fP \fBXftInitFtLibrary\fP (\fBvoid\fP);
.PE
@@ -594,13 +610,15 @@ to create a library object)
if it has not already been initialized.
This is needed before using the FreeType library to read font data from a file.
.IP
-Xft calls
+.B Xft
+calls
.BR XftInitFtLibrary ()
internally via
.BR XftFontInfoCreate "() and"
.BR XftFontOpenPattern ().
.IP
-Xft does not discard the library object
+.B Xft
+does not discard the library object
(e.g., using
.BR FT_Done_FreeType ())
when it is done.
@@ -608,7 +626,9 @@ when it is done.
\fBint\fP \fBXftGetVersion\fP (\fBvoid\fP);
.PE
Returns \fBXftVersion\fP, enabling an application to determine the
-actual version of Xft which is in use.
+actual version of
+.B Xft
+which is in use.
.\" *************************************************************************
.SS "Opening and Matching Fonts"
.PS
@@ -680,7 +700,9 @@ Also used internally by the
functions,
.B XftFontMatch
can also be used directly to determine the Fontconfig font pattern
-resulting from an Xft font open request.
+resulting from an
+.B Xft
+font open request.
The
.B FcPattern
and
@@ -903,7 +925,9 @@ data type is defined by the X11 library.
\fBDrawable\fP \fIdrawable\fP);
.PE
.B XftDrawChange
-changes the X drawable association of the existing Xft draw object
+changes the X drawable association of the existing
+.B Xft
+draw object
.I draw
from its current value to
.IR drawable .
@@ -913,7 +937,9 @@ from its current value to
\fBXftDraw\fP *\fIdraw\fP);
.PE
.B XftDrawDisplay
-returns a pointer to the display associated with the Xft draw object
+returns a pointer to the display associated with the
+.B Xft
+draw object
.IR draw .
.PP
.PS
@@ -921,7 +947,9 @@ returns a pointer to the display associated with the Xft draw object
\fBXftDraw\fP *\fIdraw\fP);
.PE
.B XftDrawDrawable
-returns the X drawable associated with the Xft draw object
+returns the X drawable associated with the
+.B Xft
+draw object
.IR draw .
.PP
.PS
@@ -929,7 +957,9 @@ returns the X drawable associated with the Xft draw object
\fBXftDraw\fP *\fIdraw\fP);
.PE
.BR XftDrawColormap ()
-returns the colormap associated with the Xft draw object
+returns the colormap associated with the
+.B Xft
+draw object
.IR draw .
.PP
.PS
@@ -937,7 +967,9 @@ returns the colormap associated with the Xft draw object
\fBXftDraw\fP *\fIdraw\fP);
.PE
.B XftDrawVisual
-returns a pointer to the visual associated with the Xft draw object
+returns a pointer to the visual associated with the
+.B Xft
+draw object
.IR draw .
.PP
.PS
@@ -945,7 +977,9 @@ returns a pointer to the visual associated with the Xft draw object
\fBXftDraw\fP *\fIdraw\fP);
.PE
.B XftDrawPicture
-returns the picture associated with the Xft draw object
+returns the picture associated with the
+.B Xft
+draw object
.IR draw .
If the the X server does not support the X Rendering Extension, 0 is
returned.
@@ -993,7 +1027,9 @@ draws no more than
.I len
glyphs of
.I string
-to Xft drawable
+to
+.B Xft
+drawable
.I d
using
.I font
@@ -1019,7 +1055,9 @@ and
.I height
at position
.IR x , " y"
-to Xft drawable
+to
+.B Xft
+drawable
.IR d .
.SH COMPATIBILITY
As of version 2,