alarsyo/spot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
spot/doc/org/tools.org
Alexandre Duret-Lutz d02ee34e10 doc: add a spot(7) man page 
Suggested by Akim Demaille.  Fixes #171.

* bin/man/spot.x, bin/spot.cc: New files.
* bin/man/Makefile.am, bin/Makefile.am: Add them.
* doc/org/tools.org, NEWS: Mention the new page.
2016-05-02 10:41:41 +02:00

4.8 KiB
Raw Blame History

Command-line tools installed by Spot {{{SPOTVERSION}}}

This document introduces command-line tools that are installed with the Spot library. We give some examples to highlight possible use-cases but shall not attempt to cover all features exhaustively (please check the man pages for further inspiration).

Conventions

For technical reasons related to the way we generate these pages, we use the following convention when rendering shell commands. The commands issued to the shell are formatted like this with a cyan line on the left:

echo Hello World

And the output of such a command is formatted as follows, with a magenta line on the left:

Hello World

Parts of these documents (e.g., lists of options) are actually the results of shell commands and will be presented as above, even if the corresponding commands are hidden.

Documentation common to multiple tools

Command-line tools

  • randltl Generate random LTL/PSL formulas.
  • ltlfilt Filter, convert, and transform LTL/PSL formulas.
  • genltl Generate LTL formulas from scalable patterns.
  • ltl2tgba Translate LTL/PSL formulas into Büchi automata.
  • ltl2tgta Translate LTL/PSL formulas into Testing automata.
  • ltlcross Cross-compare LTL/PSL-to-automata translators.
  • ltlgrind List formulas similar to but simpler than a given LTL/PSL formula.
  • dstar2tgba Convert ω-automata with any acceptance into variants of Büchi automata.
  • randaut Generate random ω-automata.
  • autfilt Filter, convert, and transform ω-automata.
  • ltldo Run LTL/PSL formulas through other tools using common input and output interfaces.

Man pages

In addition to the above illustrated documentation, Spot also installs man pages for all these tools. These man pages are mostly generated automatically from the --help output of each tool, and often completed with additional text (like examples or bibliography). For convenience, you can browse their HTML versions:

autfilt(1), dstar2tgba(1), genltl(1), ltl2tgba(1), ltl2tgta(1), ltlcross(1), ltldo(1), ltlfilt(1), randaut(1), randltl(1), spot-x(7), spot(7).

Advanced use-cases

Citing

If you want to refer to these tools in an article, please cite one of the following articles:

  • Manipulating LTL formulas using Spot 1.0, Alexandre Duret-Lutz. In Proc. of ATVA'13, LNCS 8172, pp. 442–445. Hanoi, Vietnam, Oct. 2013. (bib | pdf | slides) This focuses on ltlfilt, randltl, and ltlcross.
  • LTL translation improvements in Spot 1.0, Alexandre Duret-Lutz. Int. J. on Critical Computer-Based Systems, 5(1/2):31–54, March 2014. (bib | pdf) This describes the translation from LTL to TGBA used by ltl2tgba and ltl2tgta.
  • Model checking using generalized testing automata, Ala Eddine Ben Salem, Alexandre Duret-Lutz, and Fabrice Kordon. In Transactions on Petri Nets and Other Models of Concurrency (ToPNoC VI), 7400:94–112, 2012. (bib | pdf) This describes the generalized testing automata produced by ltl2tgta.

Check the man page for each tool for additional references about the algorithms or data sources used.