• Sam Lantinga's avatar
    Erik Heckers fixed bug #493 · f037300c
    Sam Lantinga authored
    Searching the installed man pages for SDL functions fails, e.g.
      man -k SDL_ |grep Video
    After investigating this I found that "makewhatis", the tool that generates
    the "whatis" database, reads the SDL_* man pages, but doesn't produce
    entries in the "whatis" database for the SDL_* man pages.
    After some more debugging I found the reason is a missing space.
    After editing SDL_Init.3(.gz) and replacing
       SDL_Init\- Initializes SDL
    with
       SDL_Init \- Initializes SDL
    everything works fine.
    After running "makewhatis" I can successfully do a
       man -k SDL_
    and SDL_Init is listed in the output.
    
    --HG--
    branch : SDL-1.2
    extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/branches/SDL-1.2%402660
    f037300c
SDL_JoyHatEvent.3 1.54 KB
.TH "SDL_JoyHatEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_JoyHatEvent \- Joystick hat position change event structure
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
  Uint8 type;
  Uint8 which;
  Uint8 hat;
  Uint8 value;
} SDL_JoyHatEvent;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBtype\fR
\fBSDL_JOY\fP
.TP 20
\fBwhich\fR
Joystick device index
.TP 20
\fBhat\fR
Joystick hat index
.TP 20
\fBvalue\fR
Hat position
.SH "DESCRIPTION"
.PP
\fBSDL_JoyHatEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYHATMOTION\fP is reported\&.
.PP
A \fBSDL_JOYHATMOTION\fP event occurs when ever a user moves a hat on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBhat\fR is the index of the hat (for a more detailed exlaination see the \fIJoystick section\fR)\&. \fBvalue\fR is the current position of the hat\&. It is a logically OR\&'d combination of the following values (whose meanings should be pretty obvious:) :
.IP "" 10
\fBSDL_HAT_CENTERED\fP
.IP "" 10
\fBSDL_HAT_UP\fP
.IP "" 10
\fBSDL_HAT_RIGHT\fP
.IP "" 10
\fBSDL_HAT_DOWN\fP
.IP "" 10
\fBSDL_HAT_LEFT\fP
.PP
The following defines are also provided:
.IP "" 10
\fBSDL_HAT_RIGHTUP\fP
.IP "" 10
\fBSDL_HAT_RIGHTDOWN\fP
.IP "" 10
\fBSDL_HAT_LEFTUP\fP
.IP "" 10
\fBSDL_HAT_LEFTDOWN\fP
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetHat\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59