[osrm] 01/01: Man page improvements

[Christopher Baines]

This is an automated email from the git hooks/post-receive script.

cbaines-guest pushed a commit to branch master
in repository osrm.

commit 4c0c3a2de64dbbd90fbd0b9c9ddbca7412d1b6b5
Author: Christopher Baines <mail at cbaines.net>
Date:   Sun May 10 09:31:18 2015 +0100

    Man page improvements
    
    Lots of spelling fixes, also bring the osrm.7 man page in line with the
    upstream version on the GitHub wiki.
---
 debian/README.source      |  9 +++++++++
 debian/man/osrm-prepare.1 |  2 +-
 debian/man/osrm-routed.1  |  5 ++---
 debian/man/osrm.7         | 13 ++++++++-----
 4 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/debian/README.source b/debian/README.source
new file mode 100644
index 0000000..0b81270
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,9 @@
+osrm for Debian
+---------------
+
+Note that while the manpages were originally written for this package, they have
+also been put on a GitHub wiki:
+ - https://github.com/Project-OSRM/osrm-backend/wiki/osrm.7
+ - https://github.com/Project-OSRM/osrm-backend/wiki/osrm-extract.1
+ - https://github.com/Project-OSRM/osrm-backend/wiki/osrm-prepare.1
+ - https://github.com/Project-OSRM/osrm-backend/wiki/osrm-routed.1
diff --git a/debian/man/osrm-prepare.1 b/debian/man/osrm-prepare.1
index 4afd368..b257fdb 100644
--- a/debian/man/osrm-prepare.1
+++ b/debian/man/osrm-prepare.1
@@ -4,7 +4,7 @@ osrm-prepare \- generate the hierarchy from OSRM data
 .SH SYNOPSIS
 .B osrm-prepare
 .I file.osrm
-.I file.osrm.resctictions
+.I file.osrm.restrictions
 .I profile.lua
 .SH DESCRIPTION
 The \fBosrm-prepare\fP tool takes the data generated by \fBosrm-extract\fP and creates, .osrm.hsgr, .osrm.nodes, .osrm.ramIndex, .osrm.fileIndex . After these have been generated, the osrm service can be started, or the \fBosrm-routed\fP command can be run.
diff --git a/debian/man/osrm-routed.1 b/debian/man/osrm-routed.1
index 13ee086..d642297 100644
--- a/debian/man/osrm-routed.1
+++ b/debian/man/osrm-routed.1
@@ -1,4 +1,3 @@
-.\" (C) Copyright 2013 Christopher Baines <chris at chris-desktop.home>,
 .TH OSRM-ROUTED 1 "July  4, 2013" osrm-routed "Open Source Routing Machine"
 .SH NAME
 osrm-routed \- the OSRM routing service
@@ -6,9 +5,9 @@ osrm-routed \- the OSRM routing service
 .B osrm
 .I server.ini
 .SH DESCRIPTION
-The Open Source Routing Machine (OSRM) is a high performance routing enigine for finding shortest paths in road networks.
+The Open Source Routing Machine (OSRM) is a high performance routing engine for finding shortest paths in road networks.
 .PP
-\fBosrm-routed\fP starts the router, it uses then config file given, defaulting to server.ini in the current directory. Note that on Debian, this command is executed by the init file, so for a standard setup, it should not be nessacery to run it directly.
+\fBosrm-routed\fP starts the router, it uses then config file given, defaulting to server.ini in the current directory. Note that on Debian, this command is executed by the init file, so for a standard setup, it should not be necessary to run it directly.
 .SH CONFIGURATION FILE
 Uses a key = value syntax. The table below gives the keys that can be used.
 
diff --git a/debian/man/osrm.7 b/debian/man/osrm.7
index c59da78..dbc3b39 100644
--- a/debian/man/osrm.7
+++ b/debian/man/osrm.7
@@ -1,4 +1,4 @@
-.TH OSRM 7 "July  4, 2013" osrm "Open Source Routing Machine"
+.TH OSRM 7 "May 10, 2015" osrm "Open Source Routing Machine"
 .SH NAME
 osrm \- high performance routing engine
 .SH SYNOPSIS
@@ -8,7 +8,7 @@ osrm \- high performance routing engine
 .br
 .B osrm-prepare
 .I file.osrm
-.I file.osrm.resctictions
+.I file.osrm.restrictions
 .I profile.lua
 .br
 .B osrm-routed
@@ -36,7 +36,7 @@ For this example, the profile /etc/osrm/profiles/car.lua will be used, but this
 
 Once finished, you should have the files planet-latest.osrm, planet-latest.osrm.names, planet-latest.osrm.restrictions present. You will also have some stxxl related files, but these are not directly related to osrm.
 
-To proceed, use osrm-prepare to generate the higherarchi:
+To proceed, use osrm-prepare to generate the hierarchy:
 
       osrm-prepare planet-latest.osrm planet-latest.osrm.restrictions /etc/osrm/profiles/car.lua
 
@@ -44,7 +44,7 @@ In the working directory, you should now have in addition to the above files pla
 
       service osrm restart
 
-If the service starts successfully, you should be able to use the API, if not, check the log file at /var/log.osrm/routed.log, and if nessacery, report a bug against the osrm package.
+If the service starts successfully, you should be able to use the API, if not, check the log file at /var/log.osrm/routed.log, and if necessary, report a bug against the osrm package.
 .SH SERVER API
 The service api is similar to query strings for HTTP. Three types of query are possible:
 .TS
@@ -54,11 +54,14 @@ locate at T{
 Takes latitude and longitude and returns the nearest node in the data to that point.
 T}
 nearest at T{
-Takes lattitude and longitude and returns the nearest point on a street segment to that point.
+Takes latitude and longitude and returns the nearest point on a street segment to that point.
 T}
 viaroute at T{
 Takes multiple latitude, longitude points, and returns a route from the first, through to the last.
 T}
+table at T{
+Takes multiple latitude, longitude points, and returns a distance matrix for each point.
+T}
 .TE
 .SH SEE ALSO
 .BR osrm-extract (1),

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/osrm.git