package bos

  1. Overview
  2. Docs
Basic OS interaction for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (3)

Authors

  1. T
    The bos programmers

Maintainers

  1. Daniel Bünzli

Sources

bos-0.2.1.tbz
sha512=8daeb8a4c2dd1f2460f6274ada19f4f1b6ebe875ff83a938c93418ce0e6bdb74b8afc5c9a7d410c1c9df2dad030e4fa276b6ed2da580639484e8b5bc92610b1d

doc/bos.setup/Bos_setup/index.html

Module Bos_setupSource

Quick setup for simple programs.

Linking against this module setups Logs and issuing:

open Bos_setup

in a module is sufficient to bring Rresult, Astring and Bos in scope. See also how to use this for interpreted programs.

Interpreted programs

To use Bos and this setup in an interpreted program, start the file with:

#!/usr/bin/env ocaml
#use "topfind"
#require "bos.setup"
open Bos_setup

To allow merlin to function correctly issue M-x merlin-use bos.setup in emacs or :MerlinUse bos.setup in vim.

Results

Sourcetype ('a, 'b) result = ('a, 'b) result =
  1. | Ok of 'a
  2. | Error of 'b

The type for results.

val (>>=) : ('a, 'b) result -> ('a -> ('c, 'b) result) -> ('c, 'b) result

(>>=) is R.(>>=).

val (>>|) : ('a, 'b) result -> ('a -> 'c) -> ('c, 'b) result

(>>|) is R.(>>|).

Sourcemodule R : sig ... end

Astring

Sourceval strf : ('a, Format.formatter, unit, string) format4 -> 'a

strf is Astring.strf.

Sourceval (^) : string -> string -> string

^ is Astring.(^).

Sourcemodule Char : sig ... end
Sourcemodule String : sig ... end

Bos

module Pat : sig ... end
module Cmd : sig ... end
Sourcemodule OS : sig ... end

Fmt & Logs

Note. The following aliases are strictly speaking not needed but they allow to end-users to use them by expressing a single dependency towards bos.setup.

module Fmt : sig ... end
module Logs : sig ... end