doc/source/en/TortoiseGit/git_doc/git-mergetool--lib.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-mergetool&#45;&#45;lib(1)">\r
   5 <articleinfo>\r
   6     <title>git-mergetool&#45;&#45;lib(1)</title>\r
   7 <indexterm>\r
   8 <primary>git-mergetool&#45;&#45;lib(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-mergetool--lib - Common git merge tool shell scriptlets</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool&#45;&#45;lib"</emphasis></literallayout>\r
  19 </blockquote>\r
  20 </simplesect>\r
  21 <simplesect id="_description">\r
  22 <title>DESCRIPTION</title>\r
  23 <simpara>This is not a command the end user would want to run.  Ever.\r
  24 This documentation is meant for people who are studying the\r
  25 Porcelain-ish scripts and/or are writing new ones.</simpara>\r
  26 <simpara>The <emphasis>git-mergetool&#45;&#45;lib</emphasis> scriptlet is designed to be sourced (using\r
  27 <emphasis>.</emphasis>) by other shell scripts to set up functions for working\r
  28 with git merge tools.</simpara>\r
  29 <simpara>Before sourcing <emphasis>git-mergetool&#45;&#45;lib</emphasis>, your script must set <emphasis>TOOL_MODE</emphasis>\r
  30 to define the operation mode for the functions listed below.\r
  31 <emphasis>diff</emphasis> and <emphasis>merge</emphasis> are valid values.</simpara>\r
  32 </simplesect>\r
  33 <simplesect id="_functions">\r
  34 <title>FUNCTIONS</title>\r
  35 <variablelist>\r
  36 <varlistentry>\r
  37 <term>\r
  38 get_merge_tool\r
  39 </term>\r
  40 <listitem>\r
  41 <simpara>\r
  42         returns a merge tool.\r
  43 </simpara>\r
  44 </listitem>\r
  45 </varlistentry>\r
  46 <varlistentry>\r
  47 <term>\r
  48 get_merge_tool_cmd\r
  49 </term>\r
  50 <listitem>\r
  51 <simpara>\r
  52         returns the custom command for a merge tool.\r
  53 </simpara>\r
  54 </listitem>\r
  55 </varlistentry>\r
  56 <varlistentry>\r
  57 <term>\r
  58 get_merge_tool_path\r
  59 </term>\r
  60 <listitem>\r
  61 <simpara>\r
  62         returns the custom path for a merge tool.\r
  63 </simpara>\r
  64 </listitem>\r
  65 </varlistentry>\r
  66 <varlistentry>\r
  67 <term>\r
  68 run_merge_tool\r
  69 </term>\r
  70 <listitem>\r
  71 <simpara>\r
  72         launches a merge tool given the tool name and a true/false\r
  73         flag to indicate whether a merge base is present.\r
  74         <emphasis>$MERGED</emphasis>, <emphasis>$LOCAL</emphasis>, <emphasis>$REMOTE</emphasis>, and <emphasis>$BASE</emphasis> must be defined\r
  75         for use by the merge tool.\r
  76 </simpara>\r
  77 </listitem>\r
  78 </varlistentry>\r
  79 </variablelist>\r
  80 </simplesect>\r
  81 <simplesect id="_git">\r
  82 <title>GIT</title>\r
  83 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
  84 </simplesect>\r
  85 </article>\r