Skip to content

Commit e46577d

Browse files
committed
Improve introduction section in manpage
1 parent dd47ab6 commit e46577d

2 files changed

Lines changed: 37 additions & 20 deletions

File tree

docs/osm2pgsql.1

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,25 @@ database.
1212
It is an essential part of many rendering toolchains, the Nominatim
1313
geocoder and other applications processing OSM data.
1414
.PP
15-
OSM planet snapshots can be downloaded from
16-
https://planet.openstreetmap.org/.
17-
Data extracts for various countries or other areas are also available,
18-
see https://wiki.openstreetmap.org/wiki/Planet.osm.
15+
\f[B]osm2pgsql\f[] can run in either \[lq]create\[rq] mode (the default)
16+
or in \[lq]append\[rq] mode (option \f[B]\-a, \-\-append\f[]).
17+
In \[lq]create\[rq] mode osm2pgsql will create the database tables
18+
required by the configuration and import the OSM file(s) specified on
19+
the command line into those tables.
20+
Note that you also have to use the \f[B]\-s, \-\-slim\f[] option if you
21+
want your database to be updateable.
1922
.PP
20-
When operating in \[lq]slim\[rq] mode (and on a database created in
21-
\[lq]slim\[rq] mode!), \f[B]osm2pgsql\f[] can also process OSM change
22-
files (osc files), thereby bringing an existing database up to date.
23+
In \[lq]append\[rq] mode osm2pgsql will update the database tables with
24+
the data from OSM change files specified on the command line.
2325
.PP
24-
See the manual (https://osm2pgsql.org/doc/manual.html) for more
25-
information.
26+
This man page can only cover some of the basics and describe the command
27+
line options.
28+
See the Osm2pgsql Manual (https://osm2pgsql.org/doc/manual.html) for
29+
more information.
2630
.SH OPTIONS
2731
.PP
2832
This program follows the usual GNU command line syntax, with long
2933
options starting with two dashes (\f[C]\-\-\f[]).
30-
.PP
3134
Mandatory arguments to long options are mandatory for short options too.
3235
.SH MAIN OPTIONS
3336
.TP
@@ -63,6 +66,13 @@ Set log level (`debug', `info' (default), `warn', or `error').
6366
.RS
6467
.RE
6568
.TP
69+
.B \-\-log\-progress=VALUE
70+
Enable (\f[C]true\f[]) or disable (\f[C]false\f[]) progress logging.
71+
The default is \f[C]auto\f[] which will enable progress logging on the
72+
console and disable it if the output is redirected to a file.
73+
.RS
74+
.RE
75+
.TP
6676
.B \-\-log\-sql
6777
Enable logging of SQL commands for debugging.
6878
.RS
@@ -73,6 +83,11 @@ Enable logging of all data added to the database.
7383
This will write out a huge amount of data! For debugging.
7484
.RS
7585
.RE
86+
.TP
87+
.B \-v, \-\-verbose
88+
Same as \f[C]\-\-log\-level=debug\f[].
89+
.RS
90+
.RE
7691
.SH DATABASE OPTIONS
7792
.TP
7893
.B \-d, \-\-database=NAME

docs/osm2pgsql.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,24 @@ osm2pgsql - Openstreetmap data to PostgreSQL converter
1212
is an essential part of many rendering toolchains, the Nominatim geocoder and
1313
other applications processing OSM data.
1414

15-
OSM planet snapshots can be downloaded from https://planet.openstreetmap.org/.
16-
Data extracts for various countries or other areas are also available, see
17-
https://wiki.openstreetmap.org/wiki/Planet.osm.
15+
**osm2pgsql** can run in either "create" mode (the default) or in "append" mode
16+
(option **-a, \--append**). In "create" mode osm2pgsql will create the database
17+
tables required by the configuration and import the OSM file(s) specified on
18+
the command line into those tables. Note that you also have to use the
19+
**-s, \--slim** option if you want your database to be updateable.
1820

19-
When operating in "slim" mode (and on a database created in "slim" mode!),
20-
**osm2pgsql** can also process OSM change files (osc files), thereby bringing
21-
an existing database up to date.
21+
In "append" mode osm2pgsql will update the database tables with the data from
22+
OSM change files specified on the command line.
2223

23-
See the [manual](https://osm2pgsql.org/doc/manual.html) for more information.
24+
This man page can only cover some of the basics and describe the command line
25+
options. See the [Osm2pgsql Manual](https://osm2pgsql.org/doc/manual.html) for
26+
more information.
2427

2528
# OPTIONS
2629

2730
This program follows the usual GNU command line syntax, with long options
28-
starting with two dashes (`--`).
29-
30-
Mandatory arguments to long options are mandatory for short options too.
31+
starting with two dashes (`--`). Mandatory arguments to long options are
32+
mandatory for short options too.
3133

3234
# MAIN OPTIONS
3335

0 commit comments

Comments
 (0)