summaryrefslogtreecommitdiffstats
path: root/manual/src/full---help-output.md
blob: 5d8dabcb833cc2628e168228212b52552dacc1cd (plain)
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
# Full --help output

```txt
A viewer for git and diff output

Usage: delta [OPTIONS] [MINUS_FILE] [PLUS_FILE]

Arguments:
  [MINUS_FILE]
          First file to be compared when delta is being used in diff mode

          `delta file_1 file_2` is equivalent to `diff -u file_1 file_2 | delta`.

  [PLUS_FILE]
          Second file to be compared when delta is being used in diff mode

Options:
      --blame-code-style <STYLE>
          Style string for the code section of a git blame line.

          By default the code will be syntax-highlighted with the same background color as the blame format section of the line (the background color is determined by blame-palette). E.g. setting this option to 'syntax' will syntax-highlight the code with no background color.

      --blame-format <FMT>
          Format string for git blame commit metadata.

          Available placeholders are "{timestamp}", "{author}", and "{commit}".

          [default: "{timestamp:<15} {author:<15.14} {commit:<8}"]

      --blame-palette <COLORS>
          Background colors used for git blame lines (space-separated string).

          Lines added by the same commit are painted with the same color; colors are recycled as needed.

      --blame-separator-format <FMT>
          Separator between the blame format and the code section of a git blame line.

          Contains the line number by default. Possible values are "none" to disable line numbers or a format string. This may contain one "{n:}" placeholder and will display the line number on every line. A type may be added after all other format specifiers and can be separated by '_': If type is set to 'block' (e.g. "{n:^4_block}") the line number will only be shown when a new blame block starts; or if it is set to 'every-N' the line will be show with every block and every N-th (modulo) line.

          [default: │{n:^4}│]

      --blame-separator-style <STYLE>
          Style string for the blame-separator-format

      --blame-timestamp-format <FMT>
          Format of `git blame` timestamp in raw git output received by delta

          [default: "%Y-%m-%d %H:%M:%S %z"]

      --blame-timestamp-output-format <FMT>
          Format string for git blame timestamp output.

          This string is used for formatting the timestamps in git blame output. It must follow the `strftime` format syntax specification. If it is not present, the timestamps will be formatted in a human-friendly but possibly less accurate form.

          See: (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)

      --color-only
          Do not alter the input structurally in any way.

          But color and highlight hunk lines according to your delta configuration. This is mainly intended for other tools that use delta.

      --config <PATH>
          Load the config file at PATH instead of ~/.gitconfig

          [default: ]

      --commit-decoration-style <STYLE>
          Style string for the commit hash decoration.

          See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.

          [default: ]

      --commit-regex <REGEX>
          Regular expression used to identify the commit line when parsing git output

          [default: "^commit "]

      --commit-style <STYLE>
          Style string for the commit hash line.

          See STYLES section. The style 'omit' can be used to remove the commit hash line from the output.

          [default: raw]

      --dark
          Use default colors appropriate for a dark terminal background.

          For more control, see the style options and --syntax-theme.

      --default-language <LANG>
          Default language used for syntax highlighting.

          Used when the language cannot be inferred from a filename. It will typically make sense to set this in per-repository git config (.git/config)

      --diff-highlight
          Emulate diff-highlight.

          (https://github.com/git/git/tree/master/contrib/diff-highlight)

      --diff-so-fancy
          Emulate diff-so-fancy.

          (https://github.com/so-fancy/diff-so-fancy)

      --diff-stat-align-width <N>
          Width allocated for file paths in a diff stat section.

          If a relativized file path exceeds this width then the diff stat will be misaligned.

          [default: 48]

      --features <FEATURES>
          Names of delta features to activate (space-separated).

          A feature is a named collection of delta options in ~/.gitconfig. See FEATURES section. The environment variable DELTA_FEATURES can be set to a space-separated list of feature names. If this is preceded with a + character, the features from the environment variable will be added to those specified in git config. E.g. DELTA_FEATURES=+side-by-side can be used to activate side-by-side temporarily (use DELTA_FEATURES=+ to go back to just the features from git config).

      --file-added-label <STRING>
          Text to display before an added file path.

          Used in the default value of navigate-regex.

          [default: added:]

      --file-copied-label <STRING>
          Text to display before a copied file path

          [default: copied:]

      --file-decoration-style <STYLE>
          Style string for the file decoration.

          See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.

          [default: "blue ul"]

      --file-modified-label <STRING>
          Text to display before a modified file path.

          Used in the default value of navigate-regex.

          [default: ]

      --file-removed-label <STRING>
          Text to display before a removed file path.

          Used in the default value of navigate-regex.

          [default: removed:]

      --file-renamed-label <STRING>
          Text to display before a renamed file path.

          Used in the default value of navigate-regex.

          [default: renamed:]

      --file-style <STYLE>
          Style string for the file section.

          See STYLES section. The style 'omit' can be used to remove the file section from the output.

          [default: blue]

      --file-transformation <SED_CMD>
          Sed-style command transforming file paths for display

      --grep-context-line-style <STYLE>
          Style string for non-matching lines of grep output.

          See STYLES section. Defaults to zero-style.

      --grep-file-style <STYLE>
          Style string for file paths in grep output.

          See STYLES section.

          [default: magenta]

      --grep-header-decoration-style <STYLE>
          Style string for the header decoration in grep output.

          Default is "none" when grep-ouput-type-is "ripgrep", otherwise defaults to value of header-decoration-style. See hunk-header-decoration-style.

      --grep-header-file-style <STYLE>
          Style string for the file path part of the header in grep output.

          See hunk_header_file_style.

      --grep-line-number-style <STYLE>
          Style string for line numbers in grep output.

          See STYLES section.

          [default: green]

      --grep-output-type <OUTPUT_TYPE>
          Grep output format. Possible values: "ripgrep" - file name printed once, followed by matching lines within that file, each preceded by a line number. "classic" - file name:line number, followed by matching line. Default is "ripgrep" if `rg --json` format is detected, otherwise "classic"

      --grep-match-line-style <STYLE>
          Style string for matching lines of grep output.

          See STYLES section. Defaults to plus-style.

      --grep-match-word-style <STYLE>
          Style string for the matching substrings within a matching line of grep output.

          See STYLES section. Defaults to plus-style.

      --grep-separator-symbol <STRING>
          Separator symbol printed after the file path and line number in grep output.

          Defaults to ":" for both match and context lines, since many terminal emulators recognize constructs like "/path/to/file:7:". However, standard grep output uses "-" for context lines: set this option to "keep" to keep the original separator symbols.

          [default: :]

      --hunk-header-decoration-style <STYLE>
          Style string for the hunk-header decoration.

          See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.

          [default: "blue box"]

      --hunk-header-file-style <STYLE>
          Style string for the file path part of the hunk-header.

          See STYLES section. The file path will only be displayed if hunk-header-style contains the 'file' special attribute.

          [default: blue]

      --hunk-header-line-number-style <STYLE>
          Style string for the line number part of the hunk-header.

          See STYLES section. The line number will only be displayed if hunk-header-style contains the 'line-number' special attribute.

          [default: blue]

      --hunk-header-style <STYLE>
          Style string for the hunk-header.

          See STYLES section. Special attributes 'file' and 'line-number' can be used to include the file path, and number of first hunk line, in the hunk header. The style 'omit' can be used to remove the hunk header section from the output.

          [default: "line-number syntax"]

      --hunk-label <STRING>
          Text to display before a hunk header.

          Used in the default value of navigate-regex.

          [default: ]

      --hyperlinks
          Render commit hashes, file names, and line numbers as hyperlinks.

          Following the hyperlink spec for terminal emulators: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda. By default, file names and line numbers link to the local file using a file URL, whereas commit hashes link to the commit in GitHub, if the remote repository is hosted by GitHub. See --hyperlinks-file-link-format for full control over the file URLs emitted. Hyperlinks are supported by several common terminal emulators. To make them work, you must use less version >= 581 with the -R flag (or use -r with older less versions, but this will break e.g. --navigate). If you use tmux, then you will also need a patched fork of tmux (see https://github.com/dandavison/tmux).

      --hyperlinks-commit-link-format <FMT>
          Format string for commit hyperlinks (requires --hyperlinks).

          The placeholder "{commit}" will be replaced by the commit hash. For example: --hyperlinks-commit-link-format='https://mygitrepo/{commit}/'

      --hyperlinks-file-link-format <FMT>
          Format string for file hyperlinks (requires --hyperlinks).

          The placeholders "{path}" and "{line}" will be replaced by the absolute file path and the line number, respectively. The default value of this option creates hyperlinks using standard file URLs; your operating system should open these in the application registered for that file type. However, these do not make use of the line number. In order for the link to open the file at the correct line number, you could use a custom URL format such as "file-line://{path}:{line}" and register an application to handle the custom "file-line" URL scheme by opening the file in your editor/IDE at the indicated line number. See https://github.com/dandavison/open-in-editor for an example.

          [default: file://{path}]

      --inline-hint-style <STYLE>
          Style string for short inline hint text.

          This styles certain content added by delta to the original diff such as special characters to highlight tabs, and the symbols used to indicate wrapped lines. See STYLES section.

          [default: blue]

      --inspect-raw-lines <true|false>
          Kill-switch for --color-moved support.

          Whether to examine ANSI color escape sequences in raw lines received from Git and handle lines colored in certain ways specially. This is on by default: it is how Delta supports Git's --color-moved feature. Set this to "false" to disable this behavior.

          [default: true]

      --keep-plus-minus-markers
          Prefix added/removed lines with a +/- character, as git does.

          By default, delta does not emit any prefix, so code can be copied directly from delta's output.

      --light
          Use default colors appropriate for a light terminal background.

          For more control, see the style options and --syntax-theme.

      --line-buffer-size <N>
          Size of internal line buffer.

          Delta compares the added and removed versions of nearby lines in order to detect and highlight changes at the level of individual words/tokens. Therefore, nearby lines must be buffered internally before they are painted and emitted. Increasing this value might improve highlighting of some large diff hunks. However, setting this to a high value will adversely affect delta's performance when entire files are added/removed.

          [default: 32]

      --line-fill-method <STRING>
          Line-fill method in side-by-side mode.

          How to extend the background color to the end of the line in side-by-side mode. Can be ansi (default) or spaces (default if output is not to a terminal). Has no effect if --width=variable is given.

  -n, --line-numbers
          Display line numbers next to the diff.

          See LINE NUMBERS section.

      --line-numbers-left-format <FMT>
          Format string for the left column of line numbers.

          A typical value would be "{nm:^4}⋮" which means to display the line numbers of the minus file (old version), center-aligned, padded to a width of 4 characters, followed by a dividing character. See the LINE NUMBERS section.

          [default: {nm:^4}⋮]

      --line-numbers-left-style <STYLE>
          Style string for the left column of line numbers.

          See STYLES and LINE NUMBERS sections.

          [default: auto]

      --line-numbers-minus-style <STYLE>
          Style string for line numbers in the old (minus) version of the file.

          See STYLES and LINE NUMBERS sections.

          [default: auto]

      --line-numbers-plus-style <STYLE>
          Style string for line numbers in the new (plus) version of the file.

          See STYLES and LINE NUMBERS sections.

          [default: auto]

      --line-numbers-right-format <FMT>
          Format string for the right column of line numbers.

          A typical value would be "{np:^4}│ " which means to display the line numbers of the plus file (new version), center-aligned, padded to a width of 4 characters, followed by a dividing character, and a space. See the LINE NUMBERS section.

          [default: {np:^4}│]

      --line-numbers-right-style <STYLE>
          Style string for the right column of line numbers.

          See STYLES and LINE NUMBERS sections.

          [default: auto]

      --line-numbers-zero-style <STYLE>
          Style string for line numbers in unchanged (zero) lines.

          See STYLES and LINE NUMBERS sections.

          [default: auto]

      --list-languages
          List supported languages and associated file extensions

      --list-syntax-themes
          List available syntax-highlighting color themes

      --map-styles <STYLES_MAP>
          Map styles encountered in raw input to desired output styles.

          An example is --map-styles='bold purple => red "#eeeeee", bold cyan => syntax "#eeeeee"'

      --max-line-distance <DIST>
          Maximum line pair distance parameter in within-line diff algorithm.

          This parameter is the maximum distance (0.0 - 1.0) between two lines for them to be inferred to be homologous. Homologous line pairs are highlighted according to the deletion and insertion operations transforming one into the other.

          [default: 0.6]

      --max-line-length <N>
          Truncate lines longer than this.

          To prevent any truncation, set to zero. Note that delta will be slow on very long lines (e.g. minified .js) if truncation is disabled. When wrapping lines it is automatically set to fit at least all visible characters.

          [default: 512]

      --merge-conflict-begin-symbol <STRING>
          String marking the beginning of a merge conflict region.

          The string will be repeated until it reaches th