<refentry id="reference-gogui">

<refmeta>
<refentrytitle>gogui</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source-name">GoGui</refmiscinfo>
<refmiscinfo class="version">GoGui &version;</refmiscinfo>
<refmiscinfo class="manual">GoGui Reference</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gogui</refname>
<refpurpose>Graphical user interface for Go programs.</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>gogui</command>
<arg><option>-analyze-commands</option> <replaceable>file</replaceable></arg>
<arg><option>-auto</option></arg>
<group choice="opt">
<arg choice="plain"><option>-computer-black</option></arg>
<arg choice="plain"><option>-computer-white</option></arg>
<arg choice="plain"><option>-computer-both</option></arg>
<arg choice="plain"><option>-computer-none</option></arg>
</group>
<arg><option>-command</option> <replaceable>command</replaceable></arg>
<arg><option>-config</option> <replaceable>file</replaceable></arg>
<arg><option>-gtpfile</option> <replaceable>filename</replaceable></arg>
<arg><option>-komi</option> <replaceable>value</replaceable></arg>
<arg><option>-laf</option> <replaceable>name</replaceable></arg>
<arg><option>-move</option> <replaceable>n</replaceable></arg>
<arg><option>-program</option> <replaceable>command</replaceable></arg>
<arg><option>-register</option></arg>
<arg><option>-size</option> <replaceable>n</replaceable></arg>
<arg><option>-time</option> <replaceable>timespec</replaceable></arg>
<arg><option>-verbose</option></arg>
<arg><replaceable>file</replaceable></arg>
</cmdsynopsis>

<cmdsynopsis>
<command>gogui</command>
<arg choice="plain"><option>-help</option></arg>
</cmdsynopsis>

<cmdsynopsis>
<command>gogui</command>
<arg choice="plain"><option>-version</option></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsection>
<title>Description</title>
<para>
GoGui is a graphical interface to programs that play the game of Go
and use GTP (Go Text Protocol). This reference describes only the command
line arguments for invoking GoGui. A complete HTML documentation is included
in the GoGui package.
</para>
</refsection>

<refsection>
<title>Options</title>
<variablelist>

<varlistentry>
<term>
<option>-analyze-commands</option> <replaceable>file</replaceable>
</term>
<listitem>
<para>
Use the given file to read analyze command configuration.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-auto</option>
</term>
<listitem>
<para>
Automatically start a new game if the program plays both
colors and a game is finished.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-command</option> <replaceable>command</replaceable>
</term>
<listitem>
<para>
Send GTP command at startup. The argument can contain multiple
commands separated by '\n'.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-computer-black</option>
</term>
<listitem>
<para>
Computer plays Black.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-computer-both</option>
</term>
<listitem>
<para>
Computer plays both sides.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-computer-none</option>
</term>
<listitem>
<para>
Computer plays no side.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-computer-white</option>
</term>
<listitem>
<para>
Computer plays White.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-config</option> <replaceable>file</replaceable>
</term>
<listitem>
<para>
Read command line options and arguments from the given file.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-gtpfile</option> <replaceable>filename</replaceable>
</term>
<listitem>
<para>
Send GTP file at startup.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-help</option>
</term>
<listitem>
<para>
Display help and exit.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-komi</option> <replaceable>value</replaceable>
</term>
<listitem>
<para>
Set the komi value.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-laf</option> <replaceable>name</replaceable>
</term>
<listitem>
<para>
Set the Swing look and feel.
If this option is not used, GoGui tries to use "system" on Linux and Windows,
and "quaqua" on Mac OS/X, but shows no error if the look and feel is not found.
If the option is used, the name can be "default" or an empty string for the
default look and feel of the Java implementation, a full class name, or one of
the following shortcuts:
<variablelist>
<varlistentry>
<term>cross</term>
<listitem>
<simpara>
UIManager.getCrossPlatformLookAndFeelClassName()
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>motif</term>
<listitem>
<simpara>
com.sun.java.swing.plaf.motif.MotifLookAndFeel
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>gtk</term>
<listitem>
<simpara>
com.sun.java.swing.plaf.gtk.GTKLookAndFeel
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>quaqua</term>
<listitem>
<simpara>
ch.randelshofer.quaqua.QuaquaLookAndFeel
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>system</term>
<listitem>
<simpara>
UIManager.getSystemLookAndFeelClassName()
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>windows</term>
<listitem>
<simpara>
com.sun.java.swing.plaf.windows.WindowsLookAndFeel
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-move</option> <replaceable>n</replaceable>
</term>
<listitem>
<para>
Load SGF file given as the main argument until the given move number.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-program</option> <replaceable>command</replaceable>
</term>
<listitem>
<para>
Go program to attach. The argument is the command line to start the
program.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-register</option>
</term>
<listitem>
<para>
Automatically create an entry in the  Program menu if GoGui was invoked with
the option <option>-program</option> and no menu item for a program with the
given command already exists.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-size</option> <replaceable>n</replaceable>
</term>
<listitem>
<para>
Set the board size.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-time</option> <replaceable>timespec</replaceable>
</term>
<listitem>
<para>
Set time limits (basetime[+overtime/moves]).
The base time and overtime (byoyomi) can have an optional unit specifier
(m or min for minutes; s or sec for seconds; default is minutes).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-verbose</option>
</term>
<listitem>
<para>
Print debugging messages. This includes the complete stream of GTP commands.
Compared to the GTP shell, this has the additional advantage that the
commands and responses are written immediately when they are received
and the order of the standard output and standard error stream of the
Go engine will more likely be in the correct order.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-version</option>
</term>
<listitem>
<para>
Print version and exit.
</para>
</listitem>
</varlistentry>

</variablelist>

<para>
<!-- Empty paragraph to enforce some space in JEditorPane (Java 1.5.0) -->
</para>

</refsection>

</refentry>
