Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
frama-c
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container Registry
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
pub
frama-c
Commits
f885abb7
Commit
f885abb7
authored
2 years ago
by
Andre Maroneze
Browse files
Options
Downloads
Patches
Plain Diff
[Doc] userman: remove references to -load-script
parent
17c23f39
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/userman/user-gui.tex
+3
-8
3 additions, 8 deletions
doc/userman/user-gui.tex
doc/userman/user-plugins.tex
+18
-18
18 additions, 18 deletions
doc/userman/user-plugins.tex
with
21 additions
and
26 deletions
doc/userman/user-gui.tex
+
3
−
8
View file @
f885abb7
...
...
@@ -142,7 +142,7 @@ The menu bar is organised as follows:
\item
[The analyses menu] provides items for configuring and running plug-ins.
\begin{itemize}
\item
\texttt
{
Configure and run a
nalyses
}
: opens the dialog box shown in
\item
\texttt
{
A
nalyses
}
: opens the dialog box shown in
Figure~
\ref
{
fig:launcher
}
, that allows setting
\FramaC
parameters and
re-running analyses.
\begin{figure}
[htbp!]
...
...
@@ -152,13 +152,8 @@ The menu bar is organised as follows:
\caption
{
The Analysis Configuration Window
}
\label
{
fig:launcher
}
\end{figure}
\item
\texttt
{
Compile and run an ocaml script
}
: allows you to run an
\caml
file as a plug-in (in a way similar to the
option
\optionuse
{
-
}{
load-script
}
, see Section~
\ref
{
sec:use-plugins
}
).
\item
\texttt
{
Load and run an ocaml module
}
: allows you to run a
pre-compiled
\caml
file as a plug-in (in a
way similar to the option
\optionuse
{
-
}{
load-module
}
, see
Section~
\ref
{
sec:use-plugins
}
).
\item
\texttt
{
Load and run an OCaml module
}
: allows you to load a compiled
\caml
module as a plug-in (see Section~
\ref
{
sec:use-plugins
}
).
\item
Other items are plug-in specific.
\end{itemize}
...
...
This diff is collapsed.
Click to expand it.
doc/userman/user-plugins.tex
+
18
−
18
View file @
f885abb7
...
...
@@ -34,29 +34,29 @@ plug-in's documentation for installation instructions.
\section
{
Loading Plug-ins
}
\label
{
sec:use-plugins
}
At launch,
\FramaC
loads all plug-ins in the
directories indicated by
\texttt
{
frama-c
\optionuse
{
-
}{
print-plugin-path
}}
(see
Section~
\ref
{
sec:var-plugin
}
).
\FramaC
can locate plug-ins in additional
directories by using the option
\texttt
{
\optiondef
{
-
}{
add-path
}
<paths>
}
.
To prevent this behavior, you can use option
directories indicated by
\texttt
{
frama-c
\optionuse
{
-
}{
print-plugin-path
}}
.
These directories contain
\texttt
{
META
}
files which are used by Dune to
automatically load these plug-ins.
Like other OCaml libraries,
\FramaC
plug-ins can be located via the environment
variable
\texttt
{
OCAMLPATH
}
\index
{
OCAMLPATH
}
. It does not need to be set by
default, but if you install
\FramaC
in a non-standard directory
(e.g.
\texttt
{
<PREFIX>
}
), you may need to add directory
\texttt
{
<PREFIX>/lib
}
to
\texttt
{
OCAMLPATH
}
.
To prevent
\FramaC
from automatically loading any plug-ins, you can use option
\optiondef
{
-
}{
no-autoload-plugins
}
.
Another way to load a plug-in is to set the
\texttt
{
\optiondef
{
-
}{
load-module
}
<files>
}
or
\texttt
{
\optiondef
{
-
}{
load-script
}
<files>
}
options, using in both cases a
comma-separated list of specifications, which may be one of the following:
\begin{itemize}
\item
an OCaml source file (in which case it will be compiled);
\item
an OCaml object file (
\texttt
{
.cmo
}
or
\texttt
{
.cma
}
if running
\FramaC
in bytecode, or
\texttt
{
.cmxs
}
if running
\FramaC
in native code);
\item
a Findlib package.
\end{itemize}
File extensions for source and object files may be omitted, e.g.
\texttt
{
-load-script file
}
will search for
\texttt
{
file.ml
}
and
\texttt
{
file.cm*
}
(where
\texttt
{
cm*
}
depends if
\FramaC
is running in
bytecode or native code).
\texttt
{
\optiondef
{
-
}{
load-library
}
<dirs>
}
options.
The former accepts either a compiled OCaml module (
\texttt
{
.cma
}
,
\texttt
{
.cmxa
}
,
\texttt
{
.cmxs
}
) or a library name (e.g.
\texttt
{
frama-c-aorai
}
),
while the latter accepts library names (e.g.
\texttt
{
frama-c-aorai
}
).
Both options can accept comma-separated list of names.
File extensions may be omitted, e.g.
\texttt
{
-load-module file
}
will search for
\texttt
{
file.cm*
}
.
\begin{important}
In general, plug-ins must be compiled with the
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment