Chapter 1. Invocation

Table of Contents

General
GoGui on Unix
GoGui on Windows
GoGui on Mac OS X

General

GoGui can be invoked with the command:

java -jar gogui.jar [options] [file]

using the file gogui.jar in the lib subdirectory.

The command line for executing the actual Go program can be given with the -program option. Otherwise, GoGui will start with the Go program attached in the previous session, or without Go program if none was attached. You can attach and detach a Go program at any time by using the Attach, New Program and Detach menu items from the Program menu.

See gogui(1) for a complete listing of the possible command line options to gogui.

GoGui on Unix

For Unix systems, there are launcher scripts in the bin directory. The launcher scripts respect the environment variable GOGUI_JAVA_HOME, if defined, and look for the jar files in ../lib relative to the bin directory. You can add the bin directory of GoGui to your PATH environment variable. The invocation is then simply:

gogui [options] [file]

To register GoGui as a handler for SGF files, you can configure a new file association for the type application/x-go-sgf and the file name pattern *.sgf to execute gogui.

For Linux systems, there is a shell script install.sh in the main directory, which will install GoGui on the system, including the creation of desktop menu entries, entries in the help system, and the registration as a handler for SGF files. This script needs to be run as root.

GoGui on Windows

On Windows, the Java installation registers Java as a handler for jar-files and it is possible to launch GoGui by double-clicking on gogui.jar from a file browser. You can also drag a link to this file to the desktop.

GoGui on Mac OS X

On Mac OS X, GoGui can be invoked using the UNIX launcher scripts in the bin directory. It is also possible to create an application bundle for Mac OS X by typing

ant gogui.app

in the main directory. The resulting application bundle will be in build/GoGui.app. This requires that the Ant build system is installed on the system.