[thirdparty/git.git] / Documentation / config / user.txt

user.name::
user.email::
author.name::
author.email::
committer.name::
committer.email::
	The `user.name` and `user.email` variables determine what ends
	up in the `author` and `committer` field of commit
	objects.
	If you need the `author` or `committer` to be different, the
	`author.name`, `author.email`, `committer.name` or
	`committer.email` variables can be set.
	Also, all of these can be overridden by the `GIT_AUTHOR_NAME`,
	`GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
	`GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
	See linkgit:git-commit[1] for more information.

user.useConfigOnly::
	Instruct Git to avoid trying to guess defaults for `user.email`
	and `user.name`, and instead retrieve the values only from the
	configuration. For example, if you have multiple email addresses
	and would like to use a different one for each repository, then
	with this configuration option set to `true` in the global config
	along with a name, Git will prompt you to set up an email before
	making new commits in a newly cloned repository.
	Defaults to `false`.

user.signingKey::
	If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
	key you want it to automatically when creating a signed tag or
	commit, you can override the default selection with this variable.
	This option is passed unchanged to gpg's --local-user parameter,
	so you may specify a key using any method that gpg supports.
Commit	Line	Data
18b421d4	1	user.name::
39ab4d09 WH	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.
bc94e586	16	See linkgit:git-commit[1] for more information.
18b421d4 NTND	17
	18	user.useConfigOnly::
	19	Instruct Git to avoid trying to guess defaults for `user.email`
	20	and `user.name`, and instead retrieve the values only from the
	21	configuration. For example, if you have multiple email addresses
	22	and would like to use a different one for each repository, then
	23	with this configuration option set to `true` in the global config
	24	along with a name, Git will prompt you to set up an email before
	25	making new commits in a newly cloned repository.
	26	Defaults to `false`.
	27
	28	user.signingKey::
	29	If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
	30	key you want it to automatically when creating a signed tag or
	31	commit, you can override the default selection with this variable.
	32	This option is passed unchanged to gpg's --local-user parameter,
	33	so you may specify a key using any method that gpg supports.