• 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_PushEvent.3 954 Bytes
.TH "SDL_PushEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_PushEvent \- Pushes an event onto the event queue
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_PushEvent\fP\fR(\fBSDL_Event *event\fR);
.SH "DESCRIPTION"
.PP
The event queue can actually be used as a two way communication channel\&. Not only can events be read from the queue, but the user can also push their own events onto it\&. \fBevent\fR is a pointer to the event structure you wish to push onto the queue\&.
.PP
.RS
\fBNote:  
.PP
Pushing device input events onto the queue doesn\&'t modify the state of the device within SDL\&.
.RE
.SH "RETURN VALUE"
.PP
Returns \fB0\fR on success or \fB-1\fR if the event couldn\&'t be pushed\&.
.SH "EXAMPLES"
.PP
See \fI\fBSDL_Event\fR\fR\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR, \fI\fBSDL_Event\fR\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59