summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2023-06-02 18:33:22 -0400
committerDan Davison <dandavison7@gmail.com>2023-06-02 18:43:38 -0400
commit9072d86111024152d9429949ec39afe928040494 (patch)
tree2b07b675e6285f0dee6f6176a4f4b84db912ca77
parent52e3c5a536eeb2f37e1335add0878a24ffb114c7 (diff)
Update --help output in manual
-rw-r--r--manual/src/full---help-output.md825
1 files changed, 401 insertions, 424 deletions
diff --git a/manual/src/full---help-output.md b/manual/src/full---help-output.md
index 85a8dc1a..29385e8c 100644
--- a/manual/src/full---help-output.md
+++ b/manual/src/full---help-output.md
@@ -1,631 +1,630 @@
# Full --help output
```txt
-delta 0.15.0
A viewer for git and diff output
-USAGE:
- delta [OPTIONS] [ARGS]
+Usage: delta [OPTIONS] [MINUS_FILE] [PLUS_FILE]
-ARGS:
- <MINUS_FILE>
- First file to be compared when delta is being used in diff mode
+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`.
+ `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
+ [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.
+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.
+ 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.
+ --blame-format <FMT>
+ Format string for git blame commit metadata.
- Available placeholders are "{timestamp}", "{author}", and "{commit}".
+ Available placeholders are "{timestamp}", "{author}", and "{commit}".
- [default: "{timestamp:<15} {author:<15.14} {commit:<8}"]
+ [default: "{timestamp:<15} {author:<15.14} {commit:<8}"]
- --blame-palette <COLORS>
- Background colors used for git blame lines (space-separated string).
+ --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.
+ 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.
+ --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.
+ 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}│]
+ [default: │{n:^4}│]
- --blame-separator-style <STYLE>
- Style string for the blame-separator-format
+ --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
+ --blame-timestamp-format <FMT>
+ Format of `git blame` timestamp in raw git output received by delta
- [default: "%Y-%m-%d %H:%M:%S %z"]
+ [default: "%Y-%m-%d %H:%M:%S %z"]
- --blame-timestamp-output-format <FMT>
- Format string for git blame timestamp output.
+ --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.
+ 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)
+ See: (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)
- --color-only
- Do not alter the input structurally in any way.
+ --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.
+ But color and highlight hunk lines according to your delta configuration. This is mainly intended for other tools that use delta.
- --commit-decoration-style <STYLE>
- Style string for the commit hash decoration.
+ --config <PATH>
+ Load the config file at PATH instead of ~/.gitconfig
- See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.
+ [default: ]
- [default: ]
+ --commit-decoration-style <STYLE>
+ Style string for the commit hash decoration.
- --commit-regex <REGEX>
- Regular expression used to identify the commit line when parsing git output
+ 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 "]
+ [default: ]
- --commit-style <STYLE>
- Style string for the commit hash line.
+ --commit-regex <REGEX>
+ Regular expression used to identify the commit line when parsing git output
- See STYLES section. The style 'omit' can be used to remove the commit hash line from the output.
+ [default: "^commit "]
- [default: raw]
+ --commit-style <STYLE>
+ Style string for the commit hash line.
- --dark
- Use default colors appropriate for a dark terminal background.
+ See STYLES section. The style 'omit' can be used to remove the commit hash line from the output.
- For more control, see the style options and --syntax-theme.
+ [default: raw]
- --default-language <LANG>
- Default language used for syntax highlighting.
+ --dark
+ Use default colors appropriate for a dark terminal background.
- 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)
+ For more control, see the style options and --syntax-theme.
- --diff-highlight
- Emulate diff-highlight.
+ --default-language <LANG>
+ Default language used for syntax highlighting.
- (https://github.com/git/git/tree/master/contrib/diff-highlight)
+ 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-so-fancy
- Emulate diff-so-fancy.
+ --diff-highlight
+ Emulate diff-highlight.
- (https://github.com/so-fancy/diff-so-fancy)
+ (https://github.com/git/git/tree/master/contrib/diff-highlight)
- --diff-stat-align-width <N>
- Width allocated for file paths in a diff stat section.
+ --diff-so-fancy
+ Emulate diff-so-fancy.
- If a relativized file path exceeds this width then the diff stat will be misaligned.
+ (https://github.com/so-fancy/diff-so-fancy)
- [default: 48]
+ --diff-stat-align-width <N>
+ Width allocated for file paths in a diff stat section.
- --features <FEATURES>
- Names of delta features to activate (space-separated).
+ If a relativized file path exceeds this width then the diff stat will be misaligned.
- 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).
+ [default: 48]
- --file-added-label <STRING>
- Text to display before an added file path.
+ --features <FEATURES>
+ Names of delta features to activate (space-separated).
- Used in the default value of navigate-regex.
+ 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).
- [default: added:]
+ --file-added-label <STRING>
+ Text to display before an added file path.
- --file-copied-label <STRING>
- Text to display before a copied file path
+ Used in the default value of navigate-regex.
- [default: copied:]
+ [default: added:]
- --file-decoration-style <STYLE>
- Style string for the file decoration.
+ --file-copied-label <STRING>
+ Text to display before a copied file path
- See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.
+ [default: copied:]
- [default: "blue ul"]
+ --file-decoration-style <STYLE>
+ Style string for the file decoration.
- --file-modified-label <STRING>
- Text to display before a modified file path.
+ See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.
- Used in the default value of navigate-regex.
+ [default: "blue ul"]
- [default: ]
+ --file-modified-label <STRING>
+ Text to display before a modified file path.
- --file-removed-label <STRING>
- Text to display before a removed file path.
+ Used in the default value of navigate-regex.
- Used in the default value of navigate-regex.
+ [default: ]
- [default: removed:]
+ --file-removed-label <STRING>
+ Text to display before a removed file path.
- --file-renamed-label <STRING>
- Text to display before a renamed file path.
+ Used in the default value of navigate-regex.
- Used in the default value of navigate-regex.
+ [default: removed:]
- [default: renamed:]
+ --file-renamed-label <STRING>
+ Text to display before a renamed file path.
- --file-style <STYLE>
- Style string for the file section.
+ Used in the default value of navigate-regex.
- See STYLES section. The style 'omit' can be used to remove the file section from the output.
+ [default: renamed:]
- [default: blue]
+ --file-style <STYLE>
+ Style string for the file section.
- --file-transformation <SED_CMD>
- Sed-style command transforming file paths for display
+ See STYLES section. The style 'omit' can be used to remove the file section from the output.
- --grep-context-line-style <STYLE>
- Style string for non-matching lines of grep output.
+ [default: blue]
- See STYLES section. Defaults to zero-style.
+ --file-transformation <SED_CMD>
+ Sed-style command transforming file paths for display
- --grep-file-style <STYLE>
- Style string for file paths in grep output.
+ --grep-context-line-style <STYLE>
+ Style string for non-matching lines of grep output.
- See STYLES section. Defaults to hunk-header-file-path-style.
+ See STYLES section. Defaults to zero-style.
- --grep-line-number-style <STYLE>
- Style string for line numbers in grep output.
+ --grep-file-style <STYLE>
+ Style string for file paths in grep output.
- See STYLES section. Defaults to hunk-header-line-number-style.
+ See STYLES section. Defaults to hunk-header-file-path-style.
- --grep-match-line-style <STYLE>
- Style string for matching lines of grep output.
+ --grep-line-number-style <STYLE>
+ Style string for line numbers in grep output.
- See STYLES section. Defaults to plus-style.
+ See STYLES section. Defaults to hunk-header-line-number-style.
- --grep-match-word-style <STYLE>
- Style string for the matching substrings within a matching line of grep output.
+ --grep-match-line-style <STYLE>
+ Style string for matching lines of grep output.
- See STYLES section. Defaults to plus-style.
+ See STYLES section. Defaults to plus-style.
- --grep-separator-symbol <STRING>
- Separator symbol printed after the file path and line number in grep output.
+ --grep-match-word-style <STYLE>
+ Style string for the matching substrings within a matching line of 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.
+ See STYLES section. Defaults to plus-style.
- [default: :]
+ --grep-separator-symbol <STRING>
+ Separator symbol printed after the file path and line number in grep output.
- --hunk-header-decoration-style <STYLE>
- Style string for the hunk-header decoration.
+ 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.
- See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.
+ [default: :]
- [default: "blue box"]
+ --hunk-header-decoration-style <STYLE>
+ Style string for the hunk-header decoration.
- --hunk-header-file-style <STYLE>
- Style string for the file path part of the hunk-header.
+ See STYLES section. The style string should contain one of the special attributes 'box', 'ul' (underline), 'ol' (overline), or the combination 'ul ol'.
- See STYLES section. The file path will only be displayed if hunk-header-style contains the 'file' special attribute.
+ [default: "blue box"]
- [default: blue]
+ --hunk-header-file-style <STYLE>
+ Style string for the file path part of the hunk-header.
- --hunk-header-line-number-style <STYLE>
- Style string for the line number part of the hunk-header.
+ See STYLES section. The file path will only be displayed if hunk-header-style contains the 'file' special attribute.
- See STYLES section. The line number will only be displayed if hunk-header-style contains the 'line-number' special attribute.
+ [default: blue]
- [default: blue]
+ --hunk-header-line-number-style <STYLE>
+ Style string for the line number part of the hunk-header.
- --hunk-header-style <STYLE>
- Style string for the hunk-header.
+ See STYLES section. The line number will only be displayed if hunk-header-style contains the 'line-number' special attribute.
- 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: blue]
- [default: "line-number syntax"]
+ --hunk-header-style <STYLE>
+ Style string for the hunk-header.
- --hunk-label <STRING>
- Text to display before a 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.
- Used in the default value of navigate-regex.
+ [default: "line-number syntax"]
- [default: ]
+ --hunk-label <STRING>
+ Text to display before a hunk header.
- --hyperlinks
- Render commit hashes, file names, and line numbers as hyperlinks.
+ Used in the default value of navigate-regex.
- 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).
+ [default: ]
- --hyperlinks-commit-link-format <FMT>
- Format string for commit hyperlinks (requires --hyperlinks).
+ --hyperlinks
+ Render commit hashes, file names, and line numbers as hyperlinks.
- The placeholder "{commit}" will be replaced by the commit hash. For example: --hyperlinks-commit-link-format='https://mygitrepo/{commit}/'
+ 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-file-link-format <FMT>
- Format string for file hyperlinks (requires --hyperlinks).
+ --hyperlinks-commit-link-format <FMT>
+ Format string for commit 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.
+ The placeholder "{commit}" will be replaced by the commit hash. For example: --hyperlinks-commit-link-format='https://mygitrepo/{commit}/'
- [default: file://{path}]
+ --hyperlinks-file-link-format <FMT>
+ Format string for file hyperlinks (requires --hyperlinks).
- --inline-hint-style <STYLE>
- Style string for short inline hint text.
+ 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.
- 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: file://{path}]
- [default: blue]
+ --inline-hint-style <STYLE>
+ Style string for short inline hint text.
- --inspect-raw-lines <true|false>
- Kill-switch for --color-moved support.
+ 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.
- 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: blue]
- [default: true]
+ --inspect-raw-lines <true|false>
+ Kill-switch for --color-moved support.
- --keep-plus-minus-markers
- Prefix added/removed lines with a +/- character, as git does.
+ 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.
- By default, delta does not emit any prefix, so code can be copied directly from delta's output.
+ [default: true]
- --light
- Use default colors appropriate for a light terminal background.
+ --keep-plus-minus-markers
+ Prefix added/removed lines with a +/- character, as git does.
- For more control, see the style options and --syntax-theme.
+ By default, delta does not emit any prefix, so code can be copied directly from delta's output.
- --line-buffer-size <N>
- Size of internal line buffer.
+ --light
+ Use default colors appropriate for a light terminal background.
- 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.
+ For more control, see the style options and --syntax-theme.
- [default: 32]
+ --line-buffer-size <N>
+ Size of internal line buffer.
- --line-fill-method <STRING>
- Line-fill method in side-by-side mode.
+ 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.
- 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.
+ [default: 32]
- -n, --line-numbers
- Display line numbers next to the diff.
+ --line-fill-method <STRING>
+ Line-fill method in side-by-side mode.
- See LINE NUMBERS section.
+ 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.
- --line-numbers-left-format <FMT>
- Format string for the left column of line numbers.
+ -n, --line-numbers
+ Display line numbers next to the diff.
- 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.
+ See LINE NUMBERS section.
- [default: {nm:^4}⋮]
+ --line-numbers-left-format <FMT>
+ Format string for the left column of line numbers.
- --line-numbers-left-style <STYLE>
- Style 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.
- See STYLES and LINE NUMBERS sections.
+ [default: {nm:^4}⋮]
- [default: auto]
+ --line-numbers-left-style <STYLE>
+ Style string for the left column of line numbers.
- --line-numbers-minus-style <STYLE>
- Style string for line numbers in the old (minus) version of the file.
+ See STYLES and LINE NUMBERS sections.
- See STYLES and LINE NUMBERS sections.
+ [default: auto]
- [default: auto]
+ --line-numbers-minus-style <STYLE>
+ Style string for line numbers in the old (minus) version of the file.
- --line-numbers-plus-style <STYLE>
- Style string for line numbers in the new (plus) version of the file.
+ See STYLES and LINE NUMBERS sections.
- See STYLES and LINE NUMBERS sections.