End Users Documentation

Installation

End users should usually use the ready to deploy distributions of JOMDoc in the deploy directory. See the README for a detailed description of the contents in this directory.

• The  GUI installer is a recommended way to quickly get you started with JOMDoc. The installer is portable over the Linux, Windows and Mac operating systems. Usually it should run on double click, however in case it doesn't, you can start it from the terminal with this command:

  java -jar jomdoc-install.jar
  

• To use bleeding-edge or latest it is necessary to check them out with a subversion client, like subversion for Linux or  TortoiseSVN for Windows. For example to download bleeding-edge on Linux, type this command from the terminal:

  svn co https://svn.omdoc.org/repos/jomdoc/deploy/bleeding-edge/ jomdoc-bleeding-edge
  

  See this  tutorial on how to do a checkout with TortoiseSVN.

Command-Line Client

JOMDoc comes with a command-line client, which can be accessed with the jomdoc script on Linux/Mac? and jomdoc.bat on Windows. The client scripts must be in the same directory as jomdoc.jar. To make the client system-wide accessible you have to put it in a directory that is part of the PATH system variable.

• On Linux you can put a link to the client in usr/bin (execute as root user):

  ln -s path_to_jomdoc_client /usr/bin
  

• On Windows see this  tutorial

After the client is set up, you can access it from a terminal, using this general syntax:

jomdoc <subcommand> [options] [args]

To get a general help and a list of available subcommands, type jomdoc help. For example, getting help for the help command:

$ jomdoc help help
help (?, h): Describe the usage of this program or its subcommands.
usage: help [SUBCOMMAND...]

Valid Options:
  --list-bundled-ntns   list bundled notation files that can be used with
                      the -B option of the render command
  --error-codes       possible return values from the jomdoc client

GUI interface

JOMDoc has a simple GUI interface for rendering documents. The GUI interface can be started with the jomdoc client script described in the previous section, with the --gui parameter

$ jomdoc --gui