Skip to content

Commit

Permalink
consistently use --help in usage text
Browse files Browse the repository at this point in the history
  • Loading branch information
jqnatividad committed Sep 24, 2022
1 parent 72213db commit cbace9b
Show file tree
Hide file tree
Showing 23 changed files with 24 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/cmd/behead.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Drop a CSV file's header.
Usage:
qsv behead [options] [<input>]
qsv behead --help
Common options:
-h, --help Display this message
Expand Down
1 change: 1 addition & 0 deletions src/cmd/count.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ given).
Usage:
qsv count [options] [<input>]
qsv count --help
count options:
-H, --human-readable Comma separate row count.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/dedup.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ A duplicate count will also be sent to <stderr>.
Usage:
qsv dedup [options] [<input>]
qsv dedup --help
sort options:
-s, --select <arg> Select a subset of columns to dedup.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/excel.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ not all columns with numeric values.
Usage:
qsv excel [options] [<input>]
qsv excel --help
Excel options:
-s, --sheet <name/index> Name or zero-based index of sheet to export.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/fetch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ $ qsv fetch URL data.csv --http-header "X-Api-Key:TEST_KEY" --http-header "X-Api
Usage:
qsv fetch [<url-column> | --url-template <template>] [--jql <selector> | --jqlfile <file>] [--http-header <k:v>...] [options] [<input>]
qsv fetch --help
Fetch options:
<url-column> URL column to use.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/fetchpost.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ $ qsv fetchpost https://httpbin.org/post col1-col3 data.csv --http-header "X-Api
Usage:
qsv fetchpost <url-column> <column-list> [--jql <selector> | --jqlfile <file>] [--http-header <k:v>...] [options] [<input>]
qsv fetchpost --help
Fetch options:
<url-column> If the argument starts with `http`, the URL to use.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/fixlengths.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This requires a single pass and can be done with stdin.
Usage:
qsv fixlengths [options] [<input>]
qsv fixlengths --help
fixlengths options:
-l, --length <arg> Forcefully set the length of each record. If a
Expand Down
1 change: 1 addition & 0 deletions src/cmd/flatten.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ contents of each field to provide a summary view.
Usage:
qsv flatten [options] [<input>]
qsv flatten --help
flatten options:
-c, --condense <arg> Limits the length of each field to the value
Expand Down
1 change: 1 addition & 0 deletions src/cmd/fmt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ useful.
Usage:
qsv fmt [options] [<input>]
qsv fmt --help
fmt options:
-t, --out-delimiter <arg> The field delimiter for writing CSV data.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/frequency.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ cardinality of each column is required.
Usage:
qsv frequency [options] [<input>]
qsv frequency --help
frequency options:
-s, --select <arg> Select a subset of columns to compute frequencies
Expand Down
1 change: 1 addition & 0 deletions src/cmd/generate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Usage:
qsv generate [options] [--rows=<count>] <input>
qsv generate [options] [--rows=<count>] (--indsp=<file>)
qsv generate [options] (--outdsp=<file>) [<input>]
qsv generate --help
generate options:
-r, --rows=<count> Number of rows of test data to generate.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/headers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ the --intersect flag.
Usage:
qsv headers [options] [<input>...]
qsv headers --help
headers options:
-j, --just-names Only show the header names (hide column index).
Expand Down
1 change: 1 addition & 0 deletions src/cmd/input.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ for further processing with other qsv commands.
Usage:
qsv input [options] [<input>]
qsv input --help
input options:
--quote <arg> The quote character to use. [default: "]
Expand Down
1 change: 1 addition & 0 deletions src/cmd/reverse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Note that this requires reading all of the CSV data into memory.
Usage:
qsv reverse [options] [<input>]
qsv reverse --help
Common options:
-h, --help Display this message
Expand Down
1 change: 1 addition & 0 deletions src/cmd/schema.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Note that `stdin.csv` will be overwritten if it already exists.
Usage:
qsv schema [options] [<input>]
qsv schema --help
Schema options:
--enum-threshold NUM Cardinality threshold for adding enum
Expand Down
1 change: 1 addition & 0 deletions src/cmd/slice.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ parsed.
Usage:
qsv slice [options] [<input>]
qsv slice --help
slice options:
-s, --start <arg> The index of the record to slice from.
Expand Down
3 changes: 2 additions & 1 deletion src/cmd/sniff.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ If you want more robust, guaranteed schemata, use the "schema" or "stats" comman
instead as they scan the entire file.
Usage:
qsv sniff [options] [<input>]
qsv sniff [options] [<input>]
qsv sniff --help
sniff options:
--sample <size> First n rows to sample to sniff out the metadata.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/sort.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ extsort command instead.
Usage:
qsv sort [options] [<input>]
qsv sort --help
sort options:
-s, --select <arg> Select a subset of columns to sort.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/sortcheck.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Returns exit code 0 if a CSV is sorted, and exit code 1 otherwise.
Usage:
qsv sortcheck [options] [<input>]
qsv sortcheck --help
sort options:
-s, --select <arg> Select a subset of columns to check for sort.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/stats.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ first with 'qsv index' to enable multithreading.
Usage:
qsv stats [options] [<input>]
qsv stats --help
stats options:
-s, --select <arg> Select a subset of columns to compute stats for.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/table.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ CSV data before formatting it with this command.
Usage:
qsv table [options] [<input>]
qsv table --help
table options:
-w, --width <arg> The minimum width of each column.
Expand Down
1 change: 1 addition & 0 deletions src/cmd/transpose.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ unless --multipass is given.
Usage:
qsv transpose [options] [<input>]
qsv transpose --help
transpose options:
-m, --multipass Process the transpose by making multiple
Expand Down
1 change: 1 addition & 0 deletions src/cmd/validate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ JSON Schema can be a local file or a URL.
Usage:
qsv validate [options] [<input>] [<json-schema>]
qsv validate --help
Validate options:
--fail-fast Stops on first error.
Expand Down

0 comments on commit cbace9b

Please sign in to comment.