module Env: sig .. end
Carcass environment.
A carcass environement defines how flesh,
bone and body lookups get resolved.
Directories
val etc_dir : Fpath.t
etc_dir is the path to the install's etc directory.
val user_dir : unit -> (Fpath.t, [> Rresult.R.msg ]) Rresult.result
user_dir is the path to the user's carcass directory.
Environments
type
The type for environments.
val v : no_user_dir:bool ->
no_dot_dirs:bool ->
dirs:Fpath.t list ->
flesh:Fpath.t list -> cli:(string * Carcass.Pat.t) list -> t
v ~no_user_dir ~no_dot_dirs ~dirs ~flesh ~cli is an environment such
that looks up are done, in order:
- For flesh, first in
cli, followed by flesh files (starting from
the last one), followed by files d/flesh with d in dirs
(starting from the last one).
- For bones and bodies, first in directory
dirs (starting from
the last one), then in .carcass directories from current
directory up to root (except if no_dot_dirs is true), then
in ~/.carcass (except if no_user_dir is true).