Mercurial > sdl-ios-xcode
view docs/man3/SDL_JoystickEventState.3 @ 4107:4e3b250c950e SDL-1.2
Erik Heckers fixed bug #493
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.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 29 Dec 2007 02:34:53 +0000 |
| parents | e5bc29de3f0a |
| children | 1238da4a7112 |
line wrap: on
line source
.TH "SDL_JoystickEventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickEventState \- Enable/disable joystick event polling .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBint \fBSDL_JoystickEventState\fP\fR(\fBint state\fR); .SH "DESCRIPTION" .PP This function is used to enable or disable joystick event processing\&. With joystick event processing disabled you will have to update joystick states with \fI\fBSDL_JoystickUpdate\fP\fR and read the joystick information manually\&. \fBstate\fR is either \fBSDL_QUERY\fP, \fBSDL_ENABLE\fP or \fBSDL_IGNORE\fP\&. .PP .RS \fBNote: .PP Joystick event handling is prefered .RE .SH "RETURN VALUE" .PP If \fBstate\fR is \fBSDL_QUERY\fP then the current state is returned, otherwise the new processing \fBstate\fR is returned\&. .SH "SEE ALSO" .PP \fISDL Joystick Functions\fR, \fI\fBSDL_JoystickUpdate\fP\fR, \fI\fBSDL_JoyAxisEvent\fR\fR, \fI\fBSDL_JoyBallEvent\fR\fR, \fI\fBSDL_JoyButtonEvent\fR\fR, \fI\fBSDL_JoyHatEvent\fR\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59