Mercurial > sdl-ios-xcode
view docs/man3/SDL_GetModState.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_GetModState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" .SH "NAME" SDL_GetModState \- Get the state of modifier keys\&. .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBSDLMod \fBSDL_GetModState\fP\fR(\fBvoid\fR); .SH "DESCRIPTION" .PP Returns the current state of the modifier keys (CTRL, ALT, etc\&.)\&. .SH "RETURN VALUE" .PP The return value can be an OR\&'d combination of the SDLMod enum\&. .PP .PP .RS \fBSDLMod\fR .PP .PP .nf \f(CWtypedef enum { KMOD_NONE = 0x0000, KMOD_LSHIFT= 0x0001, KMOD_RSHIFT= 0x0002, KMOD_LCTRL = 0x0040, KMOD_RCTRL = 0x0080, KMOD_LALT = 0x0100, KMOD_RALT = 0x0200, KMOD_LMETA = 0x0400, KMOD_RMETA = 0x0800, KMOD_NUM = 0x1000, KMOD_CAPS = 0x2000, KMOD_MODE = 0x4000, } SDLMod;\fR .fi .PP .RE SDL also defines the following symbols for convenience: .PP .RS .PP .nf \f(CW#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL) #define KMOD_SHIFT (KMOD_LSHIFT|KMOD_RSHIFT) #define KMOD_ALT (KMOD_LALT|KMOD_RALT) #define KMOD_META (KMOD_LMETA|KMOD_RMETA)\fR .fi .PP .RE .SH "SEE ALSO" .PP \fI\fBSDL_GetKeyState\fP\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59