package crunch

  1. Overview
  2. Docs
Convert a filesystem into a static OCaml module

Install

Dune Dependency

Authors

Maintainers

Sources

crunch-2.1.0.tbz
md5=c93bb28306eb29faa3c36796e1c661eb

Description

ocaml-crunch takes a directory of files and compiles them into a standalone OCaml module which serves the contents directly from memory. This can be convenient for libraries that need a few embedded files (such as a web server) and do not want to deal with all the trouble of file configuration.

Run man ocaml-crunch or ocaml-crunch --help for more information:

NAME
       ocaml-crunch - Convert a directory structure into a standalone OCaml
       module that can serve the file contents without requiring an external
       filesystem to be present.

SYNOPSIS
       ocaml-crunch [OPTION]... DIRECTORIES...

ARGUMENTS
       DIRECTORIES
           Directories to recursively walk and crunch.

OPTIONS
       -e VALID EXTENSION, --ext=VALID EXTENSION
           If specified, only these extensions will be included in the
           crunched output. If not specified, then all files will be crunched
           into the output module.

       --help[=FMT] (default=pager)
           Show this help in format FMT (pager, plain or groff).

       -m MODE, --mode=MODE (absent=lwt)
           Interface access mode: 'lwt' or 'plain'. 'lwt' is the default.

       -o OUTPUT, --output=OUTPUT
           Output file for the OCaml module.

       --version
           Show version information.

BUGS
       Email bug reports to <mirage-devel@lists.xenproject.org>.

Tags

org:mirage org:xapi-project

Published: 12 Jul 2017

README

ocaml-crunch -- convert a filesystem into a static OCaml module

ocaml-crunch takes a directory of files and compiles them into a standalone OCaml module which serves the contents directly from memory. This can be convenient for libraries that need a few embedded files (such as a web server) and do not want to deal with all the trouble of file configuration.

Run man ocaml-crunch or ocaml-crunch --help for more information:

NAME
       ocaml-crunch - Convert a directory structure into a standalone OCaml
       module that can serve the file contents without requiring an external
       filesystem to be present.

SYNOPSIS
       ocaml-crunch [OPTION]... DIRECTORIES...

ARGUMENTS
       DIRECTORIES
           Directories to recursively walk and crunch.

OPTIONS
       -e VALID EXTENSION, --ext=VALID EXTENSION
           If specified, only these extensions will be included in the
           crunched output. If not specified, then all files will be crunched
           into the output module.

       --help[=FMT] (default=pager)
           Show this help in format FMT (pager, plain or groff).

       -m MODE, --mode=MODE (absent=lwt)
           Interface access mode: 'lwt' or 'plain'. 'lwt' is the default.

       -o OUTPUT, --output=OUTPUT
           Output file for the OCaml module.

       --version
           Show version information.

BUGS
       Email bug reports to <mirage-devel@lists.xenproject.org>.

Dependencies (3)

  1. jbuilder >= "1.0+beta10"
  2. cmdliner
  3. ocaml >= "4.03.0"

Dev Dependencies (4)

  1. io-page-unix with-test
  2. mirage-kv-lwt with-test & >= "1.0.0" & < "2.0.0"
  3. lwt with-test
  4. cstruct with-test

Used by (18)

  1. cairn
  2. datakit-ci != "0.12.0"
  3. dream >= "1.0.0~alpha2"
  4. eris
  5. graphql-cohttp
  6. graphql-lwt >= "0.3.0" & < "0.8.0"
  7. iocaml
  8. irmin >= "0.8.1" & < "1.0.0"
  9. irmin-http < "2.0.0"
  10. mirage >= "2.0.0" & < "2.4.0"
  11. mirage-seal
  12. mirage-www >= "1.1.0"
  13. odoc >= "2.2.0"
  14. opium-graphql
  15. pds
  16. queenshead
  17. spin >= "0.6.0"
  18. stone >= "0.4.0"

Conflicts

None