Skip to content

v0.2.52..v0.2.53 changeset validate.asciidoc

Garret Voltz edited this page Feb 12, 2020 · 1 revision
diff --git a/docs/commands/validate.asciidoc b/docs/commands/validate.asciidoc
new file mode 100644
index 0000000..1c36ec4
--- /dev/null
+++ b/docs/commands/validate.asciidoc
@@ -0,0 +1,43 @@
+[[validate]]
+== validate
+
+=== Description
+
+The +validate+ command uses JOSM to identify (but does not fix) data with common erroneous aspects. This command is only available when
+Hootenanny is configured with JOSM (compiled --with-josm).
+
+* +input+                  - Input; may be any supported input format (e.g. .osm file).
+* +output+                 - (optional) Output file; may be any supported output format (e.g. .osm file). If specified, elements with 
+                             validation will be marked with tags in the output file. If not specified, then only a validation error summary 
+                             will be displayed.
+* +--available-validators+ - Displays available JOSM validators for use in validation. Not all validators have cleaning (auto-fix) capabilities. 
+                             If this option is selected, neither an input or output must be specified.
+
+=== Usage
+
+--------------------------------------
+validate (input) [output]
+
+validate [--available-validators]
+--------------------------------------
+
+==== Examples
+
+--------------------------------------
+# run default validation
+hoot validate input.osm
+
+# run default validation and mark features with validation failure tags
+hoot validate input.osm output.osm
+
+# list the available validators
+hoot validate --available-validators
+
+# run customized validation
+hoot validate -D josm.validators.include="DuplicatedWayNodes" input.osm
+--------------------------------------
+
+==== See Also
+
+* josm.* configuration options
+* https://github.com/ngageoint/hootenanny/blob/master/docs/user/SupportedDataFormats.asciidoc#applying-changes-1[Supported Input Formats]
Clone this wiki locally