package topkg

  1. Overview
  2. Docs
The transitory OCaml software packager

Install

Dune Dependency

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

Authors

  1. T
    The topkg programmers

Maintainers

  1. Daniel Bünzli

Sources

topkg-1.0.4.tbz
sha512=5baa1bf0105397589b741acd0195069823548b2051e453dffd641e5d00536b7a5f41b38d005b2b063f9e7cfb9a3b627bec3e6ad48e56769cc35a71f97a897f1b

Description

Topkg is a packager for distributing OCaml software. It provides an API to describe the files a package installs in a given build configuration and to specify information about the package's distribution, creation and publication procedures.

The optional topkg-care package provides the topkg command line tool which helps with various aspects of a package's life cycle: creating and linting a distribution, releasing it on the WWW, publish its documentation, add it to the OCaml opam repository, etc.

Topkg is distributed under the ISC license and has no dependencies. This is what your packages will need as a build dependency.

Topkg-care is distributed under the ISC license it depends on fmt, logs, bos, cmdliner, webbrowser and opam-format.

Home page: http://erratique.ch/software/topkg

Tags

packaging ocamlbuild org:erratique

Published: 06 Oct 2021

README

Topkg — The transitory OCaml software packager

v1.0.4

Topkg is a packager for distributing OCaml software. It provides an API to describe the files a package installs in a given build configuration and to specify information about the package's distribution, creation and publication procedures.

The optional topkg-care package provides the topkg command line tool which helps with various aspects of a package's life cycle: creating and linting a distribution, releasing it on the WWW, publish its documentation, add it to the OCaml opam repository, etc.

Topkg is distributed under the ISC license and has no dependencies. This is what your packages will need as a build dependency.

Topkg-care is distributed under the ISC license it depends on fmt, logs, bos, cmdliner, webbrowser and opam-format.

Home page: http://erratique.ch/software/topkg

Installation

Topkg and topkg-care can be installed with opam:

opam install topkg       # All you need for your packages
opam install topkg-care  # topkg binary, takes care of your packages

If you don't use opam consult the topkg.opam and topkg-care.opam files for build instructions.

Documentation

A basic introduction and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online.

The topkg command line tool is extensively documented in man pages available through it's help system. Type:

topkg help release # for help about releasing your package
topkg help         # for more help

Dependencies (3)

  1. ocamlbuild
  2. ocamlfind build & >= "1.6.1"
  3. ocaml >= "4.03.0" & < "5.0"

Dev Dependencies

None

  1. afl-persistent < "1.2"
  2. alcotest >= "0.5.0" & < "0.8.0"
  3. ansi-parse < "0.4.0"
  4. anycache < "0.7.4"
  5. aperf
  6. arp < "1.0.0"
  7. asetmap
  8. asn1-combinators >= "0.1.3" & < "0.2.2"
  9. astring >= "0.8.2"
  10. b0
  11. base64 = "2.1.2"
  12. bos
  13. bpf
  14. brr < "0.0.2" | >= "0.0.6"
  15. certify = "0.2"
  16. channel >= "1.1.1"
  17. charrua-client < "0.9"
  18. charrua-core >= "0.5" & < "0.8"
  19. cmarkit
  20. cmdliner >= "1.0.0" & < "1.0.3"
  21. cmdtui < "0.4.3"
  22. conex < "0.10.0"
  23. cow = "2.2.0"
  24. cpuid < "0.1.2"
  25. crunch = "2.0.0"
  26. datakit < "0.10.0"
  27. datakit-bridge-github < "0.10.0"
  28. datakit-bridge-local-git < "0.10.0"
  29. datakit-client < "0.10.0"
  30. datakit-github < "0.10.0"
  31. datakit-server < "0.10.0"
  32. decompress >= "0.5" & < "0.8"
  33. depyt < "0.2.0"
  34. digestif < "0.6.1"
  35. distwit
  36. dns >= "0.19.1" & < "1.0.0"
  37. dns-forward < "0.9.0"
  38. doc-ock < "1.1.0"
  39. doc-ock-html < "1.1.0"
  40. doc-ock-xml < "1.1.0"
  41. dockerfile >= "1.7.2" & < "3.0.0"
  42. dog >= "0.2.1"
  43. domain-name < "0.1.2"
  44. down
  45. dtoa < "0.3.0"
  46. duration < "0.1.2"
  47. edn >= "0.1.2-1-g09b142a" & < "0.1.6-1-gff9db95"
  48. enumerators >= "0.2.0"
  49. ezirmin
  50. ezsqlite < "0.4"
  51. farfadet
  52. fat-filesystem = "0.12.0"
  53. fmt >= "0.8.0"
  54. fpath
  55. functoria >= "2.0.0" & < "2.1.0"
  56. functoria-runtime < "2.1.0"
  57. gamepad
  58. gg >= "0.9.2"
  59. git-unix >= "1.10.0" & < "1.11.1"
  60. github-hooks < "0.2.0"
  61. gmap < "0.2.1"
  62. hardcaml = "1.2.0"
  63. hardcaml-affirm
  64. hardcaml-bloop
  65. hardcaml-llvmsim >= "0.3.0"
  66. hardcaml-vpi >= "0.3.0"
  67. hardcaml-waveterm >= "0.2.0"
  68. hardcaml-yosys
  69. higher >= "0.3.1"
  70. hiredis < "0.8"
  71. hkdf = "1.0.2"
  72. hmap >= "0.8.1"
  73. htmlit
  74. integers < "0.3.0"
  75. inuit < "0.4.1"
  76. ipaddr >= "2.7.1" & < "2.8.0"
  77. ipv6-multicast < "0.9"
  78. irmin >= "0.12.0" & < "1.2.0"
  79. irmin-git < "1.2.0"
  80. irmin-http < "1.2.0"
  81. irmin-mirage < "1.2.0"
  82. irmin-unix >= "1.0.0" & < "1.2.0"
  83. irmin-watcher < "0.3.0"
  84. jekyll-format < "0.2.0"
  85. jsonm >= "1.0.0"
  86. key-parsers >= "0.6.0" & < "0.10.0"
  87. libudev >= "0.2.1"
  88. linkage
  89. logs >= "0.6.0"
  90. logs-syslog < "0.2.0"
  91. lru < "0.3.0"
  92. mergeable-vector
  93. minima-theme
  94. mirage >= "3.0.0" & < "3.0.5"
  95. mirage-block = "1.0.0"
  96. mirage-block-lwt < "1.1.0"
  97. mirage-block-ramdisk = "0.3"
  98. mirage-block-solo5 >= "0.2.1" & < "0.6.0"
  99. mirage-bootvar-solo5 >= "0.2.0" & < "0.6.0"
  100. mirage-bootvar-xen = "0.4.0"
  101. mirage-channel < "3.1.0"
  102. mirage-channel-lwt < "3.1.0"
  103. mirage-clock < "1.3.0"
  104. mirage-clock-freestanding < "1.3.0"
  105. mirage-clock-lwt < "1.3.0"
  106. mirage-clock-unix = "1.2.0"
  107. mirage-console = "2.2.0"
  108. mirage-console-lwt < "2.3.2"
  109. mirage-console-solo5 >= "0.2.0" & < "0.6.0"
  110. mirage-console-unix >= "2.2.0" & < "2.3.2"
  111. mirage-console-xen = "2.2.0"
  112. mirage-console-xen-backend < "2.3.2"
  113. mirage-console-xen-proto < "2.3.2"
  114. mirage-device < "1.1.0"
  115. mirage-entropy < "0.5.1"
  116. mirage-flow = "1.2.0"
  117. mirage-flow-lwt < "1.3.0"
  118. mirage-flow-unix < "1.3.0"
  119. mirage-fs = "1.0.0"
  120. mirage-fs-lwt < "1.1.1"
  121. mirage-fs-unix = "1.3.0"
  122. mirage-http >= "2.5.3" & < "3.2.0"
  123. mirage-kv < "1.1.1"
  124. mirage-kv-lwt < "1.1.0"
  125. mirage-logs = "0.3.0"
  126. mirage-net = "1.0.0"
  127. mirage-net-fd < "0.2.1"
  128. mirage-net-lwt < "2.0.0"
  129. mirage-net-macosx >= "1.2.0" & < "1.4.0"
  130. mirage-net-solo5 >= "0.2.0" & < "0.4.3"
  131. mirage-net-unix >= "2.3.0" & < "2.4.1"
  132. mirage-os-shim
  133. mirage-profile = "0.8.0"
  134. mirage-profile-unix < "0.8.1"
  135. mirage-protocols < "1.2.0"
  136. mirage-protocols-lwt < "1.2.0"
  137. mirage-qubes = "0.4"
  138. mirage-random < "1.1.0"
  139. mirage-runtime < "3.0.5"
  140. mirage-solo5 >= "0.2.0" & < "0.6.2"
  141. mirage-stack < "1.1.0"
  142. mirage-stack-lwt < "1.1.0"
  143. mirage-time < "1.1.0"
  144. mirage-time-lwt < "1.1.0"
  145. mirage-types = "3.0.0"
  146. mirage-types-lwt = "3.0.0"
  147. mirage-unix >= "3.0.8" & < "3.2.0"
  148. mirage-vnetif = "0.3.1"
  149. mirage-xen >= "3.0.6" & < "3.2.0"
  150. msgpck < "1.3"
  151. mtime >= "0.8.4"
  152. multipart-form-data < "0.2.0"
  153. named-pipe >= "0.4.0"
  154. nlp
  155. nocrypto >= "0.5.4"
  156. nosetup
  157. note
  158. notty >= "0.2.0" & < "0.2.3"
  159. obandit
  160. ocb-stubblr >= "0.1.0"
  161. ocp-index-top
  162. octavius < "1.1.0"
  163. odds < "1.1"
  164. odig
  165. odoc < "1.1.0"
  166. oml >= "0.0.7"
  167. omod
  168. opaca
  169. osx-cf >= "0.1.1"
  170. otfm >= "0.3.0"
  171. otr >= "0.3.3" & < "0.3.6"
  172. papi < "0.1.1"
  173. parse-argv < "0.1.0"
  174. pbkdf = "0.2.0"
  175. pcap-format = "0.5.0"
  176. pkcs11 < "0.18.0"
  177. ppx_compose < "0.0.4"
  178. ppx_fun < "0.0.9"
  179. protocol-9p >= "0.7.2" & < "0.10.0"
  180. psq < "0.1.1"
  181. ptime >= "0.8.1"
  182. py < "1.1"
  183. qcow < "0.10.0"
  184. qrc
  185. randomconv < "0.1.1"
  186. rawlink >= "0.5" & < "1.0"
  187. react >= "1.2.1"
  188. reason = "1.13.7" | = "3.0.0"
  189. records >= "0.7.0" & < "1.0.0"
  190. rfc6287 >= "1.0.2" & < "1.0.4"
  191. rresult >= "0.4.0"
  192. salsa20 < "1.0.0"
  193. salsa20-core < "1.0.0"
  194. sattools
  195. scid
  196. scrypt-kdf >= "0.2.0" & < "1.0.0"
  197. sendmsg
  198. shcaml >= "0.2.0"
  199. simple-diff >= "0.2.1"
  200. statmemprof-emacs
  201. sturgeon < "0.4.2"
  202. syslog-message = "0.0.2"
  203. systemverilog < "0.0.2"
  204. tar-format >= "0.7.1"
  205. terminal_size < "0.1.4"
  206. tgls >= "0.8.4"
  207. tls >= "0.8.0" & < "0.11.0"
  208. tlstunnel >= "0.2.0"
  209. topkg-care = "1.0.4"
  210. topkg-jbuilder
  211. tsdl >= "0.9.1"
  212. ttweetnacl
  213. tuntap = "1.4.1"
  214. type-beat
  215. unix-type-representations >= "0.1.1"
  216. uucd >= "4.0.0"
  217. uucp >= "2.0.0"
  218. uuidm >= "0.9.6"
  219. uunf >= "2.0.0"
  220. uuseg >= "1.0.0"
  221. uutf >= "1.0.0"
  222. vg >= "0.9.0"
  223. wamp < "1.2"
  224. webbrowser
  225. x509 >= "0.6.0" & < "0.6.3"
  226. xmlm >= "1.3.0"
  227. yurt < "0.6"
  228. zipc
  229. zlist < "0.4.0"
  230. zxcvbn < "2.3+2"
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct