arc-shell.texi

@node The ARC command
@chapter The @code{arc} command

@arc{} has been designed as a command-line tool like shell programs used on 
Unix-like systems (e.g. @code{bash} or @code{csh}). If you execute the @arc{} 
command, the program simply displays a welcome banner and the prompt @code{arc>}:

@smallexample
$ arc
@i{arc 1.5}
@i{Copyright (c) 2002-2015 LaBRI - CNRS & University of Bordeaux.}
@i{All rights reserved.}
@i{This software is distributed under AltaRica Public License (see COPYING file).}

@i{Please report any bug to labri.altarica-bugs[at]diff.u-bordeaux.fr}
@i{or on project webpage http://altarica.labri.fr/}

@i{arc>}
@end smallexample

The user can add arguments to the @arc{} command. An argument that starts with 
a dash (@code{-}) is considered as an option; an argument that is not an option
is considered as a filename. The current version of @arc{} allows the following
options:

@table @option
@item -b 
This option indicates that @arc{} is used in batch mode i.e. it exits after 
the interpretation of all its arguments (files and options). 

@item -c @emph{script}
This option indicates to @arc{} that the next argument, @emph{script}, should 
be interpreted as a list of @code{arc} commands.

@item -d
This option exists only for debugging purposes; it enables the display of many
ugly messages.

@item -h or --help
Display the general syntax of @arc{} command-line arguments and the list of 
allowed options.

@item -q
This option specifies that @arc{} should be run in a @emph{quiet} mode i.e. 
eliminating verbose informating messages. In particular this option disables the
display of the ``Welcome'' banner.

@item -x 
This option enables enable command/response mode. This mode is used by GUI AltaRica studio. It implements a small query/response protocol.

@item -V or --version
This option displays the current version of @arc{}. If @code{-q} is not specified it prints out compilation options and many other data related to the current version in use.
@end table

@section Interactions with @arc{}

Depending of the installation host the @arc{} prompt might be compiled using
the @sc{readline} library (@bibcite{rl}) or not. This library is now used by
many prompt-based programs (e.g. Unix shells) to facilitate interactions with
the user. 

The @sc{readline} library memorizes commands executed by the user. When @arc{} 
exits this @i{history} is stored into a file named by default 
@file{~/.arc_history} but it can be changed using user preferences (see @ref{User preferences})). The next time @arc{} is started interactively, this file 
is reloaded and the user gets back commands of its previous session. 

Each command is essentially the identifier of the command followed by its
arguments. A semi-colon (@t{;}) can be used to separate several commands 
entered on the same command line. For instance, below three commands are 
executed from the same command line: the first one defines a new relation 
@code{R}, the second command displays the cardinality of @code{R} and the last
one outputs elements of @code{R}.
@smallexample
@i{arc>}eval EOF; card R ; show R
@i{eval>}R(i : [0,10]) := <n : [0,10]>(i = 3 * n);
@i{eval>}EOF
@i{R (i : [0, 10]) : 4 elements / 2 nodes}
@i{card (R) = 4}
@i{i = 0}
@i{i = 3}
@i{i = 6}
@i{i = 9}
@end smallexample

The reader familiar with previous version of @arc{} should have noticed that @command{eval} is used in a different way (see @refevalcmd).

Outputs of commands can be redirected into a file or into a pipe to another 
program. This mechanism uses the same notation than the one used by Unix 
shells:
@itemize
@item @i{cmd arg@ind{1} @dots{} arg@ind{n}} @code{>} @i{filename} outputs the
results of the command @i{cmd} into the file called @i{filename}. If 
@i{filename} does not exist it is created; else, it is made empty and 
overwritten.
@item @i{cmd arg@ind{1} @dots{} arg@ind{n}} @code{>>} @i{filename} outputs the
results of the command @i{cmd} at the end of the file called @i{filename}. If 
@i{filename} does not exist it is created.
@item @i{cmd arg@ind{1} @dots{} arg@ind{n}} @code{|} ''@i{program progarg@ind{1} ... progarg@ind{n}}'' outputs the results of the command @i{cmd} to the standard input of
@i{program} executed with arguments @i{progarg@ind{i}}. For instance
@example
apropos preferences | more
@end example
should display the list of user preferences using the pager command 
@command{more}.
@end itemize 

@section General purpose commands

@subsection @command{apropos}
@include apropos-cmd.texi

@subsection @command{cd}
@include cd-cmd.texi

@subsection @command{echo}
@include echo-cmd.texi

@subsection @command{eval}
@include eval-cmd.texi

@subsection @command{exit}
@include exit-cmd.texi

@subsection @command{gc}
@include gc-cmd.texi

@subsection @command{help}
@include help-cmd.texi

@subsection @command{info}
@include info-cmd.texi

@subsection @command{list}
@include list-cmd.texi

@subsection @command{load}
@include load-cmd.texi

@subsection @command{pwd}
@include pwd-cmd.texi

@subsection @command{remove}
@include remove-cmd.texi

@subsection @command{set}
@include set-cmd.texi

@subsection @command{show}
@include show-cmd.texi

@subsection @command{timer}
@include timer-cmd.texi

@section Commands related to AltaRica nodes

@subsection @command{ca}
@include ca-cmd.texi

@subsection @command{depgraph}
@include depgraph-cmd.texi

@subsection @command{flatten}
@include flatten-cmd.texi

@subsection @command{node-info}
@include node-info-cmd.texi

@subsection @command{obfuscate}
@include obfuscate-cmd.texi

@subsection @command{solve}
@include solve-cmd.texi

@subsection @command{stepper}
@include stepper-cmd.texi

@subsection @command{target-reduction}
@include target-reduction-cmd.texi

@subsection @command{to-lustre}
@include to-lustre-cmd.texi

@subsection @command{validate}
@include validate-cmd.texi

@subsection @command{chkctl}
@include chkctl-cmd.texi

@section Commands related to computations using exhaustive engine

@subsection @command{ts}
@include ts-cmd.texi

@subsection @command{ts-marks}
@include ts-marks-cmd.texi

@subsection @command{show-ts-marks}
@include show-ts-marks-cmd.texi

@section Commands related to @mecv{} relations

@subsection @command{card}
@include card-cmd.texi

@subsection @command{check-card}
@include check-card-cmd.texi

@subsection @command{pick}
@include pick-cmd.texi

@subsection @command{store}
@include store-cmd.texi

@section Computation of sequences and fault trees
@subsection @command{cuts} and @command{sequences}
@include cuts-cmd.texi

@section Experimental commands

@subsection @command{diag}
@include diag-cmd.texi

@subsection @command{sat}
@include sat-cmd.texi