]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/config/user.txt
Merge branch 'sp/test-i18ngrep' into maint-2.43
[thirdparty/git.git] / Documentation / config / user.txt
CommitLineData
18b421d4 1user.name::
39ab4d09
WH
2user.email::
3author.name::
4author.email::
5committer.name::
6committer.email::
7 The `user.name` and `user.email` variables determine what ends
6cc668c0 8 up in the `author` and `committer` fields of commit
39ab4d09
WH
9 objects.
10 If you need the `author` or `committer` to be different, the
4d542687 11 `author.name`, `author.email`, `committer.name`, or
39ab4d09 12 `committer.email` variables can be set.
cf6cac20 13 All of these can be overridden by the `GIT_AUTHOR_NAME`,
39ab4d09 14 `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
4d542687 15 `GIT_COMMITTER_EMAIL`, and `EMAIL` environment variables.
69e104d7 16+
17Note that the `name` forms of these variables conventionally refer to
18some form of a personal name. See linkgit:git-commit[1] and the
19environment variables section of linkgit:git[1] for more information on
20these settings and the `credential.username` option if you're looking
21for authentication credentials instead.
18b421d4
NTND
22
23user.useConfigOnly::
24 Instruct Git to avoid trying to guess defaults for `user.email`
25 and `user.name`, and instead retrieve the values only from the
26 configuration. For example, if you have multiple email addresses
27 and would like to use a different one for each repository, then
28 with this configuration option set to `true` in the global config
29 along with a name, Git will prompt you to set up an email before
30 making new commits in a newly cloned repository.
31 Defaults to `false`.
32
33user.signingKey::
34 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
35 key you want it to automatically when creating a signed tag or
36 commit, you can override the default selection with this variable.
37 This option is passed unchanged to gpg's --local-user parameter,
38 so you may specify a key using any method that gpg supports.
350a2518
FS
39 If gpg.format is set to `ssh` this can contain the path to either
40 your private ssh key or the public key when ssh-agent is used.
41 Alternatively it can contain a public key prefixed with `key::`
42 directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
2150b6fb 43 needs to be available via ssh-agent. If not set Git will call
350a2518
FS
44 gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
45 first key available. For backward compatibility, a raw key which
46 begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
47 as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
48 use the `key::` form instead.