man1/git-check-mailmap.1

   1 '\" t
   2 .\"     Title: git-check-mailmap
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-20
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.603.g94b60adee3
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-CHECK\-MAILMAP" "1" "2024-09-20" "Git 2\&.46\&.1\&.603\&.g94b60a" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-check-mailmap \- Show canonical names and email addresses of contacts
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit check\-mailmap\fR [<options>] <contact>\&...\:
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 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\&.
  40 .SH "OPTIONS"
  41 .PP
  42 \-\-stdin
  43 .RS 4
  44 Read contacts, one per line, from the standard input after exhausting contacts provided on the command\-line\&.
  45 .RE
  46 .PP
  47 \-\-mailmap\-file=<file>
  48 .RS 4
  49 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\&.
  50 .RE
  51 .PP
  52 \-\-mailmap\-blob=<blob>
  53 .RS 4
  54 Like
  55 \fB\-\-mailmap\-file\fR, but consider the value as a reference to a blob in the repository\&. If both
  56 \fB\-\-mailmap\-file\fR
  57 and
  58 \fB\-\-mailmap\-blob\fR
  59 are specified, entries in
  60 \fB\-\-mailmap\-file\fR
  61 will take precedence\&.
  62 .RE
  63 .SH "OUTPUT"
  64 .sp
  65 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\&.
  66 .SH "CONFIGURATION"
  67 .sp
  68 See \fBmailmap\&.file\fR and \fBmailmap\&.blob\fR in \fBgit-config\fR(1) for how to specify a custom \fB\&.mailmap\fR target file or object\&.
  69 .SH "MAPPING AUTHORS"
  70 .sp
  71 See \fBgitmailmap\fR(5)\&.
  72 .SH "GIT"
  73 .sp
  74 Part of the \fBgit\fR(1) suite