• 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_EnableUNICODE.3 1.19 KB
.TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_EnableUNICODE \- Enable UNICODE translation
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR);
.SH "DESCRIPTION"
.PP
Enables/Disables Unicode keyboard translation\&.
.PP
To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function\&. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default\&. For each subsequently received key down event, the \fBunicode\fR member of the \fI\fBSDL_keysym\fR\fR structure will then contain the corresponding character code, or zero for keysyms that do not correspond to any character code\&.
.PP
A value of 1 for \fBenable\fR enables Unicode translation; 0 disables it, and -1 leaves it unchanged (useful for querying the current translation mode)\&.
.PP
Note that only key press events will be translated, not release events\&.
.SH "RETURN VALUE"
.PP
Returns the previous translation mode (\fB0\fR or \fB1\fR)\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_keysym\fR\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59