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

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