debian/sdl2-config.1
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 17 Aug 2016 21:04:50 +0200
changeset 10275 ba7dc3ebb81e
parent 6886 55fc95e5817b
permissions -rw-r--r--
Emscripten: Fixed opening previously closed joystick.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6886
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     1
.TH sdl2-config 1 "2012-02-20" "SDL 2.0"
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     2
.SH NAME
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     3
sdl2-config \- script to get information about the installed version of SDL
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     4
.SH SYNOPSIS
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     5
.B sdl2-config
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     6
[ --prefix=
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     7
.IR DIR ]
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     8
[ --exec-prefix=
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     9
.IR DIR ]
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    10
[ --version ] [ --libs | --library-libs | --plugin-libs ] [ --cflags ]
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    11
.SH DESCRIPTION
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    12
.B sdl2-config
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    13
is a tool that is used to configure and determine the compiler and linker
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    14
flags that should be used to compile and link programs, libraries, and
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    15
plugins that use SDL.  It is also used internally by the m4 macros that are
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    16
included with SDL.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    17
.SH OPTIONS
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    18
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    19
.B --cflags
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    20
Print the compiler flags that are necessary to compile a program or library
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    21
that uses SDL.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    22
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    23
.BI --exec-prefix= DIR
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    24
If specified, use
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    25
.I DIR
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    26
instead of the installation exec prefix that SDL was build with when
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    27
computing the output for the --cflags, --libs, --library-libs, and
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    28
--plugin-libs options.  This option must be specified before any of the
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    29
--cflags, --libs, --library-libs, and --plugin-libs options.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    30
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    31
.B --libs
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    32
Print the linker flags that are necessary to link a program that uses SDL.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    33
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    34
.B --static-libs
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    35
Print the linker flags that are necessary to statically link a program that uses SDL.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    36
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    37
.B --library-libs
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    38
Print the linker flags that are necessary to link a library that uses SDL.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    39
(This excludes any static objects required for linking, since these must be
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    40
linked only by executable programs.)
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    41
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    42
.B --plugin-libs
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    43
Print the linker flags that are necessary to link an SDL-using object that
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    44
is to be accessed via
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    45
.IR dlopen (3).
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    46
This may include static objects with PIC symbol information.  This option
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    47
should
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    48
.B not
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    49
be used for ordinary shared libraries or standalone applications.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    50
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    51
.BI --prefix= DIR
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    52
If specified, use PREFIX instead of the installation prefix that SDL was
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    53
built with when computing the output for the --cflags, --libs,
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    54
--library-libs, and --plugin-libs options.  This option is also used for
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    55
the exec prefix if --exec-prefix was not specified.  This option must be
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    56
specified before any of the --cflags, --libs, --library-libs, and
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    57
--plugin-libs options.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    58
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    59
.B --version
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    60
Prints the currently installed version of SDL on standard output.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    61
.SH EXAMPLES
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    62
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    63
gcc -o main.o $(sdl2-config --cflags) main.c
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    64
is how you might use
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    65
.B sdl2-config
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    66
to compile a C source file for an executable program.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    67
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    68
gcc -o my_app $(sdl2-config --libs) main.o util.o
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    69
is how you might use
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    70
.B sdl2-config
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    71
to link compiled objects into an executable program.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    72
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    73
gcc -o libSDL_nifty-2.0.so.0.0.1 $(sdl --library-libs) read.o write.o munge.o
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    74
is how you might use
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    75
.B sdl2-config
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    76
to link compiled objects into a shared library.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    77
.TP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    78
gcc -o libnifty_xmms.so $(sdl --plugin-libs) stream.o blit.o deinterlace.o
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    79
is how you might use
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    80
.B sdl2-config
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    81
to link compiled objects into a plugin for use by another program.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    82
.SH AUTHOR
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    83
The Simple DirectMedia Layer (SDL) library was written by Sam Lantinga.
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    84
.PP
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    85
This manual page was written by Branden Robinson, originally for Progeny
55fc95e5817b Added native Debian package information
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    86
Linux Systems, Inc., and the Debian Project.