package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Environment variables
Show PDFs
Cli interaction

Software construction and deployment kit

Install

dune-project

Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (2)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.5.tbz

sha512=00a6868b4dfa34565d0141b335622a81a0e8d5b9e3c6dfad025dabfa3df2db2a1302b492953bbbce30c3a4406c324fcec25250a00b38f6d18a69e15605e3b07e

doc/b0_b00_kit/B00_pdf_viewer/index.html

Module `B00_pdf_viewer`

PDF viewer interaction.

Environment variables

module Env : sig ... end

Environment variables.

Show PDFs

type t

The type for specifying a PDF viewer.

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

find ~search ~pdf_viewer tries to find a PDF viewer in a platform dependent way.

val show : t option -> B0_std.Fpath.t -> (unit, string) Stdlib.result

show pdf_viewer file shows PDF file using the viewer pdf_viewer (if None an error message is returned mentioning no viewer was found).

Cli interaction

val pdf_viewer : 
  ?docs:string ->
  ?opts:string list ->
  unit ->
  B0_std.Cmd.t option Cmdliner.Term.t

pdf_viewer ~docs ~opts () is an option and PDFVIEWER environment variable to use with pdf_viewer argument of find. opts are the cli options and default to "pdf-viewer". docs is the documentation section where the option gets documented.