Starting Together

The information in this topic was current at the time of release, but the information may change during a release cycle. The most current information is posted at the TogetherSoft website at:
http://www.togethersoft.com/readme/

Launchers

The installation writes the following runtime files to $TOGETHER_HOME$/bin:

Together.exe Native Windows executable (installed only under Windows). It checks the system memory size, sets any necessary variables, and then searches for a compatible Java virtual machine. The search begins with the Sun JRE installed with Together, and proceeds to the system registry if that is not found. The launcher runs Together under the first compatible JRE it finds. If it finds none, it posts an error message and stops.
TogetherCon.exe Native console version of the same program, installed under Windows only. It might be helpful to use version, if you want to redirect console input/output to a file. Run Together.exe/? or TogetherCon.exe/? to see the launchers' parameters.
Together.bat Windows batch file (installed only under Windows). It sets necessary environment variables to default values and launches Together using the Sun JRE installed with Together. You can edit the file to control all the launch parameters if you wish.
Together.sh Shell script file for Linux/UNIX. It sets appropriate environment variables including JAVA_HOME (required), and launches Together using the Sun 1.2 JRE installed with Together. You can edit the file to point to a different Java runtime location if you wish. (Note: The JRE must be 1.2 or higher.)

Use the appropriate launcher file for your operating system to start Together.

Note: Beginning with version 4.0, Together no longer supports the Microsoft virtual machine.

Command-line startup

You can launch Together from the command line of your operating system. This method is optional on some platforms (Windows for example) and preferred on others. Using command-line start-up enables you to use command-line syntax options to do things like...

Open a specific project on startup,
Invoke Together with a shared remote configuration,
Execute some module
Run Together in command mode... i.e., without dialogs and user interactions.

You can use command-line syntax in batch (command, shell script, etc.) files that you write and use to run Together. You can create such files and use them to run Together under different supported JVMs, with different classpaths, etc. (See Reference: Invoking the Together main class ).

About 'command' mode

Running Together in command mode supports absence of user interactions (message boxes, dialogs, inputs) as much as possible. Command mode is useful for running Together modules or accessing other features via the API as part of some external automated process. For example, during a nightly build process you could invoke Together's HTML documantation generation module.

Command mode execution requires careful attention to the use of parameters to construct a proper command line. Check for existence and accessibility of the necessary project and configuration files. When executing a module in command mode, Together automatically exits after completion.

Note that Together system and other modules often display the interactive Save As dialog prompting an output location and/or file. Check for this behavior by running the module from the Modules tab of the Explorer while running Together in normal mode. To avoid user interaction, you may have to alter a module (or write a new one) to automatically specify output parameters. Some modules may have a switch that you can use to specify the output location when running from command mode. (The HTML doc-gen module, for example, has such a switch-- see Reference: Command line parameters: Generating Doc).