Merge branch 'jk/save-getenv-result'
[git] / Documentation / config / user.txt
1 user.email::
2         Your email address to be recorded in any newly created commits.
3         Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
4         `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
5
6 user.name::
7         Your full name to be recorded in any newly created commits.
8         Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
9         environment variables.  See linkgit:git-commit-tree[1].
10
11 user.useConfigOnly::
12         Instruct Git to avoid trying to guess defaults for `user.email`
13         and `user.name`, and instead retrieve the values only from the
14         configuration. For example, if you have multiple email addresses
15         and would like to use a different one for each repository, then
16         with this configuration option set to `true` in the global config
17         along with a name, Git will prompt you to set up an email before
18         making new commits in a newly cloned repository.
19         Defaults to `false`.
20
21 user.signingKey::
22         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
23         key you want it to automatically when creating a signed tag or
24         commit, you can override the default selection with this variable.
25         This option is passed unchanged to gpg's --local-user parameter,
26         so you may specify a key using any method that gpg supports.