[shapelib] 01/01: Add manfiles
Johan Van de Wauw
johanvdw-guest at moszumanska.debian.org
Wed Oct 15 15:58:46 UTC 2014
This is an automated email from the git hooks/post-receive script.
johanvdw-guest pushed a commit to branch master
in repository shapelib.
commit 282949654e5c7520331c4534dacd2e8b00f46318
Author: Johan Van de Wauw <johan.vandewauw at gmail.com>
Date: Tue Oct 14 21:36:24 2014 +0200
Add manfiles
---
debian/control | 5 +++-
debian/man/dbfadd.md | 18 ++++++++++++++
debian/man/dbfcat.1 | 40 +++++++++++++++++++++++++++++++
debian/man/dbfcat.md | 25 ++++++++++++++++++++
debian/man/dbfcreate.md | 18 ++++++++++++++
debian/man/dbfdump.md | 27 +++++++++++++++++++++
debian/man/dbfinfo.md | 29 +++++++++++++++++++++++
debian/man/shpadd.md | 28 ++++++++++++++++++++++
debian/man/shpcat.md | 25 ++++++++++++++++++++
debian/man/shpcentrd.md | 18 ++++++++++++++
debian/man/shpcreate.md | 21 +++++++++++++++++
debian/man/shpdump.md | 37 +++++++++++++++++++++++++++++
debian/man/shpdxf.md | 20 ++++++++++++++++
debian/man/shpfix.md | 21 +++++++++++++++++
debian/man/shpinfo.md | 28 ++++++++++++++++++++++
debian/man/shpproj.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++
debian/man/shprewind.md | 29 +++++++++++++++++++++++
debian/rules | 2 ++
18 files changed, 453 insertions(+), 1 deletion(-)
diff --git a/debian/control b/debian/control
index 0725c26..17090d6 100644
--- a/debian/control
+++ b/debian/control
@@ -8,8 +8,11 @@ Build-Depends: debhelper (>= 9),
libtool,
libtool-bin,
libproj-dev
+ libproj-dev,
+ libtool-bin,
+ ruby-ronn
Standards-Version: 3.9.6
-Vcs-Browser: http://anonscm.debian.org/gitweb/?p=pkg-grass/shapelib.git
+Vcs-Browser: https://anonscm.debian.org/cgit/pkg-grass/shapelib.git
Vcs-Git: git://anonscm.debian.org/pkg-grass/shapelib.git
Homepage: http://shapelib.maptools.org/
diff --git a/debian/man/dbfadd.md b/debian/man/dbfadd.md
new file mode 100644
index 0000000..f4518e3
--- /dev/null
+++ b/debian/man/dbfadd.md
@@ -0,0 +1,18 @@
+dbfadd(1) -- adds a record into an existing .dbf file
+=====================================================
+
+##SYNOPSIS
+
+`dbfadd` xbase_file field_values
+
+##OPTIONS
+ * *xbase_file*: the name of an existing xBase file
+ * *field_values*: list of values to be inserted into the xBase file. You must specify a number of values equal to the number of fields the xBase file has. The order of values must also reflect the order of fields inside xBase file.
+
+##EXAMPLE
+`dbfadd` testbase.dbf REGION1 25.656 150.22
+
+ Assuming that testbase.dbf has 3 fields( NAME, AREA and VALUE), this command line will insert a new record into testbase.dbf with the value "REGION1" for NAME, '25.656' for AREA and '150.22' for VALUE field.
+
+##AUTHOR
+`dbfcreate` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/dbfcat.1 b/debian/man/dbfcat.1
new file mode 100644
index 0000000..61a7c58
--- /dev/null
+++ b/debian/man/dbfcat.1
@@ -0,0 +1,40 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "DBFCAT" "1" "October 2014" "" ""
+.
+.SH "NAME"
+\fBdbfcat\fR \- : appends the records of a source xBase file
+.
+.SH "SYNOPSIS"
+\fBdbfcat\fR [\fI\-v\fR] [\fI\-f\fR] from_DBFfile to_DBFfile
+.
+.SH "DESCRIPTION"
+Appends the records of a source xBase file into a destiny xBase file\. Both files must have the same number of fields\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fI\-v\fR
+verbose mode\.
+.
+.TP
+\fI\-f\fR
+forces data convertion if data field types is not the same at both files or if is there any null value into from_DBFfile\.
+.
+.TP
+from_DBFfile
+source xBase file\.
+.
+.TP
+to_DBFfile
+destiny xBase file\.
+.
+.SH "EXAMPLE"
+\fBdbfadd\fR testbase\.dbf REGION1 25\.656 150\.22
+.
+.P
+Assuming that testbase\.dbf has 3 fields( NAME, AREA and VALUE), this command line will insert a new record into testbase\.dbf with the value "REGION1" for NAME, \'25\.656\' for AREA and \'150\.22\' for VALUE field\.
+.
+.SH "AUTHOR"
+\fBdbfcreate\fR is part of shapelib, maintained by Frank Warmerdam\. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw\.
diff --git a/debian/man/dbfcat.md b/debian/man/dbfcat.md
new file mode 100644
index 0000000..4311fbb
--- /dev/null
+++ b/debian/man/dbfcat.md
@@ -0,0 +1,25 @@
+dbfcat(1) -- : appends the records of a source xBase file
+=====================================================
+
+##SYNOPSIS
+
+`dbfcat` [<-v>] [<-f>] from_DBFfile to_DBFfile
+
+##DESCRIPTION
+Appends the records of a source xBase file into a destiny xBase file. Both files must have the same number of fields.
+
+##OPTIONS
+ * <-v>:
+ verbose mode.
+ * <-f>:
+ forces data convertion if data field types is not the same at both files or if is there any null value into from_DBFfile.
+ * from_DBFfile:
+ source xBase file.
+ * to_DBFfile:
+ destiny xBase file.
+
+##EXAMPLE
+`dbfcat` -v testbase1 testbase2
+
+##AUTHOR
+`dbfcat` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/dbfcreate.md b/debian/man/dbfcreate.md
new file mode 100644
index 0000000..4f720c8
--- /dev/null
+++ b/debian/man/dbfcreate.md
@@ -0,0 +1,18 @@
+dbfcreate(1) -- creates a new and empty .dbf file
+=================================================
+
+##SYNOPSIS
+
+`dbfcreate` xbase_file [[-s field_name width],[-n field_name width decimals],...]
+
+##OPTIONS
+ * xbase_file: the name of xBase file to be created. Doesn't need the extension.
+ * -s field_name width: creates a string field with name field_name and size width.
+ * -n field_name width decimals: creates a numeric field with name field_name, width of width and with decimals places sized by decimals.
+
+##EXAMPLE
+`dbfcreate` testbase -s NAME 20, -n AREA 9 3, -n VALUE 9 2
+
+ this will create a file named testbase.dbf with 3 fields: NAME ( string (20)), AREA ( float (9,3)) and VALUE ( float (9,2))
+##AUTHOR
+`dbfcreate` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/dbfdump.md b/debian/man/dbfdump.md
new file mode 100644
index 0000000..ccf7d68
--- /dev/null
+++ b/debian/man/dbfdump.md
@@ -0,0 +1,27 @@
+dbfdump(1) -- dumps the content of a xBase file to the terminal
+===============================================================
+
+##SYNOPSIS
+
+`dbfdump` [<-h>] [-r] [-m] xbase_file
+
+##OPTIONS
+ -h: output header info( field descriptions).
+ -r: output raw field info, numeric values not reformatted.
+ -m: output one line per field.
+ xbase_file: the name of an existing xBase file.
+
+
+##EXAMPLE
+
+`dbfdump` -h testbase.dbf
+
+assuming that testbase.dbf has 1 record( inserted by other example using `dbfadd`), this command line will produce the following output:
+
+ Field 0: Type=String, Title='NAME', Width=20, Decimals=0
+ Field 1: Type=Double, Title='AREA', Width=9, Decimals=3
+ Field 2: Type=Double, Title='VALUE', Width=9, Decimals=2
+ NAME AREA VALUE REGION1 25.656 150.22
+
+##AUTHOR
+`dbfdump` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/dbfinfo.md b/debian/man/dbfinfo.md
new file mode 100644
index 0000000..909f3cd
--- /dev/null
+++ b/debian/man/dbfinfo.md
@@ -0,0 +1,29 @@
+dbfinfo(1) -- Displays basic information for a given dBase file
+===============================================================
+
+##SYNOPSIS
+
+`dbfinfo` xbase_file
+
+##DESCRIPTION
+Displays basic information for a given xBase file, like number of columns, number of records and type of each column.
+##OPTIONS
+
+ * xbase_file:
+ The name of an existing xBase file.
+
+##EXAMPLE
+
+`dbfinfo` testbase
+
+ Info for testbase.dbf
+ 3 Columns, 1 Records in file
+ NAME string (20,0)
+ AREA float (9,3)
+ VALUE float (9,2)
+
+
+##AUTHOR
+
+`dbfinfo` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
+
diff --git a/debian/man/shpadd.md b/debian/man/shpadd.md
new file mode 100644
index 0000000..75372f0
--- /dev/null
+++ b/debian/man/shpadd.md
@@ -0,0 +1,28 @@
+shpadd(1) -- adds a shape into an existing shapefile
+===============================================================
+
+##SYNOPSIS
+
+`shpadd` <shp_file> <[[x y] [+]]*>
+
+##OPTIONS
+
+<shp_file>: the name of an existing shapefile.
+
+_x1 y1 x2 y2 ... xn yn_: the set of x,y coordinates that describes the shape that you wish to add.
+ Note that you must specify the correct number of parameters for a given type of shapefile. e.g.: for point shapefiles you have to pass 1 pair of XY coordinates and for a polygon shapefile you should pass at least 4 pairs of XY coordinates( where the first and the last point must have the same coordinates).
+
+
+##EXAMPLE
+`shpadd` testpolygon 100000 7000000 250000 6500000 200000 6000000 100000 7000000
+
+assuming that testpolygon is a polygon shapefile, this command line will insert a new shape( a triangle) into testpolygon with the following XY coordinates:
+
+ vertice 0: 100000 7000000 ( this will also be the vertice where the shape starts and ends)
+ vertice 1: 250000 6500000
+ vertice 2: 200000 6000000
+ vertice 3: 100000 7000000
+
+
+##AUTHOR
+`shpadd` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/shpcat.md b/debian/man/shpcat.md
new file mode 100644
index 0000000..00a98d3
--- /dev/null
+++ b/debian/man/shpcat.md
@@ -0,0 +1,25 @@
+shpcat(1) -- appends the records of a source shapefile
+=====================================================
+
+##SYNOPSIS
+
+`shpcat` [<-v>] [<-f>] from_shpfile to_shpfile
+
+##DESCRIPTION
+Appends the content of a source shapefile into a destiny shapefile. Both files must be the same shapefile type.
+
+##OPTIONS
+ * <-v>:
+ verbose mode.
+ * <-f>:
+ forces data convertion if data field types is not the same at both files or if is there any null value into from_DBFfile.
+ * from_shpfile:
+ source shapefile.
+ * to_shpfile:
+ destiny shapefile.
+
+##EXAMPLE
+`shpcat` -v shapefile1 shapefile2
+
+##AUTHOR
+`shpcat` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/shpcentrd.md b/debian/man/shpcentrd.md
new file mode 100644
index 0000000..099050e
--- /dev/null
+++ b/debian/man/shpcentrd.md
@@ -0,0 +1,18 @@
+shpcentrd(1) -- computes XY centroid for polygon shapefiles
+=====================================================
+
+##SYNOPSIS
+
+`shpcentrd` shp_file new_shp_file
+
+##OPTIONS
+ * shp_file:
+ the name of an existing polygon shapefile.
+ * new_shp_file:
+ the name of the point shapefile that will be created
+
+##EXAMPLE
+`shpcentrd` apolygonfile pointcentrd
+
+##AUTHOR
+`shpcentrd` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/shpcreate.md b/debian/man/shpcreate.md
new file mode 100644
index 0000000..0a841c3
--- /dev/null
+++ b/debian/man/shpcreate.md
@@ -0,0 +1,21 @@
+shpcreate(1) -- creates a new and empty shapefile
+===============================================================
+
+##SYNOPSIS
+
+`shpcreate` shp_file [point|arc|polygon|multipoint]
+
+##OPTIONS
+ shp_file: the name of the shapefile to be created. Doesn't need the extension
+ point|arc|polygon|multipoint: the type of shapefile that you wish to create. Must specify a valid option.
+
+
+##EXAMPLE
+
+`shpcreate` testpolygon polygon
+
+
+this will create a polygon shapefile named testpolygon (in fact testpolygon.shp and testpolygon.shx will be created).
+
+##AUTHOR
+`dbfdump` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/shpdump.md b/debian/man/shpdump.md
new file mode 100644
index 0000000..ce1127f
--- /dev/null
+++ b/debian/man/shpdump.md
@@ -0,0 +1,37 @@
+shpdump(1) -- dumps and or validates the content of a shapefile
+===============================================================
+
+##SYNOPSIS
+
+`shpdump` [-<validate>] shp_file
+
+##OPTIONS
+
+-<validate>:
+
+ count the number of objects that have invalid ring ordenings
+shp_file:
+
+ the name of an existing shapefile.
+
+
+##EXAMPLE
+`shpdump` testpolygon
+
+assuming that testpolygon is an existing shapefile previously created, this command line will output the following result:
+
+Shapefile Type: Polygon # of Shapes: 1
+
+File Bounds: ( 100000.000, 6000000.000,0,0)
+ to ( 250000.000, 7000000.000,0,0)
+
+Shape:0 (Polygon) nVertices=4, nParts=1
+ Bounds:( 100000.000, 6000000.000, 0, 0)
+ to ( 250000.000, 7000000.000, 0, 0)
+ ( 100000.000, 7000000.000, 0, 0) Ring
+ ( 250000.000, 6500000.000, 0, 0)
+ ( 200000.000, 6000000.000, 0, 0)
+ ( 100000.000, 7000000.000, 0, 0)
+
+##AUTHOR
+`shpdump` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/shpdxf.md b/debian/man/shpdxf.md
new file mode 100644
index 0000000..cd38fd2
--- /dev/null
+++ b/debian/man/shpdxf.md
@@ -0,0 +1,20 @@
+shpdxf(1) -- creates a DXF from an existing shapefield
+===============================================================
+
+##SYNOPSIS
+
+`shpdxf` shapefile <idfield>
+
+##OPTIONS
+
+ * shapefile:
+ the name of an existing shapefile.
+ * idfield: attribute that will be used as id
+
+
+##EXAMPLE
+
+`shpdxf` shapefile name
+
+##AUTHOR
+`shpxdf` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/shpfix.md b/debian/man/shpfix.md
new file mode 100644
index 0000000..0bc9d9d
--- /dev/null
+++ b/debian/man/shpfix.md
@@ -0,0 +1,21 @@
+shpfix(1) -- fix nulls and inconsistencies in shapefiles
+===============================================================
+
+##SYNOPSIS
+
+`shpfix` in_shp_file out_shp_file [<record# to blank>]
+
+##OPTIONS
+
+in_shp_file:
+ the name of an existing shapefile.
+
+out_shp_file:
+ the name of the new fixed shapefile that will be created.
+
+##EXAMPLE
+
+`shpfix` broken fixed
+
+##AUTHOR
+`shpfix` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
diff --git a/debian/man/shpinfo.md b/debian/man/shpinfo.md
new file mode 100644
index 0000000..4cced65
--- /dev/null
+++ b/debian/man/shpinfo.md
@@ -0,0 +1,28 @@
+shpinfo(1) -- Displays basic information for a given shapefile
+===============================================================
+
+##SYNOPSIS
+
+`shpinfo` shapefile
+
+##DESCRIPTION
+Displays basic information for a given shapefile, like shapefile type, number of objects and its extents.
+
+##OPTIONS
+
+ * shapefile:
+ The name of an existing shapefile.
+
+##EXAMPLE
+
+`shpinfo` testpolygon
+
+ Info for testpolygon
+ Polygon(5), 1 Records in file
+ File Bounds: ( 100000, 6000000)
+ ( 250000, 7000000)
+
+##AUTHOR
+
+`shpinfo` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
+
diff --git a/debian/man/shpproj.md b/debian/man/shpproj.md
new file mode 100644
index 0000000..2ecc907
--- /dev/null
+++ b/debian/man/shpproj.md
@@ -0,0 +1,63 @@
+shpproj(1) -- Reproject Shapefiles using PROJ.4
+===============================================================
+
+##SYNOPSIS
+
+`shpproj` in_shp_file out_shp_file [<-i=in_proj_file | -i="in_params" | -i=geographic>] [<-o=out_info_file | -o="out_params" | -o=geographic>]
+
+
+##OPTIONS
+
+ * in_shp_file:
+ the name of an existing shapefile.
+
+ * out_shp_file:
+ the name of the new fixed shapefile that will be created.
+
+ * <-i>:
+ Input projection. Input can come from one of three sources. A projection parameter file, directly through parameters or geographic. If the shapefile has an associated prj file, name the same as the shapefile but ending in ".prj" it will be used by default ignoring all other parameters. If input is omitted it defaults to geographic, unless the default prj file exists.
+
+
+ * <-o>:
+ Output can come from one of three sources. A projection parameter file, directly through parameters or geographic. If output is omitted it defaults to geographic.
+
+##PROJECTION DETAILS
+
+ * PROJECTION PARAMETER FILE:
+ This file MUST end with the extension ".prj". It has the form of one projection parameter per line. Parameters can be in any order. The projection parameters are those used to define a PROJ.4 projection.
+
+ * PROJECTION PARAMETERS:
+ Are the same as used by proj and invproj.
+
+use:
+ proj -lu to see available units
+ proj -le to see available ellipsoid
+
+Or visit the PROJ.4 web page at http://www.remotesensing.org/proj for more details.
+
+##EXAMPLE
+
+
+
+
+##AUTHOR
+wing example projects file rowtest to row3, moving data from Stateplane NAD83 zone 1002 to utm zone 16 in meters
+
+
+`shpproj` rowtest row -i="init=nad83:1002 units=us-ft" -o="proj=utm zone=16 units=m"
+
+`shpproj` rowtest row3 -o="proj=utm zone=18 units=m" -i="zone=16 proj=utm units=us-ft"
+
+`shpproj` rowtest row3 -o="proj=utm zone=18 units=m"
+
+
+This example uses a prj file and converts to geographic. note that -o=geographic can be ommitted.
+
+`shpproj` rowtest row3 -i=myfile.prj -o=geographic
+
+##AUTHOR
+
+`shpproj` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
+
+##SEE ALSO
+proj(1)
diff --git a/debian/man/shprewind.md b/debian/man/shprewind.md
new file mode 100644
index 0000000..4c50a5e
--- /dev/null
+++ b/debian/man/shprewind.md
@@ -0,0 +1,29 @@
+shprewind(1) -- validates and resets the winding order of rings
+===============================================================
+
+##SYNOPSIS
+
+`shprewind` in_shp_file out_shp_file
+
+##DESCRIPTION
+
+ Validates and resets the winding order of rings in polygon geometries to match the ordering required by shapefile specification. This is usefull for shapefiles having troubles when checked with a 'shpdump -validate'.
+
+##OPTIONS
+
+in_shp_file:
+ the name of an existing shapefile.
+
+out_shp_file:
+ the name of the new fixed shapefile that will be created.
+
+##EXAMPLE
+
+`shprewind` badshapefile newshapefile
+
+##AUTHOR
+`shprewind` is part of shapelib, maintained by Frank Warmerdam. This guide was created by Eduardo Patoo Kanegae and converted to manpage by Johan Van de Wauw.
+
+##SEE ALSO
+
+shpfix(1), shpdump(1)
diff --git a/debian/rules b/debian/rules
index 221378d..c5480e8 100755
--- a/debian/rules
+++ b/debian/rules
@@ -11,11 +11,13 @@ override_dh_auto_test:
override_dh_auto_build:
dh_auto_build
make -C $(CURDIR)/contrib
+ ronn -r --manual=shplib debian/man/*.md
override_dh_auto_clean:
dh_auto_clean
make -C $(CURDIR)/contrib clean
rm -f contrib/Shape_PointInPoly contrib/shpsort
+ rm -f debian/man/*.1
override_dh_auto_install:
mkdir -p debian/tmp/usr/bin/
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/shapelib.git
More information about the Pkg-grass-devel
mailing list