B0_editor (b0.B0

Environment variables

module Env : sig ... end

Environment variables.

val find : 
  ?win_exe:bool ->
  ?search:B0_std.Fpath.t list ->
  unit ->
  (B0_std.Cmd.t option, string) Stdlib.result

find ?win_exe ?search () finds a suitable editor. This is (in order):

Ok (Some pager) if pager is a tool invocation parsed from the VISUAL environment variable that can be found via Os.Cmd.find ?search.
Ok (Some pager) if pager is a tool invocation parsed from the EDITOR environment variable that can be found via Os.Cmd.find ?win_exe ?search.
Ok (Some pager) if nano can be found via Os.Cmd.find ?win_exe ?search.
Ok None otherwise.

val edit_files : 
  B0_std.Cmd.t option ->
  B0_std.Fpath.t list ->
  (B0_std.Os.Cmd.status, string) Stdlib.result

edit-files editor fs uses editor to edit the files fs. If editor is:

None, an error message is returned mentioning that no editor was found.
Some editor invokes the command with files fs and returns the exit status of the program.