Skip to content
Snippets Groups Projects
Commit cdf64a92 authored by erwan's avatar erwan
Browse files

Doc: update the CLI options lists

parent 37787b56
No related branches found
No related tags found
No related merge requests found
......@@ -148,3 +148,7 @@ tags
.vim
# End of https://www.gitignore.io/api/vim,code,ocaml,emacs
/tools/simca/xxx1
/toto
/tools/simca/xxx
/tools/simca/x
# -*- eval: (org-babel-execute-buffer) -*-
# +SETUPFILE: theme-readtheorg-local.setup
#+SETUPFILE: theme-bigblow-local.setup
#+LANGUAGE: en
......@@ -13,7 +14,11 @@
#+AUTHOR: Erwan Jahier
#+TITLE: SASA: a SimulAtor of Self-stabilizing Algorithms
#+LINK: sasa https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/tree/master/%s
# Pour relancer tous les blocks (et maj lees sasa -h and co) : org-babel-execute-buffer
# Pour les lancer 1 par 1 : M-x org-babel-execute-src-block (ctrl-c ctrl-v e)
#
* TL;DR
<<sasa>> SASA is a *Self-stabilizing Algorithms SimulAtor*, based on
......@@ -36,7 +41,7 @@ cd test
cp -rf skeleton my_algo
cd my_algo
make ring.cmxs
sasa ring.dot
sasa ring.dot -l 4
#+END_SRC
SASA source code: https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa
......@@ -164,6 +169,8 @@ sasa -h | grep "\-daemon"
: --locally-central-daemon, -lcd
: --distributed-daemon, -dd
: --custom-daemon, -custd
: --worst-daemon, -wd
: --bad-daemon, -bd <int>
** Running batch simulations with manual daemons
......@@ -254,7 +261,6 @@ with =gnuplot-rif= or =sim2chro=; cf http://www-verimag.imag.fr/DIST-TOOLS/SYNCH
#+BEGIN_SRC sh :results output :exports both
sasa --help
#+END_SRC
#+RESULTS:
#+begin_example
usage: sasa [<option>]* <topology>.dot
......@@ -268,15 +274,25 @@ use -h to see the available options.
Use a Locally Central daemon
(i.e., never activates two neighbors actions in the same step)
--distributed-daemon, -dd
Use a Distributed daemon (which select at least one action)
Use a Distributed daemon (which select at least one action). This is the default daemon.
--custom-daemon, -custd
Use a Custom daemon (forces --rif)
--rif, -rif Follows RIF conventions
--worst-daemon, -wd
Use the daemon that maximizes the potential function
--bad-daemon, -bd <int>
Use a daemon that tries to maximize the potential function,
considering sub-graphs of a given maximal size
--seed, -seed
Set the pseudo-random generator seed of build-in daemons
Set the pseudo-random generator seed of build-in daemons (wins over --replay)
--replay, -replay
Use the last generated seed to replay the last run
--gen-register, -reg
Generates the registering file and exit.
--length, -l <int>
Maximum number of steps to be done (10000 by default).
--version, -version, -v
Display the sasa version and exit.
--verbose, -vl <int>
Set the verbose level
--help, -help, -h
......@@ -284,22 +300,29 @@ use -h to see the available options.
--more, -m Display more options
#+end_example
More =sasa= options:
#+name: sasamore
#+BEGIN_SRC sh :results output :exports both
sasa --more
#+END_SRC
#+RESULTS:
#+RESULTS: sasamore
#+begin_example
--gen-lutin-daemon, -gld
Generate Lutin daemons and exit
--rif, -rif Display only outputs on stdout (i.e., behave as a rif input file)
--no-data-file, -nd
Do not generate any data file
--gen-lustre-oracle-skeleton, -glos
Generate a Lustre oracle skeleton
--list-algos, -algo
Output the algo files used in the dot file and exit.
--dummy-input
Add a dummy input to sasa so that built-in daemon can be used from rdbg
--ignore-first-inputs, -ifi
Ignore first inputs (necessary to use luciole via lurette/rdbg/luciole-rif)
--version, -version, -v
Display the sasa version and exit.
Ignore first inputs (necessary to use luciole via
lurette/rdbg/luciole-rif)
--ocaml-version
Display the version ocaml version sasa was compiled with and exit.
#+end_example
......@@ -336,17 +359,24 @@ This make rule (defined in =Makefile= and =../Makefile.inc=)
2. launches =rdbg= with some arguments. =rdbg= then prompts the user to
enter one of the folling commands:
#+BEGIN_SRC sh :exports results
#+BEGIN_SRC sh :results output :exports both
rdbg -o ring.rif -sut "sasa ring.dot --locally-central-daemon"
#+END_SRC
#+RESULTS:
#+BEGIN_EXAMPLE
[] create a fresh session
[q] quit
[s] do nothing
[/q/s]:
#+END_SRC
#+END_EXAMPLE
#+RESULTS:
By default, the first in the list is executed; hence if you press
=[Return]= without any command, a fresh session is created. More precisely
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment