package open
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=8485b81977c92a3161ddec2fa73d7031dfa4f9fad3c6f1e22902c6dd39b7a8c7
md5=06ff5e4158525c187ba9049757d5d942
Description
Published: 18 Apr 2018
README
ocaml-open
Conveniently open files such as PDFs in their default applications straigt from OCaml.
Quick start
You can install the library using opam
:
$ opam install open
Then in utop
or ocaml
,
$ ocaml
> #require "open";;
> Open.in_default_app "/home/steffen/ocaml.svg";;
- : bool = true
The boolean returned by Open.in_default_app
indicates whether the open command exited normally:
> Open.in_default_app "/path/to/non-existent.file";;
- : bool = false
API
The tiny API is documented here.
Building from source
Dependencies
The library requires dune
(formerly known as jbuilder) to build, but has no other dependencies.
Building Library and Examples
Run make
to build and make test
to see the library in action. This should open several files from the examples/basic
folder.
There is also a more sophisticated example in examples/graphviz
that requires graphivz and Jane Street's core
(version v0.9.0 or higher). You can build & run it as follows:
jbuilder build @graphviz
Limitations and Implementation
The library has been tested under Linux, MacOS, and Cygwin. There is experimental support for native Windows, but this is untested. The implementation uses
xdg-open
on Linuxopen
on MacOScygstart
on Cygiwn, andcmd start
on Windows.
Suggestion and Contributions
Suggestions and contributions are always welcome. Feel free to submit pull requests.