summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Steven Schubiger <stsc@refcnt.org>2019-08-22 21:46:18 +0200
committerGravatar Steven Schubiger <stsc@refcnt.org>2019-08-22 21:46:18 +0200
commitf71e04ab70ae8fc7eeca70e90828bfb1e4fbaa01 (patch)
treee25eeb209ce1d16543d0ddcd4e4a115fbb925262
parent6323c270d4c14a27d0b7d035698e2b16ac840ac9 (diff)
downloadcolorize-f71e04ab70ae8fc7eeca70e90828bfb1e4fbaa01.tar.gz
colorize-f71e04ab70ae8fc7eeca70e90828bfb1e4fbaa01.tar.bz2
Document config file usage
-rw-r--r--colorize.153
1 files changed, 52 insertions, 1 deletions
diff --git a/colorize.1 b/colorize.1
index f3341ed..b065b64 100644
--- a/colorize.1
+++ b/colorize.1
@@ -1,4 +1,4 @@
-.TH COLORIZE 1 "2019-02-23" "colorize v0.64" "User Commands"
+.TH COLORIZE 1 "2019-08-22" "colorize v0.64" "User Commands"
.SH NAME
colorize \- colorize text on terminal with ANSI escape sequences
.SH SYNOPSIS
@@ -51,6 +51,57 @@ show help screen and exit
.TP
.BR \-V ", " \-\-version
display version data and exit
+.SH FILES
+.TP
+.B ~/.colorize.conf
+user configuration file
+.PP
+.RS
+If the aforementioned file exists, it is read, parsed and processed
+prior to handling the command-line options. Command-line options
+override configuration values, but are currently not capable of
+unsetting them. If unsetting is desired, comment them out or remove
+them.
+.RE
+.PP
+.RS
+.B Sample configuration file
+.RS
+.nf
+# ~/.colorize.conf
+attr = bold,underscore
+color = magenta # favorite one
+exclude-random = black
+omit-color-empty = yes
+.fi
+.RE
+.RE
+.PP
+.RS
+.B Configurable options and values
+.RS
+.nf
+attr (values same as command-line option)
+color (value same as command-line colors)
+exclude-random (value same as command-line option)
+omit-color-empty (yes/no)
+.fi
+.RE
+.RE
+.PP
+.RS
+.B Syntax
+.RS
+Each line ought to start with a name of an option, followed by = and
+an optional value. Leaving the value blank, unsets the option.
+.PP
+Whitespace is allowed before the option name, after the option name,
+before the option value and after the option value.
+.PP
+Comments may be placed before or after the option is set. Everything
+following the '#' sign is treated as being commented out.
+.RE
+.RE
.SH NOTES
The list of color escape sequence codes being emitted and omitted is
as follows: