Full text search
Command-line options for OmniMark CI

Command-line arguments can appear in any order on the command line. Options are not case sensitive. File names are case sensitive if your file system is case sensitive.

The only argument that is not preceded on the command line by a control argument is the name of each input file. If no input files are specified, the input is read from the standard input.

If the "-source" and "-save" control arguments are both specified, there is no input file to process.

Note that the percent sign (%) can be used on the command line to enter a string of characters such as the single quote ('), double quote ("), and the percent sign itself, by placing a percent sign before them. This is often more easily done inside an arguments file than on the command line because of the command processor's interpretation of characters such as quotation marks.

Also, white space inside arguments files is used only to separate options and file names, so an arguments file can contain several lines of options. This is primarily of interest to users of systems with limited command-line lengths, such as MS-DOS and MS Windows, but can be used on any platform. Commonly specified options can be placed in a single arguments file and accessed using the "-argsfile" option.

The other possible control arguments are listed below, in alphabetical order.

-activate switch-name

activates the OmniMark switch named "switch-name".

-a switch-name

is an abbreviation of the "-activate" argument. This is useful when there is more than one activation required on the command line.

-alog log-path

specifies that any error messages that OmniMark produces are appended to the error file given by "log-path". Unlike "-log" (below), "-alog" appends messages to the end of the file specified by "log-path", if the file exists. If the file does not exist, "-alog" will create it. If neither "-log" nor "-alog" are specified on the command line, error messages are written to the program's standard error stream. On most computer systems, errors will be displayed on the user's screen.

-aof output

specifies "output", the system-specific name of a file into which standard OmniMark output is written. The difference between this option and the "-of" option is that output is written to the end of the named file if it already exists.

-aos stream file

opens and associates the stream "stream" with the file "file" in the same manner as the "-os" argument, except that output is written to the end of the file if it already exists. This argument cannot be specified when the "-source" and "-save" options have both been specified.

-argsfile command-file-path

specifies that some of the contents of the command line are in the arguments file given by "command-file-path". When an "-argsfile command-file-path" option is encountered, the contents of "command-file-path" are immediately processed as if they appeared on the command line, and arguments files can refer to other arguments files.

-brief

disables printing of the identification information that usually appears when OmniMark begins processing.

-counter counter-name value

sets the OmniMark counter named "counter-name" to "value" prior to running an OmniMark program. Any "initial" specification for the specified counter is ignored.

-c counter-name value

is an abbreviation of the "-counter" argument.

-deactivate switch-name

deactivates the OmniMark switch named "switch-name" prior to running an OmniMark program. Any "initial" specification for the specified switch is ignored.

-dea switch-name

is an abbreviation of the "-deactivate" argument.

-define stream-name content

specifies the stream "stream-name", which is to be opened as a buffer and have the contents specified by "content" placed in it, after which it will be closed. The effect of this argument is to have a buffer with defined content when OmniMark starts processing. Each stream may be defined only once. This argument cannot be specified when the "-source" and "-save" options have both been specified.

-d stream-name content

is an abbreviation of the "-define" argument.

-expand

lists the OmniMark source program on the standard output or the "-log" file with comments deleted and macro calls expanded. This option is useful when developing OmniMark programs that use complex macros.

-f argsfile

is an abbreviation of the "-argsfile" option.

-ftrace

causes a trace of function calls and returns to be written to the #error stream.

-help

causes OmniMark to display a list of its command-line options. If given, this display appears in the file named by the "-log" argument.

-herald

runs OmniMark in V2 compatibility mode. In the program being run with this command-line option specified, declarations are optional (although if any are given, all must be given). Also, shelf types must be given where required in V2 and, if no translation type is specified in the program, it is assumed to be a down-translation and not a V3 process program.

-include include-path

specifies a directory in which to look for files to be included. If the file specified in an include declaration within the program cannot be opened, OmniMark looks for a file of the same name in directory "include-path". There can be multiple occurrences of this argument on a command line. OmniMark will inspect the directories in the order in which they occur on the command line until a file of the specified name is found. OmniMark processes "include-path" in a system-independent manner. To look in the "include-path" directory, OmniMark simply appends "include-path" to the front of the file name it is trying to include. This has two consequences. First, the "include-path" must have a trailing directory name separator, as required by the operating system on which OmniMark is being run. Second, OmniMark will not remove any directory name prefixes from a file name before appending the "include-path".

-i include-path

is an abbreviation of the "-include" argument. It is useful for shortening long commands that have multiple "-include" arguments.

-libpath libpath

specifies "libpath", a system-specific directory name. This argument can only be used when running down-translations, up-translations, and context-translations. If the file specified as a system identifier in a library declaration cannot be opened, OmniMark looks for a file of the same name in the directory "libpath". There can be multiple occurrences of this argument on the command line. OmniMark will inspect the directories in the order they occur on the command line until a file of the specified name is found. Note that "libpath" is processed in the same manner as the argument of "-include", so a trailing directory name separator is required at the end of the "libpath", and no directory name prefixes will be removed from a file name before the "libpath" is appended.

-l libpath

is an abbreviation for the "-libpath" argument. It is especially useful for shortening long command lines that have multiple "-libpath" arguments. This argument cannot be specified when the "-source" and "-save" options have both been specified.

-library library

specifies "library", the system-dependent name of the file containing OmniMark library declarations and comments. It allows document-specific bindings of public identifiers to be processed without requiring modification of the OmniMark program. This facility allows OmniMark programs to be run on different systems with different organizations of files. This argument cannot be specified when the "-source" and "-save" options have both been specified.

-limit number

specifies the maximum number of errors that may be reported before processing stops. By default, there is no limit. This option is an abbreviation for "-threshold". "-limit" and "-threshold" are not valid for use with the OmniMark SI virtual machine.

-linger number

specifies the number of seconds to hold on to the license after running the program. This option is used in shell scripts where OmniMark is called repeatedly.

-load saved-application

specifies that the saved OmniMark application is to be loaded from the system-specific file named "saved-application". This option is not available with OmniMark LE.

-log output-file

causes any error messages produced by OmniMark to be written to the system-specific file named "output-file". If this argument is not specified, error messages are written to the program's standard output. On many computer systems, they appear on the user's screen.

-nocount

turns off the message at the end of processing that gives the number of reported errors and warnings. "-nocount" is not valid for use with the OmniMark SI virtual machine.

-noernum

suppresses SGML error code when SGML error and warning messages are displayed.

-nowait

avoids waiting for an available license.

-of output-file

specifies "output-file", the system-specific name of a file into which standard OmniMark output is written. This argument is equivalent to "-os output output-file". This argument cannot be specified when the "-source" and "-save" options have both been specified.

-os stream-file

causes OmniMark to open the specified stream to the indicated file where "stream" is the name of an OmniMark stream and "file" is a system-dependent file name. This argument has the same effect as the OmniMark action open stream as "file" within the OmniMark program, but allows the file name to be specified by the end-user on the command line. More than one "-os" can appear on the command line, binding more than one stream to a file. This argument cannot be specified when the "-source" and "-save" options have both been specified.

-save saved-application

specifies that the saved OmniMark program is to be saved in the system-specific file named "saved-application". This option is not available with OmniMark LE.

-source program

specifies that the OmniMark program is to be read from the file named "program". This argument cannot be specified when the "-load" option has been specified.

-s program

is an abbreviation of the "-source" argument.

-src program

is an abbreviation of the "-source" argument.

-stats

when specified, causes an OmniMark program to generate and output data regarding memory usage and execution times.

-submit submit

specifies "submit", a system-specific directory name. This is a deprecated command-line option that will be removed in a future version of OmniMark. If the file specified in a submit action cannot be opened, OmniMark looks for a file of the same name in directory "submit". There can be multiple occurrences of this argument on a command line. OmniMark will inspect the directories in the order in which they occur on the command line until a file of the specified name is found. Note that "submit" is processed in the same manner as "-include", so a trailing directory name separator is required at the end of the "libpath", and no directory name prefixes will be removed from a file name before the "libpath" is appended. This argument cannot be specified when the "-source" and "-save" options have both been specified. "-submit" is not valid for use with the OmniMark SI virtual machine.

-temp temp

specifies "temp", the system-specific name of the first temporary file used by OmniMark for referent processing. This is a deprecated command-line option that will be removed in a future version of OmniMark. If this argument is not specified and a temporary file is required, the first temporary file used by OmniMark is named "xgm1001.tmp", which is created by OmniMark and is deleted after use. This argument cannot be specified when both the "-source" and "-save" options have been specified. "-temp" is not valid for use with the OmniMark SI virtual machine.

-temppfx dirpath

specifies "temppfx", a prefix used by OmniMark to create temporary files. Note that, since V3R0, the temp file that is generated uses an "om" prefix followed by a randomly generated six-character string. Older versions of OmniMark generated "xgml[number].tmp" files. For example, if "temppfx" is set to "/tmp/", OmniMark will use the prefix to create temporary files with absolute paths as follows:

  /tmp/om[random string].tmp, /tmp/om[randomstring].tmp ...

If this option is not specified, OmniMark uses the directory in which it is running to create the temporary files. Temporary files are required only when referents are used. For this reason, "temppfx" is ignored when no referents are used in the OmniMark program. Note that "temppfx" specifies a prefix as opposed to a path. Setting "temppfx" to "/tmp" will cause OmniMark to create the temporary files "/tmpom[random string].tmp, /tmpom[random string].tmp, . . .", and this would cause problems if you didn't have write permissions in the "/" directory. The options "-temp" and "-temppfx" cannot be used at the same time.

-term

causes the OmniMark program to be read from standard input. An explicit input file or the "-save" option must be given when this option is specified.

-threshold number

specifies the maximum number of errors that may be reported before processing stops. By default, there is no limit.

-version

causes the OmniMark banner with the copyright information, date, and version information to be output to the standard error, and then halts.

-warning

enables the display of informative messages that are usually suppressed.

-x libpath

is an abbreviation of the "-xflpath" argument.

-xflpath libpath

is used to define the path of external function libraries from the command line. This allows programmers to declare function libraries in OmniMark programs without having to specify their precise location. The program will always look for an external function library in the current directory first; if it is not found, it will then search in the paths specified with "-xflpath" on the command line until the file is found.

Additionally, this option simplifies the cross-platform portability of OmniMark programs since the file extension for external function libraries (which in UNIX is usually ".so", in Windows NT is usually ".dll", etc) can also be specified on the command line. If a programmer wants an OmniMark program to be portable in this fashion, only the file name (without the file name extension) of the external function library needs to be specified in the function library declaration.

When using this option to specify the path and file name extension of the external function libraries, "=L" must be used to mark the place in the libpath where the file name of the library (as specified in the library declaration in the OmniMark program) would appear. For example, a typical command line specifying both the path and file name extension for the external function libraries on a UNIX system could be:

  omnimark -xflpath /common/omnimark/lib/=L.so

The "-xflpath" option is processed in the same manner as "-include", so a trailing directory name separator is required at the end of the "libpath".

More than one external function library path may be specified using "-xflpath".

----

[CONTENTS] [CONCEPTS] [SYNTAX] [LIBRARIES] [SAMPLES] [ERRORS] [INDEX]