Add the openal-config manpage. ========================================================================== --- /dev/null +++ b/admin/openal-config.1.in @@ -0,0 +1,57 @@ +.TH openal-config 1 "@DATE@" "@PACKAGE_VERSION@" +.SH NAME +openal-config \- script to get information about the installed version of OpenAL +.SH SYNOPSIS +.B openal-config +[ \-\-prefix=\fIDIR\fR ] +[ \-\-exec-prefix=\fIDIR\fR ] +[ \-\-version ] [ \-\-cflags ] [ \-\-libs ] +.SH DESCRIPTION +.B openal-config +is a tool that is used to configure and determine the compiler and linker flags +that should be used to compile and link programs and libraries that use OpenAL. +.SH OPTIONS +.TP +.B \-\-cflags +Print the compiler flags that are necessary to compile a program or library that +uses OpenAL. +.TP +.BI \-\-exec\-prefix= DIR +If specified, use \fIDIR\fR instead of the installation exec prefix that OpenAL +was built with when computing the output for the \-\-cflags and \-\-libs +options. This option must be specified before any of the \-\-cflags and \-\-libs +options. +.TP +.B \-\-libs +Print the linker flags that are necessary to link a program or library that uses +OpenAL. +.TP +.BI \-\-prefix= DIR +If specified, use \fIDIR\fR instead of the installation prefix that OpenAL was +built with when computing the output for the \-\-cflags and \-\-libs options. +If \-\-exec\-prefix was not specified, \fIDIR\fR is also used as exec prefix. +This option must be specified before any of the \-\-cflags and \-\-libs options. +.TP +.B \-\-version +Prints the currently installed version of OpenAL on standard output. +.SH EXAMPLES +.PP +To compile a C source file for use in an executable program that uses OpenAL, +type a command like this: +.IP +.B gcc $(openal\-config \-\-cflags) \-c main.c \-o main.o +.PP +To link the resulting object file into an executable program, use a command like +the following: +.IP +.B gcc \-o my_app main.o util.o $(openal\-config \-\-libs) +.SH AUTHOR +OpenAL was written by Juan Carlos Arevalo Baeza, Jonathan Blow, Keith Charley, +Scott Draeker, John Grantham, Jacob Hawley, Garin Hiebert, Carlos Hasan, Nathan +Hill, Bill Huey, Mike Jarosch, Jean-Marc Jot, Maxim Kizub, John Kraft, Bernd +Kreimeier, Ian Ollmann, Rick Overman, Sean L. Palmer, Sven Panne, Pierre +Phaneuf, Terry Sikes, Joseph Valenzuela, Michael Vance, Carlo Vogelsang, and +Chris Robinson. +.PP +This manual page was written by Thierry Reding for the Debian Project (but may +be used by others).