Documentation / git-mailinfo.txton commit Fix documentation grammar typo (0a565de)
   1git-mailinfo(1)
   2===============
   3
   4NAME
   5----
   6git-mailinfo - Extracts patch and authorship from a single e-mail message
   7
   8
   9SYNOPSIS
  10--------
  11'git mailinfo' [-k] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
  12
  13
  14DESCRIPTION
  15-----------
  16Reads a single e-mail message from the standard input, and
  17writes the commit log message in <msg> file, and the patches in
  18<patch> file.  The author name, e-mail and e-mail subject are
  19written out to the standard output to be used by 'git-am'
  20to create a commit.  It is usually not necessary to use this
  21command directly.  See linkgit:git-am[1] instead.
  22
  23
  24OPTIONS
  25-------
  26-k::
  27        Usually the program 'cleans up' the Subject: header line
  28        to extract the title line for the commit log message,
  29        among which (1) remove 'Re:' or 're:', (2) leading
  30        whitespaces, (3) '[' up to ']', typically '[PATCH]', and
  31        then prepends "[PATCH] ".  This flag forbids this
  32        munging, and is most useful when used to read back
  33        'git-format-patch -k' output.
  34
  35-u::
  36        The commit log message, author name and author email are
  37        taken from the e-mail, and after minimally decoding MIME
  38        transfer encoding, re-coded in UTF-8 by transliterating
  39        them.  This used to be optional but now it is the default.
  40+
  41Note that the patch is always used as-is without charset
  42conversion, even with this flag.
  43
  44--encoding=<encoding>::
  45        Similar to -u but if the local convention is different
  46        from what is specified by i18n.commitencoding, this flag
  47        can be used to override it.
  48
  49-n::
  50        Disable all charset re-coding of the metadata.
  51
  52--scissors::
  53        Remove everything in body before a scissors line.  A line that
  54        mainly consists of scissors (either ">8" or "8<") and perforation
  55        (dash "-") marks is called a scissors line, and is used to request
  56        the reader to cut the message at that line.  If such a line
  57        appears in the body of the message before the patch, everything
  58        before it (including the scissors line itself) is ignored when
  59        this option is used.
  60+
  61This is useful if you want to begin your message in a discussion thread
  62with comments and suggestions on the message you are responding to, and to
  63conclude it with a patch submission, separating the discussion and the
  64beginning of the proposed commit log message with a scissors line.
  65+
  66This can enabled by default with the configuration option mailinfo.scissors.
  67
  68--no-scissors::
  69        Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
  70
  71<msg>::
  72        The commit log message extracted from e-mail, usually
  73        except the title line which comes from e-mail Subject.
  74
  75<patch>::
  76        The patch extracted from e-mail.
  77
  78
  79Author
  80------
  81Written by Linus Torvalds <torvalds@osdl.org> and
  82Junio C Hamano <gitster@pobox.com>
  83
  84
  85Documentation
  86--------------
  87Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
  88
  89GIT
  90---
  91Part of the linkgit:git[1] suite