Formality®

Tool Invocation Commands

Version O-2018.06, June 2018
Formality® Tool Invocation Commands Version O- 2018.06

Copyright Notice and Proprietary Information

© 2018 Syno ps ys , Inc . All rights res erved. This s o ftware and do c umentatio n c o ntain c o nfidential and pro prietary
info rmatio n that is the pro perty o f Syno ps ys , Inc . The s o ftware and do c umentatio n are furnis hed under a lic ens e
agreement and may be us ed o r c o pied o nly in ac c o rdanc e with the terms o f the lic ens e agreement. No part o f the s o ftware
and do c umentatio n may be repro duc ed, trans mitted, o r trans lated, in any fo rm o r by any means , elec tro nic , mec hanic al,
manual, o ptic al, o r o therwis e, witho ut prio r written permis s io n o f Syno ps ys , Inc ., o r as expres s ly pro vided by the lic ens e
agreement.

Dest inat ion Cont rol St at ement

All tec hnic al data c o ntained in this public atio n is s ubjec t to the expo rt c o ntro l laws o f the United States o f Americ a.
Dis c lo s ure to natio nals o f o ther c o untries c o ntrary to United States law is pro hibited. It is the reader's res po ns ibility to
determine the applic able regulatio ns and to c o mply with them.

Disclaimer
SYNOPSYS, INC., AND ITS LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS
MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE.

Trademarks
Syno ps ys and c ertain Syno ps ys pro duc t names are trademarks o f Syno ps ys , as s et fo rth at
http://www.s yno ps ys .c o m/Co mpany/Pages /Trademarks .as px.
All o ther pro duc t o r c o mpany names may be trademarks o f their res pec tive o wners .

Free and Open-Source Licensing Not ices

If applic able, Free and Open-So urc e So ftware (FOSS) lic ens ing no tic es are available in the pro duc t ins tallatio n.

Third-Part y Links
Any links to third-party webs ites inc luded in this do c ument are fo r yo ur c o nvenienc e o nly. Syno ps ys do es no t endo rs e and
is no t res po ns ible fo r s uc h webs ites and their prac tic es , inc luding privac y prac tic es , availability, and c o ntent.
Syno ps ys , Inc .
690 E. Middlefield Ro ad
Mo untain View, CA 94043
www.s yno ps ys .c o m

Copyright Not ice for t he Command-Line Edit ing Feat ure

© 1992, 1993 The Regents o f the Univers ity o f Califo rnia. All rights res erved. This c o de is derived fro m s o ftware
c o ntributed to Berkeley by Chris to s Zo ulas o f Co rnell Univers ity.
Redis tributio n and us e in s o urc e and binary fo rms , with o r witho ut mo dific atio n, are permitted pro vided that the fo llo wing
c o nditio ns are met:

1. Redis tributio ns o f s o urc e c o de mus t retain the abo ve c o pyright no tic e, this lis t o f c o nditio ns and the fo llo wing
dis c laimer.
2. Redis tributio ns in binary fo rm mus t repro duc e the abo ve c o pyright no tic e, this lis t o f c o nditio ns and the fo llo wing
dis c laimer in the do c umentatio n and/o r o ther materials pro vided with the dis tributio n.
3. All advertis ing materials mentio ning features o r us e o f this s o ftware mus t dis play the fo llo wing ac kno wledgement:
This pro duc t inc ludes s o ftware develo ped by the Univers ity o f Califo rnia, Berkeley and its c o ntributo rs .
4. Neither the name o f the Univers ity no r the names o f its c o ntributo rs may be us ed to endo rs e o r pro mo te pro duc ts
derived fro m this s o ftware witho ut s pec ific prio r written permis s io n.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.

2
Formality® Tool Invocation Commands Version O- 2018.06

Copyright Not ice for t he Line-Edit ing Library

© 1992 Simmule Turner and Ric h Salz . All rights res erved.
This s o ftware is no t s ubjec t to any lic ens e o f the Americ an Telepho ne and Telegraph Co mpany o r o f the Regents o f the
Univers ity o f Califo rnia.
Permis s io n is granted to anyo ne to us e this s o ftware fo r any purpo s e o n any c o mputer s ys tem, and to alter it and
redis tribute it freely, s ubjec t to the fo llo wing res tric tio ns :

1. The autho rs are no t res po ns ible fo r the c o ns equenc es o f us e o f this s o ftware, no matter ho w awful, even if they
aris e fro m flaws in it.
2. The o rigin o f this s o ftware mus t no t be mis repres ented, either by explic it c laim o r by o mis s io n. Sinc e few us ers
ever read s o urc es , c redits mus t appear in the do c umentatio n.
3. Altered vers io ns mus t be plainly marked as s uc h, and mus t no t be mis repres ented as being the o riginal s o ftware.
Sinc e few us ers ever read s o urc es , c redits mus t appear in the do c umentatio n.
4. This no tic e may no t be remo ved o r altered.

Contents 3
Formality® Tool Invocation Commands Version O- 2018.06

Cont ent s

fm_shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
...........
formality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7. . . . . . . . . . .

fm_shell 4
Formality® Tool Invocation Commands Version O- 2018.06

fm_shell
Runs the Formality shell.

SYNTAX
fm_shell
[ -root path_name ]
[ -work_path path_name ]
[ -32 | -32bit ]
[ -64 | -64bit ]
[ -session session_file_name ]
[ -x command_string ]
[ -file file_name ]
[ -name_suffix suffix ]
[ -overwrite ]
[ -no_init ]
[ -version ]

ARGUMENTS
-root path_name

Specifies the Synopsys root path.

-work_path path_name

Specifies a Formality work directory path. All the temporary files and directories that the tool creates,
such as formality.log, fm_shell_command.log, FM_WORK/, or formality_svf/, are stored in the specified
location. Ensure that the specified location is readable and writable.

-32 | -32bit

Invokes the 32-bit executable of the Formality command shell.

-64 | -64bit

Invokes the 64-bit executable of the Formality command shell. This is the default.

-session session_file_name

Specifies a saved Formality session file to restore before displaying the fm_shell prompt. The session is
restored after loading the setup files but before executing the command string specified by the -x

fm_shell 5
Formality® Tool Invocation Commands Version O- 2018.06

option or the script specified by the -file option.

-x command_string

Specifies a command string to execute. The command string can be a string of one or more fm_shell
commands separated by semicolons. These commands are executed before displaying the fm_shell
prompt and before executing the script specified by using the -file option. If the last statement in the
command string is quit, the Formality shell command prompt is not displayed and the tool exits after
executing the command_string.

-file file_name

Executes a file of fm_shell commands specified by the file_name argument before displaying the initial
fm_shell prompt. If the last statement in the file is quit, the Formality shell command prompt is not
displayed and the tool exits after executing the commands in the file.

-name_suffix suffix

Appends the suffix specified by the suffix argument to the names of Formality supplemental log files,
formality.log and fm_shell_command.log. The suffix is also appended to the name of the temporary
work directory, FM_WORK, and to the name of the automated setup file directory, formality_svf, that
Formality creates.

-overwrite

Specifies that the log files and the temporary work directory can be overwritten. Use this option with the
-name_suffix suffix option.

-no_init

Specifies that the .synopsys_fm.setup startup files are not to be executed.

-version

Displays the version number and build date information, and then exits.

DESCRIPTION
The fm_shell command interprets and executes Formality shell commands. The command interpreter is
based on Tcl.

The fm_shell executes commands until you terminate the session using the quit or exit commands. From
the Formality shell, you can also terminate the fm_shell session by pressing Ctrl+D.

To cancel, or interrupt, the command currently executing in fm_shell, press Ctrl+C. The time it takes for a
command to process an interrupt depends upon the type of command. If you press Ctrl+C three times
before a command responds to the interrupt, the Formality shell exits and returns you to the UNIX shell.

For more information, see Formality User's Guide and Reference Manual.

fm_shell 6
Formality® Tool Invocation Commands Version O- 2018.06

SEE ALSO
formality(1)

formality 7
Formality® Tool Invocation Commands Version O- 2018.06

formality
Runs the Formality Graphical User Interface (GUI).

SYNTAX
formality
[-root path_name]
[-work_path path_name]
[-32 | -32bit]
[-64 | -64bit]
[-session session_file_name]
[ -x command_string ]
[-file file_name]
[-name_suffix suffix]
[-overwrite]
[-no_init]
[-version]

Dat a Types
path_name string
session_file_name string
file_name string
suffix string

ARGUMENTS
-root path_name

Specifies the Synopsys root path.

-work_path path_name

Specifies a Formality work directory path. All the temporary files and directories that the tool creates,
such as formality.log, fm_shell_command.log, FM_WORK/, or formality_svf/, are stored in the specified
location. Ensure that the specified location is readable and writable.

-32 | -32bit

Specifies that the 32-bit executable should be used.

-64 | -64bit

formality 8
Formality® Tool Invocation Commands Version O- 2018.06

Specifies that the 64-bit executable should be used. This is the default value.

-session session_file_name

Specifies a saved Formality session file to load before dissplaying the initial fm_shell prompt. The
session is restored after loading the setup files but before executing the command string specified by
the -x option or the script specified by the -file option.

-x command_string

Specifies a command string to execute. The command string can be a string of one or more fm_shell
commands separated by semicolons. The tool executes these commands before displaying the
fm_shell prompt and before executing the script specified by the -file option. If the last statement in
the command string is quit, the tool does not display the Formality shell command prompt and
exits after executing the command string.

-file file_name

Specifies a file containing fm_shell commands to execute before displaying the fm_shell prompt. If
the last statement in the file is quit, the tool exits after executing the commands in the file, and does
not display the Formality shell command prompt.

-name_suffix suffix

Appends the suffix specified by the suffix argument to names of Formality supplemental log files,
formality.log and fm_shell_command.log. The tool also appends the suffix to the name of the
temporary work directory FM_WORK, and to the name of the automated setup file directory,
formality_svf, that it creates.

-overwrite

Specifies that the log files and the temporary work directory can be overwritten. Use this option with the
-name_suffix suffix option.

-no_init

Specifies that the .synopsys_fm.setup startup files are not to be executed.

-version

Displays the version number, build date information, and then exits.

DESCRIPTION
This command provides a graphical user interface (GUI) to the Formality shell.

It interprets and executes Formality shell commands. The Formality command interpreter is based on Tcl.

Formality executes commands until you terminate it using the quit or exit commands. From the
invocation shell, you can also terminate the Formality session by pressing Ctrl+D.

To cancel or interrupt the command currently executing in Formality, press Ctrl+C in the invocation shell or
click the Stop button. The time it takes for a command to process an interrupt depends upon the type of

formality 9
Formality® Tool Invocation Commands Version O- 2018.06

command. If you press Ctrl+C three times before a command responds to the interrupt, Formality exits
and returns you to the UNIX shell.

For more information, see Formality User's Guide and Reference Manual.

SEE ALSO
fm_shell(1)

formality 10