- added man page for ginac-config

[ginac.git] / ginac-config.1.in

diff --git a/ginac-config.1.in b/ginac-config.1.in
new file mode 100644 (file)
index 0000000..095059f
--- /dev/null
+++ b/ginac-config.1.in
@@ -0,0 +1,62 @@
+.TH ginac-config 1 "November, 2000" "GiNaC @VERSION@" "The GiNaC Group"
+.SH NAME
+ginac-config \- script to get information about the installed version of GiNaC
+.SH SYNOPSIS
+[\-\-prefix\fI[=DIR]\fP] [\-\-exec\-prefix\fI[=DIR]\fP] [\-\-version] [\-\-libs] [\-\-cppflags]
+.SH DESCRIPTION
+.PP
+.B ginac-config
+is a tool that is used to determine the compiler and linker flags that
+should be used to compile and link programs that use GiNaC. It is also used
+internally to the .m4 macros for GNU autoconf that are included with GiNaC.
+.SH OPTIONS
+.TP
+.B \-\-version
+Print the currently installed version of GiNaC on the standard output.
+.TP
+.B \-\-libs
+Print the linker flags that are necessary to link a GiNaC program.
+.TP
+.B \-\-cppflags
+Print the compiler flags that are necessary to compile a GiNaC program.
+.TP
+.B \-\-prefix=PREFIX
+If specified, use PREFIX instead of the installation prefix that GiNaC was
+built with when computing the output for the \-\-cppflags 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
+\-\-cppflags options.
+.TP
+.B \-\-exec\-prefix=PREFIX
+If specified, use PREFIX instead of the installation exec prefix that GiNaC
+was built with when computing the output for the \-\-cppflags and \-\-libs
+options.  This option must be specified before any \-\-libs or \-\-cppflags
+options.
+.SH AUTHOR
+.TP
+The GiNaC Group:
+.br
+Christian Bauer <Christian.Bauer@uni-mainz.de>
+.br
+Alexander Frink <Alexander.Frink@uni-mainz.de>
+.br
+Richard Kreckel <Richard.Kreckel@uni-mainz.de>
+.SH SEE ALSO
+GiNaC Tutorial \- An open framework for symbolic computation within the
+C++ programming language
+.SH COPYRIGHT
+Copyright \(co 1999-2000 Johannes Gutenberg Universit\(:at Mainz, Germany
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.