summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorkazer_ <kazer_@ffa7fe5e-494d-0410-b361-a75ebd5db220>2008-08-21 10:01:47 +0000
committerkazer_ <kazer_@ffa7fe5e-494d-0410-b361-a75ebd5db220>2008-08-21 10:01:47 +0000
commitdc0fe01a51eae38ddf83952255924ae904199d65 (patch)
treed08b4448b7af40a30de513cd2e3e3e118158738e /man
parent085ba39c5b26779a144157425f922af315441c51 (diff)
downloadnavit-dc0fe01a51eae38ddf83952255924ae904199d65.tar.gz
Add:Manpages:Initial manpages for navit and osm2navit. Warning : need to update the Makefile so that they are actually installed
git-svn-id: http://svn.code.sf.net/p/navit/code/trunk/navit@1283 ffa7fe5e-494d-0410-b361-a75ebd5db220
Diffstat (limited to 'man')
-rw-r--r--man/navit.149
-rw-r--r--man/osm2navit.156
2 files changed, 105 insertions, 0 deletions
diff --git a/man/navit.1 b/man/navit.1
new file mode 100644
index 000000000..fe94a11f4
--- /dev/null
+++ b/man/navit.1
@@ -0,0 +1,49 @@
+.TH osm2navit 1 "August, 21 2008" "version 0.4+svn" "USER COMMANDS"
+.SH NAME
+navit \- The modular touchscreen-friendly vector based navigation software.
+.SH SYNOPSIS
+.B navit
+[\-h] [\-v] [\-c config file]
+.SH DESCRIPTION
+Navit is a open source (GPL) car navigation system with routing engine.
+
+It's modular design is capable of using vector maps of various formats
+for routing and rendering of the displayed map. It's even possible to
+use multiple maps at a time.
+
+The GTK+ or SDL user interfaces are designed to work well with touch
+screen displays. Points of Interest of various formats are displayed
+on the map.
+
+The current vehicle position is either read from gpsd or directly from
+NMEA GPS sensors.
+
+The routing engine not only calculates an optimal route to your
+destination, but also generates directions and even speaks to you.
+
+Navit is translated is 16 languages currently.
+
+For more informations, please refer to our wiki :
+ http://wiki.navit-project.org
+
+You can also try our mailing lists :
+ http://sourceforge.net/mailarchive/forum.php?forum_name=navit-users
+
+Or visit us on IRC : #navit on the freenode network
+.SH OPTIONS
+.TP
+\-h
+display a short help text and exit
+.TP
+\-v
+display the version number and exit
+.TP
+\-c
+specify the config file (navit.xml) to use
+.SH BUGS
+Should you find one, please report it :
+ http://trac.navit-project.org
+.SH AUTHOR
+The navit Team - http://www.navit-project.org
+.SH SEE ALSO
+osm2navit(1) \ No newline at end of file
diff --git a/man/osm2navit.1 b/man/osm2navit.1
new file mode 100644
index 000000000..d48069b14
--- /dev/null
+++ b/man/osm2navit.1
@@ -0,0 +1,56 @@
+.TH navit 1 "August, 21 2008" "version 0.4+svn" "USER COMMANDS"
+.SH NAME
+osm2navit \- parse osm textfile and converts to NavIt binfile format
+.SH SYNOPSIS
+.B bzcat planet.osm.bz2 | osm2navit mymap.bin
+[\-h] [\-N] [\-W] [\-a value] [\-c] [\-d connect string] [\-e phase]
+[\-k] [\-o] [\-s phase] [\-i input file] [\-w] [\-z level]
+.SH DESCRIPTION
+osm2navit parses osm textfile and converts to NavIt binfile format
+.SH OPTIONS
+.TP
+\-h (--help)
+display a short help message
+.TP
+\-N (--nodes-only)
+process only nodes
+.TP
+\-W (--ways-only)
+process only ways
+.TP
+\-a (--attr-debug-level)
+control which data is included in the debug attribute
+.TP
+\-c (--dump-coordinates)
+dump coordinates after phase 1
+.TP
+\-d (--db) <connect string>
+get osm data out of a postgresql database with osm simple scheme and given connect string
+.TP
+\-e (--end) <phase>
+end at specified phase
+.TP
+\-k (--keep-tmpfiles)
+do not delete tmp files after processing. useful to reuse them
+.TP
+\-o (--coverage)
+map every street to item overage
+.TP
+\-s (--start) <phase>
+start at specified phase
+.TP
+\-i (--input-file) <file>
+specify the input file name (OSM), overrules default stdin
+.TP
+\-w (--dedupe-ways)
+ensure no duplicate ways or nodes. useful when using several input files
+.TP
+\-z (--compression-level) <level>
+set the compression level
+.SH BUGS
+Should you find one, please report it :
+ http://trac.navit-project.org
+.SH AUTHOR
+The navit Team - http://www.navit-project.org
+.SH SEE ALSO
+navit(1) \ No newline at end of file