From bba477f56d9af387c810e93fbc5b844831e6de74 Mon Sep 17 00:00:00 2001 From: Thomas von Dein Date: Mon, 19 Jan 2026 13:53:57 +0100 Subject: [PATCH] updated documentation --- cmd/tablizer.go | 19 ++++++++++++++++--- tablizer.1 | 22 ++++++++++++++++++---- 2 files changed, 34 insertions(+), 7 deletions(-) diff --git a/cmd/tablizer.go b/cmd/tablizer.go index d27a71e..bbeb50e 100644 --- a/cmd/tablizer.go +++ b/cmd/tablizer.go @@ -20,6 +20,7 @@ SYNOPSIS -F, --filter Filter given field with regex, can be used multiple times -T, --transpose-columns string Transpose the speficied columns (separated by ,) -R, --regex-transposer Apply /search/replace/ regexp to fields given in -T + -K --regex-colorizer /from/color/ colorize pattern of output (color: fg[:bg]) -j, --json Read JSON input (must be array of hashes) -I, --interactive Interactively filter and select rows -g, --auto-headers Generate headers if there are none present in input @@ -467,9 +468,20 @@ CONFIGURATION AND COLORS lightGreen, lightMagenta, lightRed, lightWhite, lightYellow, magenta, red, white, yellow - The Variables FG and BG are being used to highlight matches. The other - *FG and *BG variables are for colored table output (enabled with the - "-L" parameter). + but you may also use HTML color codes without the hash sign. + + The Variables FG and BG are being used to highlight matching rows. The + other *FG and *BG variables are for colored table output (enabled with + the "-L" parameter). + + You can also use the option "-K" to colorize particular patterns, not + whole lines. The option can be given multiple times and expects the + following parameter: + + -K '/regex/foreground[:background]/ + + that is, background color is optional. This colorization will applied on + top of any previous colorizations, if any. Colorization can be turned off completely either by setting the parameter "-N" or the environment variable NO_COLOR to a true value. @@ -531,6 +543,7 @@ Operational Flags: -F, --filter Filter given field with regex, can be used multiple times -T, --transpose-columns string Transpose the speficied columns (separated by ,) -R, --regex-transposer Apply /search/replace/ regexp to fields given in -T + -K --regex-colorizer /from/color/ colorize pattern of output (color: fg[:bg]) -j, --json Read JSON input (must be array of hashes) -I, --interactive Interactively filter and select rows -g, --auto-headers Generate headers if there are none present in input diff --git a/tablizer.1 b/tablizer.1 index 87e4c00..e82b6f8 100644 --- a/tablizer.1 +++ b/tablizer.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "TABLIZER 1" -.TH TABLIZER 1 "2025-12-08" "1" "User Commands" +.TH TABLIZER 1 "2026-01-19" "1" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -158,6 +158,7 @@ tablizer \- Manipulate tabular output of other programs \& \-F, \-\-filter Filter given field with regex, can be used multiple times \& \-T, \-\-transpose\-columns string Transpose the speficied columns (separated by ,) \& \-R, \-\-regex\-transposer Apply /search/replace/ regexp to fields given in \-T +\& \-K \-\-regex\-colorizer /from/color/ colorize pattern of output (color: fg[:bg]) \& \-j, \-\-json Read JSON input (must be array of hashes) \& \-I, \-\-interactive Interactively filter and select rows \& \-g, \-\-auto\-headers Generate headers if there are none present in input @@ -682,9 +683,22 @@ black, blue, cyan, darkGray, default, green, lightBlue, lightCyan, lightGreen, lightMagenta, lightRed, lightWhite, lightYellow, magenta, red, white, yellow .PP -The Variables \fB\s-1FG\s0\fR and \fB\s-1BG\s0\fR are being used to highlight matches. The -other *FG and *BG variables are for colored table output (enabled with -the \f(CW\*(C`\-L\*(C'\fR parameter). +but you may also use \s-1HTML\s0 color codes without the hash sign. +.PP +The Variables \fB\s-1FG\s0\fR and \fB\s-1BG\s0\fR are being used to highlight matching +rows. The other *FG and *BG variables are for colored table output +(enabled with the \f(CW\*(C`\-L\*(C'\fR parameter). +.PP +You can also use the option \f(CW\*(C`\-K\*(C'\fR to colorize particular patterns, not +whole lines. The option can be given multiple times and expects the +following parameter: +.PP +.Vb 1 +\& \-K \*(Aq/regex/foreground[:background]/ +.Ve +.PP +that is, background color is optional. This colorization will applied +on top of any previous colorizations, if any. .PP Colorization can be turned off completely either by setting the parameter \f(CW\*(C`\-N\*(C'\fR or the environment variable \fB\s-1NO_COLOR\s0\fR to a true value.