From 5d36d409082413414edde11af5a3c4fa8e879bfd Mon Sep 17 00:00:00 2001 From: Michael Budde Date: Wed, 9 Nov 2022 20:12:51 +0100 Subject: [PATCH] Update README --- README.md | 74 ++++++++++++++++++++++++------------------------------- 1 file changed, 32 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 3491470..2465685 100644 --- a/README.md +++ b/README.md @@ -55,48 +55,38 @@ cargo install tabulate ## Options ``` -tabulate - -USAGE: - tabulate [OPTIONS] - -OPTIONS: - --column-info - Print information about the columns - - -c, --compress-cols - Control how much columns are compressed. Set to 0 to disable column - compression, i.e. columns are sized to fit the largest value [default: - 1.0] - -d, --delimiter - Use characters of DELIM as column delimiters [default: " \t"] - - -n, --estimate-count - Estimate column sizes from the first N lines. The value 0 means all - lines [default: 1000] - - -x, --exclude - Select which columns should be excluded from the output. This option - takes precedence over --include - -h, --help - Prints help information - - -i, --include - Select which columns to include in the output - - -s, --strict - Parse columns as strictly being delimited by a single delimiter - - -t, --truncate - Truncate data that does not fit in a column. Takes an optional list of - columns that should be truncated. If no LIST is given all columns are - truncated - -V, --version - Prints version information - - -LIST should be a comma-separated list of ranges. Each range should be of one of the -following forms: +Usage: tabulate [OPTIONS] + +Options: + -t, --truncate [...] + Truncate data that does not fit in a column. Takes an optional list of columns that should be + truncated. If no LIST is given all columns are truncated + -c, --compress-cols + Number between 0.0 and 1.0 that controls how much columns are compressed. Set to 0 to disable + column compression, i.e. columns are sized to fit the largest value [default: 1.0] + -n, --estimate-count + Estimate column sizes from the first N lines. The value 0 means all lines [default: 1000] + -i, --include ... + Select which columns to include in the output + -x, --exclude ... + Select which columns should be excluded from the output. This option takes precedence over + --include + -d, --delimiter + Use characters of DELIM as column delimiters [default: " \t"] + -o, --output-delimiter + Specify the delimiter to use to separate columns in the output [default: " "] + -s, --strict + Parse columns as strictly being delimited by a single delimiter + --online + Print lines during column size estimation phase + --column-info + Print information about the columns + -h, --help + Print help information + -V, --version + Print version information + +LIST should be a comma-separated list of ranges. Each range should be of one of the following forms: N N'th column, starting at 1 N- from N'th column to end of line