Module B00_editor

Editor interaction.

Environment variables

module Env : sig ... end

Environment variables.

val envs : unit -> Cmdliner.Term.env_info list

envs () describe the VISUAL and EDITOR environment variables.

Editing

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

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

  1. Ok (Some pager) if pager is a tool invocation parsed from the VISUAL environment variable that can be found via Os.Cmd.find ?search.
  2. Ok (Some pager) if pager is a tool invocation parsed from the EDITOR environment variable that can be found via Os.Cmd.find ?search.
  3. Ok (Some pager) if nano can be found via Os.Cmd.find ?search.
  4. Ok None otherwise.
val edit_files : B00_std.Cmd.t option -> B00_std.Fpath.t list -> (B00_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.