Skip to content

Commit 058cd33

Browse files
authored
Merge pull request #1341 from joto/update-manpage-pgsql-options
Update pgsql output options in manpage
2 parents 35d07e0 + 939857e commit 058cd33

2 files changed

Lines changed: 55 additions & 52 deletions

File tree

docs/osm2pgsql.1

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,8 @@ Example: \f[B]\-\-bbox\f[] \f[B]\-0.5,51.25,0.5,51.75\f[]
136136
.SH MIDDLE OPTIONS
137137
.TP
138138
.B \-i, \-\-tablespace\-index=TABLESPC
139-
Store all indexes in a separate PostgreSQL tablespace named by this
140-
parameter.
141-
This allows one to e.g.\ store the indexes on faster storage like SSDs.
139+
Store all indexes in the PostgreSQL tablespace \f[C]TABLESPC\f[].
140+
This option also affects the tables created by the pgsql output.
142141
.RS
143142
.RE
144143
.TP
@@ -294,30 +293,29 @@ no default.)
294293
.RE
295294
.SH PGSQL OUTPUT OPTIONS
296295
.TP
297-
.B \-i, \-\-tablespace\-index=TABLESPACENAME
298-
Store all indexes in a separate PostgreSQL tablespace named by this
299-
parameter.
300-
This allows one to e.g.\ store the indexes on faster storage like SSDs.
296+
.B \-i, \-\-tablespace\-index=TABLESPC
297+
Store all indexes in the PostgreSQL tablespace \f[C]TABLESPC\f[].
298+
This option also affects the middle tables.
301299
.RS
302300
.RE
303301
.TP
304-
.B \-\-tablespace\-main\-data=TABLESPACENAME
305-
Store the data tables (non slim) in the given tablespace.
302+
.B \-\-tablespace\-main\-data=TABLESPC
303+
Store the data tables in the PostgreSQL tablespace \f[C]TABLESPC\f[].
306304
.RS
307305
.RE
308306
.TP
309-
.B \-\-tablespace\-main\-index=TABLESPACENAME
310-
Store the indexes of the main tables (non slim) in the given tablespace.
307+
.B \-\-tablespace\-main\-index=TABLESPC
308+
Store the indexes in the PostgreSQL tablespace \f[C]TABLESPC\f[].
311309
.RS
312310
.RE
313311
.TP
314312
.B \-\-latlong
315-
Store data in degrees of latitude & longitude.
313+
Store coordinates in degrees of latitude & longitude.
316314
.RS
317315
.RE
318316
.TP
319317
.B \-m, \-\-merc
320-
Store data in Spherical Mercator (Web Mercator, EPSG:3857) (the
318+
Store coordinates in Spherical Mercator (Web Mercator, EPSG:3857) (the
321319
default).
322320
.RS
323321
.RE
@@ -334,37 +332,37 @@ This option affects the middle as well as the pgsql output table names.
334332
.RE
335333
.TP
336334
.B \-\-tag\-transform\-script=SCRIPT
337-
Specify a lua script to handle tag filtering and normalisation.
335+
Specify a Lua script to handle tag filtering and normalisation.
338336
The script contains callback functions for nodes, ways and relations,
339337
which each take a set of tags and returns a transformed, filtered set of
340338
tags which are then written to the database.
341339
.RS
342340
.RE
343341
.TP
344342
.B \-x, \-\-extra\-attributes
345-
Include attributes for each object in the database.
346-
This includes the username, userid, timestamp and version.
347-
Note: this option also requires additional entries in your style file.
343+
Include attributes (user name, user id, changeset id, timestamp and
344+
version).
345+
This also requires additional entries in your style file.
348346
.RS
349347
.RE
350348
.TP
351349
.B \-k, \-\-hstore
352-
Add tags without column to an additional hstore (key/value) column to
353-
database tables.
350+
Add tags without column to an additional hstore (key/value) column in
351+
the database tables.
354352
.RS
355353
.RE
356354
.TP
357355
.B \-j, \-\-hstore\-all
358-
Add all tags to an additional hstore (key/value) column in database
356+
Add all tags to an additional hstore (key/value) column in the database
359357
tables.
360358
.RS
361359
.RE
362360
.TP
363-
.B \-z, \-\-hstore\-column=KEY_PREFIX
364-
Add an additional hstore (key/value) column containing all tags that
365-
start with the specified string, eg \-\-hstore\-column \[lq]name:\[rq]
366-
will produce an extra hstore column that contains all \f[C]name:xx\f[]
367-
tags.
361+
.B \-z, \-\-hstore\-column=PREFIX
362+
Add an additional hstore (key/value) column named \f[C]PREFIX\f[]
363+
containing all tags that have a key starting with \f[C]PREFIX\f[], eg
364+
\f[C]\\\-\-hstore\-column\ "name:"\f[] will produce an extra hstore
365+
column that contains all \f[C]name:xx\f[] tags.
368366
.RS
369367
.RE
370368
.TP
@@ -382,7 +380,7 @@ Create indexes for all hstore columns after import.
382380
.B \-G, \-\-multi\-geometry
383381
Normally osm2pgsql splits multi\-part geometries into separate database
384382
rows per part.
385-
A single OSM id can therefore have several rows.
383+
A single OSM object can therefore use several rows in the output tables.
386384
With this option, osm2pgsql instead generates multi\-geometry features
387385
in the PostgreSQL tables.
388386
.RS
@@ -397,7 +395,8 @@ based on the assumption that Shapefiles generated by OSMCoastline
397395
.RE
398396
.TP
399397
.B \-\-reproject\-area
400-
Compute area column using spherical mercator coordinates.
398+
Compute area column using spherical mercator coordinates even if a
399+
different projection is used for the geometries.
401400
.RS
402401
.RE
403402
.TP

docs/osm2pgsql.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ mandatory for short options too.
104104
# MIDDLE OPTIONS
105105

106106
-i, \--tablespace-index=TABLESPC
107-
: Store all indexes in a separate PostgreSQL tablespace named by this parameter.
108-
This allows one to e.g. store the indexes on faster storage like SSDs.
107+
: Store all indexes in the PostgreSQL tablespace `TABLESPC`. This option
108+
also affects the tables created by the pgsql output.
109109

110110
\--tablespace-slim-data=TABLESPC
111111
: Store the slim mode tables in the given tablespace.
@@ -201,21 +201,22 @@ mandatory for short options too.
201201

202202
# PGSQL OUTPUT OPTIONS
203203

204-
-i, \--tablespace-index=TABLESPACENAME
205-
: Store all indexes in a separate PostgreSQL tablespace named by this parameter.
206-
This allows one to e.g. store the indexes on faster storage like SSDs.
204+
-i, \--tablespace-index=TABLESPC
205+
: Store all indexes in the PostgreSQL tablespace `TABLESPC`. This option
206+
also affects the middle tables.
207207

208-
\--tablespace-main-data=TABLESPACENAME
209-
: Store the data tables (non slim) in the given tablespace.
208+
\--tablespace-main-data=TABLESPC
209+
: Store the data tables in the PostgreSQL tablespace `TABLESPC`.
210210

211-
\--tablespace-main-index=TABLESPACENAME
212-
: Store the indexes of the main tables (non slim) in the given tablespace.
211+
\--tablespace-main-index=TABLESPC
212+
: Store the indexes in the PostgreSQL tablespace `TABLESPC`.
213213

214214
\--latlong
215-
: Store data in degrees of latitude & longitude.
215+
: Store coordinates in degrees of latitude & longitude.
216216

217217
-m, \--merc
218-
: Store data in Spherical Mercator (Web Mercator, EPSG:3857) (the default).
218+
: Store coordinates in Spherical Mercator (Web Mercator, EPSG:3857)
219+
(the default).
219220

220221
-E, \--proj=SRID
221222
: Use projection EPSG:SRID.
@@ -225,26 +226,27 @@ mandatory for short options too.
225226
middle as well as the pgsql output table names.
226227

227228
\--tag-transform-script=SCRIPT
228-
: Specify a lua script to handle tag filtering and normalisation. The script
229+
: Specify a Lua script to handle tag filtering and normalisation. The script
229230
contains callback functions for nodes, ways and relations, which each take
230231
a set of tags and returns a transformed, filtered set of tags which are
231232
then written to the database.
232233

233234
-x, \--extra-attributes
234-
: Include attributes for each object in the database.
235-
This includes the username, userid, timestamp and version.
236-
Note: this option also requires additional entries in your style file.
235+
: Include attributes (user name, user id, changeset id, timestamp and version).
236+
This also requires additional entries in your style file.
237237

238238
-k, \--hstore
239-
: Add tags without column to an additional hstore (key/value) column to database tables.
239+
: Add tags without column to an additional hstore (key/value) column in
240+
the database tables.
240241

241242
-j, \--hstore-all
242-
: Add all tags to an additional hstore (key/value) column in database tables.
243+
: Add all tags to an additional hstore (key/value) column in the database
244+
tables.
243245

244-
-z, \--hstore-column=KEY_PREFIX
245-
: Add an additional hstore (key/value) column containing all tags
246-
that start with the specified string, eg \--hstore-column "name:" will
247-
produce an extra hstore column that contains all `name:xx` tags.
246+
-z, \--hstore-column=PREFIX
247+
: Add an additional hstore (key/value) column named `PREFIX` containing all
248+
tags that have a key starting with `PREFIX`, eg `\--hstore-column "name:"`
249+
will produce an extra hstore column that contains all `name:xx` tags.
248250

249251
\--hstore-match-only
250252
: Only keep objects that have a value in at least one of the non-hstore
@@ -254,9 +256,10 @@ mandatory for short options too.
254256
: Create indexes for all hstore columns after import.
255257

256258
-G, \--multi-geometry
257-
: Normally osm2pgsql splits multi-part geometries into separate database rows per part.
258-
A single OSM id can therefore have several rows. With this option, osm2pgsql instead
259-
generates multi-geometry features in the PostgreSQL tables.
259+
: Normally osm2pgsql splits multi-part geometries into separate database rows
260+
per part. A single OSM object can therefore use several rows in the output
261+
tables. With this option, osm2pgsql instead generates multi-geometry
262+
features in the PostgreSQL tables.
260263

261264
-K, \--keep-coastlines
262265
: Keep coastline data rather than filtering it out. By default objects
@@ -265,7 +268,8 @@ mandatory for short options too.
265268
will be used for the coastline data.
266269

267270
\--reproject-area
268-
: Compute area column using spherical mercator coordinates.
271+
: Compute area column using spherical mercator coordinates even if a
272+
different projection is used for the geometries.
269273

270274
\--output-pgsql-schema=SCHEMA
271275
: Use PostgreSQL schema SCHEMA for all tables, indexes, and functions in

0 commit comments

Comments
 (0)