Merge branch 'jc/partial-remove'

[git.git] / Documentation / git-config.txt

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 5f66a7fcd5907b26ff6bdf94b53c2619c1eff509..a592b61e2fe998525d0978547b3ea7e4ad2d72ac 100644 (file)
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -9,17 +9,17 @@ git-config - Get and set repository or global options
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git-config' [--system | --global] [type] [-z|--null] name [value [value_regex]]
-'git-config' [--system | --global] [type] --add name value
-'git-config' [--system | --global] [type] --replace-all name [value [value_regex]]
-'git-config' [--system | --global] [type] [-z|--null] --get name [value_regex]
-'git-config' [--system | --global] [type] [-z|--null] --get-all name [value_regex]
-'git-config' [--system | --global] [type] [-z|--null] --get-regexp name_regex [value_regex]
-'git-config' [--system | --global] --unset name [value_regex]
-'git-config' [--system | --global] --unset-all name [value_regex]
-'git-config' [--system | --global] --rename-section old_name new_name
-'git-config' [--system | --global] --remove-section name
-'git-config' [--system | --global] [-z|--null] -l | --list
+'git-config' [<file-option>] [type] [-z|--null] name [value [value_regex]]
+'git-config' [<file-option>] [type] --add name value
+'git-config' [<file-option>] [type] --replace-all name [value [value_regex]]
+'git-config' [<file-option>] [type] [-z|--null] --get name [value_regex]
+'git-config' [<file-option>] [type] [-z|--null] --get-all name [value_regex]
+'git-config' [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex]
+'git-config' [<file-option>] --unset name [value_regex]
+'git-config' [<file-option>] --unset-all name [value_regex]
+'git-config' [<file-option>] --rename-section old_name new_name
+'git-config' [<file-option>] --remove-section name
+'git-config' [<file-option>] [-z|--null] -l | --list

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -40,10 +40,16 @@ convert the value to the canonical form (simple decimal number for int,
 a "true" or "false" string for bool).  If no type specifier is passed,
 no checks or transformations are performed on the value.
 
 a "true" or "false" string for bool).  If no type specifier is passed,
 no checks or transformations are performed on the value.
 

+The file-option can be one of '--system', '--global' or '--file'
+which specify where the values will be read from or written to.
+The default is to assume the config file of the current repository,
+.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
+(see <<FILES>>).
+

 This command will fail if:
 
 This command will fail if:
 

-. The .git/config file is invalid,
-. Can not write to .git/config,
+. The config file is invalid,
+. Can not write to the config file,

 . no section was provided,
 . the section or key is invalid,
 . you try to unset an option which does not exist,
 . no section was provided,
 . the section or key is invalid,
 . you try to unset an option which does not exist,


@@ -93,6 +99,9 @@ rather than from all available files.
 +
 See also <<FILES>>.
 
 +
 See also <<FILES>>.
 

+-f config-file, --file config-file::
+       Use the given config file instead of the one specified by GIT_CONFIG.
+

 --remove-section::
        Remove the given section from the configuration file.
 
 --remove-section::
        Remove the given section from the configuration file.
 


@@ -130,10 +139,10 @@ See also <<FILES>>.
 FILES
 -----
 
 FILES
 -----
 

-There are three files where git-config will search for configuration
-options:
+If not set explicitly with '--file', there are three files where
+git-config will search for configuration options:

 
 

-.git/config::
+$GIT_DIR/config::

        Repository specific configuration file. (The filename is
        of course relative to the repository root, not the working
        directory.)
        Repository specific configuration file. (The filename is
        of course relative to the repository root, not the working
        directory.)


@@ -205,9 +214,7 @@ Given a .git/config like this:
 
        ; Proxy settings
        [core]
 
        ; Proxy settings
        [core]

-               gitproxy="ssh" for "ssh://kernel.org/"

                gitproxy="proxy-command" for kernel.org
                gitproxy="proxy-command" for kernel.org

-               gitproxy="myprotocol-command" for "my://"

                gitproxy=default-proxy ; for all the rest
 
 you can set the filemode to true with
                gitproxy=default-proxy ; for all the rest
 
 you can set the filemode to true with


@@ -282,7 +289,7 @@ To actually match only values with an exclamation mark, you have to
 To add a new proxy, without altering any of the existing ones, use
 
 ------------
 To add a new proxy, without altering any of the existing ones, use
 
 ------------

-% git config core.gitproxy '"proxy" for example.com'
+% git config core.gitproxy '"proxy-command" for example.com'

 ------------
 
 
 ------------