Skip to content

v0.2.47..v0.2.48 changeset crop.asciidoc

Garret Voltz edited this page Sep 27, 2019 · 1 revision
diff --git a/docs/commands/crop.asciidoc b/docs/commands/crop.asciidoc
index 9d1a35a..246dcb6 100644
--- a/docs/commands/crop.asciidoc
+++ b/docs/commands/crop.asciidoc
@@ -3,17 +3,21 @@
 
 === Description
 
-The +crop+ command crops a map to the given bounds. Individual features on the border are modified to make sure nothing 
-is outside the given bounds.
+The +crop+ command crops a map to the given bounds. 
 
-* +input+  - The input OSM data path.
-* +output+ - The output OSM data path.
-* +bounds+ - Comma delimited bounds. minx,miny,maxx,maxy e.g.38,-105,39,-104
+The default cropping behavior is that individual features on the border are modified to make sure nothing is outside the given bounds. This
+behavior may be customized with the `crop.*` configuration options.
+
+* +input+          - The input data path
+* +output+         - The output data path
+* +bounds+         - Comma delimited bounds. minx,miny,maxx,maxy e.g.38,-105,39,-104
+* +--write-bounds+ - Optionally outputs a file containing the input bounds. The location of the file is controlled via the 
+                     `bounds.output.file` configuration option.
 
 === Usage
 
 --------------------------------------
-crop (input.osm) (output.osm) (bounds)
+crop (input.osm) (output.osm) (bounds) [--write-bounds]
 --------------------------------------
 
 === Configuration Options
@@ -24,14 +28,14 @@ The configuration options `crop.*` control the behavior of map cropping. See the
 
 --------------------------------------
 # regular crop
-hoot crop data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031" 
+hoot crop data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031"
 
 # don't split feature that cross the bounds
-hoot crop -D crop.keep.entire.features.crossing.bounds=true data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031" 
+hoot crop -D crop.keep.entire.features.crossing.bounds=true data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031"
 
 # only keep features completely within the bounds
-hoot crop -D crop.keep.only.features.inside.bounds=true data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031" 
+hoot crop -D crop.keep.only.features.inside.bounds=true data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031"
 
 # reverse the crop; keep only features outside of the bounds
-hoot crop -D crop.invert=true data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031" 
+hoot crop -D crop.invert=true data/dc-roads/dcgis-cropped.osm "-77.0551,38.8845,-77.0281,38.9031"
 --------------------------------------
Clone this wiki locally