summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSiggi Langauf <siggi@users.sourceforge.net>2001-08-28 22:08:39 +0000
committerSiggi Langauf <siggi@users.sourceforge.net>2001-08-28 22:08:39 +0000
commit852d8d42c068b330b2cfa59f2b6786ca87acea41 (patch)
tree784ac477d50aaeba7f89d42e51dc12e4bc694537
parent6bea16fb8408d80701ba329edfb3cd7ae5b880af (diff)
downloadxine-lib-852d8d42c068b330b2cfa59f2b6786ca87acea41.tar.gz
xine-lib-852d8d42c068b330b2cfa59f2b6786ca87acea41.tar.bz2
added man page for xine-config
CVS patchset: 511 CVS date: 2001/08/28 22:08:39
-rw-r--r--doc/man/en/Makefile.am2
-rw-r--r--doc/man/en/xine-config.159
2 files changed, 60 insertions, 1 deletions
diff --git a/doc/man/en/Makefile.am b/doc/man/en/Makefile.am
index 78665fc0e..53fec0693 100644
--- a/doc/man/en/Makefile.am
+++ b/doc/man/en/Makefile.am
@@ -1,6 +1,6 @@
SUBDIRS = man3
-man_MANS = xine-lib.3
+man_MANS = xine-lib.3 xine-config.1
EXTRA_DIST = $(man_MANS) xine-lib.3.in
diff --git a/doc/man/en/xine-config.1 b/doc/man/en/xine-config.1
new file mode 100644
index 000000000..0a2d8bcc6
--- /dev/null
+++ b/doc/man/en/xine-config.1
@@ -0,0 +1,59 @@
+.TH XINE 1 2001-08-28 "The xine project"
+.SH NAME
+xine-config - script to get information about the installed version of libxine
+.SH SYNOPSIS
+.B xine-config
+[\-\-prefix\fI[=DIR]\fP] [\-\-exec\-prefix\fI[=DIR]\fP] [\-\-version] [\-\-libs] [\-\-cflags] [\-\-plugindir] [\-\-skindir]
+.SH DESCRIPTION
+.PP
+\fIxine-config\fP is a tool that is used to determine
+the compiler and linker flags that should be used to compile
+and link programs that use \fIlibxine\fP. It can also be used to determine
+the directories where \fIlibxine\fP expects plugins and skins.
+Finally, it's also used internally
+by the .m4 macros for GNU autoconf that are included with \fIxine-lib\fP.
+.
+.SH OPTIONS
+.l
+\fIxine-config\fP accepts the following options:
+.TP 8
+.B \-\-version
+Print the currently installed version of \fIlibxine\fP on the standard output.
+.TP 8
+.B \-\-libs
+Print the linker flags that are necessary to link \fIlibxine\fP to a program.
+.TP 8
+.B \-\-cflags
+Print the compiler flags that are necessary to compile a program that uses
+\fIlibxine\fP.
+.TP 8
+.B \-\-plugindir
+Print the directory where \fIlibxine\fP plugins are stored/expected.
+.TP 8
+.B \-\-skindir
+Print the directory in which \fIlibxine\fP skins are stored/expected.
+.TP 8
+.B \-\-prefix=PREFIX
+If specified, use PREFIX instead of the installation prefix that \fIxine-lib\fP
+was built with when computing the output for the \-\-cflags and
+\-\-libs options. This option is also used for the exec prefix
+if \-\-exec\-prefix was not specified. This option must be specified
+before any \-\-libs or \-\-cflags options.
+.TP 8
+.B \-\-exec\-prefix=PREFIX
+If specified, use PREFIX instead of the installation exec prefix that
+\fIxine-lib\fP was built with when computing the output for the \-\-cflags
+and \-\-libs options. This option must be specified before any
+\-\-libs or \-\-cflags options.
+.SH SEE ALSO
+.BR xine-lib (3),
+.BR xine (1)
+.SH COPYRIGHT
+Copyright \(co 2001 Siggi Langauf/the xine project, based on the man page
+for gtk-config, \(co 1998 Owen Taylor
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose and without fee is hereby granted,
+provided that the above copyright notice appear in all copies and that
+both that copyright notice and this permission notice appear in
+supporting documentation.