summaryrefslogtreecommitdiffstats
path: root/doc/long-help.txt
diff options
context:
space:
mode:
authorKeith Hall <keith-hall@users.noreply.github.com>2024-11-13 21:25:59 +0200
committerGitHub <noreply@github.com>2024-11-13 21:25:59 +0200
commit022574314f311875c3146437400f35e182b74fe4 (patch)
treeea52b658552b4db4468cc3e458ccf958bed55739 /doc/long-help.txt
parent2caeaef14bec10565a62451d92dd92362b483275 (diff)
parent8a4701f93ff296b80b813bde07002796f9ff2f1d (diff)
Merge branch 'master' into bat_config_dir_docs
Diffstat (limited to 'doc/long-help.txt')
-rw-r--r--doc/long-help.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/long-help.txt b/doc/long-help.txt
index 87fb5d96..85d595b9 100644
--- a/doc/long-help.txt
+++ b/doc/long-help.txt
@@ -119,6 +119,27 @@ Options:
Set the theme for syntax highlighting. Use '--list-themes' to see all available themes. To
set a default theme, add the '--theme="..."' option to the configuration file or export
the BAT_THEME environment variable (e.g.: export BAT_THEME="...").
+
+ Special values:
+
+ * auto: Picks a dark or light theme depending on the terminal's colors (default).
+ Use '--theme-light' and '--theme-dark' to customize the selected theme.
+ * auto:always: Detect the terminal's colors even when the output is redirected.
+ * auto:system: Detect the color scheme from the system-wide preference (macOS only).
+ * dark: Use the dark theme specified by '--theme-dark'.
+ * light: Use the light theme specified by '--theme-light'.
+
+ --theme-light <theme>
+ Sets the theme name for syntax highlighting used when the terminal uses a light
+ background. Use '--list-themes' to see all available themes. To set a default theme, add
+ the '--theme-light="..." option to the configuration file or export the BAT_THEME_LIGHT
+ environment variable (e.g. export BAT_THEME_LIGHT="...").
+
+ --theme-dark <theme>
+ Sets the theme name for syntax highlighting used when the terminal uses a dark background.
+ Use '--list-themes' to see all available themes. To set a default theme, add the
+ '--theme-dark="..." option to the configuration file or export the BAT_THEME_DARK
+ environment variable (e.g. export BAT_THEME_DARK="...").
--list-themes
Display a list of supported themes for syntax highlighting.