Update neo4j-admin database check syntax and options to reflect the code (#687)

Cherry-picked from #682

Author: renetapopova

modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc

@@ -4,114 +4,122 @@
 
 You can use the `neo4j-admin database check` command to check the consistency of a database, a dump, or a backup.
 The `neo4j-admin` tool is located in the _/bin_ directory.
-If checking the consistency of a database, note that it has to be stopped first or else the consistency check will result in an error.
-
-[NOTE]
-====
-It is not recommended to use an NFS to check the consistency of a database, a dump, or a backup as this slows the process down significantly.
-====
 
 == Syntax
 
 The `neo4j-admin database check` command has the following syntax:
 
+[source,role=noheader]
 ----
-neo4j-admin database check [-h]
-                           [--expand-commands] 
-                           [--force]
-                           [--verbose]
-                           [--check-counts[=true|false]]
-                           [--check-graph[=true|false]]
-                           [--check-indexes[=true|false]]
-                           [--check-property-owners[=true|false]]
-                           [--additional-config=<file>]
-                           [--max-off-heap-memory=<size>]
-                           [--report-path=<path>]
-                           [--threads=<number of threads>]
-                           [[--from-path-data=<path> --from-path-txn=<path>] | [--from-path=<path> [--temp-path=<path>]]] 
+neo4j-admin database check [-h] [--expand-commands] [--force] [--verbose]
+                           [--check-counts[=true|false]] [--check-graph[=true|false]]
+                           [--check-indexes[=true|false]] [--check-property-owners[=true|false]]
+                           [--additional-config=<file>] [--max-off-heap-memory=<size>]
+                           [--report-path=<path>][--threads=<number of threads>]
+                           [[--from-path-data=<path> --from-path-txn=<path>] | [--from-path=<path> [--temp-path=<path>]]]
                            <database>
 ----
 
-`<database>` -- Name of the database to check.
+=== Description
 
-== Options
+This command allows for checking the consistency of a database, a dump, or a backup.
+It cannot be used with a database that is currently in use.
 
-The `neo4j-admin database check` command has the following options:
+Some checks can be quite expensive, so it may be useful to turn some of them off for very large databases.
+Increasing the heap size might be a good idea.
+
+[NOTE]
+====
+It is not recommended to use an NFS to check the consistency of a database, a dump, or a backup as this slows the process down significantly.
+====
 
-[options="header",cols="1m,2a,3a"]
+=== Parameters
+
+.`neo4j-admin database check` parameters
+[options="header", cols="1m,3a"]
 |===
-| Option                    
-| Possible values     
+| Parameter
 | Description
 
-| -h, --help
-|
-| Show this help message and exit.
+|<database>
+|Name of the database to check.
+|===
 
-| --expand-commands
-|
-| Allow command expansion in config value evaluation.
+=== Options
 
-| --force            
-| `true` or `false` (Default: `false`)
-| Force a consistency check to be run, despite resources, and may run a more thorough check.
+The `neo4j-admin database check` command has the following options:
+
+.`neo4j-admin database check` options
+[options="header", cols="5m,6a,4m"]
+|===
+| Option
+| Description
+| Default
 
 | --verbose
-| `true` or `false` (Default: `false`)
 | Enable verbose output.
+|
+
+|-h, --help
+|Show this help message and exit.
+|
 
-| --check-graph
-| `true` or `false` (Default: `true`)
-| Perform checks between nodes, relationships, properties, types, and tokens.
+|--expand-commands
+|Allow command expansion in config value evaluation.
+|
 
-| --check-counts 
-| `true` or `false`
-| Perform consistency checks on the counts. Requires the `check-graph` option to be `true` (which is by default) and will implicitly enable `<check-graph>` if it is not explicitly disabled. Default: `<check-graph>`.
+|--additional-config=<file>
+| Configuration file with additional configuration.
+|
 
-| --check-indexes
-| `true` or `false` (Default: `true`)
-| Perform checks on indexes.
+|--force
+| `Force a consistency check to be run, despite resources, and may run a more thorough check.
+|
 
-| --check-property-owners
-| `true` or `false` (Default: `false`)
-| Perform consistency checks on the ownership of properties. Requires the `check-graph` option to be `true` (which is by default) and will implicitly enable `<check-graph>` if it is not explicitly disabled.
+|--check-indexes[=true\|false]
+|Perform consistency checks on indexes.
+|true
 
-| --additional-config
-| `<file>`
-| Path to a configuration file that contains additional configuration options.
+|--check-graph[=true\|false]
+|Perform consistency checks between nodes, relationships, properties, types, and tokens.
+|true
 
-| --max-off-heap-memory
-| `<size>` (Default: `90%`)
-| Maximum memory that `neo4j-admin`` can use for page cache and various caching data structures to improve performance.
-Value can be plain numbers, like `10000000` or e.g. `20G` for 20 gigabytes, or even e.g. `70%`, which will amount to 70% of currently free memory on the machine.
+|--check-counts[=true\|false]
+| Perform consistency checks on the counts. Requires <check-graph>, and may implicitly enable <check-graph> if it were not explicitly disabled.
+|<check-graph>
 
-| --report-path
-| `<path>` (Default: `.`)
-| Path to where a consistency report will be written. Interpreted as a directory, unless it has an extension of _.report_.
+| --check-property-owners[=true\|false]
+| Perform consistency checks on the ownership of properties. Requires <check-graph>, and may implicitly enable <check-graph> if it were not explicitly disabled.
+|false
 
-| --threads
-| `<number of threads>` (Default: the number of CPUs on the machine)
-| Number of threads used to check the consistency.
+| --report-path=<path>
+| Path to where a consistency report will be written. Interpreted as a directory, unless it has an extension of `.report`.
+| .
 
-| --from-path-data 
-| `<path>` (Default:  xref:reference/configuration-settings.adoc#config_server.directories.data, [`server.directories.data`]/databases)
-| Path to the databases directory, containing the database directory to source from.
+|--max-off-heap-memory=<size>
+| Maximum memory that `neo4j-admin` can use for page cache and various caching data structures to improve performance.
+Value can be plain numbers, like `10000000` or e.g. `20G` for 20 gigabytes, or even e.g. `70%`, which will amount to 70% of currently free memory on the machine.
+|90%
 
-| --from-path-txn 
-| `<path>` (Default: xref:reference/configuration-settings.adoc#config_server.directories.transaction.logs.root[`server.directories.transaction.logs.root`])
-| Path to the transactions_ directory, containing the transaction directory for the database to source from.
+|--threads=<number of threads>
+|Number of threads used to check the consistency.
+|The number of CPUs on the machine.
 
-| --from-path
-| `<path>`
-| Path to the directory containing dump/backup artifacts whose consistency will be checked.
+|--from-path-data=<path>
+|Path to the databases directory, containing the database directory to source from.
+| xref:reference/configuration-settings.adoc#config_server.directories.data, [`server.directories.data`]/databases
 
-| --temp-path
-| `<path>`
-| Path to a directory to be used as a staging area to extract dump/backup artifacts if needed.
+|--from-path-txn=<path>
+|Path to the transactions directory, containing the transaction directory for the database to source from.
+| xref:reference/configuration-settings.adoc#config_server.directories.transaction.logs.root[`server.directories.transaction.logs.root`]
 
-| <database>
+|--from-path=<path>
+|Path to a directory containing dump/backup artifacts to check the consistency of.
 |
-| Name of the database to check.
+
+|--temp-path=<path>
+|Path to a directory to be used as a staging area to extract dump/backup artifacts, if needed.
+|<from-path>
 |===
 
 == Output