decorate: refactor format_decorations()
[alt-git.git] / Documentation / git-check-mailmap.txt
blob02f441832321e4d6a9a35ad38e98a4ae5af0982e
1 git-check-mailmap(1)
2 ====================
4 NAME
5 ----
6 git-check-mailmap - Show canonical names and email addresses of contacts
9 SYNOPSIS
10 --------
11 [verse]
12 'git check-mailmap' [<options>] <contact>...
15 DESCRIPTION
16 -----------
18 For each ``Name $$<user@host>$$'' or ``$$<user@host>$$'' from the command-line
19 or standard input (when using `--stdin`), look up the person's canonical name
20 and email address (see "Mapping Authors" below). If found, print them;
21 otherwise print the input as-is.
24 OPTIONS
25 -------
26 --stdin::
27         Read contacts, one per line, from the standard input after exhausting
28         contacts provided on the command-line.
31 OUTPUT
32 ------
34 For each contact, a single line is output, terminated by a newline.  If the
35 name is provided or known to the 'mailmap', ``Name $$<user@host>$$'' is
36 printed; otherwise only ``$$<user@host>$$'' is printed.
39 CONFIGURATION
40 -------------
42 See `mailmap.file` and `mailmap.blob` in linkgit:git-config[1] for how
43 to specify a custom `.mailmap` target file or object.
46 MAPPING AUTHORS
47 ---------------
49 See linkgit:gitmailmap[5].
52 GIT
53 ---
54 Part of the linkgit:git[1] suite