Documentation/git-check-mailmap.txt

   1 git-check-mailmap(1)
   2 ====================
   3
   4 NAME
   5 ----
   6 git-check-mailmap - Show canonical names and email addresses of contacts
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git check-mailmap' [<options>] <contact>...
  13
  14
  15 DESCRIPTION
  16 -----------
  17
  18 For each ``Name $$<user@host>$$'', ``$$<user@host>$$'', or ``$$user@host$$''
  19 from the command-line or standard input (when using `--stdin`), look up the
  20 person's canonical name and email address (see "Mapping Authors" below). If
  21 found, print them; otherwise print the input as-is.
  22
  23
  24 OPTIONS
  25 -------
  26 --stdin::
  27         Read contacts, one per line, from the standard input after exhausting
  28         contacts provided on the command-line.
  29
  30 --mailmap-file=<file>::
  31         In addition to any configured mailmap files, read the specified
  32         mailmap file. Entries in this file take precedence over entries in
  33         either the default mailmap file or any configured mailmap file.
  34
  35 --mailmap-blob=<blob>::
  36         Like `--mailmap-file`, but consider the value as a reference to a
  37         blob in the repository. If both `--mailmap-file` and
  38         `--mailmap-blob` are specified, entries in `--mailmap-file` will
  39         take precedence.
  40
  41 OUTPUT
  42 ------
  43
  44 For each contact, a single line is output, terminated by a newline.  If the
  45 name is provided or known to the 'mailmap', ``Name $$<user@host>$$'' is
  46 printed; otherwise only ``$$<user@host>$$'' is printed.
  47
  48
  49 CONFIGURATION
  50 -------------
  51
  52 See `mailmap.file` and `mailmap.blob` in linkgit:git-config[1] for how
  53 to specify a custom `.mailmap` target file or object.
  54
  55
  56 MAPPING AUTHORS
  57 ---------------
  58
  59 See linkgit:gitmailmap[5].
  60
  61
  62 GIT
  63 ---
  64 Part of the linkgit:git[1] suite