<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</option> <replaceable>command</replaceable></arg>
<arg><option>-auto</option></arg>
<group choice="opt">
<arg choice="plain"><option>-computer-black</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>-fast</option></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>-rules</option> <group choice="plain">
  <arg choice="plain">chinese</arg> <arg choice="plain">japanese</arg>
  </group></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.sgf</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).
</para>
</refsection>

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

<varlistentry>
<term>
<option>-analyze</option> <replaceable>command</replaceable>
</term>
<listitem>
<para>
Initialize analyze command and automatically run it after
changes on the board.
Works only for commands not containing wildcards.
</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>-config</option> <replaceable>file</replaceable>
</term>
<listitem>
<para>
Read command line options and arguments from file.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-fast</option>
</term>
<listitem>
<para>
Use simple and fast graphics for board.
</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 Swing look and feel.
If this option is not used, GoGui tries to use plasticxp (jwindows on
Windows), but shows no error if the look and feel is not found.
If the option is used, the name can be 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>jwindows</term>
<listitem>
<simpara>
com.jgoodies.looks.windows.WindowsLookAndFeel
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>plasticxp</term>
<listitem>
<simpara>
com.jgoodies.looks.plastic.PlasticXPLookAndFeel
</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 until move number.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-program</option> <replaceable>command</replaceable>
</term>
<listitem>
<para>
Go program to attach.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-rules</option> chinese | japanese
</term>
<listitem>
<para>
Set rules.
</para>
</listitem>
</varlistentry>

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

<varlistentry>
<term>
<option>-time</option> <replaceable>timespec</replaceable>
</term>
<listitem>
<para>
Set time limits (min[+min/moves]).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-verbose</option>
</term>
<listitem>
<para>
Print debugging messages.
</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>
