Merge branch 'pw/rebase-exec-cleanup'
[alt-git.git] / Documentation / config / user.txt
blobec9233b060a82c41dd9a01785a6f1e748ddf0ad9
1 user.name::
2 user.email::
3 author.name::
4 author.email::
5 committer.name::
6 committer.email::
7         The `user.name` and `user.email` variables determine what ends
8         up in the `author` and `committer` field of commit
9         objects.
10         If you need the `author` or `committer` to be different, the
11         `author.name`, `author.email`, `committer.name` or
12         `committer.email` variables can be set.
13         Also, all of these can be overridden by the `GIT_AUTHOR_NAME`,
14         `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
15         `GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
17 Note that the `name` forms of these variables conventionally refer to
18 some form of a personal name.  See linkgit:git-commit[1] and the
19 environment variables section of linkgit:git[1] for more information on
20 these settings and the `credential.username` option if you're looking
21 for authentication credentials instead.
23 user.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`.
33 user.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.
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
43         needs to be available via ssh-agent. If not set git will call
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.