forked from garabik/grc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
grcat.1
95 lines (81 loc) · 2.43 KB
/
grcat.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
.TH GRCAT 1
.SH NAME
grcat \- read from standard input, colourise it and write to standard
output
.SH SYNOPSIS
.B grcat
.I "configuration"
.SH DESCRIPTION
.I "configuration"
is a name of a configuration file. Directories
~/.grc/, /usr/local/share/grc/, /usr/share/grc/
are searched for the file (in this order).
If the file is not found, it is assumed to be an absolute path of a
configuration file located elsewhere.
Configuration file consists of entries, one per regexp, entries are
separated with lines with first character non-alphanumeric (except #).
Lines beginning with # or empty lines are ignored.
Each entry consists of several lines.
Each line has form:
.I keyword=value
where keyword is one of:
.BR regexp ",
.BR colours ",
.BR command ",
.BR concat ",
.BR skip ",
.BR count ".
Only
.BR regexp
is mandatory, but it does not have much sense by itself
unless you specify at least a
.BR colour
or
.BR command
keyword as well.
.I regexp
is the regular expression to match
.I colours
is the list of colours, separated by commas (you can specify only
one colour), each colour per one regexp group specified in regexp.
.I command
is command to be executed when regexp matches. Its output will
be mixed with normal stdout, use redirectors ( >/dev/null) if you want
to supress it.
.I replace
means the regular expression match will be replaced by the value, all the
preceeding regular expressions will be evaluated against the original text, all
the following regular expressions will be evaluated against the replaced text
.I skip
can be either
.BR yes ",
or
.BR no ",
if yes, the matched line will be skipped and not displayed in output.
Default is no.
.I count
is one of words:
.BR once ",
.BR more ",
or
.BR stop ".
.BR once
means that if the regexp is matched, its first occurrence is coloured
and the program will continue with other regexp's.
.BR more
means that if there are multiple matches of the regexp in one line,
all of them will be coloured.
.BR stop
means that the regexp will be coloured and program will move to the
next line (i.e. ignoring other regexp's)
Regular expressions are evaluated from top to bottom, this allows nested
and overlapped
expressions. (e.g. you colour everything inside parentheses with one
colour, and if a following expression matches the text inside parentheses,
it will be also coloured)
.SH OPTIONS
None so far.
.SH SEE ALSO
.BR grc "(1)
.SH AUTHOR
Written by Radovan Garab\('ik <garabik @ kassiopeia.juls.savba.sk>