Autogenerated HTML docs for v1.4.0-rc2-g5e3a6

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

diff --git a/git-repo-config.txt b/git-repo-config.txt
index 00efde5..d5142e0 100644 (file)
--- a/git-repo-config.txt
+++ b/git-repo-config.txt
@@ -3,7 +3,7 @@ git-repo-config(1)
 
 NAME
 ----
 
 NAME
 ----

-git-repo-config - Get and set options in .git/config.
+git-repo-config - Get and set options in .git/config

 
 
 SYNOPSIS
 
 
 SYNOPSIS


@@ -15,6 +15,7 @@ SYNOPSIS
 'git-repo-config' [type] --get-all name [value_regex]
 'git-repo-config' [type] --unset name [value_regex]
 'git-repo-config' [type] --unset-all name [value_regex]
 'git-repo-config' [type] --get-all name [value_regex]
 'git-repo-config' [type] --unset name [value_regex]
 'git-repo-config' [type] --unset-all name [value_regex]

+'git-repo-config' -l | --list

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


@@ -22,10 +23,11 @@ You can query/set/replace/unset options with this command. The name is
 actually the section and the key separated by a dot, and the value will be
 escaped.
 
 actually the section and the key separated by a dot, and the value will be
 escaped.
 

-If you want to set/unset an option which can occur on multiple lines, you
-should provide a POSIX regex for the value. If you want to handle the lines
-*not* matching the regex, just prepend a single exclamation mark in front
-(see EXAMPLES).
+If you want to set/unset an option which can occur on multiple
+lines, a POSIX regexp `value_regex` needs to be given.  Only the
+existing values that match the regexp are updated or unset.  If
+you want to handle the lines that do *not* match the regex, just
+prepend a single exclamation mark in front (see EXAMPLES).

 
 The type specifier can be either '--int' or '--bool', which will make
 'git-repo-config' ensure that the variable(s) are of the given type and
 
 The type specifier can be either '--int' or '--bool', which will make
 'git-repo-config' ensure that the variable(s) are of the given type and


@@ -33,10 +35,10 @@ 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.
 

-This command will fail if
+This command will fail if:

 
 

-. .git/config is invalid,
-. .git/config can not be written to,
+. The .git/config file is invalid,
+. Can not write to .git/config,

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


@@ -47,8 +49,8 @@ OPTIONS
 -------
 
 --replace-all::
 -------
 
 --replace-all::

-       Default behaviour is to replace at most one line. This replaces
-       all lines matching the key (and optionally the value_regex)
+       Default behavior is to replace at most one line. This replaces
+       all lines matching the key (and optionally the value_regex).

 
 --get::
        Get the value for a given key (optionally filtered by a regex
 
 --get::
        Get the value for a given key (optionally filtered by a regex


@@ -58,12 +60,18 @@ OPTIONS
        Like get, but does not fail if the number of values for the key
        is not exactly one.
 
        Like get, but does not fail if the number of values for the key
        is not exactly one.
 

+--get-regexp::
+       Like --get-all, but interprets the name as a regular expression.
+

 --unset::
        Remove the line matching the key from .git/config.
 
 --unset-all::
        Remove all matching lines from .git/config.
 
 --unset::
        Remove the line matching the key from .git/config.
 
 --unset-all::
        Remove all matching lines from .git/config.
 

+-l, --list::
+       List all variables set in .git/config.
+

 
 EXAMPLE
 -------
 
 EXAMPLE
 -------


@@ -87,11 +95,11 @@ Given a .git/config like this:
                renames = true
 
        ; Proxy settings
                renames = true
 
        ; Proxy settings

-       [proxy]
-               command="ssh" for "ssh://kernel.org/"
-               command="proxy-command" for kernel.org
-               command="myprotocol-command" for "my://"
-               command=default-proxy ; for all the rest
+       [core]
+               gitproxy="ssh" for "ssh://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
 
 
 you can set the filemode to true with
 


@@ -104,7 +112,7 @@ to what URL they apply. Here is how to change the entry for kernel.org
 to "ssh".
 
 ------------
 to "ssh".
 
 ------------

-% git repo-config proxy.command '"ssh" for kernel.org' 'for kernel.org$'
+% git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'

 ------------
 
 This makes sure that only the key/value pair for kernel.org is replaced.
 ------------
 
 This makes sure that only the key/value pair for kernel.org is replaced.


@@ -115,7 +123,7 @@ To delete the entry for renames, do
 % git repo-config --unset diff.renames
 ------------
 
 % git repo-config --unset diff.renames
 ------------
 

-If you want to delete an entry for a multivar (like proxy.command above),
+If you want to delete an entry for a multivar (like core.gitproxy above),

 you have to provide a regex matching the value of exactly one line.
 
 To query the value for a given key, do
 you have to provide a regex matching the value of exactly one line.
 
 To query the value for a given key, do


@@ -133,27 +141,27 @@ or
 or, to query a multivar:
 
 ------------
 or, to query a multivar:
 
 ------------

-% git repo-config --get proxy.command "for kernel.org$"
+% git repo-config --get core.gitproxy "for kernel.org$"

 ------------
 
 If you want to know all the values for a multivar, do:
 
 ------------
 ------------
 
 If you want to know all the values for a multivar, do:
 
 ------------

-% git repo-config --get-all proxy.command
+% git repo-config --get-all core.gitproxy

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

-If you like to live dangerous, you can replace *all* proxy.commands by a
+If you like to live dangerous, you can replace *all* core.gitproxy by a

 new one with
 
 ------------
 new one with
 
 ------------

-% git repo-config --replace-all proxy.command ssh
+% git repo-config --replace-all core.gitproxy ssh

 ------------
 
 However, if you really only want to replace the line for the default proxy,
 i.e. the one without a "for ..." postfix, do something like this:
 
 ------------
 ------------
 
 However, if you really only want to replace the line for the default proxy,
 i.e. the one without a "for ..." postfix, do something like this:
 
 ------------

-% git repo-config proxy.command ssh '! for '
+% git repo-config core.gitproxy ssh '! for '

 ------------
 
 To actually match only values with an exclamation mark, you have to
 ------------
 
 To actually match only values with an exclamation mark, you have to


@@ -163,13 +171,16 @@ To actually match only values with an exclamation mark, you have to
 ------------
 
 
 ------------
 
 

+include::config.txt[]
+
+

 Author
 ------
 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 
 Documentation
 --------------
 Author
 ------
 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 
 Documentation
 --------------

-Documentation by Johannes Schindelin.
+Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.

 
 GIT
 ---
 
 GIT
 ---