debian/sdl2-config.1
changeset 6886 55fc95e5817b
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/debian/sdl2-config.1	Fri Feb 15 14:56:08 2013 -0800
     1.3 @@ -0,0 +1,86 @@
     1.4 +.TH sdl2-config 1 "2012-02-20" "SDL 2.0"
     1.5 +.SH NAME
     1.6 +sdl2-config \- script to get information about the installed version of SDL
     1.7 +.SH SYNOPSIS
     1.8 +.B sdl2-config
     1.9 +[ --prefix=
    1.10 +.IR DIR ]
    1.11 +[ --exec-prefix=
    1.12 +.IR DIR ]
    1.13 +[ --version ] [ --libs | --library-libs | --plugin-libs ] [ --cflags ]
    1.14 +.SH DESCRIPTION
    1.15 +.B sdl2-config
    1.16 +is a tool that is used to configure and determine the compiler and linker
    1.17 +flags that should be used to compile and link programs, libraries, and
    1.18 +plugins that use SDL.  It is also used internally by the m4 macros that are
    1.19 +included with SDL.
    1.20 +.SH OPTIONS
    1.21 +.TP
    1.22 +.B --cflags
    1.23 +Print the compiler flags that are necessary to compile a program or library
    1.24 +that uses SDL.
    1.25 +.TP
    1.26 +.BI --exec-prefix= DIR
    1.27 +If specified, use
    1.28 +.I DIR
    1.29 +instead of the installation exec prefix that SDL was build with when
    1.30 +computing the output for the --cflags, --libs, --library-libs, and
    1.31 +--plugin-libs options.  This option must be specified before any of the
    1.32 +--cflags, --libs, --library-libs, and --plugin-libs options.
    1.33 +.TP
    1.34 +.B --libs
    1.35 +Print the linker flags that are necessary to link a program that uses SDL.
    1.36 +.TP
    1.37 +.B --static-libs
    1.38 +Print the linker flags that are necessary to statically link a program that uses SDL.
    1.39 +.TP
    1.40 +.B --library-libs
    1.41 +Print the linker flags that are necessary to link a library that uses SDL.
    1.42 +(This excludes any static objects required for linking, since these must be
    1.43 +linked only by executable programs.)
    1.44 +.TP
    1.45 +.B --plugin-libs
    1.46 +Print the linker flags that are necessary to link an SDL-using object that
    1.47 +is to be accessed via
    1.48 +.IR dlopen (3).
    1.49 +This may include static objects with PIC symbol information.  This option
    1.50 +should
    1.51 +.B not
    1.52 +be used for ordinary shared libraries or standalone applications.
    1.53 +.TP
    1.54 +.BI --prefix= DIR
    1.55 +If specified, use PREFIX instead of the installation prefix that SDL was
    1.56 +built with when computing the output for the --cflags, --libs,
    1.57 +--library-libs, and --plugin-libs options.  This option is also used for
    1.58 +the exec prefix if --exec-prefix was not specified.  This option must be
    1.59 +specified before any of the --cflags, --libs, --library-libs, and
    1.60 +--plugin-libs options.
    1.61 +.TP
    1.62 +.B --version
    1.63 +Prints the currently installed version of SDL on standard output.
    1.64 +.SH EXAMPLES
    1.65 +.TP
    1.66 +gcc -o main.o $(sdl2-config --cflags) main.c
    1.67 +is how you might use
    1.68 +.B sdl2-config
    1.69 +to compile a C source file for an executable program.
    1.70 +.TP
    1.71 +gcc -o my_app $(sdl2-config --libs) main.o util.o
    1.72 +is how you might use
    1.73 +.B sdl2-config
    1.74 +to link compiled objects into an executable program.
    1.75 +.TP
    1.76 +gcc -o libSDL_nifty-2.0.so.0.0.1 $(sdl --library-libs) read.o write.o munge.o
    1.77 +is how you might use
    1.78 +.B sdl2-config
    1.79 +to link compiled objects into a shared library.
    1.80 +.TP
    1.81 +gcc -o libnifty_xmms.so $(sdl --plugin-libs) stream.o blit.o deinterlace.o
    1.82 +is how you might use
    1.83 +.B sdl2-config
    1.84 +to link compiled objects into a plugin for use by another program.
    1.85 +.SH AUTHOR
    1.86 +The Simple DirectMedia Layer (SDL) library was written by Sam Lantinga.
    1.87 +.PP
    1.88 +This manual page was written by Branden Robinson, originally for Progeny
    1.89 +Linux Systems, Inc., and the Debian Project.