Quotes around otherwise ambiguous (underline containing) name
[geos.git] / debian / geos-config.1
blob1b4c54ab79eb3afe748115abcfe886fe3e242785
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .TH GEOS 1 "November  8, 2004"
3 .\" Please adjust this date whenever revising the manpage.
4 .SH NAME
5 geos-config - script to get information about the installed version of GEOS
6 .SH SYNOPSIS
7 .B geos-config
8 [\-\-prefix\fI[=DIR]\fP] [\-\-version] [\-\-libs] [\-\-cflags] [\-\-includes] [\-\-jtsport]
9 .br
10 .SH DESCRIPTION
11 .PP
12 \fIgeos-config\fP is a tool that is used to configure to determine
13 the compiler and linker flags that should be used to compile
14 and link programs that use \fIGEOS\fP. It is also used internally
15 to the .m4 macros for GNU autoconf that are included with \fIGEOS\fP.
17 \fIGEOS (Geometry Engine - Open Source)\fP is a C++ port of the 
18 \fIJava Topology Suite (JTS)\fP. As such, it aims to contain the 
19 complete functionality of JTS in C++. This includes all the 
20 \fIOpenGIS "Simple Features for SQL"\fP spatial predicate functions 
21 and spatial operators, as well as specific JTS topology 
22 functions such as IsValid().
24 .SH OPTIONS
25 These programs follow the usual GNU command line syntax, with long
26 options starting with two dashes (`-').
28 \fIgeos-config\fP accepts the following options:
29 .TP 8
30 .B  \-\-version
31 Print the currently installed version of \fIGEOS\fP on the standard output.
32 .TP 8
33 .B  \-\-libs
34 Print the linker flags that are necessary to link a \fIGEOS\fP program.
35 .TP 8
36 .B  \-\-cflags
37 Print the compiler flags that are necessary to compile a \fIGEOS\fP program.
38 .TP 8
39 .B  \-\-prefix=PREFIX
40 If specified, use PREFIX instead of the installation prefix that \fIGEOS\fP
41 was built with when computing the output for the \-\-cflags and
42 \-\-libs options. This option must be specified before any 
43 \-\-libs or \-\-cflags options.
44 .TP 8
45 .B \-\-jtsport
46 Print the version of Java Topology Suite library, which is implemented 
47 by the current \fIGEOS\fP library.
49 .SH SEE ALSO
50 .BR /usr/share/doc/libgeos-doc/html/index.html
51 .br
52 The installed \fIGEOS\fP library is fully documented in the GEOS documentation 
53 package, at 
54 .IR /usr/share/doc/libgeos-doc/html/index.html
55 and the pages at the same location, viewable with a web browser.
57 For further information, see the \fIGEOS\fP home page, at 
58 http://geos.osgeo.org/.
59 .SH AUTHOR
60 See /usr/share/doc/libgeos/AUTHORS
61 .PP
62 This manual page was written by Alex Bodnaru <alexbodn@012.net.il>,
63 for the Debian project (but may be used by others).