summaryrefslogtreecommitdiff
path: root/Documentation/config/help.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/config/help.adoc')
-rw-r--r--Documentation/config/help.adoc27
1 files changed, 27 insertions, 0 deletions
diff --git a/Documentation/config/help.adoc b/Documentation/config/help.adoc
new file mode 100644
index 0000000000..b369589cec
--- /dev/null
+++ b/Documentation/config/help.adoc
@@ -0,0 +1,27 @@
+help.browser::
+ Specify the browser that will be used to display help in the
+ 'web' format. See linkgit:git-help[1].
+
+help.format::
+ Override the default help format used by linkgit:git-help[1].
+ Values 'man', 'info', 'web' and 'html' are supported. 'man' is
+ the default. 'web' and 'html' are the same.
+
+help.autoCorrect::
+ If git detects typos and can identify exactly one valid command similar
+ to the error, git will try to suggest the correct command or even
+ run the suggestion automatically. Possible config values are:
+ - 0, "false", "off", "no", "show": show the suggested command (default).
+ - 1, "true", "on", "yes", "immediate": run the suggested command
+immediately.
+ - positive number > 1: run the suggested command after specified
+deciseconds (0.1 sec).
+ - "never": don't run or show any suggested command.
+ - "prompt": show the suggestion and prompt for confirmation to run
+the command.
+
+help.htmlPath::
+ Specify the path where the HTML documentation resides. File system paths
+ and URLs are supported. HTML pages will be prefixed with this path when
+ help is displayed in the 'web' format. This defaults to the documentation
+ path of your Git installation.