Command Line Reference

FreeFlyer has the capability to run from a Command Prompt. The execution of Mission Plans from the command line allows quick, successive running of multiple Mission Plans, with or without the FreeFlyer user interface. You can repeat the same runs many times using a batch file to specify the executable and switches. See Creating a Batch File for more information. For more information on creating FreeFlyer movies from the command line, please see the Command Line section of the Generating Movies Guide.

There are a variety of Sample Mission Plans (included with your FreeFlyer installation) that demonstrate various applications of these topics. Continue to the Interfacing with External Resources Samples page to view descriptions and images of these examples.

See the pages listed below for more information on the references available in this section.

•Creating a Batch File

•FF.exe - Executes Mission Plans without the FreeFlyer Graphical User Interface (GUI). Available in both Windows and Linux.

•FreeFlyer.exe - Shows the FreeFlyer GUI. Available in Windows only.

Syntax

Type "FF.exe" or "FreeFlyer.exe" followed by desired switches

FF.exe --version

FreeFlyer.exe --disable-splash-screen

Switches may be specified in any order

The following two lines of code operate in the same manner:

FreeFlyer.exe --disable-splash-screen --mission-plan <PATH TO FILE>

FreeFlyer.exe --mission-plan <PATH TO FILE> --disable-splash-screen

Switches may be specified using their full name or their abbreviation

The following two lines of code operate in the same manner:

FreeFlyer.exe --disable-splash-screen --mission-plan <PATH TO FILE>

FreeFlyer.exe -dss -mp <PATH TO FILE>

Path names are relative to the path in which the command line client is called

C:\Products>"C:\Program Files\FreeFlyer\FreeFlyer.exe" --mission-plan .\MissionPlans\default.MissionPlan

•Present working directory: C:\Products

•Other path names are relative to present working directory (including Mission Plan Lists)

Note: In Linux, the phrase "ff" is symbolically linked to an active version of FreeFlyer so that FF.exe can be called from any directory. By default, the active version is the most recently-installed version of FreeFlyer. The set active version command line switch can be used to change the active version.

Exit Codes

When FreeFlyer.exe or FF.exe finishes executing, an exit code which describes the details of the execution will be returned that the user can retrieve. FreeFlyer returns the following exit codes under the specified circumstances.

Exit Code	Value	Circumstance
SUCCESS	0	FreeFlyer returned successfully.
UNSPECIFIED_ERROR	1	A generic error occurred.
INVALID_COMMAND_LINE_ARGUMENT	2	A command line argument should not be present or has a bad value.
MISSING_COMMAND_LINE_ARGUMENT	3	A command line argument was expected but not found.
FILE_PARSE_ERROR	4	A necessary file could not be parsed.
SCRIPT_ERROR_OCCURRED	5	An error occurred while a Mission Plan was running (FF.exe only)
MISSING_DATA_FILE	6	A data file is missing.
BAD_DIRECTORY_STRUCTURE	7	The directory structure is bad.
INSUFFICIENT_SYSTEM_PRIVILEGES	8	The user doesn't have permissions to read/edit a file/directory.
LICENSE_ERROR	9	A license error, such as downgrading to a higher tier or not having a license available for use, occurred.
INVALID_IDE_MODE_CONFIGURATION	10	An invalid IDE mode was specified.