Open a document with an external application

Author(s): The Ciao Development Team.

This module provides predicates to open documents with the user's preferred external applications. It is based on external commands typically provided by each operating system (e.g., xdg-open (Linux), cygstart (Windows), open (macOS)).

Usage and interface

Library usage:
:- use_module(library(opendoc)).
Exports:
- Predicates:
  opendoc/1, opendoc/2.

Documentation on exports

PREDICATEopendoc/1

Usage:opendoc(Target)

Opens Target (a file or URL) with the user's preferred application

Call and exit should be compatible with:
(basic_props:term/1)Target is any term.
The following properties should hold at call time:
(term_typing:nonvar/1)Target is currently a term which is not a free variable.

PREDICATEopendoc/2

Usage:opendoc(Target,Opts)

Opens Target (a file or URL) with the user's preferred application. Opts is a subset of [generic, in_emacs] (generic is the default)

Call and exit should be compatible with:
(basic_props:term/1)Target is any term.
(basic_props:list/1)Opts is a list.
The following properties should hold at call time:
(term_typing:nonvar/1)Target is currently a term which is not a free variable.
(term_typing:nonvar/1)Opts is currently a term which is not a free variable.

Documentation on imports

This module has the following direct dependencies:

System library modules:
pathnames, process, terms, lists, system.
Packages:
prelude, initial, condcomp, assertions, assertions/assertions_basic, regtypes, dcg, basicmodes, fsyntax.