Mercurial > sdl-ios-xcode
view docs/man3/SDL_DisplayFormat.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_DisplayFormat" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_DisplayFormat \- Convert a surface to the display format .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBSDL_Surface *\fBSDL_DisplayFormat\fP\fR(\fBSDL_Surface *surface\fR); .SH "DESCRIPTION" .PP This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer, suitable for fast blitting onto the display surface\&. It calls \fISDL_ConvertSurface\fR .PP If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function\&. .PP If you want an alpha channel, see \fISDL_DisplayFormatAlpha\fR\&. .SH "RETURN VALUE" .PP If the conversion fails or runs out of memory, it returns \fBNULL\fR .SH "SEE ALSO" .PP \fI\fBSDL_ConvertSurface\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR \fI\fBSDL_SetAlpha\fP\fR, \fI\fBSDL_SetColorKey\fP\fR, \fI\fBSDL_Surface\fR\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01