[osmium-tool] 06/13: Bring man page format more in line with usual man pages.
Sebastiaan Couwenberg
sebastic at moszumanska.debian.org
Tue Jul 21 20:15:45 UTC 2015
This is an automated email from the git hooks/post-receive script.
sebastic pushed a commit to tag v1.0.1
in repository osmium-tool.
commit e7e33ef79249a622a778c16f0a4e7e024d99bbff
Author: Jochen Topf <jochen at topf.org>
Date: Tue Mar 31 10:06:38 2015 +0200
Bring man page format more in line with usual man pages.
1. The blurb behind the name now starts with lower case letter and
doesn't end in a period.
2. In the list of options the short option appears first and the
long option option is separated from parameter with an equal
sign.
3. Unify formatting of SYNOPSIS
---
man/osmium-apply-changes.md | 34 +++++++++++++++++-----------------
man/osmium-cat.md | 36 ++++++++++++++++++------------------
man/osmium-file-formats.md | 2 +-
man/osmium-fileinfo.md | 8 ++++----
man/osmium-merge-changes.md | 32 ++++++++++++++++----------------
man/osmium-time-filter.md | 32 ++++++++++++++++----------------
man/osmium.md | 6 +++---
7 files changed, 75 insertions(+), 75 deletions(-)
diff --git a/man/osmium-apply-changes.md b/man/osmium-apply-changes.md
index 8cc21a2..0e7657f 100644
--- a/man/osmium-apply-changes.md
+++ b/man/osmium-apply-changes.md
@@ -3,12 +3,12 @@
# NAME
-osmium-apply-changes - Apply OSM change file(s) to OSM data file.
+osmium-apply-changes - apply OSM change file(s) to OSM data file
# SYNOPSIS
-**osmium apply-changes** \[OPTIONS\] *INPUT-FILE* *CHANGE-FILE...*
+**osmium apply-changes** \[*OPTIONS*\] *INPUT-FILE* *CHANGE-FILE*...
# DESCRIPTION
@@ -25,37 +25,37 @@ data has to fit in there!
# OPTIONS
---generator NAME
-: The name and version of the program generating the output file. It will be
- added to the header of the output file. Default is "*osmium/*" and the version
- of osmium.
+-f, --output-format=FORMAT
+: The format of the output file. Can be used to set the output file format
+ if it can't be autodetected from the output file name.
+ See **osmium-file-formats**(5) or the libosmium manual for details.
---input-format, -F FORMAT
+-F, --input-format=FORMAT
: The format of the input files. Can be used to set the input format if it
can't be autodetected from the file names. This will set the format for
all input files, there is no way to set the format for some input files
only. See **osmium-file-formats**(5) or the libosmium manual for details.
---output, -o FILE
-: Name of the output file. Default is '-' (*stdout*).
+--generator=NAME
+: The name and version of the program generating the output file. It will be
+ added to the header of the output file. Default is "*osmium/*" and the version
+ of osmium.
---output-format, -f FORMAT
-: The format of the output file. Can be used to set the output file format
- if it can't be autodetected from the output file name.
- See **osmium-file-formats**(5) or the libosmium manual for details.
+-o, --output=FILE
+: Name of the output file. Default is '-' (*stdout*).
---overwrite, -O
+-O, --overwrite
: Allow an existing output file to be overwritten. Normally **osmium** will
refuse to write over an existing file.
---remove-deleted, -r
+-r, --remove-deleted
: Remove deleted objects from the output. If this is not set, deleted objects
will be in the output with the visible flag set to false.
---simplify, -s
+-s, --simplify
: Only write the last version of any object to the output.
---verbose, -v
+-v, --verbose
: Set verbose mode. The program will output information about what it is
doing to *stderr*.
diff --git a/man/osmium-cat.md b/man/osmium-cat.md
index 0ad81ca..ca16d5b 100644
--- a/man/osmium-cat.md
+++ b/man/osmium-cat.md
@@ -3,12 +3,12 @@
# NAME
-osmium-cat - Concatenate OSM files and convert to different formats.
+osmium-cat - concatenate OSM files and convert to different formats
# SYNOPSIS
-**osmium cat** \[OPTIONS\] \[**-o** *OUTPUT-FILE*\] *INPUT-FILE...*
+**osmium cat** \[*OPTIONS*\] *INPUT-FILE*...
# DESCRIPTION
@@ -22,38 +22,38 @@ can be used to convert OSM files from one format into another.
# OPTIONS
---generator NAME
-: The name and version of the program generating the output file. It will be
- added to the header of the output file. Default is "*osmium/*" and the version
- of osmium.
+-f, --output-format=FORMAT
+: The format of the output file. Can be used to set the output file format
+ if it can't be autodetected from the output file name.
+ **See osmium-file-formats**(5) or the libosmium manual for details.
---input-format, -F FORMAT
+-F, --input-format=FORMAT
: The format of the input files. Can be used to set the input format if it
can't be autodetected from the file names. This will set the format for
all input files, there is no way to set the format for some input files
only. See **osmium-file-formats**(5) or the libosmium manual for details.
---output, -o FILE
+--generator=NAME
+: The name and version of the program generating the output file. It will be
+ added to the header of the output file. Default is "*osmium/*" and the version
+ of osmium.
+
+-o, --output=FILE
: Name of the output file. Default is '-' (*stdout*).
---output-format, -f FORMAT
-: The format of the output file. Can be used to set the output file format
- if it can't be autodetected from the output file name.
- **See osmium-file-formats**(5) or the libosmium manual for details.
+-O, --overwrite
+: Allow an existing output file to be overwritten. Normally **osmium** will
+ refuse to write over an existing file.
--output-header OPTION
: Add output header option. This option can be given several times. See the
*libosmium manual* for a list of allowed header options.
---overwrite, -O
-: Allow an existing output file to be overwritten. Normally **osmium** will
- refuse to write over an existing file.
-
---object-type, -t TYPE
+-t, --object-type=TYPE
: Read only objects of given type (*node*, *way*, *relation*, *changeset*).
By default all types are read. This option can be given multiple times.
---verbose, -v
+-v, --verbose
: Set verbose mode. The program will output information about what it is
doing to *stderr*.
diff --git a/man/osmium-file-formats.md b/man/osmium-file-formats.md
index b799be1..1d49718 100644
--- a/man/osmium-file-formats.md
+++ b/man/osmium-file-formats.md
@@ -3,7 +3,7 @@
# NAME
-osmium-file-formats - OSM file formats known to Osmium.
+osmium-file-formats - OSM file formats known to Osmium
# FORMATS
diff --git a/man/osmium-fileinfo.md b/man/osmium-fileinfo.md
index 5ab3ab8..d758bd5 100644
--- a/man/osmium-fileinfo.md
+++ b/man/osmium-fileinfo.md
@@ -3,12 +3,12 @@
# NAME
-osmium-fileinfo - Show information about an OpenStreetMap file.
+osmium-fileinfo - show information about an OpenStreetMap file
# SYNOPSIS
-**osmium fileinfo** \[OPTIONS\] *FILE*
+**osmium fileinfo** \[*OPTIONS*\] *FILE*
# DESCRIPTION
@@ -46,10 +46,10 @@ Data
# OPTIONS
---extended, -e
+-e, --extended
: Read the complete file and show additional information.
---input-format, -f
+-f, --input-format=FORMAT
: The format of the input file. Can be used to set the input file format
if it can't be autodetected from the file name.
See **osmium-file-formats**(5) or the libosmium manual for details.
diff --git a/man/osmium-merge-changes.md b/man/osmium-merge-changes.md
index 4212f49..79bc24c 100644
--- a/man/osmium-merge-changes.md
+++ b/man/osmium-merge-changes.md
@@ -3,12 +3,12 @@
# NAME
-osmium-merge-changes - Merge several OSM change files into one.
+osmium-merge-changes - merge several OSM change files into one
# SYNOPSIS
-**osmium merge-changes** \[OPTIONS\] *CHANGE-FILE...*
+**osmium merge-changes** \[*OPTIONS*\] *CHANGE-FILE*...
# DESCRIPTION
@@ -22,33 +22,33 @@ in what order the change files are given or in what order they contain the data.
# OPTIONS
---generator NAME
-: The name and version of the program generating the output file. It will be
- added to the header of the output file. Default is "*osmium/*" and the version
- of osmium.
+-f, --output-format=FORMAT
+: The format of the output file. Can be used to set the output file format
+ if it can't be autodetected from the output file name.
+ See **osmium-file-formats**(5) or the libosmium manual for details.
---input-format, -F FORMAT
+-F, --input-format=FORMAT
: The format of the input files. Can be used to set the input format if it
can't be autodetected from the file names. This will set the format for
all input files, there is no way to set the format for some input files
only. See **osmium-file-formats**(5) or the libosmium manual for details.
---output, -o FILE
-: Name of the output file. Default is '-' (*stdout*).
+--generator=NAME
+: The name and version of the program generating the output file. It will be
+ added to the header of the output file. Default is "*osmium/*" and the version
+ of osmium.
---output-format, -f FORMAT
-: The format of the output file. Can be used to set the output file format
- if it can't be autodetected from the output file name.
- See **osmium-file-formats**(5) or the libosmium manual for details.
+-o, --output=FILE
+: Name of the output file. Default is '-' (*stdout*).
---overwrite, -O
+-O, --overwrite
: Allow an existing output file to be overwritten. Normally **osmium** will
refuse to write over an existing file.
---simplify, -s
+-s, --simplify
: Only write the last version of any object to the output.
---verbose, -v
+-v, --verbose
: Set verbose mode. The program will output information about what it is
doing to *stderr*.
diff --git a/man/osmium-time-filter.md b/man/osmium-time-filter.md
index a6e201c..1cb428b 100644
--- a/man/osmium-time-filter.md
+++ b/man/osmium-time-filter.md
@@ -3,13 +3,13 @@
# NAME
-osmium-time-filter - Filter OSM data by time from a history file.
+osmium-time-filter - filter OSM data by time from a history file
# SYNOPSIS
-**osmium time-filter** \[OPTIONS\] *INPUT-FILE* \[*TIME*\]\
-**osmium time-filter** \[OPTIONS\] *INPUT-FILE* *FROM-TIME* *TO-TIME*
+**osmium time-filter** \[*OPTIONS*\] *INPUT-FILE* \[*TIME*\]\
+**osmium time-filter** \[*OPTIONS*\] *INPUT-FILE* *FROM-TIME* *TO-TIME*
# DESCRIPTION
@@ -30,29 +30,29 @@ The format for the timestamps is "yyyy-mm-ddThh:mm::ssZ".
# OPTIONS
---generator
-: The name and version of the program generating the output file. It will be
- added to the header of the output file. Default is "*osmium/*" and the version
- of osmium.
+-f, --output-format=FORMAT
+: The format of the output file. Can be used to set the output file format
+ if it can't be autodetected from the output file name.
+ **See osmium-file-formats**(5) or the libosmium manual for details.
---input-format, -F
+-F, --input-format=FORMAT
: The format of the input file. Can be used to set the input file format
if it can't be autodetected from the file name.
**See osmium-file-formats**(5) or the libosmium manual for details.
---output-file, -o
-: Name of the output file. Default is '-' (*stdout*).
+--generator=NAME
+: The name and version of the program generating the output file. It will be
+ added to the header of the output file. Default is "*osmium/*" and the version
+ of osmium.
---output-format, -f
-: The format of the output file. Can be used to set the output file format
- if it can't be autodetected from the output file name.
- **See osmium-file-formats**(5) or the libosmium manual for details.
+-o, --output-file=FILE
+: Name of the output file. Default is '-' (*stdout*).
---overwrite, -O
+-O, --overwrite
: Allow an existing output file to be overwritten. Normally **osmium** will
refuse to write over an existing file.
---verbose, -v
+-v, --verbose
: Set verbose mode. The program will output information about what it is
doing to *stderr*.
diff --git a/man/osmium.md b/man/osmium.md
index a38fd79..c3371fc 100644
--- a/man/osmium.md
+++ b/man/osmium.md
@@ -2,12 +2,12 @@
% Jochen Topf <jochen at topf.org>
# NAME
-osmium - Multipurpose tool for working with OpenStreetMap data.
+osmium - multipurpose tool for working with OpenStreetMap data
# SYNOPSIS
-**osmium** *COMMAND* \[ARGS\]\
+**osmium** *COMMAND* \[*ARGS*\]\
**osmium** --help\
**osmium** --version
@@ -21,7 +21,7 @@ Run **osmium help** *COMMAND* to get more information about a command.
# OPTIONS
---help, -h
+-h, --help
: Show usage and list of commands.
--version
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/osmium-tool.git
More information about the Pkg-grass-devel
mailing list