[shapelib] 13/13: Man page formatting consistency fixes.
Sebastiaan Couwenberg
sebastic at moszumanska.debian.org
Tue Aug 11 00:25:13 UTC 2015
This is an automated email from the git hooks/post-receive script.
sebastic pushed a commit to branch master
in repository shapelib.
commit d3f9aa034315179b93dfd5edcb61a7b7a596f057
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Tue Aug 11 02:16:16 2015 +0200
Man page formatting consistency fixes.
---
debian/man/dbfadd.md | 21 ++++++++++---------
debian/man/dbfcat.md | 31 +++++++++++++++-------------
debian/man/dbfcreate.md | 28 +++++++++++++------------
debian/man/dbfdump.md | 26 +++++++++++-------------
debian/man/dbfinfo.md | 22 ++++++++++----------
debian/man/shpadd.md | 23 +++++++++------------
debian/man/shpcat.md | 32 +++++++++++++++++------------
debian/man/shpcentrd.md | 22 +++++++++++---------
debian/man/shpcreate.md | 23 +++++++++------------
debian/man/shpdump.md | 15 ++++++--------
debian/man/shpdxf.md | 22 +++++++++++---------
debian/man/shpfix.md | 21 ++++++++++---------
debian/man/shpinfo.md | 21 +++++++++----------
debian/man/shpproj.md | 54 +++++++++++++++++++------------------------------
debian/man/shprewind.md | 15 ++++++--------
debian/man/shptest.md | 3 +--
16 files changed, 185 insertions(+), 194 deletions(-)
diff --git a/debian/man/dbfadd.md b/debian/man/dbfadd.md
index 34de19e..4ce833c 100644
--- a/debian/man/dbfadd.md
+++ b/debian/man/dbfadd.md
@@ -2,29 +2,30 @@ dbfadd(1) -- add a row to an xBase DBF file
===========================================
##SYNOPSIS
-
`dbfadd` _xbase_file_ _field_values..._
##DESCRIPTION
Adds a row to the DBF file named by _xbase_file_ with column values given by the _field_values_ options that follow. A NULL value is denoted by an empty argument.
##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.
+ * _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
+`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.
+ 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.
##EXIT STATUS
- * 0:
+ * `0`:
Successful program execution.
- * 1:
+ * `1`:
Missing _xbase_file_ or _field_values_ arguments.
- * 2:
+ * `2`:
Failed to open _xbase_file_ for reading and appending.
- * 3:
+ * `3`:
Too few values in _field_values..._
##DIAGNOSTICS
@@ -41,5 +42,5 @@ Got _count1_ fields, but require _count2_
Field values that are too large to fit in a field are silently truncated from the right. Numeric field values that can't be parsed by `atof`(3) get undefined values.
##SEE ALSO
-`dbfcreate`(1), `dbfdump`(1), `dbf_dump`(1), `shpadd`(1), `shpcreate`(1), `shpdump`(1), `shprewind`(1)
+`dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
diff --git a/debian/man/dbfcat.md b/debian/man/dbfcat.md
index 4311fbb..2ed251d 100644
--- a/debian/man/dbfcat.md
+++ b/debian/man/dbfcat.md
@@ -1,25 +1,28 @@
-dbfcat(1) -- : appends the records of a source xBase file
-=====================================================
+dbfcat(1) -- appends the records of a source xBase file
+=======================================================
##SYNOPSIS
-
-`dbfcat` [<-v>] [<-f>] from_DBFfile to_DBFfile
+`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.
+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.
+ * `-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
+`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.
+
+##SEE ALSO
+`dbfadd`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/dbfcreate.md b/debian/man/dbfcreate.md
index a671eff..b51437d 100644
--- a/debian/man/dbfcreate.md
+++ b/debian/man/dbfcreate.md
@@ -2,32 +2,34 @@ dbfcreate(1) -- Create an empty xBase DBF file
==============================================
##SYNOPSIS
-
-`dbfcreate` _xbase_file_ [[-s _field_name_ _width_] | [-n _field_name_ _width_ _decimals_],...]
+`dbfcreate` _xbase_file_ [[`-s` _field_name_ _width_] | [`-n` _field_name_ _width_ _decimals_],...]
##DESCRIPTION
Creates an empty DBF file called _xbase_file_ with columns described by all the `-s` and `-n` options that follow.
##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.
+ * _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
+`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))
+this will create a file named _testbase_`.dbf` with 3 fields: `NAME` (string (_20_)), `AREA` (float (_9_,_3_)) and `VALUE` (float (_9_,_2_))
##EXIT STATUS
- * 0:
+ * `0`:
Successful program execution.
- * 1:
+ * `1`:
Missing _xbase_file_ argument.
- * 2:
+ * `2`:
Failed to create the file _xbase_file_ for writing.
- * 3:
+ * `3`:
Missing _field_name_, _width_, or _decimals_ argument for a `-s` or `-n` option.
- * 4:
+ * `4`:
Failed to add a column given by a `-s` or `-n` option.
##DIAGNOSTICS
@@ -45,5 +47,5 @@ Argument incomplete, or unrecognised: _arg_
`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. It was further enhanced with the man page written by Joonas Pihlaja (jpihlaja at cc.helsinki.fi).
##SEE ALSO
-`dbfadd`(1), `dbfdump`(1), `dbf_dump`(1), `shpadd`(1), `shpcreate`(1), `shpdump`(1), `shprewind`(1)
+`dbfadd`(1), `dbfcat`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
diff --git a/debian/man/dbfdump.md b/debian/man/dbfdump.md
index d7d3a0b..99aa117 100644
--- a/debian/man/dbfdump.md
+++ b/debian/man/dbfdump.md
@@ -1,9 +1,8 @@
-dbfdump(1) -- dumps the content of a xBase file to the terminal
+dbfdump(1) -- dumps the content of a xBase file to the terminal
===============================================================
##SYNOPSIS
-
-`dbfdump` [-h] [-r] [-m] _xbase_file_
+`dbfdump` [`-h`] [`-r`] [`-m`] _xbase_file_
##DESCRIPTION
Dumps the contents of _xbase_file_ to standard output. The first line contains the field names appearing in _xbase_file_, and each of the following lines contains the field values of a record. Field names and values are padded by spaces to their field widths. Empty fields are printed as the string "(NULL)".
@@ -11,7 +10,7 @@ Dumps the contents of _xbase_file_ to standard output. The first line contains t
##OPTIONS
* `-h`:
output header info (field descriptions).
-
+
Prints the column field definitions before other output. Each field definition consists of a line of the form
Field: _index_, Type=_type_, Title=`_name_', Width=_width_, Decimals=_precision_
@@ -38,27 +37,26 @@ Dumps the contents of _xbase_file_ to standard output. The first line contains t
the name of an existing xBase file.
##EXAMPLE
+`dbfdump` `-h` _testbase.dbf_
-`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:
+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
+ NAME AREA VALUE REGION1 25.656 150.22
##EXIT STATUS
- * 0:
+ * `0`:
Successful program execution.
- * 1:
+ * `1`:
Missing _xbase_file_ argument.
- * 2:
+ * `2`:
Failed to open _xbase_file_.
- * 3:
+ * `3`:
There are no fields in _xbase_file_.
##DIAGNOSTICS
@@ -67,7 +65,7 @@ The following diagnostics may be issued on stdout:
DBFOpen(_xbase_file_,"r") failed.
There are no fields in this table!
-
+
##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. It was further enhanced with the man page written by Joonas Pihlaja (jpihlaja at cc.helsinki.fi).
@@ -75,5 +73,5 @@ There are no fields in this table!
Unless the `-r` option is given, values in numeric fields that overflow the `int` or `double` types of the `C` language are printed as plus or minus a huge number. For integer fields the huge value is `HUGE_VALL` from <stdlib.h> and for real fields it is `HUGE_VALF`.
##SEE ALSO
-`dbf_dump`(1), `dbfcreate`(1), `dbfadd`(1), `shpadd`(1), `shpcreate`(1), `shpdump`(1), `shprewind`(1)
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
diff --git a/debian/man/dbfinfo.md b/debian/man/dbfinfo.md
index 909f3cd..f68ea5b 100644
--- a/debian/man/dbfinfo.md
+++ b/debian/man/dbfinfo.md
@@ -1,29 +1,29 @@
-dbfinfo(1) -- Displays basic information for a given dBase file
+dbfinfo(1) -- Displays basic information for a given xBase file
===============================================================
##SYNOPSIS
-
-`dbfinfo` xbase_file
+`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
+Displays basic information for a given xBase file, like number of columns, number of records and type of each column.
- * xbase_file:
- The name of an existing xBase file.
+##OPTIONS
+ * _xbase_file_:
+ The name of an existing xBase file.
##EXAMPLE
-
-`dbfinfo` testbase
+`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
+##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.
+##SEE ALSO
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/shpadd.md b/debian/man/shpadd.md
index 1f95c77..5060343 100644
--- a/debian/man/shpadd.md
+++ b/debian/man/shpadd.md
@@ -2,7 +2,6 @@ shpadd(1) -- append a shape to an ESRI shapefile
================================================
##SYNOPSIS
-
`shpadd` _shp_file_ [[_x_ _y_] [+]]*
##DESCRIPTION
@@ -10,30 +9,28 @@ Appends a shape to the shapefile determined from _shp_file_. The geometric data
Shapefiles actually consist of two files with the same basename and extensions `.shp` and `.shx` (or `.SHP` and `.SHX`) containing the shape data and shape index respectively. The files to open are determined by first stripping any filename extension from file and attempting to open the files _shp_file_`.shp` or _shp_file_`.SHP`, and _shp_file_`.shx` or _shp_file_`.SHX` for the respective data and index files.
-
##OPTIONS
+ * _shp_file_:
+ the name of an existing shapefile.
-<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).
-
+ * _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
+`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:
+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 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
##EXIT STATUS
- * 0:
+ * `0`:
Successful program execution.
- * 1:
+ * `1`:
Missing _shp_file_ argument, the shapefile can't be opened, or the program ran out of memory.
##DIAGNOSTICS
@@ -50,5 +47,5 @@ Out of memory
Coordinate values that can't be be parsed by `sscanf`(3) get undefined values. There's no way to give measure or _Z_ data to vertices in a shape, but those are always set to zero if the shapefile's shape type requires those values. `MultiPatch` shape types aren't supported.
##SEE ALSO
-`dbfadd`(1), `dbfcreate`(1), `dbfdump`(1), `dbf_dump`(1), `shpcreate`(1), `shpdump`(1), `shprewind`(1)
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
diff --git a/debian/man/shpcat.md b/debian/man/shpcat.md
index 00a98d3..0d9d80b 100644
--- a/debian/man/shpcat.md
+++ b/debian/man/shpcat.md
@@ -1,25 +1,31 @@
shpcat(1) -- appends the records of a source shapefile
-=====================================================
+======================================================
##SYNOPSIS
-
-`shpcat` [<-v>] [<-f>] from_shpfile to_shpfile
+`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.
+Appends the content of a source shapefile into a destination 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.
+ * `-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_:
+ destination shapefile.
##EXAMPLE
-`shpcat` -v shapefile1 shapefile2
+`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.
+
+##SEE ALSO
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/shpcentrd.md b/debian/man/shpcentrd.md
index 099050e..4e58a4f 100644
--- a/debian/man/shpcentrd.md
+++ b/debian/man/shpcentrd.md
@@ -1,18 +1,22 @@
-shpcentrd(1) -- computes XY centroid for polygon shapefiles
-=====================================================
+shpcentrd(1) -- computes XY centroid for polygon shapefiles
+===========================================================
##SYNOPSIS
-
-`shpcentrd` shp_file new_shp_file
+`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
+ * _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
+`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.
+
+##SEE ALSO
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/shpcreate.md b/debian/man/shpcreate.md
index b6f7e9f..59e7f0e 100644
--- a/debian/man/shpcreate.md
+++ b/debian/man/shpcreate.md
@@ -2,8 +2,7 @@ shpcreate(1) -- create an empty ESRI shapefile
==============================================
##SYNOPSIS
-
-`shpcreate` _shp_file_ [`point`|`arc`|`polygon`|`multipoint`]
+`shpcreate` _shp_file_ [`point`|`arc`|`polygon`|`multipoint`]
##DESCRIPTION
Creates an empty shapefile supporting shapes of the given type. Shapefiles actually consist of two files with the same basename and extensions `.shp` and `.shx` (or `.SHP` and `.SHX`) containing the shape data and shape index respectively. The files to create are determined by first stripping any filename extension from _shp_file_ and attempting to create the files _shp_file_`.shp` or _shp_file_`.SHP`, and _shp_file_`.shx` or _shp_file_`.SHX` for the respective data and index files. T [...]
@@ -11,28 +10,26 @@ Creates an empty shapefile supporting shapes of the given type. Shapefiles actu
##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`
-`shpcreate` testpolygon polygon
-
-
-this will create a polygon shapefile named testpolygon (in fact testpolygon.shp and testpolygon.shx will be created).
+this will create a polygon shapefile named testpolygon (in fact _testpolygon_`.shp` and _testpolygon_`.shx` will be created).
##EXIT STATUS
- * 0:
+ * `0`:
Successful program execution.
- * 1:
+ * `1`:
Missing _shp_file_ or _shapetype_ argument.
- * 2:
+ * `2`:
Unknown shapetype.
- * 3:
+ * `3`:
Unable to create the shapefile.
##DIAGNOSTICS
@@ -41,10 +38,10 @@ The following diagnostics may be issued on stdout:
Shape Type `_shapetype_' not recognised.
Unable to create:_shp_file_
-
+
##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. It was further enhanced with the man page written by Joonas Pihlaja (jpihlaja at cc.helsinki.fi).
##SEE ALSO
-`dbfadd`(1), `dbfcreate`(1), `dbfdump`(1), `dbf_dump`(1), `shpadd`(1), `shpdump`(1), `shprewind`(1)
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
diff --git a/debian/man/shpdump.md b/debian/man/shpdump.md
index 6ac3066..6b31e00 100644
--- a/debian/man/shpdump.md
+++ b/debian/man/shpdump.md
@@ -2,8 +2,7 @@ shpdump(1) -- dumps as text and/or validates the content of an ESRI shapefile
=============================================================================
##SYNOPSIS
-
-`shpdump` [-<validate>] _shp_file_
+`shpdump` [-_validate_] _shp_file_
##DESCRIPTION
Prints the contents of the shapefile _shp_file_ to standard output in textual format. Shapefiles actually consist of two files with the same basename and extensions `.shp` and `.shx` (or `.SHP` and `.SHX`) containing the shape data and shape index respectively. The files to open are determined by first stripping any filename extension from _shp_file_ and attempting to open the files _shp_file_`.shp` or _shp_file_`.SHP`, and _shp_file_`.shx` or _shp_file_`.SHX` for the respective data a [...]
@@ -80,10 +79,8 @@ Each type of shape except `MultiPatch` typed shapes comes in three flavours: The
* `UnknownShapeType`:
This type is returned for shapes whose type isn't recognised.
-
##OPTIONS
-
- * -<validate>:
+ * -_validate_:
count the number of objects that have invalid ring ordenings
Performs validation on the orientation of inner and outer rings in `Polygon`, `PolygonZ`, and `PolygonM` objects. According to the shapefile specification outer rings should be given a clockwise orientation, and inner rings that define holes a counterclockwise orientation. If some rings of a shape are oriented the wrong way around then the following message is output after dumping that shape:
@@ -98,10 +95,10 @@ Each type of shape except `MultiPatch` typed shapes comes in three flavours: The
the name of an existing shapefile.
##EXIT STATUS
- * 0:
+ * `0`:
Successful program execution.
- * 1:
+ * `1`:
No shapefile _shp_file_ was given or it couldn't be opened.
##EXAMPLE
@@ -147,8 +144,8 @@ Unable to open:_shp_file_
`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. It was further enhanced with the man page written by Joonas Pihlaja (jpihlaja at cc.helsinki.fi).
##BUGS
-The `-validate` option supports only one outer ring in a polygonal shape and assumes that the first ring in a shape is the outer ring. It doesn't support polygons inside `MultiPatch` shapes. The _X_ and _Y_ coordinates of a point are printed to three decimal places only.
+The `-`_validate_ option supports only one outer ring in a polygonal shape and assumes that the first ring in a shape is the outer ring. It doesn't support polygons inside `MultiPatch` shapes. The _X_ and _Y_ coordinates of a point are printed to three decimal places only.
##SEE ALSO
-`dbfadd`(1), `dbfcreate`(1), `dbfdump`(1), `dbf_dump`(1), `shpadd`(1), `shpcreate`(1), `shprewind`(1)
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
diff --git a/debian/man/shpdxf.md b/debian/man/shpdxf.md
index cd38fd2..63dc989 100644
--- a/debian/man/shpdxf.md
+++ b/debian/man/shpdxf.md
@@ -1,20 +1,22 @@
-shpdxf(1) -- creates a DXF from an existing shapefield
-===============================================================
+shpdxf(1) -- creates a DXF from an existing shapefield
+======================================================
##SYNOPSIS
-
-`shpdxf` shapefile <idfield>
+`shpdxf` _shapefile_ _idfield_
##OPTIONS
+ * _shapefile_:
+ the name of an existing shapefile.
- * shapefile:
- the name of an existing shapefile.
- * idfield: attribute that will be used as id
-
+ * _idfield_:
+ attribute that will be used as id
##EXAMPLE
-
-`shpdxf` shapefile name
+`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.
+
+##SEE ALSO
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/shpfix.md b/debian/man/shpfix.md
index 0bc9d9d..a06fa96 100644
--- a/debian/man/shpfix.md
+++ b/debian/man/shpfix.md
@@ -1,21 +1,22 @@
shpfix(1) -- fix nulls and inconsistencies in shapefiles
-===============================================================
+=========================================================
##SYNOPSIS
-
-`shpfix` in_shp_file out_shp_file [<record# to blank>]
+`shpfix` _in_shp_file_ _out_shp_file_ [_record# to blank_]
##OPTIONS
+ * _in_shp_file_:
+ the name of an existing shapefile.
-in_shp_file:
- the name of an existing shapefile.
-
-out_shp_file:
- the name of the new fixed shapefile that will be created.
+ * _out_shp_file_:
+ the name of the new fixed shapefile that will be created.
##EXAMPLE
-
-`shpfix` broken fixed
+`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.
+
+##SEE ALSO
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/shpinfo.md b/debian/man/shpinfo.md
index 4cced65..8f66648 100644
--- a/debian/man/shpinfo.md
+++ b/debian/man/shpinfo.md
@@ -1,28 +1,27 @@
shpinfo(1) -- Displays basic information for a given shapefile
-===============================================================
+==============================================================
##SYNOPSIS
-
-`shpinfo` shapefile
+`shpinfo` _shapefile_
##DESCRIPTION
-Displays basic information for a given shapefile, like shapefile type, number of objects and its extents.
+Displays basic information for a given shapefile, like shapefile type, number of objects and its extents.
##OPTIONS
-
- * shapefile:
- The name of an existing shapefile.
+ * _shapefile_:
+ The name of an existing shapefile.
##EXAMPLE
-
-`shpinfo` testpolygon
+`shpinfo` _testpolygon_
Info for testpolygon
Polygon(5), 1 Records in file
File Bounds: ( 100000, 6000000)
- ( 250000, 7000000)
+ ( 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.
+##SEE ALSO
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpproj`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/shpproj.md b/debian/man/shpproj.md
index 2ecc907..fccd5c8 100644
--- a/debian/man/shpproj.md
+++ b/debian/man/shpproj.md
@@ -1,33 +1,28 @@
-shpproj(1) -- Reproject Shapefiles using PROJ.4
-===============================================================
+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>]
-
+`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.
- * in_shp_file:
- the name of an existing shapefile.
-
- * out_shp_file:
- the name of the new fixed shapefile that will be created.
+ * _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.
+ * `-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.
+ * `-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.
+ 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.
+ Are the same as used by proj and invproj.
use:
proj -lu to see available units
@@ -36,28 +31,21 @@ use:
Or visit the PROJ.4 web page at http://www.remotesensing.org/proj for more details.
##EXAMPLE
+The following 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"
-
-
-##AUTHOR
-wing example projects file rowtest to row3, moving data from Stateplane NAD83 zone 1002 to utm zone 16 in meters
+`shpproj` _rowtest_ _row3_ `-o=`"proj=utm zone=18 units=m" `-i=`"zone=16 proj=utm units=us-ft"
-
-`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"
-`shpproj` rowtest row3 -o="proj=utm zone=18 units=m" -i="zone=16 proj=utm units=us-ft"
+This example uses a prj file and converts to geographic. note that `-o=geographic` can be ommitted.
-`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
+`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)
+`proj`(1), `dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shprewind`(1), `shptest`(1)
+
diff --git a/debian/man/shprewind.md b/debian/man/shprewind.md
index 14a0602..73d46d2 100644
--- a/debian/man/shprewind.md
+++ b/debian/man/shprewind.md
@@ -2,7 +2,6 @@ shprewind(1) -- validates and resets the winding order of rings
===============================================================
##SYNOPSIS
-
`shprewind` _in_shp_file_ _out_shp_file_
##DESCRIPTION
@@ -10,21 +9,20 @@ Validates and resets the winding order of rings in polygon geometries to match t
Makes a copy of the shapefile _in_shp_file_ to _out_shp_file_ and fixes the orientation of points in the rings of `Polygon`, `PolygonZ`, and `PolygonM` typed shapes to conform to the shapefile specification. According to the specification, the vertices of outer rings should be oriented clockwise on the _X/Y_ plane, and those of inner rings counterclockwise.
-Shapefiles actually consist of two files with the same basename and extensions .shp and .shx (or .SHP and .SHX) containing the shape data and shape index respectively. The files to open are determined by first stripping any filename extension from _in_shp_file_ and attempting to open the files _in_shp_file_`.shp` or _in_shp_file_`.SHP`, and _in_shp_file_`.shx` or _in_shp_file_`.SHX` for the respective data and index files. The files to create from _out_shp_file_ are determined by strip [...]
+Shapefiles actually consist of two files with the same basename and extensions `.shp` and `.shx` (or `.SHP` and `.SHX`) containing the shape data and shape index respectively. The files to open are determined by first stripping any filename extension from _in_shp_file_ and attempting to open the files _in_shp_file_`.shp` or _in_shp_file_`.SHP`, and _in_shp_file_`.shx` or _in_shp_file_`.SHX` for the respective data and index files. The files to create from _out_shp_file_ are determined [...]
##OPTIONS
-
- * _in_shp_file_:
+ * _in_shp_file_:
the name of an existing shapefile.
* _out_shp_file_:
the name of the new fixed shapefile that will be created.
##EXIT STATUS
- * 0:
+ * `0`:
Successful program execution.
- * 1:
+ * `1`:
Missing _in_shp_file_ or _out_shp_file_ arguments, failed to open shapefile _in_shp_file_ or create shapefile _out_shp_file_.
##DIAGNOSTICS
@@ -37,8 +35,7 @@ Unable to create:_out_shp_file_
_count_ objects rewound.
##EXAMPLE
-
-`shprewind` badshapefile newshapefile
+`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. It was further enhanced with the man page written by Joonas Pihlaja (jpihlaja at cc.helsinki.fi).
@@ -47,5 +44,5 @@ _count_ objects rewound.
The implementation assumes that there is at most one outer ring in each shape, that it is the first ring in a shape, and all other rings in a shape are inner rings. Polygons inside `MultiPatch` shape types aren't rewound.
##SEE ALSO
-`dbfadd`(1), `dbfcreate`(1), `dbfdump`(1), `dbf_dump`(1), `shpadd`(1), `shpcreate`(1), `shpdump`(1), `shpfix`(1)
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shptest`(1)
diff --git a/debian/man/shptest.md b/debian/man/shptest.md
index 43c47fe..2718ab4 100644
--- a/debian/man/shptest.md
+++ b/debian/man/shptest.md
@@ -2,7 +2,6 @@ shptest(1) -- create some shapefiles for testing
================================================
##SYNOPSIS
-
`shptest` _num_
##DESCRIPTION
@@ -69,5 +68,5 @@ Test `_num_' not recognised.
Frank Warmerdam (warmerdam at pobox.com) is the maintainer of the shapelib shapefile library. Joonas Pihlaja (jpihlaja at cc.helsinki.fi) wrote this man page.
##SEE ALSO
-`dbfadd`(1), `dbfcreate`(1), `dbfdump`(1), `dbf_dump`(1), `shpcreate`(1), `shpdump`(1), `shprewind`(1)
+`dbfadd`(1), `dbfcat`(1), `dbfcreate`(1), `dbfdump`(1), `dbfinfo`(1), `shpadd`(1), `shpcat`(1), `shpcentrd`(1), `shpcreate`(1), `shpdump`(1), `shpdxf`(1), `shpfix`(1), `shpinfo`(1), `shpproj`(1), `shprewind`(1)
--
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