diff options
| author | Thomas E. Dickey <dickey@invisible-island.net> | 2021-03-15 20:24:39 -0400 |
|---|---|---|
| committer | Thomas E. Dickey <dickey@invisible-island.net> | 2021-03-17 19:09:48 -0400 |
| commit | 8ca8885d3153d6091e7c7b0a8c9510cd487cd583 (patch) | |
| tree | ede8df73b3b424136b0b20cd72681b19ca21d903 | |
| parent | 61adeda1d32b1f298551d51616286bff104fcd69 (diff) | |
| download | xorg-lib-libXcursor-8ca8885d3153d6091e7c7b0a8c9510cd487cd583.tar.gz | |
document the library-attributes
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
| -rw-r--r-- | man/Xcursor.man | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/man/Xcursor.man b/man/Xcursor.man index 8b9956a..e115661 100644 --- a/man/Xcursor.man +++ b/man/Xcursor.man @@ -392,6 +392,33 @@ XcursorLibraryLoadImages calls XcursorFileLoadImages and on success calls XcursorImagesSetName to associate \fIname\fP with the result. .RE +.SS Library attributes +.NS +const char * XcursorLibraryPath (void) +.NE +Returns the library search path: +.RS +.bP +If the environment variable \fBXCURSOR_PATH\fP is set, +return that value. +.bP +Otherwise, return the compiled-in search path. +.RE + +.NS +int XcursorLibraryShape (const char *\fIlibrary\fP) +.NE +Search Xcursor's table of cursor font names for the given +\*(``shape name\*('' (\fIlibrary\fP): +.RS +.bP +If found, return the index into that table, +multiplied by two (to account for the source- and mask-values +used in an X cursor font). +.bP +If not found, return -1. +.RE + .SS Cursor APIs .NS @@ -547,7 +574,7 @@ These are the recognized values: .RE .TP 15 .B XCURSOR_PATH -This variable sets the list of paths to look for cursors in, +This variable sets the list of paths in which to search for cursors, rather than the compiled-in default list. .IP Directories in this path are separated by colons (:). |