package down
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=03d4a5e82da97ac7814f93385d1a216976976ed7b00693c1e4fa24f6ea2e15121b39344bc599b82e1d2fea12d87663810c2aaca920af1d8b4db5682c6ec61dc6
doc/down/Down/Session/index.html
Module Down.Session
Manage sessions.
See the manual.
Sessions
The type for session names. Use ""
to denote the last_name
session.
last_name ()
is the last session name that was used with any of the functions of this module; if any and still existing. Persisted accross ocaml
invocations.
val load : ?silent:bool -> name -> unit
load s
loads and executes session s
. If silent
is true
the result of phrases is not printed out (defaults to false
).
val edit : name -> unit
edit s
edits session s
in your editor. A session is created if s
does not exist.
val of_file : ?replace:bool -> file:string -> name -> unit
of_file ~replace ~file s
takes the contents of file file
and stores it session s
. The function errors if s
exists; unless replace
is true
(defaults to false
).
val delete : name -> unit
delete s
deletes session s
.
Recording
Note. Unsaved recorded phrases are persisted across ocaml
sessions.
val save : ?replace:bool -> name -> unit
save s
saves recorded phrases to s
, stops recording and clears the recorded phrases. The function errors and the recorded phrases are kept intact if s
exists; unless replace
is true
(defaults to false
). See also append
.
val append : name -> unit
append s
is like save
except it appends to s
or creates it if it does not exist.
Stepping
val steps : name -> unit
steps ()
loads a session for stepping through manually via shift-{up,down}
(or C-x C-{p,n}
).
next_step ()
moves to the next step of the stepped session. Usually you do this via shift-down
or C-x C-n
.