package topkg

  1. Overview
  2. Docs
The transitory OCaml software packager

Install

Dune Dependency

Authors

Maintainers

Sources

topkg-1.0.7.tbz
sha512=09e59f1759bf4db8471f02d0aefd8db602b44932a291c05c312b1423796e7a15d1598d3c62a0cec7f083eff8e410fac09363533dc4bd2120914bb9664efea535

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: 01 Feb 2023

README

Topkg — The transitory OCaml software packager

v1.0.7

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.05.0"

Dev Dependencies

None

  1. afl-persistent < "1.2"
  2. anycache < "0.7.4"
  3. aperf
  4. arp < "1.0.0"
  5. asetmap
  6. asn1-combinators < "0.2.2"
  7. astring
  8. b0
  9. base64 = "2.1.2"
  10. bos
  11. bpf
  12. brr < "0.0.2" | >= "0.0.6"
  13. bytesrw
  14. certify < "0.3.0"
  15. cmarkit
  16. cmdtui < "0.4.3"
  17. conex < "0.10.0"
  18. cow = "2.2.0"
  19. cpuid < "0.1.2"
  20. crunch = "2.0.0"
  21. decompress >= "0.5" & < "0.8"
  22. depyt < "0.3.0"
  23. digestif < "0.6.1"
  24. dockerfile >= "1.7.2" & < "3.0.0"
  25. domain-name < "0.1.2"
  26. down
  27. dtoa < "0.3.0"
  28. duration < "0.1.2"
  29. enumerators >= "0.2.0"
  30. ezsqlite < "0.4"
  31. farfadet
  32. fmt
  33. fpath
  34. functoria-runtime < "2.1.0"
  35. gamepad
  36. gg
  37. git-unix >= "1.10.0" & < "1.11.4"
  38. gmap < "0.2.1"
  39. hardcaml = "1.2.0"
  40. hardcaml-bloop
  41. hardcaml-llvmsim >= "0.3.0"
  42. hardcaml-vpi >= "0.3.0"
  43. hardcaml-yosys
  44. higher >= "0.3.1"
  45. hiredis < "0.8"
  46. hkdf = "1.0.2"
  47. hmap
  48. htmlit
  49. integers < "0.3.0"
  50. inuit < "0.4.1"
  51. irmin-watcher < "0.3.0"
  52. jekyll-format < "0.2.0"
  53. jsonm
  54. jsont
  55. key-parsers < "0.10.1"
  56. libudev
  57. linkage
  58. logs
  59. logs-syslog < "0.2.0"
  60. lru < "0.3.0"
  61. mergeable-vector
  62. minima-theme
  63. mirage-block < "1.1.0"
  64. mirage-block-solo5 < "0.6.0"
  65. mirage-bootvar-solo5 < "0.6.0"
  66. mirage-bootvar-xen = "0.4.0"
  67. mirage-channel < "3.1.0"
  68. mirage-channel-lwt < "3.1.0"
  69. mirage-clock < "1.3.0"
  70. mirage-clock-freestanding < "1.3.0"
  71. mirage-clock-lwt < "1.3.0"
  72. mirage-clock-unix = "1.2.0"
  73. mirage-console = "2.2.0"
  74. mirage-console-lwt < "2.3.2"
  75. mirage-console-solo5 < "0.6.0"
  76. mirage-console-unix >= "2.2.0" & < "2.3.2"
  77. mirage-console-xen-proto < "2.3.2"
  78. mirage-device < "1.1.0"
  79. mirage-entropy < "0.5.1"
  80. mirage-flow < "1.3.0"
  81. mirage-flow-lwt < "1.3.0"
  82. mirage-flow-unix < "1.3.0"
  83. mirage-fs = "1.0.0"
  84. mirage-fs-lwt < "1.1.1"
  85. mirage-kv < "1.1.1"
  86. mirage-kv-lwt < "1.1.0"
  87. mirage-logs = "0.3.0"
  88. mirage-net < "1.1.1"
  89. mirage-net-lwt < "2.0.0"
  90. mirage-net-macosx >= "1.2.0" & < "1.4.0"
  91. mirage-net-solo5 < "0.4.3"
  92. mirage-os-shim
  93. mirage-profile = "0.8.0"
  94. mirage-profile-unix < "0.8.1"
  95. mirage-protocols < "1.2.0"
  96. mirage-protocols-lwt < "1.2.0"
  97. mirage-random < "1.1.0"
  98. mirage-runtime < "3.0.5"
  99. mirage-solo5 < "0.6.2"
  100. mirage-stack < "1.1.0"
  101. mirage-stack-lwt < "1.1.0"
  102. mirage-time < "1.1.0"
  103. mirage-time-lwt < "1.1.0"
  104. mirage-types = "3.0.0"
  105. mirage-types-lwt = "3.0.0"
  106. mirage-unix >= "3.0.8" & < "3.2.0"
  107. mirage-vnetif = "0.3.1"
  108. msgpck < "1.3"
  109. mtime
  110. multipart-form-data < "0.2.0"
  111. named-pipe >= "0.4.0"
  112. nlp
  113. nocrypto
  114. nosetup
  115. note
  116. notty < "0.2.3"
  117. obandit
  118. ocb-stubblr >= "0.1.0"
  119. ocp-index-top
  120. octavius < "1.1.0"
  121. odds < "1.1"
  122. odig
  123. oml >= "0.0.7"
  124. omod
  125. opaca
  126. osx-cf
  127. otfm
  128. otr < "0.3.6"
  129. papi < "0.1.1"
  130. parse-argv < "0.1.0"
  131. pbkdf = "0.2.0"
  132. pcap-format = "0.5.0"
  133. pkcs11 < "0.18.0"
  134. ppx_compose < "0.0.4"
  135. ppx_fun < "0.0.9"
  136. psq < "0.1.1"
  137. ptime
  138. py < "1.1"
  139. qrc
  140. randomconv < "0.1.1"
  141. rawlink < "1.0"
  142. react >= "1.2.1"
  143. records >= "0.7.0" & < "1.0.0"
  144. rfc6287 < "1.0.4"
  145. rresult
  146. salsa20 < "1.0.0"
  147. salsa20-core < "1.0.0"
  148. sattools
  149. scid
  150. scrypt-kdf >= "0.2.0" & < "1.0.0"
  151. sendmsg
  152. shcaml
  153. simple-diff >= "0.2.1"
  154. statmemprof-emacs
  155. sturgeon < "0.4.2"
  156. syslog-message = "0.0.2"
  157. systemverilog < "0.0.2"
  158. terminal_size < "0.1.4"
  159. tgls
  160. tls < "0.11.0"
  161. tlstunnel
  162. topkg-care >= "1.0.7"
  163. topkg-jbuilder
  164. tsdl
  165. ttweetnacl
  166. tuntap = "1.4.1"
  167. unix-type-representations >= "0.1.1"
  168. uucd
  169. uucp
  170. uuidm
  171. uunf >= "2.0.1"
  172. uuseg
  173. uutf
  174. vg
  175. wamp < "1.2"
  176. webbrowser
  177. xmlm
  178. yurt < "0.6"
  179. zipc
  180. zlist < "0.4.0"
  181. zxcvbn < "2.3+2"

Conflicts

None

OCaml

Innovation. Community. Security.