aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2020-02-17 12:02:35 +0100
committerKristian Evers <kristianevers@gmail.com>2020-02-17 21:02:41 +0100
commit2d98931a8875412325680773db85572c383add66 (patch)
tree030c9a8cb79cdff96c482edead1251f02ede6d7c
parente4c9c26ee7d3fbcdc88c273ef764f479e76aa428 (diff)
downloadPROJ-2d98931a8875412325680773db85572c383add66.tar.gz
PROJ-2d98931a8875412325680773db85572c383add66.zip
Remove man3 files
Closes #1258
-rw-r--r--HOWTO-RELEASE7
-rw-r--r--man/Makefile.am2
-rw-r--r--man/man3/Makefile.am3
-rw-r--r--man/man3/geodesic.3123
-rw-r--r--man/man3/pj_init.3114
-rwxr-xr-xscripts/update_man.sh2
6 files changed, 3 insertions, 248 deletions
diff --git a/HOWTO-RELEASE b/HOWTO-RELEASE
index 23bcdafb..1f140bfe 100644
--- a/HOWTO-RELEASE
+++ b/HOWTO-RELEASE
@@ -60,12 +60,9 @@ Update the following files with the new ABI version number:
1.2 Update man pages
-------------------------------------------------------------------------------
-Man pages are (mostly) automatically generated from the Sphinx docs. The pages
-in man/man3/ was manually updated in 1.1. Here we update the pages in
-man/man1/. Follow these steps:
+Man pages are (mostly) automatically generated from the Sphinx docs. Follow
+these steps:
- - Update version number and date in `man/man3/pj_init.3` and
- `man/man3/geodesic.3`
- Temporarily update version in `docs/source/conf.py`
- run `scripts/update_man.sh`
- Revert version number in `docs/source/conf.py`
diff --git a/man/Makefile.am b/man/Makefile.am
index 3505dd4d..0a49a142 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,3 +1,3 @@
-SUBDIRS = man1 man3
+SUBDIRS = man1
EXTRA_DIST = CMakeLists.txt
diff --git a/man/man3/Makefile.am b/man/man3/Makefile.am
deleted file mode 100644
index 4a3128a8..00000000
--- a/man/man3/Makefile.am
+++ /dev/null
@@ -1,3 +0,0 @@
-man_MANS = pj_init.3 geodesic.3
-
-EXTRA_DIST = $(man_MANS)
diff --git a/man/man3/geodesic.3 b/man/man3/geodesic.3
deleted file mode 100644
index 1b9d85d4..00000000
--- a/man/man3/geodesic.3
+++ /dev/null
@@ -1,123 +0,0 @@
-.\" @(#)geodesic.3
-.\"
-.TH GEODESIC 3 "2020/01/01 Rel. 6.3.0"
-.ad b
-.hy 1
-.SH NAME
-.B geod_init
-\- initialize an ellipsoid
-.br
-.B geod_direct geod_gendirect
-\- the direct geodesic problem
-.br
-.B geod_inverse geod_geninverse
-\- the inverse geodesic problem
-.br
-.B geod_lineinit geod_directline geod_gendirectline geod_inverseline
-\- initialize a geodesic line
-.br
-.B geod_setdistance geod_gensetdistance
-\- set distance to reference point
-.br
-.B geod_position geod_genposition
-\- a position on a geodesic line
-.br
-.B geod_polygon_init
-\- initialize a polygon
-.br
-.B geod_addpoint geod_addedge
-\- add to a polygon
-.br
-.B geod_polygon_compute geod_polygon_testpoint geod_polygon_testedge
-\- compute properties of polygon
-.br
-.B geod_polygon_clear
-\- clear polygon
-.br
-.B geod_polygonarea
-\- the area of a polygon
-.br
-.SH SYNOPSIS
-.nf
-#include <geodesic.h>
-.br
-and link against the \fBproj\fR library.
-.SH DESCRIPTION
-This library is a port of the geodesic routines in the C++ library,
-GeographicLib, to C. It solves the direct and inverse geodesic problems
-on an ellipsoid of revolution. In addition, the reduced length of a
-geodesic and the area between a geodesic and the equator can be
-computed. The results are accurate to round off for |\fIf\fR| < 1/50,
-where \fIf\fR is the flattening. Note that the geodesic routines
-measure angles (latitudes, longitudes, and azimuths) in degrees, unlike
-the rest of the \fBproj\fR library, which uses radians. The
-documentation for this library is included in geodesic.h. A formatted
-version of the documentation is available at
-https://geographiclib.sourceforge.io/1.50/C. Detailed documentation of
-the interface is given at
-https://geographiclib.sourceforge.io/1.50/C/geodesic_8h.html.
-.SH EXAMPLE
-The following program reads in lines with the coordinates for two points
-in decimal degrees (\fIlat1\fR, \fIlon1\fR, \fIlat2\fR, \fIlon2\fR) and
-prints out \fIazi1\fR, \fIazi2\fR, \fIs12\fR for the geodesic line
-between each pair of points on the WGS84 ellipsoid. (N.B. \fIazi2\fR is
-the forward azimuth at point 2.)
-.nf
-\f(CW
-
-#include <stdio.h>
-#include <geodesic.h>
-
-int main() {
- double a = 6378137, f = 1/298.257223563; /* WGS84 */
- double lat1, lon1, azi1, lat2, lon2, azi2, s12;
- struct geod_geodesic g;
-
- geod_init(&g, a, f);
- while (scanf("%lf %lf %lf %lf",
- &lat1, &lon1, &lat2, &lon2) == 4) {
- geod_inverse(&g, lat1, lon1, lat2, lon2,
- &s12, &azi1, &azi2);
- printf("%.8f %.8f %.3f\en", azi1, azi2, s12);
- }
- return 0;
-} \fR
-.br
-.fi
-.SH LIBRARY
-libproj.a \- library of projections and support procedures
-.SH SEE ALSO
-Full online documentation for \fBgeodesic(3)\fR,
-.br
-https://geographiclib.sourceforge.io/1.50/C
-.br
-https://geographiclib.sourceforge.io/1.50/C/geodesic_8h.html
-.PP
-.B geod(1)
-.PP
-\fBGeographicLib\fR, https://geographiclib.sourceforge.io
-.PP
-The \fBGeodesicExact\fR class in GeographicLib solves the geodesic
-problems in terms of elliptic integrals; the results are accurate for
-arbitrary \fIf\fR.
-.PP
-C. F. F. Karney, \fIAlgorithms for Geodesics\fR,
-.br
-J. Geodesy \fB87\fR, 43-55 (2013);
-.br
-DOI: https://doi.org/10.1007/s00190-012-0578-z
-.br
-https://geographiclib.sourceforge.io/geod-addenda.html
-.PP
-\fIA geodesic bibliography\fR,
-.br
-https://geographiclib.sourceforge.io/geodesic-papers/biblio.html
-.PP
-The Wikipedia page, \fIGeodesics on an ellipsoid\fR,
-.br
-https://en.wikipedia.org/wiki/Geodesics_on_an_ellipsoid
-.SH BUGS
-A list of known bugs can found at https://github.com/OSGeo/PROJ/issues
-where new bug reports can be submitted too.
-.SH HOME PAGE
-https://proj.org/
diff --git a/man/man3/pj_init.3 b/man/man3/pj_init.3
deleted file mode 100644
index d2a98b58..00000000
--- a/man/man3/pj_init.3
+++ /dev/null
@@ -1,114 +0,0 @@
-.\" @(#)pj_init.3 - 6.3.0
-.\"
-.TH PJ_INIT 3 "2020/01/1 Rel. 6.3.0"
-.ad b
-.hy 1
-.SH NAME
-pj_init \- initialize cartographic projection
-.br
-pj_init_plus \- initialize cartographic projection
-.br
-pj_fwd \- forward cartographic projection
-.br
-pj_inv \- inverse cartographic projection
-.br
-pj_transform \- transform between coordinate systems
-.br
-pj_free \- de-initialize projection
-.SH SYNOPSIS
-.nf
-#include <proj_api.h>
-
-projPJ pj_init(int argc, char **argv)
-
-projPJ pj_init_plus(const char *defn)
-
-projUV pj_fwd(projUV val, projPJ proj)
-
-projUV pj_inv(projUV val, projPJ proj)
-
-int pj_transform(projPJ src_cs, projPJ dst_cs, long point_count,
- int point_offset, double *x, double *y, double *z)
-
-void pj_free(projPJ proj)
-
-.SH DESCRIPTION
-Procedure \fBpj_init\fR selects and initializes a cartographic projection
-with its argument control parameters.
-\fBArgc\fR is the number of elements in the array of control strings
-\fBargv\fR that each contain individual cartographic control keyword
-assignments (\f(CW+\fR \fBproj\fR arguments).
-The list must contain at least the \fBproj=\fIprojection\fR and
-Earth's radius or elliptical parameters.
-If the initialization of the projection is successful a valid
-address is returned otherwise a NULL value.
-
-The \fBpj_init_plus\fR function operates similarly to \fBpj_init\fR but
-takes a single string containing the definition, with each parameter
-prefixed with a plus sign. For example "+proj=utm +zone=11 +ellps=WGS84".
-
-Once initialization is performed either forward or inverse
-projections can be performed with the returned value of \fBpj_init\fR
-used as the argument \fBproj\fR.
-The argument structure \fBprojUV\fR values \fBu\fR and \fBv\fR contain
-respective longitude and latitude or x and y.
-Latitude and longitude are in radians.
-If a projection operation fails, both elements of \fBprojUV\fR are
-set to HUGE_VAL (defined in \fImath.h\fR).
-
-\fBNote:\fR all projections have a forward mode, but some do not have
-an inverse projection.
-If the projection does not have an inverse the projPJ structure element
-\fIinv\fR will be NULL.
-
-The \fBpj_transform\fR function may be used to transform points between
-the two provided coordinate systems. In addition to converting between
-cartographic projection coordinates and geographic coordinates, this function
-also takes care of datum shifts if possible between the source and destination
-coordinate system. Unlike \fBpj_fwd\fR and \fBpj_inv\fR it is also allowable
-for the coordinate system definitions (\fBPJ *\fR) to be geographic coordinate
-systems (defined as +proj=latlong). The \fBx\fR, \fBy\fR and \fBz\fR arrays
-contain the input values of the points, and are replaced with the output
-values. The \fBpoint_offset\fR should indicate the spacing the of \fBx,y,z\fR
-arrays, normally 1. The function returns zero on success, or the error number (also in
-pj_errno) on failure.
-
-Memory associated with the projection may be freed with \fBpj_free\fR.
-.SH EXAMPLE
-The following program reads latitude and longitude values in decimal
-degrees, performs Mercator projection with a Clarke 1866 ellipsoid and
-a 33\(de latitude of true scale and prints the projected
-cartesian values in meters:
-.nf
-\f(CW
-#include <proj_api.h>
-
-main(int argc, char **argv) {
- char *args[] = { "proj=merc", "ellps=clrk66", "lat_ts=33" };
- projUV p;
- projPJ pj;
-
- if (!(pj = pj_init(3, args)))
- exit(1);
- while (scanf("%lf %lf", &p.v, &p.u) == 2) {
- p.u *= DEG_TO_RAD;
- p.v *= DEG_TO_RAD;
- p = pj_fwd(p, pj);
- printf("%.2f\et%.2f\en", p.u, p.v);
- }
- exit(0);
-} \fR
-.br
-.fi
-.SH LIBRARY
-libproj.a \- library of projections and support procedures
-.SH SEE ALSO
-.B https://github.com/OSGeo/proj.4/wiki/ProjAPI, proj(1),
-.br
-.I "Cartographic Projection Procedures for the UNIX Environment\(emA User's Manual,"
-(Evenden, 1990, Open-file report 90\-284).
-.SH BUGS
-A list of known bugs can found at https://github.com/OSGeo/PROJ/issues
-where new bug reports can be submitted too.
-.SH HOME PAGE
-https://proj.org/
diff --git a/scripts/update_man.sh b/scripts/update_man.sh
index a058f739..5ad34763 100755
--- a/scripts/update_man.sh
+++ b/scripts/update_man.sh
@@ -9,6 +9,4 @@ git add man/man1/cct.1
git add man/man1/geod.1
git add man/man1/gie.1
git add man/man1/projinfo.1
-git add man/man3/geodesic.3
-git add man/man3/pj_init.3
git commit -m "Update man-pages from Sphinx-docs"