File: diffr.1

package info (click to toggle)
rust-diffr 0.1.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 224 kB
  • sloc: makefile: 10
file content (95 lines) | stat: -rw-r--r-- 2,736 bytes parent folder | download
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
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "DIFFR" "1" "April 14, 2023" "diffr 1.5.0" "User Manual"
.hy
.SH NAME
.PP
diffr - adds word-level diff on top of unified diffs
.SH SYNOPSIS
.PP
\f[B]diffr\f[R] [\f[B]--colors\f[R] \f[I]<color_spec>\f[R]]
[\f[B]--line-numbers\f[R] <compact|aligned>]
.PP
diff -u | \f[B]diffr\f[R] [OPTIONS]
.PP
git show | \f[B]diff\f[R] [OPTIONS]
.SH DESCRIPTION
.PP
\f[B]--colors\f[R] \f[I]<color_spec>\f[R] Configure color settings for
console ouput.
.IP
.nf
\f[C]
There are four faces to customize:
+----------------+--------------+----------------+
|  line prefix   |      +       |       -        |
+----------------+--------------+----------------+
| common segment |    added     |    removed     |
| unique segment | refine-added | refine-removed |
+----------------+--------------+----------------+

The customization allows
- to change the foreground or background color;
- to set or unset the attributes \[aq]bold\[aq], \[aq]intense\[aq], \[aq]underline\[aq];
- to clear all attributes.

Customization is done passing a color_spec argument.
This flag may be provided multiple times.

The syntax is the following:

color_spec = face-name + \[aq]:\[aq] + attributes
attributes = attribute
           | attribute + \[aq]:\[aq] + attributes
attribute  = (\[aq]foreground\[aq] | \[aq]background\[aq]) + \[aq]:\[aq] + color
           | (<empty> | \[aq]no\[aq]) + font-flag
           | \[aq]none\[aq]
font-flag  = \[aq]italic\[aq]
           | \[aq]bold\[aq]
           | \[aq]intense\[aq]
           | \[aq]underline\[aq]
color      = \[aq]none\[aq]
           | [0-255]
           | [0-255] + \[aq],\[aq] + [0-255] + \[aq],\[aq] + [0-255]
           | (\[aq]black\[aq], \[aq]blue\[aq], \[aq]green\[aq], \[aq]red\[aq],
              \[aq]cyan\[aq], \[aq]magenta\[aq], \[aq]yellow\[aq], \[aq]white\[aq])

For example, the color_spec

    \[aq]refine-added:background:blue:bold\[aq]

sets the color of unique added segments with
a blue background, written with a bold font.
\f[R]
.fi
.PP
\f[B]--line-numbers\f[R] <compact|aligned> Display line numbers.
Style is optional.
When style = `compact', take as little width as possible.
When style = `aligned', align to tab stops (useful if tab is used for
indentation).
[default: compact]
.PP
\f[B]-h\f[R], \f[B]--help\f[R] Prints help information
.PP
\f[B]-V\f[R], \f[B]--version\f[R] Prints version information
.SH AUTHOR
.PP
Nathan Moreau <nathan.moreau\[at]m4x.org>
.SH LICENSE
.PP
The MIT License (MIT)