diff --git a/README.md b/README.md index 641576cd..a9a37ac7 100644 --- a/README.md +++ b/README.md @@ -180,22 +180,19 @@ Commands: Options: -C, --configuration Configuration file - + [env: TOPIARY_CONFIG_FILE] --configuration-collation Configuration collation mode - + [env: TOPIARY_CONFIG_COLLATION] [default: merge] Possible values: - - merge: When multiple sources of configuration are available, matching items are - updated from the higher priority source, with collections merged as the union of sets - - revise: When multiple sources of configuration are available, matching items - (including collections) are superseded from the higher priority source - - override: When multiple sources of configuration are available, the highest priority - source is taken. All values from lower priority sources are discarded + - merge: When multiple sources of configuration are available, matching items are updated from the higher priority source, with collections merged as the union of sets + - revise: When multiple sources of configuration are available, matching items (including collections) are superseded from the higher priority source + - override: When multiple sources of configuration are available, the highest priority source is taken. All values from lower priority sources are discarded -v, --verbose... Logging verbosity (increased per occurrence) @@ -220,9 +217,8 @@ Usage: topiary format [OPTIONS] <--language |FILES> Arguments: [FILES]... Input files and directories (omit to read from stdin) - - Language detection and query selection is automatic, mapped from file extensions defined - in the Topiary configuration. + + Language detection and query selection is automatic, mapped from file extensions defined in the Topiary configuration. Options: -t, --tolerate-parsing-errors @@ -232,31 +228,26 @@ Options: Do not check that formatting twice gives the same output -l, --language - Topiary supported language (for formatting stdin) - - [possible values: json, nickel, ocaml, ocaml-interface, ocamllex, toml] + Topiary language identifier (for formatting stdin) -q, --query Topiary query file override (when formatting stdin) -C, --configuration Configuration file - + [env: TOPIARY_CONFIG_FILE] --configuration-collation Configuration collation mode - + [env: TOPIARY_CONFIG_COLLATION] [default: merge] Possible values: - - merge: When multiple sources of configuration are available, matching items are - updated from the higher priority source, with collections merged as the union of sets - - revise: When multiple sources of configuration are available, matching items - (including collections) are superseded from the higher priority source - - override: When multiple sources of configuration are available, the highest priority - source is taken. All values from lower priority sources are discarded + - merge: When multiple sources of configuration are available, matching items are updated from the higher priority source, with collections merged as the union of sets + - revise: When multiple sources of configuration are available, matching items (including collections) are superseded from the higher priority source + - override: When multiple sources of configuration are available, the highest priority source is taken. All values from lower priority sources are discarded -v, --verbose... Logging verbosity (increased per occurrence) @@ -285,14 +276,13 @@ Usage: topiary visualise [OPTIONS] <--language |FILE> Arguments: [FILE] Input file (omit to read from stdin) - - Language detection and query selection is automatic, mapped from file extensions defined - in the Topiary configuration. + + Language detection and query selection is automatic, mapped from file extensions defined in the Topiary configuration. Options: -f, --format Visualisation format - + [default: dot] Possible values: @@ -300,31 +290,26 @@ Options: - json: JSON serialisation -l, --language - Topiary supported language (for formatting stdin) - - [possible values: json, nickel, ocaml, ocaml-interface, ocamllex, toml] + Topiary language identifier (for formatting stdin) -q, --query Topiary query file override (when formatting stdin) -C, --configuration Configuration file - + [env: TOPIARY_CONFIG_FILE] --configuration-collation Configuration collation mode - + [env: TOPIARY_CONFIG_COLLATION] [default: merge] Possible values: - - merge: When multiple sources of configuration are available, matching items are - updated from the higher priority source, with collections merged as the union of sets - - revise: When multiple sources of configuration are available, matching items - (including collections) are superseded from the higher priority source - - override: When multiple sources of configuration are available, the highest priority - source is taken. All values from lower priority sources are discarded + - merge: When multiple sources of configuration are available, matching items are updated from the higher priority source, with collections merged as the union of sets + - revise: When multiple sources of configuration are available, matching items (including collections) are superseded from the higher priority source + - override: When multiple sources of configuration are available, the highest priority source is taken. All values from lower priority sources are discarded -v, --verbose... Logging verbosity (increased per occurrence) @@ -354,22 +339,19 @@ Usage: topiary config [OPTIONS] Options: -C, --configuration Configuration file - + [env: TOPIARY_CONFIG_FILE] --configuration-collation Configuration collation mode - + [env: TOPIARY_CONFIG_COLLATION] [default: merge] Possible values: - - merge: When multiple sources of configuration are available, matching items are - updated from the higher priority source, with collections merged as the union of sets - - revise: When multiple sources of configuration are available, matching items - (including collections) are superseded from the higher priority source - - override: When multiple sources of configuration are available, the highest priority - source is taken. All values from lower priority sources are discarded + - merge: When multiple sources of configuration are available, matching items are updated from the higher priority source, with collections merged as the union of sets + - revise: When multiple sources of configuration are available, matching items (including collections) are superseded from the higher priority source + - override: When multiple sources of configuration are available, the highest priority source is taken. All values from lower priority sources are discarded -v, --verbose... Logging verbosity (increased per occurrence) @@ -400,28 +382,25 @@ Usage: topiary completion [OPTIONS] [SHELL] Arguments: [SHELL] Shell (omit to detect from the environment) - + [possible values: bash, elvish, fish, powershell, zsh] Options: -C, --configuration Configuration file - + [env: TOPIARY_CONFIG_FILE] --configuration-collation Configuration collation mode - + [env: TOPIARY_CONFIG_COLLATION] [default: merge] Possible values: - - merge: When multiple sources of configuration are available, matching items are - updated from the higher priority source, with collections merged as the union of sets - - revise: When multiple sources of configuration are available, matching items - (including collections) are superseded from the higher priority source - - override: When multiple sources of configuration are available, the highest priority - source is taken. All values from lower priority sources are discarded + - merge: When multiple sources of configuration are available, matching items are updated from the higher priority source, with collections merged as the union of sets + - revise: When multiple sources of configuration are available, matching items (including collections) are superseded from the higher priority source + - override: When multiple sources of configuration are available, the highest priority source is taken. All values from lower priority sources are discarded -v, --verbose... Logging verbosity (increased per occurrence)