blob: 03a920deee8d3feb93ec45ba88397566636c8a16 [file] [log] [blame]
'\" t
.\" Title: git-check-mailmap
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
.\" Date: 2025-10-05
.\" Manual: Git Manual
.\" Source: Git 2.51.0.433.g45547b60ac
.\" Language: English
.\"
.TH "GIT\-CHECK\-MAILMAP" "1" "2025-10-05" "Git 2\&.51\&.0\&.433\&.g45547b" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-check-mailmap \- Show canonical names and email addresses of contacts
.SH "SYNOPSIS"
.sp
.nf
\fIgit check\-mailmap\fR [<options>] <contact>\&...\:
.fi
.SH "DESCRIPTION"
.sp
For each \(lqName <user@host>\(rq, \(lq<user@host>\(rq, or \(lquser@host\(rq from the command\-line or standard input (when using \fB\-\-stdin\fR), look up the person\(cqs canonical name and email address (see "Mapping Authors" below)\&. If found, print them; otherwise print the input as\-is\&.
.SH "OPTIONS"
.PP
\-\-stdin
.RS 4
Read contacts, one per line, from the standard input after exhausting contacts provided on the command\-line\&.
.RE
.PP
\-\-mailmap\-file=<file>
.RS 4
In addition to any configured mailmap files, read the specified mailmap file\&. Entries in this file take precedence over entries in either the default mailmap file or any configured mailmap file\&.
.RE
.PP
\-\-mailmap\-blob=<blob>
.RS 4
Like
\fB\-\-mailmap\-file\fR, but consider the value as a reference to a blob in the repository\&. If both
\fB\-\-mailmap\-file\fR
and
\fB\-\-mailmap\-blob\fR
are specified, entries in
\fB\-\-mailmap\-file\fR
will take precedence\&.
.RE
.SH "OUTPUT"
.sp
For each contact, a single line is output, terminated by a newline\&. If the name is provided or known to the \fImailmap\fR, \(lqName <user@host>\(rq is printed; otherwise only \(lq<user@host>\(rq is printed\&.
.SH "CONFIGURATION"
.sp
See \fBmailmap\&.file\fR and \fBmailmap\&.blob\fR in \fBgit-config\fR(1) for how to specify a custom \&.\fBmailmap\fR target file or object\&.
.SH "MAPPING AUTHORS"
.sp
See \fBgitmailmap\fR(5)\&.
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite