alarsyo/spot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

man: improve typesetting and prepare for html output

Browse source 
* src/bin/man/autfilt.x, src/bin/man/dstar2tgba.x,
src/bin/man/ltl2tgba.x, src/bin/man/ltlcross.x,
src/bin/man/ltlgrind.x, src/bin/man/randltl.x, src/bin/man/spot-x.x:
Improve typesetting and cross-references.
* tools/help2man: Adjust to better detect the optional arguments.
Detect options that are not separated from their description by two
spaces.  Argp output some of those.
* tools/man2html.pl: New file.
* Makefile.am: Distribute it.
* src/bin/ltlfilt.cc: Fix description of --define.
* src/bin/ltlgrind.cc: Fix duplicate description for --help and
--version.  Reorder --help output slightly.
* NEWS: Mention the few fixes.
This commit is contained in:
Alexandre Duret-Lutz 2015-08-12 19:13:45 +02:00
parent 5b75ad5abd
commit f7b65001e9
13 changed files with 290 additions and 159 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Makefile.am
View file

@ -58,8 +58,9 @@ debian/changelog: configure.ac
ACLOCAL_AMFLAGS = -I m4 ACLOCAL_AMFLAGS = -I m4
EXTRA_DIST = HACKING ChangeLog.1 tools/gitlog-to-changelog \ EXTRA_DIST = HACKING ChangeLog.1 tools/gitlog-to-changelog \
tools/help2man tools/test-driver-teamcity $(UTF8) \ tools/help2man tools/man2html.pl \
$(DEBIAN) m4/gnulib-cache.m4 .dir-locals.el tools/test-driver-teamcity $(UTF8) $(DEBIAN) \
m4/gnulib-cache.m4 .dir-locals.el
dist-hook: gen-ChangeLog dist-hook: gen-ChangeLog

9
NEWS
View file

@ -5,11 +5,14 @@ New in spot 1.99.2a (not yet released)
* Bugs fixed * Bugs fixed
- Some acceptance conditions like Fin(0)|Fin(1)|Fin(2)&Inf(3) - Some acceptance conditions like Fin(0)|Fin(1)|Fin(2)&Inf(3)
where not detected as generalized-Rabin. were not detected as generalized-Rabin.
- Unknown arguments for print_hoa() (i.e., option -H in command-line - Unknown arguments for print_hoa() (i.e., option -H in command-line
tools) are now diagnosed. tools) are now diagnosed.
- the CGI script for LTL translation now force transition-based - The CGI script for LTL translation now force transition-based
acceptance on WDBA-minimized automata when TGBA is requested acceptance on WDBA-minimized automata when TGBA is requested.
- ltlgrind --help output had some options documented twice, or
in the wrong place.
- The man page for ltlcross had obsolete examples.
New in spot 1.99.2 (2015-07-18) New in spot 1.99.2 (2015-07-18)

2
src/bin/ltlfilt.cc
View file

@ -114,7 +114,7 @@ static const argp_option options[] =
{ "relabel-bool", OPT_RELABEL_BOOL, "abc|pnn", OPTION_ARG_OPTIONAL, { "relabel-bool", OPT_RELABEL_BOOL, "abc|pnn", OPTION_ARG_OPTIONAL,
"relabel Boolean subexpressions, alphabetically unless " \ "relabel Boolean subexpressions, alphabetically unless " \
"specified otherwise", 0 }, "specified otherwise", 0 },
{ "define", OPT_DEFINE, "[FILENAME]", OPTION_ARG_OPTIONAL, { "define", OPT_DEFINE, "FILENAME", OPTION_ARG_OPTIONAL,
"when used with --relabel or --relabel-bool, output the relabeling map " "when used with --relabel or --relabel-bool, output the relabeling map "
"using #define statements", 0 }, "using #define statements", 0 },
{ "remove-wm", OPT_REMOVE_WM, 0, 0, { "remove-wm", OPT_REMOVE_WM, 0, 0,

8
src/bin/ltlgrind.cc
View file

@ -55,9 +55,6 @@ static const char * argp_program_doc =
"List formulas that are similar to but simpler than a given formula."; "List formulas that are similar to but simpler than a given formula.";
static const argp_option options[] = { static const argp_option options[] = {
{"mutations", 'm', "NUM", 0, "number of mutations to apply to the " \
"formulae (default: 1)", -1},
{"sort", OPT_SORT, 0, 0, "sort the result by formula size", 0},
{0, 0, 0, 0, "Mutation rules (all enabled unless those options are used):", {0, 0, 0, 0, "Mutation rules (all enabled unless those options are used):",
15}, 15},
{"ap-to-const", OPT_AP2CONST, 0, 0, {"ap-to-const", OPT_AP2CONST, 0, 0,
@ -83,6 +80,9 @@ static const argp_option options[] = {
"0 or max to unbounded", 15}, "0 or max to unbounded", 15},
{0, 0, 0, 0, "Output options:", 20}, {0, 0, 0, 0, "Output options:", 20},
{"max-count", 'n', "NUM", 0, "maximum number of mutations to output", 20}, {"max-count", 'n', "NUM", 0, "maximum number of mutations to output", 20},
{"mutations", 'm', "NUM", 0, "number of mutations to apply to the " \
"formulae (default: 1)", 0},
{"sort", OPT_SORT, 0, 0, "sort the result by formula size", 0},
{0, 0, 0, 0, "Miscellaneous options:", -1}, {0, 0, 0, 0, "Miscellaneous options:", -1},
{0, 0, 0, 0, 0, 0} {0, 0, 0, 0, 0, 0}
}; };
@ -171,7 +171,7 @@ main(int argc, char* argv[])
const argp ap = { options, parse_opt, 0, argp_program_doc, children, 0, 0 }; const argp ap = { options, parse_opt, 0, argp_program_doc, children, 0, 0 };
if (int err = argp_parse(&ap, argc, argv, 0, 0, 0)) if (int err = argp_parse(&ap, argc, argv, ARGP_NO_HELP, 0, 0))
exit(err); exit(err);
mut_opts |= opt_all; mut_opts |= opt_all;

1
src/bin/man/autfilt.x
View file

@ -4,3 +4,4 @@ autfilt \- filter, convert, and transform Büchi automata
.\" Add any additional description here .\" Add any additional description here
[SEE ALSO] [SEE ALSO]
.BR spot-x (7) .BR spot-x (7)
.BR dstar2tgba (1)

4
src/bin/man/dstar2tgba.x
View file

@ -37,6 +37,6 @@ LNCS 8461.
Explains the SAT-based minimization techniques that can be used (on Explains the SAT-based minimization techniques that can be used (on
request only) by dstar2tgba to minimize deterministic Büchi automata. request only) by dstar2tgba to minimize deterministic Büchi automata.
[SEE ALSO] [SEE ALSO]
.BR spot-x (7) .BR spot-x (7),
.BR autfilt (1)

171
src/bin/man/ltl2tgba.x
View file

@ -1,13 +1,13 @@
.\" -*- coding: utf-8 -*-
[NAME] [NAME]
ltl2tgba \- translate LTL/PSL formulas into Büchi automata ltl2tgba \- translate LTL/PSL formulas into Büchi automata
[NOTE ON TGBA] [NOTE ON TGBA]
TGBA stands for Transition-based Generalized Büchi Automaton. The TGBA stands for Transition-based Generalized Büchi Automaton. The
name was coined by Dimitra Giannakopoulou and Flavio Lerda in their name was coined by Dimitra Giannakopoulou and Flavio Lerda in their
FORTE'02 paper (From States to Transitions: Improving Translation of FORTE'02 paper (From States to Transitions: Improving Translation of
LTL Formulae to Büchi Automata), although similar automata have been LTL Formulae to Büchi Automata), although similar automata have been
used under different names long before that. used under different names long before that.
.PP
As its name implies a TGBA uses a generalized Büchi acceptance As its name implies a TGBA uses a generalized Büchi acceptance
condition, meanings that a run of the automaton is accepted iff it condition, meanings that a run of the automaton is accepted iff it
visits ininitely often multiple acceptance sets, and it also uses visits ininitely often multiple acceptance sets, and it also uses
@ -16,20 +16,28 @@ transitions. TGBA are often more consise than traditional Büchi
automata. For instance the LTL formula \f(CWGFa & GFb\fR can be automata. For instance the LTL formula \f(CWGFa & GFb\fR can be
translated into a single-state TGBA while a traditional Büchi translated into a single-state TGBA while a traditional Büchi
automaton would need 3 states. Compare automaton would need 3 states. Compare
.PP
% ltl2tgba 'GFa & GFb' .in +4n
.nf
.ft C
% ltl2tgba 'GFa & GFb'
.fi
.PP
with with
.PP
% ltl2tgba --ba 'GFa & GFb' .in +4n
.ft C
.nf
% ltl2tgba --ba 'GFa & GFb'
.fi
.PP
In the dot output produced by the above commands, the membership of In the dot output produced by the above commands, the membership of
the transitions to the various acceptance sets is denoted using names the transitions to the various acceptance sets is denoted using names
in braces. The actuall names do not really matter as they may be in braces. The actuall names do not really matter as they may be
produced by the translation algorithm or altered by any latter produced by the translation algorithm or altered by any latter
postprocessing. postprocessing.
.PP
When the \fB\--ba\fR option is used to request a Büchi automaton, Spot When the \fB\-\-ba\fR option is used to request a Büchi automaton, Spot
builds a TGBA with a single acceptance set, and in which for any state builds a TGBA with a single acceptance set, and in which for any state
either all outgoing transitions are accepting (this is equivalent to either all outgoing transitions are accepting (this is equivalent to
the state being accepting) or none of them are. Double circles are the state being accepting) or none of them are. Double circles are
@ -38,97 +46,116 @@ denoting the accepting transitions are still shown because the
underling structure really is a TGBA. underling structure really is a TGBA.
[NOTE ON LBTT'S FORMAT] [NOTE ON LBTT'S FORMAT]
The format, described at .UR http://www.tcs.hut.fi/Software/lbtt/doc/html/Format-for-automata.html
http://www.tcs.hut.fi/Software/lbtt/doc/html/Format-for-automata.html, LBTT's format
.UE
has support for both transition-based and state based generalized acceptance. has support for both transition-based and state based generalized acceptance.
.PP
Because Spot uses transition-based generalized Büchi automata Because Spot uses transition-based generalized Büchi automata
internally, it will normally use the transition-based flavor of that internally, it will normally use the transition-based flavor of that
format, indicated with a 't' flag after the number of acceptance sets. format, indicated with a 't' flag after the number of acceptance sets.
For instance: For instance:
.PP
% ltl2tgba --lbtt 'GFp0 & GFp1 & FGp2' .in +4n
2 2t // 2 states, 2 transition-based acceptance sets .ft C
0 1 // state 0: initial .nf
0 -1 t // trans. to state 0, no acc., label: true % ltl2tgba --lbtt 'GFp0 & GFp1 & FGp2'
1 -1 | & p0 p2 & p1 p2 // trans. to state 1, no acc., label: (p0&p2)|(p1&p2) 2 2t // 2 states, 2 transition-based acceptance sets
-1 // end of state 0 0 1 // state 0: initial
1 0 // state 1: not initial 0 -1 t // trans. to state 0, no acc., label: true
1 0 1 -1 & & p0 p1 p2 // trans. to state 1, acc. 0 and 1, label: p0&p1&p2 1 -1 | & p0 p2 & p1 p2 // trans. to state 1, no acc., label: (p0&p2)|(p1&p2)
1 0 -1 & & p1 p2 ! p0 // trans. to state 1, acc. 0, label: !p0&p1&p2 -1 // end of state 0
1 1 -1 & & p0 p2 ! p1 // trans. to state 1, acc. 1, label: p0&!p1&p2 1 0 // state 1: not initial
1 -1 & & p2 ! p0 ! p1 // trans. to state 1, no acc., label: !p0&!p1&p2 1 0 1 -1 & & p0 p1 p2 // trans. to state 1, acc. 0 and 1, label: p0&p1&p2
-1 // end if state 1 1 0 -1 & & p1 p2 ! p0 // trans. to state 1, acc. 0, label: !p0&p1&p2
1 1 -1 & & p0 p2 ! p1 // trans. to state 1, acc. 1, label: p0&!p1&p2
1 -1 & & p2 ! p0 ! p1 // trans. to state 1, no acc., label: !p0&!p1&p2
-1 // end if state 1
.fi
.PP
Here, the two acceptance sets are represented by the numbers 0 and 1, Here, the two acceptance sets are represented by the numbers 0 and 1,
and they each contain two transitions (the first transition of state 1 and they each contain two transitions (the first transition of state 1
belongs to both sets). belongs to both sets).
.PP
When both --ba and --lbtt options are used, the state-based flavor of When both \fB\-\-ba\fR and \fB\-\-lbtt\fR options are used,
the state-based flavor of
the format is used instead. Note that the LBTT format supports the format is used instead. Note that the LBTT format supports
generalized acceptance conditions on states, but Spot only use this generalized acceptance conditions on states, but Spot only use this
format for Büchi automata, where there is always only one acceptance format for Büchi automata, where there is always only one acceptance
set. Unlike in the LBTT documentation, we do not use the set. Unlike in the LBTT documentation, we do not use the
optional 's' flag to indicate the state-based acceptance, this way our optional '\fBs\fR' flag to indicate the state-based acceptance, this way our
output is also compatible with that of LBT (see output is also compatible with that of
http://www.tcs.hut.fi/Software/maria/tools/lbt/). .UR http://www.tcs.hut.fi/Software/maria/tools/lbt/
LBT
% ltl2tgba --ba --lbtt FGp0 .UE .
2 1 // 2 states, 1 (state-based) accepance set .PP
0 1 -1 // state 0: initial, non-accepting .in +4n
0 t // trans. to state 0, label: true .ft C
1 p0 // trans. to state 1, label: p0 .nf
-1 // end of state 0 % ltl2tgba --ba --lbtt FGp0
1 0 0 -1 // state 1: not initial, in acceptance set 0 2 1 // 2 states, 1 (state-based) accepance set
1 p0 // trans. to state 0, label: p0 0 1 -1 // state 0: initial, non-accepting
-1 // end if state 1 0 t // trans. to state 0, label: true
1 p0 // trans. to state 1, label: p0
-1 // end of state 0
1 0 0 -1 // state 1: not initial, in acceptance set 0
1 p0 // trans. to state 0, label: p0
-1 // end if state 1
.fi
.PP
You can force ltl2tgba to use the transition-based flavor of the You can force ltl2tgba to use the transition-based flavor of the
format even for Büchi automaton using --lbtt=t. format even for Büchi automaton using \fB\-\-lbtt=t\fR.
.PP
% ltl2tgba --ba --lbtt=t FGp0 .in +4n
2 1t // 2 states, 1 transition-based accepance set. .ft C
0 1 // state 0: initial .nf
0 -1 t // trans. to state 0, no acc., label: true % ltl2tgba --ba --lbtt=t FGp0
1 -1 p0 // trans. to state 1, no acc., label: p0 2 1t // 2 states, 1 transition-based accepance set.
-1 // end of state 0 0 1 // state 0: initial
1 0 // state 1: not initial 0 -1 t // trans. to state 0, no acc., label: true
1 0 -1 p0 // trans. to state 1, acc. 0, label: p0 1 -1 p0 // trans. to state 1, no acc., label: p0
-1 // end if state 1 -1 // end of state 0
1 0 // state 1: not initial
1 0 -1 p0 // trans. to state 1, acc. 0, label: p0
-1 // end if state 1
.fi
.PP
When representing a Büchi automaton using transition-based acceptance, When representing a Büchi automaton using transition-based acceptance,
all transitions leaving accepting states are put into the acceptance set. all transitions leaving accepting states are put into the acceptance set.
.PP
A final note concerns the name of the atomic propositions. The A final note concerns the name of the atomic propositions. The
original LBTT and LBT formats require these atomic propositions to original LBTT and LBT formats require these atomic propositions to
have names such as 'p0', 'p32', ... We extend the format to accept have names such as '\fBp0\fR', '\fBp32\fR', ... We extend the format to accept
atomic proposition with arbitrary names that do not conflict with atomic proposition with arbitrary names that do not conflict with
LBT's operators (e.g. 'i' is the symbol of the implication operator so LBT's operators (e.g. '\fBi\fR' is the symbol of the implication operator so
it may not be used as an atomic proposition), or as double-quoted it may not be used as an atomic proposition), or as double-quoted
strings. Spot will always output atomic-proposition that do not match strings. Spot will always output atomic-proposition that do not match
p[0-9]+ as double-quoted strings. \fBp[0-9]+\fR as double-quoted strings.
.PP
% bin/ltl2tgba --lbtt 'GFa & GFb' .in +4n
1 2t .ft C
0 1 .nf
0 0 1 -1 & "a" "b" % bin/ltl2tgba --lbtt 'GFa & GFb'
0 0 -1 & "b" ! "a" 1 2t
0 1 -1 & "a" ! "b" 0 1
0 -1 & ! "b" ! "a" 0 0 1 -1 & "a" "b"
-1 0 0 -1 & "b" ! "a"
0 1 -1 & "a" ! "b"
0 -1 & ! "b" ! "a"
-1
.fi
[NOTE ON GENERATING MONITORS] [NOTE ON GENERATING MONITORS]
The monitors generated with option \fB\-M\fR are finite state automata The monitors generated with option \fB\-M\fR are finite state automata
used to reject finite words that cannot be extended to infinite words used to reject finite words that cannot be extended to infinite words
compatible with the supplied formula. The idea is that the monitor compatible with the supplied formula. The idea is that the monitor
should progress alongside the system, and can only make decisions should progress alongside the system, and can only make decisions
based on the finite prefix read so far. based on the finite prefix read so far.
.PP
Monitors can be seen as Büchi automata in which all recognized runs are Monitors can be seen as Büchi automata in which all recognized runs are
accepting. As such, the only infinite words they can reject are those accepting. As such, the only infinite words they can reject are those
are not recognized, i.e., infinite words that start with a bad prefix. are not recognized, i.e., infinite words that start with a bad prefix.
.PP
Because of this limited expressiveness, a monitor for some given LTL Because of this limited expressiveness, a monitor for some given LTL
or PSL formula may accept a larger language than the one specified by or PSL formula may accept a larger language than the one specified by
the formula. For instance a monitor for the LTL formula \f(CWa U b\fR the formula. For instance a monitor for the LTL formula \f(CWa U b\fR
@ -136,7 +163,7 @@ will reject (for instance) any word starting with \f(CW!a&!b\fR as
there is no way such a word can validate the formula, but it will not there is no way such a word can validate the formula, but it will not
reject a finite prefix repeating only \f(CWa&!b\fR as such a prefix reject a finite prefix repeating only \f(CWa&!b\fR as such a prefix
could be extented in a way that is comptible with \f(CWa U b\fR. could be extented in a way that is comptible with \f(CWa U b\fR.
.PP
For more information about monitors, we refer the readers to the For more information about monitors, we refer the readers to the
following two papers (the first paper describes the construction of following two papers (the first paper describes the construction of
the second paper in a more concise way): the second paper in a more concise way):

158
src/bin/man/ltlcross.x
View file

@ -1,58 +1,89 @@
.\" -*- coding: utf-8 -*-
[NAME] [NAME]
ltlcross \- cross-compare LTL/PSL translators to Büchi automata ltlcross \- cross-compare LTL/PSL translators to Büchi automata
[DESCRIPTION]
.\" Add any additional description here
[EXAMPLES] [EXAMPLES]
The following commands compare never claims produced by ltl2tgba(1) The following commands compare never claims produced by
and spin(1) and 100 random formulas, using a timeout of 2 minutes. A .BR ltl2tgba (1),
trace of the execution of the two tools, including any potential issue .BR spin (1),
detected, is reported on standard error, while statistics are and
written to \f(CWresults.json\fR. .B lbt
for 100 random formulas, using a timeout of 2 minutes. Because
.B ltlcross
knows those tools, there is no need to specify their input and
output. A trace of the execution of the two tools, including any
potential issue detected, is reported on standard error, while
statistics are written to \f(CWresults.json\fR.
.PP
.in +4n
.nf .nf
.ft C
% randltl \-n100 \-\-tree\-size=20..30 a b c | \e % randltl \-n100 \-\-tree\-size=20..30 a b c | \e
ltlcross \-T120 'ltl2tgba \-s %f >%N' 'spin \-f %s >%N' \-\-json=results.json ltlcross \-T120 ltl2tgba spin lbt \-\-json=results.json
.fi .fi
.LP .PP
The next command compares
The next command compares lbt, ltl3ba, and ltl2tgba(1) on a set of .BR lbt ,
formulas saved in file \f(CWinput.ltl\fR. Statistics are again writen .BR ltl3ba ,
as CSV into \f(CWresults.csv\fR. Note the use of \f(CW%L\fR to and
indicate that the formula passed to lbt should be written into a file .BR ltl2tgba (1)
in LBT's format, and \f(CW%T\fR to read the output in LBTT's format on a set of formulas saved in file \f(CWinput.ltl\fR.
(which is a superset of the format output by LBT). Statistics are again writen
as CSV into \f(CWresults.csv\fR. This examples specify the
input and output for each tool, to show how this can be done.
Note the use of \f(CW%L\fR to indicate that the formula passed t
for the formula in
.BR spin (1)'s
format, and \f(CW%f\fR for the
formula in Spot's format. Each of these tool produces an
automaton in a different format (respectively, LBTT's format,
Spin's never claims, and HOA format), but Spot's parser can
distinguish and understand these three formats.
.PP
.in +4n
.nf .nf
.ft C
% ltlcross \-F input.ltl \-\-csv=results.csv \e % ltlcross \-F input.ltl \-\-csv=results.csv \e
'lbt <%L >%T' \e 'lbt <%L >%O' \e
'ltl3ba \-f %s >%N' \e 'ltl3ba \-f %s >%O' \e
'ltl2tgba \-\-lbtt %f >%T' 'ltl2tgba \-H %f >%O'
.fi .fi
.LP .PP
Rabin or Streett automata output by
Rabin or Streett automata output by ltl2dstar can be read from a .B ltl2dstar
file specified with \f(CW%D\fR. For instance: can be read from a
file specified with \f(CW%D\fR instead of \f(CW%O\fR. For instance:
.PP
.in +4n
.nf .nf
.ft C
% ltlcross \-F input.ltl \e % ltlcross \-F input.ltl \e
'ltl2dstar \-\-ltl2nba=spin:path/ltl2tgba@\-s %L %D' \e 'ltl2dstar \-\-ltl2nba=spin:ltl2tgba@\-s %L %D' \e
'ltl2dstar \-\-automata=streett \-\-ltl2nba=spin:path/ltl2tgba@\-s %L %D' \e 'ltl2dstar \-\-automata=streett \-\-ltl2nba=spin:ltl2tgba@\-s %L %D' \e
.fi .fi
.LP .PP
However, for historical reasons these Rabin and
However because Spot only supports Büchi acceptance, these Rabin and
Streett automata are immediately converted to TGBA before further Streett automata are immediately converted to TGBA before further
processing by ltlcross. This is still interesting to search for bugs processing by
.BR ltlcross .
This is still interesting to search for bugs
in translators to Rabin or Streett automata, but the statistics might in translators to Rabin or Streett automata, but the statistics might
not be very relevant. not be very relevant. If statistics matters to you and you do not want
this conversion to occur, use the HOA format to interface with ltl2dstar:
.PP
.in +4n
.nf
.ft C
% ltlcross \-F input.ltl \e
'ltl2dstar \-\-output\-format=hoa \-\-ltl2nba=spin:ltl2tgba@\-s %L %O' \e
'ltl2dstar \-\-output\-format=hoa \-\-automata=streett \-\-ltl2nba=spin:ltl2tgba@\-s %L %O' \e
.fi
.PP
If you use ltlcross in an automated testsuite just to check for If you use ltlcross in an automated testsuite just to check for
potential problems, avoid the \fB\-\-csv\fR and \fB\-\-json\fR potential problems, avoid the \fB\-\-csv\fR and \fB\-\-json\fR
options: ltlcross is faster when it does not have to compute these options: ltlcross is faster when it does not have to compute these
statistics. statistics.
[ENVIRONMENT VARIABLES] [ENVIRONMENT VARIABLES]
.TP .TP
\fBSPOT_TMPDIR\fR, \fBTMPDIR\fR \fBSPOT_TMPDIR\fR, \fBTMPDIR\fR
These variables control in which directory temporary files (e.g., These variables control in which directory temporary files (e.g.,
@ -61,28 +92,22 @@ translators) are created. \fBTMPDIR\fR is only read if
\fBSPOT_TMPDIR\fR does not exist. If none of these environment \fBSPOT_TMPDIR\fR does not exist. If none of these environment
variables exist, or if their value is empty, files are created in the variables exist, or if their value is empty, files are created in the
current directory. current directory.
.TP .TP
\fBSPOT_TMPKEEP\fR \fBSPOT_TMPKEEP\fR
When this variable is defined, temporary files are not removed. When this variable is defined, temporary files are not removed.
This is mostly useful for debugging. This is mostly useful for debugging.
[OUTPUT DATA] [OUTPUT DATA]
The following columns are output in the CSV or JSON files. The following columns are output in the CSV or JSON files.
.TP
.TP 7
\fBformula\fR \fBformula\fR
The formula translated. The formula translated.
.TP .TP
\fBtool\fR \fBtool\fR
The tool used to translate this formula. This is either the value of the The tool used to translate this formula. This is either the value of the
full \fICOMMANDFMT\fR string specified on the command-line, or, full \fICOMMANDFMT\fR string specified on the command-line, or,
if \fICOMMANDFMT\fR has the form \f(CW{\fISHORTNAME\fR\f(CW}\fR\FiCMD\fR, if \fICOMMANDFMT\fR has the form \f(CW{\fISHORTNAME\fR\f(CW}\fR\fICMD\fR,
the value of \fISHORTNAME\fR. the value of \fISHORTNAME\fR.
.TP .TP
\fBexit_status\fR, \fBexit_code\fR \fBexit_status\fR, \fBexit_code\fR
Information about how the execution of the translator went. If the Information about how the execution of the translator went. If the
@ -90,60 +115,51 @@ option \fB\-\-omit\-missing\fR is given, these two columns are omitted
and only the lines corresponding to successful translation are output. and only the lines corresponding to successful translation are output.
Otherwise, \fBexit_status\fR is a string that can take the following Otherwise, \fBexit_status\fR is a string that can take the following
values: values:
.RS .RS
.TP .TP
\f(CW"ok"\fR \f(CW"ok"\fR
The translator ran succesfully (this does not imply that the produced The translator ran succesfully (this does not imply that the produced
automaton is correct) and ltlcross could parse the resulting automaton is correct) and ltlcross could parse the resulting
automaton. In this case \fBexit_code\fR is always 0. automaton. In this case \fBexit_code\fR is always 0.
.TP .TP
\f(CW"timeout"\fR \f(CW"timeout"\fR
The translator ran for more than the number of seconds The translator ran for more than the number of seconds
specified with the \fB\-\-timeout\fR option. In this specified with the \fB\-\-timeout\fR option. In this
case \fBexit_code\fR is always -1. case \fBexit_code\fR is always -1.
.TP .TP
\f(CW"exit code"\fR \f(CW"exit code"\fR
The translator terminated with a non-zero exit code. The translator terminated with a non-zero exit code.
\fBexit_code\fR contains that value. \fBexit_code\fR contains that value.
.TP .TP
\f(CW"signal"\fR \f(CW"signal"\fR
The translator terminated with a signal. The translator terminated with a signal.
\fBexit_code\fR contains that signal's number. \fBexit_code\fR contains that signal's number.
.TP .TP
\f(CW"parse error"\fR \f(CW"parse error"\fR
The translator terminated normally, but ltlcross could not The translator terminated normally, but ltlcross could not
parse its output. In this case \fBexit_code\fR is always -1. parse its output. In this case \fBexit_code\fR is always -1.
.TP .TP
\f(CW"no output"\fR \f(CW"no output"\fR
The translator terminated normally, but without creating the specified The translator terminated normally, but without creating the specified
output file. In this case \fBexit_code\fR is always -1. output file. In this case \fBexit_code\fR is always -1.
.RE .RE
.TP .TP
\fBtime\fR \fBtime\fR
A floating point number giving the run time of the translator in seconds. A floating point number giving the run time of the translator in seconds.
This is reported for all executions, even failling ones. This is reported for all executions, even failling ones.
.PP .PP
Unless the \fB\-\-omit\-missing\fR option is used, data for all the Unless the \fB\-\-omit\-missing\fR option is used, data for all the
following columns might be missing. following columns might be missing.
.TP .TP
\fBin_type\fR, \fBin_states\fR, \fBin_edges\fR, \fBin_transitions\fR, \fBin_acc\fR , \fBin_scc\fR \fBin_type\fR, \fBin_states\fR, \fBin_edges\fR, \fBin_transitions\fR,
These columns are only output if \f(CW%D\fR appears in any command \fBin_acc\fR , \fBin_scc\fR These columns are only output if
specification, i.e., if any of the tools output some Streett or Rabin \f(CW%D\fR appears in any command specification, i.e., if any of the
automata. In this case \fBin_type\fR contains a string that is either tools output some Streett or Rabin automata. In this case
\f(CWDRA\fR (Deterministic Rabin Automaton) or \f(CWDSA\fR \fBin_type\fR contains a string that is either \f(CWDRA\fR
(Deterministic Streett Automaton). The other columns respectively (Deterministic Rabin Automaton) or \f(CWDSA\fR (Deterministic Streett
give the number of states, edges, transitions, acceptance pairs, and Automaton). The other columns respectively give the number of states,
strongly connected components in that automaton. edges, transitions, acceptance pairs, and strongly connected
components in that automaton.
.TP .TP
\fBstates\fR, \fBedges\fR, \fBtransitions\fR, \fBacc\fR \fBstates\fR, \fBedges\fR, \fBtransitions\fR, \fBacc\fR
The number of states, edges, transitions, and acceptance sets in the The number of states, edges, transitions, and acceptance sets in the
@ -153,13 +169,12 @@ translated automaton. Column \fBedges\fR counts the number of edges
that might have been merged into a formula-labeled edge. For instance that might have been merged into a formula-labeled edge. For instance
an edge labeled by \f(CWtrue\fR will be counted as 2^3=8 transitions if an edge labeled by \f(CWtrue\fR will be counted as 2^3=8 transitions if
the automaton mention 3 atomic propositions. the automaton mention 3 atomic propositions.
.PP
If the translator produced a Streett or Rabin automaton, these columns If the translator produced a Streett or Rabin automaton, these columns
contains the size of a TGBA (or BA) produced by ltlcross from that contains the size of a TGBA (or BA) produced by ltlcross from that
Streett or Rabin automaton. Check \fBin_states\fR, \fBin_edges\fR, Streett or Rabin automaton. Check \fBin_states\fR, \fBin_edges\fR,
\fBin_transitions\fR, and \fBin_acc\fR for statistics about the actual \fBin_transitions\fR, and \fBin_acc\fR for statistics about the actual
input automaton. input automaton.
.TP .TP
\fBscc\fR, \fBnonacc_scc\fR, \fBterminal_scc\fR, \fBweak_scc\fR, \fBstrong_scc\fR \fBscc\fR, \fBnonacc_scc\fR, \fBterminal_scc\fR, \fBweak_scc\fR, \fBstrong_scc\fR
The number of strongly connected components in the automaton. The The number of strongly connected components in the automaton. The
@ -168,18 +183,15 @@ count the SCCs that are non-accepting (a.k.a. transiant), terminal
(recognizes and accepts all words), weak (do not recognize all words, (recognizes and accepts all words), weak (do not recognize all words,
but accepts all recognized words), or strong (accept some words, but but accepts all recognized words), or strong (accept some words, but
reject some recognized words). reject some recognized words).
.TP .TP
\fBnondet_states\fR, \fBnondet_aut\fR \fBnondet_states\fR, \fBnondet_aut\fR
The number of nondeterministic states, and a Boolean indicating whether the The number of nondeterministic states, and a Boolean indicating whether the
automaton is nondeterministic. automaton is nondeterministic.
.TP .TP
\fBterminal_aut\fR, \fBweak_aut\fR, \fBstrong_aut\fR \fBterminal_aut\fR, \fBweak_aut\fR, \fBstrong_aut\fR
Three Boolean used to indicate whether the automaton is terminal (no Three Boolean used to indicate whether the automaton is terminal (no
weak nor strong SCCs), weak (some weak SCCs but no strong SCCs), or strong weak nor strong SCCs), weak (some weak SCCs but no strong SCCs), or strong
(some strong SCCs). (some strong SCCs).
.TP .TP
\fBproduct_states\fR, \fBproduct_transitions\fR, \fBproduct_scc\fR \fBproduct_states\fR, \fBproduct_transitions\fR, \fBproduct_scc\fR
Size of the product between the translated automaton and a randomly Size of the product between the translated automaton and a randomly
@ -198,18 +210,21 @@ over the \fIN\fR products performed.
[BIBLIOGRAPHY] [BIBLIOGRAPHY]
If you would like to give a reference to this tool in an article, If you would like to give a reference to this tool in an article,
we suggest you cite the following paper: we suggest you cite the following paper:
.PP
.TP .TP
\(bu \(bu
Alexandre Duret-Lutz: Manipulating LTL formulas using Spot 1.0. Alexandre Duret-Lutz: Manipulating LTL formulas using Spot 1.0.
Proceedings of ATVA'13. LNCS 8172. Proceedings of ATVA'13. LNCS 8172.
.PP .PP
ltlcross is a Spot-based reimplementation of a tool called LBTT. LBTT .B ltlcross
is a Spot-based reimplementation of a tool called LBTT. LBTT
was developped by Heikki Tauriainen at the Helsinki University of was developped by Heikki Tauriainen at the Helsinki University of
Technology. The main motivation for the reimplementation was to Technology. The main motivation for the reimplementation was to
support PSL, and output more statistics about the translations. support PSL, and output more statistics about the translations.
.PP
The sanity checks performed on the result of each translator (by The sanity checks performed on the result of each translator (by
either LBTT or ltlcross) are described in the following paper: either LBTT or ltlcross) are described in the following paper:
.PP
.TP .TP
\(bu \(bu
H. Tauriainen and K. Heljanko: Testing LTL formula translation into H. Tauriainen and K. Heljanko: Testing LTL formula translation into
@ -227,7 +242,12 @@ equivalent to Test 2 of Tauriainen and Heljanko. If only one
automaton is deterministic, say P1, it can still be used to check we automaton is deterministic, say P1, it can still be used to check we
can be used to check the result of another translators, for instance can be used to check the result of another translators, for instance
checking the emptiness of Comp(P1)*P2. checking the emptiness of Comp(P1)*P2.
.PP
Our implementation will detect and reports problems (like Our implementation will detect and reports problems (like
inconsistencies between two translations) but unlike LBTT it does not inconsistencies between two translations) but unlike LBTT it does not
offer an interactive mode to investigate such problems. offer an interactive mode to investigate such problems.
.PP
Another major difference with LBTT is that ltlcross is
not restricted to generalized Büchi acceptance. It supports
Rabin and Streett automata via ltl2dstar's format, and automata
with arbitrary acceptance conditions via the HOA format.

2
src/bin/man/ltlgrind.x
View file

@ -3,4 +3,4 @@ ltlgrind \- list mutations of a formula.
[DESCRIPTION] [DESCRIPTION]
.\" Add any additional description here .\" Add any additional description here
[SEE ALSO] [SEE ALSO]
.BR ltlcross (1), .BR ltlcross (1)

3
src/bin/man/randltl.x
View file

@ -11,4 +11,5 @@ Alexandre Duret-Lutz: Manipulating LTL formulas using Spot 1.0.
Proceedings of ATVA'13. LNCS 8172. Proceedings of ATVA'13. LNCS 8172.
[SEE ALSO] [SEE ALSO]
.BR genltl (1), .BR genltl (1),
.BR ltlfilt (1) .BR ltlfilt (1),
.BR randaut (1)

1
src/bin/man/spot-x.x
View file

@ -120,3 +120,4 @@ paper to deal with TBA or TGBA.
.BR ltl2tgba (1) .BR ltl2tgba (1)
.BR ltl2tgta (1) .BR ltl2tgta (1)
.BR dstar2tgba (1) .BR dstar2tgba (1)
.BR autfilt (1)

21
tools/help2man
View file

@ -2,7 +2,7 @@
# Generate a short man page from --help and --version output. # Generate a short man page from --help and --version output.
# Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, # Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
# 2010, 2011, 2012 Free Software Foundation, Inc. # 2010, 2011, 2012, 2015 Free Software Foundation, Inc.
# This program is free software; you can redistribute it and/or modify # This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by # it under the terms of the GNU General Public License as published by
@ -485,7 +485,14 @@ while (length)
my $content = ''; my $content = '';
# Option with description. # Option with description.
if (s/^( {1,10}([+-]\S.*?))(?:( +(?!-))|\n( {20,}))(\S.*)\n//) my $descrpat2 = '(?:( +(?!-))|\n( {20,}))(\S.*)\n';
my $descrpat1 = '(?:( (?!-))|\n( {20,}))(\S.*)\n';
if (s/^( {1,10}([+-]\S.*?))$descrpat2//o ||
# Cases where "-x, --option" or "--option" is separated from
# "description" by a single space, because "description" then
# starts on column 29. This is output by argp.
s/^( {2}([+-]\S.{24}))$descrpat1//o ||
s/^( {6}([+-]\S.{20}))$descrpat1//o)
{ {
$matched .= $& if %append; $matched .= $& if %append;
$indent = length ($4 || "$1$3"); $indent = length ($4 || "$1$3");
@ -548,7 +555,8 @@ while (length)
s/\x84//g; s/\x84//g;
# Convert options. # Convert options.
s/(^| |\()(-[][\w=-]+)/$1 . convert_option $2/mge; s/(^| )(-[][\w-]+(?:=[][\w=\/|()'"-]*)?)/$1 . convert_option $2/mge;
s/\((-[][\w-]+(?:=[][\w=\/|()'"-]*)?)\)/"(" . convert_option $1 . ")"/mge;
# Escape remaining hyphens # Escape remaining hyphens
s/-/\x83/g; s/-/\x83/g;
@ -682,10 +690,15 @@ sub convert_option
local $_ = '\fB' . shift; local $_ = '\fB' . shift;
s/-/\x83/g; s/-/\x83/g;
unless (s/\[=(.*)\]$/\\fR[=\\fI$1\\fR]/) if (s/\[=(.*)\]$/\\fR[=\\fI$1\\fR]/)
{
s/\|/\\fR|\\fI/g;
}
else
{ {
s/=(.)/\\fR=\\fI$1/; s/=(.)/\\fR=\\fI$1/;
s/ (.)/ \\fI$1/; s/ (.)/ \\fI$1/;
s/[\[\|\]]/\\fR$&\\fI/g;
$_ .= '\fR'; $_ .= '\fR';
} }

64
tools/man2html.pl Executable file
View file

@ -0,0 +1,64 @@
#!/usr/bin/perl
## -*- coding: utf-8 -*-
## Copyright (C) 2015 Laboratoire de Recherche et Développement de
## l'Epita (LRDE).
## Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6),
## département Systèmes Répartis Coopératifs (SRC), Université Pierre
## et Marie Curie.
##
## This file is part of Spot, a model checking library.
##
## Spot is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or
## (at your option) any later version.
##
## Spot is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
## or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
## License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
use strict;
sub error($)
{
print "$0: ", @_;
exit 1;
}
error "Specify a directory with man pages\n" if @ARGV != 1;
my $dir = @ARGV[0];
opendir(DIR, $dir) or die $!;
while (my $file = readdir(DIR))
{
next unless $file =~ m/\.\d$/;
$file = "$dir/$file";
print "converting $file to $file.html with groff\n";
my $html = `(echo '.HEAD <LINK REL="stylesheet" TYPE="text/css" HREF="https://spot.lrde.epita.fr/spot.css">'
echo '.HEAD <meta name="viewport" content="width=device-width, initial-scale=1">'
cat $file) | groff -Kutf8 -mandoc -Thtml - -P -r`;
$html =~ s|GNU GPL version 3 or later.*http://gnu.org/licenses/gpl.html&gt;|<a href="http://gnu.org/licenses/gpl.html">GNU GPL version 3 or later</a>|s;
$html =~ s|<h2>.*?</h2>|<div class="outline-2">$&</div>|smg;
$html =~ s|(<a href="#.*?">.*?</a><br>\n)+|<div id="table-of-contents"><h2>Table of Contents</h2><div id="text-table-of-contents"><ul>\n$&</ul></div></div>|sm;
$html =~ s|(<a href="#.*?">.*?</a>)<br>|<li>$1</li>|g;
$html =~ s|<p(.*?)>&bull;</p></td>.<td width="10%"></td>.<td width="78%">|<p$1>&bull;</p></td>\n<td width="88%">|smg;
$html =~ s|&lt;spot\@lrde.epita.fr&gt;|&lt;<a href="mailto:spot\@lrde.epita.fr">spot\@lrde.epita.fr</a>&gt;|;
$html =~ s|&lt;(https?://.*)&gt;|&lt;<a href="$1">$1</a>&gt;|;
$html =~ s|<p style="margin-left:11%; margin-top: 1em"><b>([^<>]*?:)\s*<br>|<h3 style="margin-left:11%">$1</h3><p style="margin-left:11%"><b>|smg;
$html =~ s|<p style="margin-left:11%; margin-top: 1em"><b>([^<>]*?:)\s*</b>\s*<br>|<h3 style="margin-left:11%">$1</h3><p style="margin-left:11%">|smg;
$html =~ s|<p style="margin-left:11%; margin-top: 1em"><b>([^<>]*?:)\s*</b></p>|<h3 style="margin-left:11%">$1</h3>|smg;
$html =~ s@<body>@<body class="man"><div id="org-div-home-and-up"><a accesskey="h" href="https://spot.lrde.epita.fr/tools.html"> UP </a>| <a accesskey="H" href="https://spot.lrde.epita.fr/index.html"> HOME </a></div>@;
$html =~ s{<b>([\w-]+)</b>\((\d+)\)}{
(-f "$1.$2") ? "<a href=\"$1.$2.html\"><b>$1</b></a>($2)" : $&;
}xge;
open(FILE, ">$file.html");
print FILE $html;
close(FILE);
}
closedir(DIR);
exit 0;