package b0

  1. Overview
  2. Docs
Software construction and deployment kit

Install

dune-project
 Dependency

Authors

Maintainers

Sources

b0-0.0.6.tbz
sha512=e9aa779e66c08fc763019f16d4706f465d16c05d6400b58fbd0313317ef33ddea51952e2b058db28e65f7ddb7012f328c8bf02d8f1da17bb543348541a2587f0

doc/b0.std/B0_editor/index.html

Module B0_editorSource

Editor interaction.

Editing

Sourcetype t

The type for editors.

Sourceval find : ?search:B0_std.Cmd.tool_search -> ?cmd:B0_std.Cmd.t -> unit -> (t, string) result

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

  • Ok e or Error _ if cmd is specified and according to whether OS.Cmd.get ?search succeeds
  • Ok e if pager is a tool invocation parsed from the VISUAL environment variable that can be found via Os.Cmd.find ?search.
  • Ok e if pager is a tool invocation parsed from the EDITOR environment variable that can be found via Os.Cmd.find ?search
  • Ok e if Cmd.tool "nano" can be found via Os.Cmd.find ?search.
  • Error _ otherwise.
Sourceval edit_files : t -> B0_std.Fpath.t list -> (B0_std.Os.Cmd.status, string) 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.

Cli interaction

Sourcemodule Env : sig ... end

Environment variables.