| 1 |
.\" |
| 2 |
.\" Copyright 2002 Keith Packard.\" |
| 3 |
.\" Permission to use, copy, modify, distribute, and sell this software and its |
| 4 |
.\" documentation for any purpose is hereby granted without fee, provided that |
| 5 |
.\" the above copyright notice appear in all copies and that both that |
| 6 |
.\" copyright notice and this permission notice appear in supporting |
| 7 |
.\" documentation, and that the name of Keith Packard not be used in |
| 8 |
.\" advertising or publicity pertaining to distribution of the software without |
| 9 |
.\" specific, written prior permission. Keith Packard makes no |
| 10 |
.\" representations about the suitability of this software for any purpose. It |
| 11 |
.\" is provided "as is" without express or implied warranty. |
| 12 |
.\" |
| 13 |
.\" KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, |
| 14 |
.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO |
| 15 |
.\" EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR |
| 16 |
.\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, |
| 17 |
.\" DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
| 18 |
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
| 19 |
.\" PERFORMANCE OF THIS SOFTWARE. |
| 20 |
.\" |
| 21 |
.\" |
| 22 |
.\" $XFree86: xc/programs/xcursorgen/xcursorgen.man,v 1.1 2002/09/03 06:48:28 keithp Exp $ |
| 23 |
.\" |
| 24 |
.TH XCURSORGEN 1 "xcursorgen 1.0.8" "X Version 11" |
| 25 |
.SH NAME |
| 26 |
xcursorgen \- create an X cursor file from a collection of PNG images |
| 27 |
.SH SYNOPSIS |
| 28 |
.B "xcursorgen" |
| 29 |
[ \fB\-V\fP ] [ \fB\-\-version\fP ] [ \fB\-?\fP ] [ \fB\-\-help\fP ] |
| 30 |
[ \fB\-p\fP \fIdir\fP ] [ \fB\-\-prefix\fP \fIdir\fP ] |
| 31 |
.RI "[ " config-file |
| 32 |
.RI "[ " output-file " ] ]" |
| 33 |
.SH DESCRIPTION |
| 34 |
Xcursorgen reads the \fIconfig-file\fP to find the list of cursor images along |
| 35 |
with their hotspot and nominal size information. Xcursorgen converts all of |
| 36 |
the images to Xcursor format and writes them to the \fIoutput-file\fP. |
| 37 |
.P |
| 38 |
Each line in the config file is of the form: |
| 39 |
.br |
| 40 |
<size> <xhot> <yhot> <filename> <ms-delay> |
| 41 |
.br |
| 42 |
.P |
| 43 |
Multiple images with the same <size> are used to create animated cursors, |
| 44 |
the <ms-delay> value on each line indicates how long each image should be |
| 45 |
displayed before switching to the next. <ms-delay> can be elided for static |
| 46 |
cursors. |
| 47 |
.P |
| 48 |
If \fIconfig-file\fP is not specified, or is specified as "-", |
| 49 |
standard input is used for the configuration file. |
| 50 |
If \fIoutput-file\fP is not specified, or is specified as "-", |
| 51 |
standard output is used for the output file. |
| 52 |
.SH OPTIONS |
| 53 |
.TP 8 |
| 54 |
.BR \-V ", " \-\-version |
| 55 |
Display the version number and exit. |
| 56 |
.TP 8 |
| 57 |
.BR \-? ", " \-\-help |
| 58 |
Display the usage message and exit. |
| 59 |
.TP 8 |
| 60 |
.BR "\-p \fIdir\fP" ", " "\-\-prefix \fIdir\fP" |
| 61 |
Find cursor images in the directory specified by \fIdir\fP. If not specified, |
| 62 |
the current directory is used. |
| 63 |
.SH "SEE ALSO" |
| 64 |
Xcursor(3) |