OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-gui.html.xml
diff --git a/doc/source/en/TortoiseGit/git_doc/git-gui.html.xml b/doc/source/en/TortoiseGit/git_doc/git-gui.html.xml
new file mode 100644 (file)
index 0000000..35cb599
--- /dev/null
@@ -0,0 +1,227 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
+\r
+<article lang="en" id="git-gui(1)">\r
+<articleinfo>\r
+    <title>git-gui(1)</title>\r
+        <indexterm>\r
+                <primary>git-gui(1)</primary>\r
+        </indexterm>\r
+</articleinfo>\r
+<simplesect id="_name">\r
+<title>NAME</title>\r
+<simpara>git-gui - A portable graphical interface to Git</simpara>\r
+</simplesect>\r
+<simplesect id="_synopsis">\r
+<title>SYNOPSIS</title>\r
+<simpara><emphasis>git gui</emphasis> [&lt;command&gt;] [arguments]</simpara>\r
+</simplesect>\r
+<simplesect id="_description">\r
+<title>DESCRIPTION</title>\r
+<simpara>A Tcl/Tk based graphical user interface to Git.  <emphasis>git-gui</emphasis> focuses\r
+on allowing users to make changes to their repository by making\r
+new commits, amending existing ones, creating branches, performing\r
+local merges, and fetching/pushing to remote repositories.</simpara>\r
+<simpara>Unlike <emphasis>gitk</emphasis>, <emphasis>git-gui</emphasis> focuses on commit generation\r
+and single file annotation and does not show project history.\r
+It does however supply menu actions to start a <emphasis>gitk</emphasis> session from\r
+within <emphasis>git-gui</emphasis>.</simpara>\r
+<simpara><emphasis>git-gui</emphasis> is known to work on all popular UNIX systems, Mac OS X,\r
+and Windows (under both Cygwin and MSYS).  To the extent possible\r
+OS specific user interface guidelines are followed, making <emphasis>git-gui</emphasis>\r
+a fairly native interface for users.</simpara>\r
+</simplesect>\r
+<simplesect id="_commands">\r
+<title>COMMANDS</title>\r
+<variablelist>\r
+<varlistentry>\r
+<term>\r
+blame\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Start a blame viewer on the specified file on the given\r
+        version (or working directory if not specified).\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+browser\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Start a tree browser showing all files in the specified\r
+        commit (or <emphasis>HEAD</emphasis> by default).  Files selected through the\r
+        browser are opened in the blame viewer.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+citool\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Start <emphasis>git-gui</emphasis> and arrange to make exactly one commit before\r
+        exiting and returning to the shell.  The interface is limited\r
+        to only commit actions, slightly reducing the application&#8217;s\r
+        startup time and simplifying the menubar.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+version\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Display the currently running version of <emphasis>git-gui</emphasis>.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+</variablelist>\r
+</simplesect>\r
+<simplesect id="_examples">\r
+<title>Examples</title>\r
+<variablelist>\r
+<varlistentry>\r
+<term>\r
+git gui blame Makefile\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Show the contents of the file <emphasis>Makefile</emphasis> in the current\r
+        working directory, and provide annotations for both the\r
+        original author of each line, and who moved the line to its\r
+        current location.  The uncommitted file is annotated, and\r
+        uncommitted changes (if any) are explicitly attributed to\r
+        <emphasis>Not Yet Committed</emphasis>.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git gui blame v0.99.8 Makefile\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Show the contents of <emphasis>Makefile</emphasis> in revision <emphasis>v0.99.8</emphasis>\r
+        and provide annotations for each line.  Unlike the above\r
+        example the file is read from the object database and not\r
+        the working directory.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git gui blame --line=100 Makefile\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Loads annotations as described above and automatically\r
+        scrolls the view to center on line <emphasis>100</emphasis>.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git gui citool\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Make one commit and return to the shell when it is complete.\r
+        This command returns a non-zero exit code if the window was\r
+        closed in any way other than by making a commit.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git gui citool --amend\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Automatically enter the <emphasis>Amend Last Commit</emphasis> mode of\r
+        the interface.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git gui citool --nocommit\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Behave as normal citool, but instead of making a commit\r
+        simply terminate with a zero exit code. It still checks\r
+        that the index does not contain any unmerged entries, so\r
+        you can use it as a GUI version of <xref linkend="git-mergetool(1)"/>\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git citool\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Same as <literal>git gui citool</literal> (above).\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git gui browser maint\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Show a browser for the tree of the <emphasis>maint</emphasis> branch.  Files\r
+        selected in the browser can be viewed with the internal\r
+        blame viewer.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+</variablelist>\r
+</simplesect>\r
+<simplesect id="_see_also">\r
+<title>SEE ALSO</title>\r
+<variablelist>\r
+<varlistentry>\r
+<term>\r
+<xref linkend="gitk(1)"/>\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        The git repository browser.  Shows branches, commit history\r
+        and file differences.  gitk is the utility started by\r
+        <emphasis>git-gui</emphasis>'s Repository Visualize actions.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+</variablelist>\r
+</simplesect>\r
+<simplesect id="_other">\r
+<title>Other</title>\r
+<simpara><emphasis>git-gui</emphasis> is actually maintained as an independent project, but stable\r
+versions are distributed as part of the Git suite for the convenience\r
+of end users.</simpara>\r
+<simpara>A <emphasis>git-gui</emphasis> development repository can be obtained from:</simpara>\r
+<literallayout class="monospaced">git clone git://repo.or.cz/git-gui.git</literallayout>\r
+<simpara>or</simpara>\r
+<literallayout class="monospaced">git clone http://repo.or.cz/r/git-gui.git</literallayout>\r
+<simpara>or browsed online at <ulink url="http://repo.or.cz/w/git-gui.git/">http://repo.or.cz/w/git-gui.git/</ulink>.</simpara>\r
+</simplesect>\r
+<simplesect id="_author">\r
+<title>Author</title>\r
+<simpara>Written by Shawn O. Pearce &lt;<ulink url="mailto:spearce@spearce.org">spearce@spearce.org</ulink>&gt;.</simpara>\r
+</simplesect>\r
+<simplesect id="_documentation">\r
+<title>Documentation</title>\r
+<simpara>Documentation by Shawn O. Pearce &lt;<ulink url="mailto:spearce@spearce.org">spearce@spearce.org</ulink>&gt;.</simpara>\r
+</simplesect>\r
+<simplesect id="_git">\r
+<title>GIT</title>\r
+<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
+</simplesect>\r
+</article>\r