summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas E. Dickey <dickey@invisible-island.net>2021-03-15 19:00:14 -0400
committerThomas E. Dickey <dickey@invisible-island.net>2021-03-17 19:09:35 -0400
commitbd591012ed1521d4d6dd602f831f13bd57d6782b (patch)
treeff42fe80d2164740610c39a793f8bda9b434627e
parent438e798b34c7ef7c52455247cb5361eab728fe76 (diff)
downloadxorg-lib-libXcursor-bd591012ed1521d4d6dd602f831f13bd57d6782b.tar.gz
italicize parameter names, for readability
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
-rw-r--r--man/Xcursor.man164
1 files changed, 85 insertions, 79 deletions
diff --git a/man/Xcursor.man b/man/Xcursor.man
index 6334a17..04b2190 100644
--- a/man/Xcursor.man
+++ b/man/Xcursor.man
@@ -46,9 +46,11 @@ XCURSOR \- Cursor management library
.fi
.SH DESCRIPTION
.B Xcursor
-is a simple library designed to help locate and load cursors. Cursors can
-be loaded from files or memory. A library of common cursors exists which
-map to the standard X cursor names. Cursors can exist in several sizes and
+is a simple library designed to help locate and load cursors.
+Cursors can be loaded from files or memory.
+A library of common cursors exists which
+map to the standard X cursor names.
+Cursors can exist in several sizes and
the library automatically picks the best size.
.SH FUNCTIONAL OVERVIEW
@@ -253,194 +255,198 @@ versions.
.SS Object Management
.NS
-XcursorImage *XcursorImageCreate (int width, int height)
+XcursorImage *XcursorImageCreate (int \fIwidth\fP, int \fIheight\fP)
.NS
-void XcursorImageDestroy (XcursorImage *image)
+void XcursorImageDestroy (XcursorImage *\fIimage\fP)
.NE
Allocate and free images. On allocation, the hotspot and the pixels are
-left uninitialized. The size is set to the maximum of width and height.
+left uninitialized.
+The size is set to the maximum of \fIwidth\fP and \fIheight\fP.
.NS
-XcursorImages *XcursorImagesCreate (int size)
+XcursorImages *XcursorImagesCreate (int \fIsize\fP)
.NS
-void XcursorImagesDestroy (XcursorImages *images)
+void XcursorImagesDestroy (XcursorImages *\fIimages\fP)
.NE
Allocate and free arrays to hold multiple cursor images. On allocation,
-nimage is set to zero.
+\fInimage\fP is set to zero.
.NS
-XcursorCursors *XcursorCursorsCreate (Display *dpy, int size)
+XcursorCursors *XcursorCursorsCreate (Display *\fIdpy\fP, int \fIsize\fP)
.NS
-void XcursorCursorsDestroy (XcursorCursors *cursors)
+void XcursorCursorsDestroy (XcursorCursors *\fIcursors\fP)
.NE
Allocate and free arrays to hold multiple cursors. On allocation,
-ncursor is set to zero, ref is set to one.
+\fIncursor\fP is set to zero, \fIref\fP is set to one.
.SS Reading and writing images.
.NS
-XcursorImage *XcursorXcFileLoadImage (XcursorFile *file, int size)
+XcursorImage *XcursorXcFileLoadImage (XcursorFile *\fIfile\fP, int \fIsize\fP)
.NS
-XcursorImages *XcursorXcFileLoadImages (XcursorFile *file, int size)
+XcursorImages *XcursorXcFileLoadImages (XcursorFile *\fIfile\fP, int \fIsize\fP)
.NS
-XcursorImages *XcursorXcFileLoadAllImages (XcursorFile *file)
+XcursorImages *XcursorXcFileLoadAllImages (XcursorFile *\fIfile\fP)
.NS
XcursorBool XcursorXcFileLoad (
- XcursorFile *file,
- XcursorComments **commentsp,
- XcursorImages **imagesp)
+ XcursorFile *\fIfile\fP,
+ XcursorComments **\fIcommentsp\fP,
+ XcursorImages **\fIimagesp\fP)
.NS
XcursorBool XcursorXcFileSave (
- XcursorFile *file,
- const XcursorComments *comments,
- const XcursorImages *images)
+ XcursorFile *\fIfile\fP,
+ const XcursorComments *\fIcomments\fP,
+ const XcursorImages *\fIimages\fP)
.NE
These read and write cursors from an XcursorFile handle. After reading, the
file pointer will be left at some random place in the file.
.NS
-XcursorImage *XcursorFileLoadImage (FILE *file, int size)
+XcursorImage *XcursorFileLoadImage (FILE *\fIfile\fP, int \fIsize\fP)
.NS
-XcursorImages *XcursorFileLoadImages (FILE *file, int size)
+XcursorImages *XcursorFileLoadImages (FILE *\fIfile\fP, int \fIsize\fP)
.NS
-XcursorImages *XcursorFileLoadAllImages (FILE *file)
+XcursorImages *XcursorFileLoadAllImages (FILE *\fIfile\fP)
.NS
-XcursorBool XcursorFileLoad (FILE *file,
- XcursorComments **commentsp,
- XcursorImages **imagesp)
+XcursorBool XcursorFileLoad (
+ FILE *\fIfile\fP,
+ XcursorComments **\fIcommentsp\fP,
+ XcursorImages **\fIimagesp\fP)
.NS
-XcursorBool XcursorFileSaveImages (FILE *file,
- const XcursorImages *images)
+XcursorBool XcursorFileSaveImages (
+ FILE *\fIfile\fP,
+ const XcursorImages *\fIimages\fP)
.NS
XcursorBool XcursorFileSave (
- FILE * file,
- const XcursorComments *comments,
- const XcursorImages *images)
+ FILE * \fIfile\fP,
+ const XcursorComments *\fIcomments\fP,
+ const XcursorImages *\fIimages\fP)
.NE
These read and write cursors from a stdio FILE handle. Writing flushes
before returning so that any errors should be detected.
.NS
XcursorImage *XcursorFilenameLoadImage (
- const char *filename,
- int size)
+ const char *\fIfilename\fP,
+ int \fIsize\fP)
.NS
XcursorImages *XcursorFilenameLoadImages (
- const char *filename,
- int size)
+ const char *\fIfilename\fP,
+ int \fIsize\fP)
.NS
-XcursorImages *XcursorFilenameLoadAllImages (const char *file)
+XcursorImages *XcursorFilenameLoadAllImages (const char *\fIfile\fP)
.NS
XcursorBool XcursorFilenameLoad (
- const char *file,
- XcursorComments **commentsp,
- XcursorImages **imagesp)
+ const char *\fIfile\fP,
+ XcursorComments **\fIcommentsp\fP,
+ XcursorImages **\fIimagesp\fP)
.NS
XcursorBool XcursorFilenameSaveImages (
- const char *filename,
- const XcursorImages *images)
+ const char *\fIfilename\fP,
+ const XcursorImages *\fIimages\fP)
.NS
XcursorBool XcursorFilenameSave (
- const char *file,
- const XcursorComments *comments,
- const XcursorImages *images)
+ const char *\fIfile\fP,
+ const XcursorComments *\fIcomments\fP,
+ const XcursorImages *\fIimages\fP)
.NE
These parallel the stdio FILE interfaces above, but take filenames.
.SS Reading library images
.NS
XcursorImage *XcursorLibraryLoadImage (
- const char *name,
- const char *theme,
- int size)
+ const char *\fIname\fP,
+ const char *\fItheme\fP,
+ int \fIsize\fP)
.NS
XcursorImages *XcursorLibraryLoadImages (
- const char *name,
- const char *theme,
+ const char *\fIname\fP,
+ const char *\fItheme\fP,
int size)
.NE
-These search the library path, loading the first file found. If 'theme' is
-not NULL, these functions first try appending -theme to name and then
-name alone.
+These search the library path, loading the first file found.
+If \fItheme\fP is not NULL,
+these functions first try appending -theme to \fIname\fP and
+then \fIname\fP alone.
.SS Cursor APIs
.NS
Cursor XcursorFilenameLoadCursor (
- Display *dpy,
- const char *file)
+ Display *\fIdpy\fP,
+ const char *\fIfile\fP)
.NS
XcursorCursors *XcursorFilenameLoadCursors (
- Display *dpy,
- const char *file)
+ Display *\fIdpy\fP,
+ const char *\fIfile\fP)
.NE
These load cursors from the specified file.
.NS
Cursor XcursorLibraryLoadCursor (
- Display *dpy,
- const char *name)
+ Display *\fIdpy\fP,
+ const char *\fIname\fP)
.NS
XcursorCursors *XcursorLibraryLoadCursors (
- Display *dpy,
- const char *name)
+ Display *\fIdpy\fP,
+ const char *\fIname\fP)
.NE
-These load cursors using the specified library name. The theme
+These load cursors using the specified library \fIname\fP. The theme
comes from the display.
.SS X Cursor Name APIs
.NS
XcursorImage *XcursorShapeLoadImage (
- unsigned int shape,
- const char *theme,
- int size)
+ unsigned int \fIshape\fP,
+ const char *\fItheme\fP,
+ int \fIsize\fP)
.NS
XcursorImages *XcursorShapeLoadImages (
- unsigned int shape,
- const char *theme,
- int size)
+ unsigned int \fIshape\fP,
+ const char *\fItheme\fP,
+ int \fIsize\fP)
.NE
-These map 'shape' to a library name using the standard X cursor names and
+These map \fIshape\fP to a library name using the standard X cursor names and
then load the images.
.NS
Cursor XcursorShapeLoadCursor (
- Display *dpy,
- unsigned int shape)
+ Display *\fIdpy\fP,
+ unsigned int \fIshape\fP)
.NS
XcursorCursors *XcursorShapeLoadCursors (
- Display *dpy,
- unsigned int shape)
+ Display *\fIdpy\fP,
+ unsigned int \fIshape\fP)
.NE
-These map 'shape' to a library name and then load the cursors.
+These map \fIshape\fP to a library name and then load the cursors.
.SS Display Information APIs
.NS
-XcursorBool XcursorSupportsARGB (Display *dpy)
+XcursorBool XcursorSupportsARGB (Display *\fIdpy\fP)
.NE
Returns whether the display supports ARGB cursors or whether cursors will be
mapped to a core X cursor.
.NS
-XcursorBool XcursorSetDefaultSize (Display *dpy, int size)
+XcursorBool XcursorSetDefaultSize (Display *\fIdpy\fP, int \fIsize\fP)
.NE
Sets the default size for cursors on the specified display. When loading
cursors, those whose nominal size is closest to this size will be preferred.
.NS
-int XcursorGetDefaultSize (Display *dpy)
+int XcursorGetDefaultSize (Display *\fIdpy\fP)
.NE
Gets the default cursor size.
.NS
-XcursorBool XcursorSetTheme (Display *dpy, const char *theme)
+XcursorBool XcursorSetTheme (Display *\fIdpy\fP, const char *\fItheme\fP)
.NE
Sets the current theme name.
.NS
-char *XcursorGetTheme (Display *dpy)
+char *XcursorGetTheme (Display *\fIdpy\fP)
.NE
Gets the current theme name.