Make verse of git-config manpage more readable
Also mention '--file' in FILES. Signed-off-by: Alex Riesen <raa.lkml@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Alex Riesen committed
Aug 1, 2007 at 00:01 UTC
be52a41c4ea02fe7fabfef4ea9af821cdfd69a15
1 file changed
+19
-13
Documentation/git-config.txt
+19
-13
@@ -9,17 +9,17 @@ git-config - Get and set repository or global options
9
SYNOPSIS
10
--------
11
[verse]
12
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] name [value [value_regex]]
13
-'git-config' [--system | --global | [-f|--file] config-file] [type] --add name value
14
-'git-config' [--system | --global | [-f|--file] config-file] [type] --replace-all name [value [value_regex]]
15
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get name [value_regex]
16
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get-all name [value_regex]
17
-'git-config' [--system | --global | [-f|--file] config-file] [type] [-z|--null] --get-regexp name_regex [value_regex]
18
-'git-config' [--system | --global | [-f|--file] config-file] --unset name [value_regex]
19
-'git-config' [--system | --global | [-f|--file] config-file] --unset-all name [value_regex]
20
-'git-config' [--system | --global | [-f|--file] config-file] --rename-section old_name new_name
21
-'git-config' [--system | --global | [-f|--file] config-file] --remove-section name
22
-'git-config' [--system | --global | [-f|--file] config-file] [-z|--null] -l | --list
12
+'git-config' [<file-option>] [type] [-z|--null] name [value [value_regex]]
13
+'git-config' [<file-option>] [type] --add name value
14
+'git-config' [<file-option>] [type] --replace-all name [value [value_regex]]
15
+'git-config' [<file-option>] [type] [-z|--null] --get name [value_regex]
16
+'git-config' [<file-option>] [type] [-z|--null] --get-all name [value_regex]
17
+'git-config' [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex]
18
+'git-config' [<file-option>] --unset name [value_regex]
19
+'git-config' [<file-option>] --unset-all name [value_regex]
20
+'git-config' [<file-option>] --rename-section old_name new_name
21
+'git-config' [<file-option>] --remove-section name
22
+'git-config' [<file-option>] [-z|--null] -l | --list
23
24
DESCRIPTION
25
-----------
@@ -40,6 +40,12 @@ convert the value to the canonical form (simple decimal number for int,
40
a "true" or "false" string for bool). If no type specifier is passed,
41
no checks or transformations are performed on the value.
42
43
+The file-option can be one of '--system', '--global' or '--file'
44
+which specify where the values will be read from or written to.
45
+The default is to assume the config file of the current repository,
46
+.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
47
+(see <<FILES>>).
48
+
49
This command will fail if:
50
51
. The config file is invalid,
@@ -133,8 +139,8 @@ See also <<FILES>>.
139
FILES
140
-----
141
136
-There are three files where git-config will search for configuration
137
-options:
142
+If not set explicitely with '--file', there are three files where
143
+git-config will search for configuration options:
144
145
.git/config::
146
Repository specific configuration file. (The filename is