README

Topkg — The transitory OCaml software packager

Warning Topkg is in maintenance mode and should not longer be used.

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 thetopkg 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 hasno dependencies. This is what your packages will need as abuild dependency.

Topkg-care is distributed under the ISC license it depends onfmt,logs,bos,cmdliner,webbrowser andopam-format.

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

Installation

Topkg and topkg-care can be installed withopam:

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

If you don't useopam consult thetopkg.opam andtopkg-care.opam files for build instructions.

Documentation

A basic introduction and API reference is automatically generated byocamldoc from the interfaces. It can be consultedonline.

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

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

1. ocamlbuild
2. ocamlfindbuild & >= "1.6.1"
3. ocaml>= "4.08.0"

None

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

None