• 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_Quit.3 909 Bytes
.TH "SDL_Quit" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_Quit \- Shut down SDL
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBvoid \fBSDL_Quit\fP\fR(\fBvoid\fR);
.SH "DESCRIPTION"
.PP
\fBSDL_Quit\fP shuts down all SDL subsystems and frees the resources allocated to them\&. This should always be called before you exit\&. For the sake of simplicity you can set \fBSDL_Quit\fP as your \fBatexit\fP call, like: 
.PP
.nf
\f(CWSDL_Init(SDL_INIT_VIDEO|SDL_INIT_AUDIO);
atexit(SDL_Quit);
\&.
\&.\fR
.fi
.PP
.PP
.RS
\fBNote:  
.PP
While using \fBatexit\fP maybe be fine for small programs, more advanced users should shut down SDL in their own cleanup code\&. Plus, using \fBatexit\fP in a library is a sure way to crash dynamically loaded code
.RE
.SH "SEE ALSO"
.PP
\fI\fBSDL_QuitSubsystem\fP\fR, \fI\fBSDL_Init\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00