man1/git-repo-config.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-REPO-CONFIG" 1 "" "" ""
  21 .SH NAME
  22 git-repo-config \- Get and set options in .git/config
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fIgit\-repo\-config\fR [type] name [value [value_regex]]
  27 \fIgit\-repo\-config\fR [type] \-\-replace\-all name [value [value_regex]]
  28 \fIgit\-repo\-config\fR [type] \-\-get name [value_regex]
  29 \fIgit\-repo\-config\fR [type] \-\-get\-all name [value_regex]
  30 \fIgit\-repo\-config\fR [type] \-\-unset name [value_regex]
  31 \fIgit\-repo\-config\fR [type] \-\-unset\-all name [value_regex]
  32 \fIgit\-repo\-config\fR \-l | \-\-list
  33 .fi
  34
  35 .SH "DESCRIPTION"
  36
  37
  38 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\&.
  39
  40
  41 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 \fInot\fR match the regex, just prepend a single exclamation mark in front (see EXAMPLES)\&.
  42
  43
  44 The type specifier can be either \fI\-\-int\fR or \fI\-\-bool\fR, which will make \fIgit\-repo\-config\fR ensure that the variable(s) are of the given type and 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\&.
  45
  46
  47 This command will fail if:
  48
  49 .TP 3
  50 1.
  51 The \&.git/config file is invalid,
  52 .TP
  53 2.
  54 Can not write to \&.git/config,
  55 .TP
  56 3.
  57 no section was provided,
  58 .TP
  59 4.
  60 the section or key is invalid,
  61 .TP
  62 5.
  63 you try to unset an option which does not exist, or
  64 .TP
  65 6.
  66 you try to unset/set an option for which multiple lines match\&.
  67 .LP
  68
  69 .SH "OPTIONS"
  70
  71 .TP
  72 \-\-replace\-all
  73 Default behavior is to replace at most one line\&. This replaces all lines matching the key (and optionally the value_regex)\&.
  74
  75 .TP
  76 \-\-get
  77 Get the value for a given key (optionally filtered by a regex matching the value)\&.
  78
  79 .TP
  80 \-\-get\-all
  81 Like get, but does not fail if the number of values for the key is not exactly one\&.
  82
  83 .TP
  84 \-\-get\-regexp
  85 Like \-\-get\-all, but interprets the name as a regular expression\&.
  86
  87 .TP
  88 \-\-unset
  89 Remove the line matching the key from \&.git/config\&.
  90
  91 .TP
  92 \-\-unset\-all
  93 Remove all matching lines from \&.git/config\&.
  94
  95 .TP
  96 \-l, \-\-list
  97 List all variables set in \&.git/config\&.
  98
  99 .SH "EXAMPLE"
 100
 101
 102 Given a \&.git/config like this:
 103
 104 .nf
 105 #
 106 # This is the config file, and
 107 # a '#' or ';' character indicates
 108 # a comment
 109 #
 110 .fi
 111
 112 .nf
 113 ; core variables
 114 [core]
 115         ; Don't trust file modes
 116         filemode = false
 117 .fi
 118
 119 .nf
 120 ; Our diff algorithm
 121 [diff]
 122         external = "/usr/local/bin/gnu\-diff \-u"
 123         renames = true
 124 .fi
 125
 126 .nf
 127 ; Proxy settings
 128 [core]
 129         gitproxy="ssh" for "ssh://kernel\&.org/"
 130         gitproxy="proxy\-command" for kernel\&.org
 131         gitproxy="myprotocol\-command" for "my://"
 132         gitproxy=default\-proxy ; for all the rest
 133 .fi
 134
 135
 136 you can set the filemode to true with
 137
 138 .nf
 139 % git repo\-config core\&.filemode true
 140 .fi
 141
 142
 143 The hypothetic proxy command entries actually have a postfix to discern to what URL they apply\&. Here is how to change the entry for kernel\&.org to "ssh"\&.
 144
 145 .nf
 146 % git repo\-config core\&.gitproxy '"ssh" for kernel\&.org' 'for kernel\&.org$'
 147 .fi
 148
 149
 150 This makes sure that only the key/value pair for kernel\&.org is replaced\&.
 151
 152
 153 To delete the entry for renames, do
 154
 155 .nf
 156 % git repo\-config \-\-unset diff\&.renames
 157 .fi
 158
 159
 160 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\&.
 161
 162
 163 To query the value for a given key, do
 164
 165 .nf
 166 % git repo\-config \-\-get core\&.filemode
 167 .fi
 168
 169
 170 or
 171
 172 .nf
 173 % git repo\-config core\&.filemode
 174 .fi
 175
 176
 177 or, to query a multivar:
 178
 179 .nf
 180 % git repo\-config \-\-get core\&.gitproxy "for kernel\&.org$"
 181 .fi
 182
 183
 184 If you want to know all the values for a multivar, do:
 185
 186 .nf
 187 % git repo\-config \-\-get\-all core\&.gitproxy
 188 .fi
 189
 190
 191 If you like to live dangerous, you can replace \fIall\fR core\&.gitproxy by a new one with
 192
 193 .nf
 194 % git repo\-config \-\-replace\-all core\&.gitproxy ssh
 195 .fi
 196
 197
 198 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:
 199
 200 .nf
 201 % git repo\-config core\&.gitproxy ssh '! for '
 202 .fi
 203
 204
 205 To actually match only values with an exclamation mark, you have to
 206
 207 .nf
 208 % git repo\-config section\&.key value '[!]'
 209 .fi
 210
 211 .SH "CONFIGURATION FILE"
 212
 213
 214 The git configuration file contains a number of variables that affect the git command's behavior\&. They can be used by both the git plumbing and the porcelains\&. The variables are divided into sections, where in the fully qualified variable name the variable itself is the last dot\-separated segment and the section name is everything before the last dot\&. The variable names are case\-insensitive and only alphanumeric characters are allowed\&. Some variables may appear multiple times\&.
 215
 216
 217 The syntax is fairly flexible and permissive; whitespaces are mostly ignored\&. The \fI#\fR and \fI;\fR characters begin comments to the end of line, blank lines are ignored, lines containing strings enclosed in square brackets start sections and all the other lines are recognized as setting variables, in the form \fIname = value\fR\&. If there is no equal sign on the line, the entire line is taken as \fIname\fR and the variable is recognized as boolean "true"\&. String values may be entirely or partially enclosed in double quotes; some variables may require special value format\&.
 218
 219 .SS "Example"
 220
 221 .nf
 222 # Core variables
 223 [core]
 224         ; Don't trust file modes
 225         filemode = false
 226 .fi
 227
 228 .nf
 229 # Our diff algorithm
 230 [diff]
 231         external = "/usr/local/bin/gnu\-diff \-u"
 232         renames = true
 233 .fi
 234
 235 .SS "Variables"
 236
 237
 238 Note that this list is non\-comprehensive and not necessarily complete\&. For command\-specific variables, you will find a more detailed description in the appropriate manual page\&. You will find a description of non\-core porcelain configuration variables in the respective porcelain documentation\&.
 239
 240 .TP
 241 core\&.fileMode
 242 If false, the executable bit differences between the index and the working copy are ignored; useful on broken filesystems like FAT\&. See \fBgit\-update\-index\fR(1)\&. True by default\&.
 243
 244 .TP
 245 core\&.gitProxy
 246 A "proxy command" to execute (as \fIcommand host port\fR) instead of establishing direct connection to the remote server when using the git protocol for fetching\&. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string\&. This variable may be set multiple times and is matched in the given order; the first match wins\&.
 247
 248 Can be overridden by the \fIGIT_PROXY_COMMAND\fR environment variable (which always applies universally, without the special "for" handling)\&.
 249
 250 .TP
 251 core\&.ignoreStat
 252 The working copy files are assumed to stay unchanged until you mark them otherwise manually \- Git will not detect the file changes by lstat() calls\&. This is useful on systems where those are very slow, such as Microsoft Windows\&. See \fBgit\-update\-index\fR(1)\&. False by default\&.
 253
 254 .TP
 255 core\&.preferSymlinkRefs
 256 Instead of the default "symref" format for HEAD and other symbolic reference files, use symbolic links\&. This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link\&.
 257
 258 .TP
 259 core\&.logAllRefUpdates
 260 If true, git\-update\-ref will append a line to "$GIT_DIR/logs/<ref>" listing the new SHA1 and the date/time of the update\&. If the file does not exist it will be created automatically\&. This information can be used to determine what commit was the tip of a branch "2 days ago"\&. This value is false by default (no logging)\&.
 261
 262 .TP
 263 core\&.repositoryFormatVersion
 264 Internal variable identifying the repository format and layout version\&.
 265
 266 .TP
 267 core\&.sharedRepository
 268 If true, the repository is made shareable between several users in a group (making sure all the files and objects are group\-writable)\&. See \fBgit\-init\-db\fR(1)\&. False by default\&.
 269
 270 .TP
 271 core\&.warnAmbiguousRefs
 272 If true, git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the \&.git/refs/ tree\&. True by default\&.
 273
 274 .TP
 275 alias\&.*
 276 Command aliases for the \fBgit\fR(1) command wrapper \- e\&.g\&. after defining "alias\&.last = cat\-file commit HEAD", the invocation "git last" is equivalent to "git cat\-file commit HEAD"\&. To avoid confusion and troubles with script usage, aliases that hide existing git commands are ignored\&. Arguments are split by spaces, the usual shell quoting and escaping is supported\&. quote pair and a backslash can be used to quote them\&.
 277
 278 .TP
 279 apply\&.whitespace
 280 Tells git\-apply how to handle whitespaces, in the same way as the \fI\-\-whitespace\fR option\&. See \fBgit\-apply\fR(1)\&.
 281
 282 .TP
 283 diff\&.renameLimit
 284 The number of files to consider when performing the copy/rename detection; equivalent to the git diff option \fI\-l\fR\&.
 285
 286 .TP
 287 format\&.headers
 288 Additional email headers to include in a patch to be submitted by mail\&. See \fBgit\-format\-patch\fR(1)\&.
 289
 290 .TP
 291 gitcvs\&.enabled
 292 Whether the cvs pserver interface is enabled for this repository\&. See \fBgit\-cvsserver\fR(1)\&.
 293
 294 .TP
 295 gitcvs\&.logfile
 296 Path to a log file where the cvs pserver interface well... logs various stuff\&. See \fBgit\-cvsserver\fR(1)\&.
 297
 298 .TP
 299 http\&.sslVerify
 300 Whether to verify the SSL certificate when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_NO_VERIFY\fR environment variable\&.
 301
 302 .TP
 303 http\&.sslCert
 304 File containing the SSL certificate when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CERT\fR environment variable\&.
 305
 306 .TP
 307 http\&.sslKey
 308 File containing the SSL private key when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_KEY\fR environment variable\&.
 309
 310 .TP
 311 http\&.sslCAInfo
 312 File containing the certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CAINFO\fR environment variable\&.
 313
 314 .TP
 315 http\&.sslCAPath
 316 Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CAPATH\fR environment variable\&.
 317
 318 .TP
 319 http\&.maxRequests
 320 How many HTTP requests to launch in parallel\&. Can be overridden by the \fIGIT_HTTP_MAX_REQUESTS\fR environment variable\&. Default is 5\&.
 321
 322 .TP
 323 http\&.lowSpeedLimit, http\&.lowSpeedTime
 324 If the HTTP transfer speed is less than \fIhttp\&.lowSpeedLimit\fR for longer than \fIhttp\&.lowSpeedTime\fR seconds, the transfer is aborted\&. Can be overridden by the \fIGIT_HTTP_LOW_SPEED_LIMIT\fR and \fIGIT_HTTP_LOW_SPEED_TIME\fR environment variables\&.
 325
 326 .TP
 327 i18n\&.commitEncoding
 328 Character encoding the commit messages are stored in; git itself does not care per se, but this information is necessary e\&.g\&. when importing commits from emails or in the gitk graphical history browser (and possibly at other places in the future or in other porcelains)\&. See e\&.g\&. \fBgit\-mailinfo\fR(1)\&. Defaults to \fIutf\-8\fR\&.
 329
 330 .TP
 331 merge\&.summary
 332 Whether to include summaries of merged commits in newly created merge commit messages\&. False by default\&.
 333
 334 .TP
 335 pull\&.octopus
 336 The default merge strategy to use when pulling multiple branches at once\&.
 337
 338 .TP
 339 pull\&.twohead
 340 The default merge strategy to use when pulling a single branch\&.
 341
 342 .TP
 343 show\&.difftree
 344 The default \fBgit\-diff\-tree\fR(1) arguments to be used for \fBgit\-show\fR(1)\&.
 345
 346 .TP
 347 showbranch\&.default
 348 The default set of branches for \fBgit\-show\-branch\fR(1)\&. See \fBgit\-show\-branch\fR(1)\&.
 349
 350 .TP
 351 user\&.email
 352 Your email address to be recorded in any newly created commits\&. Can be overridden by the \fIGIT_AUTHOR_EMAIL\fR and \fIGIT_COMMITTER_EMAIL\fR environment variables\&. See \fBgit\-commit\-tree\fR(1)\&.
 353
 354 .TP
 355 user\&.name
 356 Your full name to be recorded in any newly created commits\&. Can be overridden by the \fIGIT_AUTHOR_NAME\fR and \fIGIT_COMMITTER_NAME\fR environment variables\&. See \fBgit\-commit\-tree\fR(1)\&.
 357
 358 .TP
 359 whatchanged\&.difftree
 360 The default \fBgit\-diff\-tree\fR(1) arguments to be used for \fBgit\-whatchanged\fR(1)\&.
 361
 362 .TP
 363 imap
 364 The configuration variables in the \fIimap\fR section are described in \fBgit\-imap\-send\fR(1)\&.
 365
 366 .SH "AUTHOR"
 367
 368
 369 Written by Johannes Schindelin <Johannes\&.Schindelin@gmx\&.de>
 370
 371 .SH "DOCUMENTATION"
 372
 373
 374 Documentation by Johannes Schindelin, Petr Baudis and the git\-list <git@vger\&.kernel\&.org>\&.
 375
 376 .SH "GIT"
 377
 378
 379 Part of the \fBgit\fR(7) suite
 380