REFERENCE:

Command line parameters

Basic command-line syntax

Together_starter [Options] [ProjectFile]

where: 

Together_starter	is a command that starts Together. Under Windows, it can be the name of the Windows launcher (Together.exe*), or a batch file (e.g. Together.bat). For other platforms, you might create Together.sh, Together.cmd, etc. depending on the operating system. Alternatively, this can be a complicated command that calls your Java VM, specifying parameters for it, followed by the Together main class name (com.togethersoft.together.Main) followed by any parameters for that class.
Options	are one or more concordant options, starting with hyphen. If an option requires a value, you can use either "=" (equal) or ":" (colon) symbols after the option's name. For example you can type: -script=com.togethersoft.modules.helloworld.HelloJava or  -script:com.togethersoft.modules.helloworld.HelloJava Note: Use colon ( : ) symbol under Windows, since "=" is incorrectly processed by the Windows command line interpreter.
ProjectFile	is the path to a Together project file to be opened. The file name must have .tpr extension. Optional for invoking modules that do not need to access model information from a specific project.

Using the Windows launcher

The installer for Windows platforms installs the Windows-specific launcher Together.exe. The launcher invokes the registered Java virtual machine, prepares a command line for it, and passes any parameters in the input command that don't pertain to itself on through to the main Together class.

For complete parameters of Together.exe see Reference: Together.exe parameters.)

Invoking the Together main class

Under all supported operating systems you can invoke the Together main class directly, specifying any desired or necessary parameters. The name of this class is com.togethersoft.together.Main. Since this can require a complex command that calls your Java VM, specifying parameters for it, followed by the Together main class name, followed by any parameters for it, you will probably prefer to create batch/command/shell script files for this kind of startup. You can find examples of such files in several platform-specific subdirectories in $TOGETHER_HOME$/bin. Use these files directly, configuring as necessary for your system, or use them as models to create your own launcher files.

Parameters of Together's main class

<Project.tpr>	specifies the fully qualified name of Together project file that will automatically open on start-up.
-config.path:<path>	tells Together to search <path> for configuration properties instead of the default hard-coded location. For information on usage see Getting Started Guide: Creating a shared multi-user configuration
-script: <module name>	Automatically run a module or script after opening the specified project.  If name is specified without the full path, Together searches for the module in the default locations (depending on the extension of the given file). For more information, see User's Guide: Working with modules.

Command-line examples

Running modules on start-up

The following command line starts Together and executes the Hello_World module, compiling it if necessary. (Note that the scriptloader.config file must be configured in accordance to your Java environment). The project file name parameter is optional in this case, since Hello_World script does not access project information. Note that Java files and Java classes should be specified with the proper case of letters (Java is the case-sensitive language).

cd %TOGETHER_HOME%<E> bin\Together -script:com.togethersoft.modules.helloworld.HelloJavasamples\java\CashSales\CashSales.tpr

Generating doc from the command line

You can run HTML or RTF documentation generation script from the command line as part of an automated build process, using Together.exe, TogetherCon.exe or umldoc.exe (for Windows users only).

Together.exe launches Together shell and brings you through the entire documentation generation procedure. The main intention behind using TogetherCon.exe and umldoc.exe was to be able to produce documentation without opening Together windows.

When you run Together.exe or TogetherCon.exe in the command line mode, you can select between generating HTML or RTF documentation, specifying the appropriate module name. umldoc.exe utility allows to generate HTML documentation only.

Launching the documentation generation module:

<launcher> [module] [options] <project>

where:

<launcher> is Together.exe, TogetherCon.exe or umldoc.exe

[module] is a script command for the specific utility.

-script=com.togethersoft.modules.genhtml.GenerateHTML for generating HTML documentation;
-script=com.togethersoft.modules.genhdoc.GenerateDocumentation for generating RTF documentation;
Note: This parameter is not required for umldoc.exe, since it executes generateHTML module only.

• [options] are the ones for the command-line GenerateHTML module launcher ($TOGETHER_HOME$\bin\win32\umldoc.exe ) or for GenerateDocumentation. The options are listed below in the tables.
  

• <project> is the path to the project on which to generate documentation;

Options for umldoc.exe:

Option	Description
-overview <file>	Read overview documentation from HTML file
-public	Show only public classes and members
-protected	Show protected/public classes and members (default)
-package	Show package/protected/public classes and members
-private	Show all classes and members
-help	Display command line options
-sourcepath <pathlist>	Specify where to find source files
-classpath <pathlist>	Specify where to find user class files
-d <directory>	Destination directory for output files. Note: Not required for Together.exe, since it initiates the Together documentation generation dialog.
-use	Create class and package usage pages
-version	Include @version paragraphs
-author	Include @author paragraphs
-splitindex	Split index into one file per letter
-windowtitle <text>	Browser window title for the documenation
-doctitle <html-code>	Include title for the package index(first) page
-header <html-code>	Include header text for each page
-footer <html-code>	Include footer text for each page
-bottom <html-code>	Include bottom text for each page
-nodeprecated	Do not include @deprecated information
-nodeprecatedlist	Do not generate deprecated list
-notree	Do not generate class hierarchy
-noindex	Do not generate index
-nohelp	Do not generate help link
-nonavbar	Do not generate navigation bar
-stylesheetfile <path>	Cascading stylesheet file to control appearance & formatting of the generated documentation
-togethersettings	Use settings from config/GenerateHTML.config file
-recurse	Create output for packages specified in [packagenames]and their subpackages
-javadoc	Create the same output as javadoc.exe produces
-browser	Launch HTML browser
-diagrams	Create diagrams' pictures
-navtree	Generate Navigation Tree
-nopackagedependencies	Do not show package dependencies in all class diagrams

Options for gendoc

Each GenDoc option can be either "switch option" or "parameter option". Switch options are represented as

  -option_name

Parameter options should be followed by parameter values

  -option_name parameter_value

There are two option types in GenDoc: the Regular options and the Custom options. Regular options allow to specify the required parameters for the Doc Generator, such as template file, output directory, etc. GenDoc recognizes a fixed number of regular options.

Regular options

Option	Description
-template <path>	template file. if ommitted, the default 'ProjectReport' template will be used: ..modules\gendoc\templates\ProjectReport.tpl
-metamodel <path>	meta-model file; if ommitted, the default meta-model file will be used: ..modules\gendoc\templates\MetaModel.mm
-format <RTF | HTML | TXT>	output format; RTF assumed by default.
-styletemplate <path>	style template file (depends on the output format, e.g. *.dot file for RTF output)
-d <directory>	output destination directory
-f <path>	output file path. This option allows to redirect all GenDoc output to the specified file. The option is compatible with TXT output format only.
-diagrams	include diagram charts
-recurse	create output for packages specified in [packagenames] and their subpackages

Custom options

Any options that are not recognized as the regular options, are considered custom options. There is no fixed list of custom options and they are not directly processed by the Doc Generator. A custom option should always have a parameter. GenDoc stores all passed custom options and their values. Subsequently, when a particular template is processed, the value of any custom option can be obtained by name within the template, using the function getDGOption(String optionName).

This feature allows to pass parameters to the template from command line and adjust the template behavior dynamically.

See also:

User's Guide: Generating Project Documentation