Use proper syntax for replaceables in command docs
[git/git.git] / 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>$$'' 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.
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
31 OUTPUT
32 ------
33
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.
37
38
39 MAPPING AUTHORS
40 ---------------
41
42 include::mailmap.txt[]
43
44
45 GIT
46 ---
47 Part of the linkgit:git[1] suite