1ODOC(1)                           Odoc Manual                          ODOC(1)
2
3
4

NAME

6       odoc
7

SYNOPSIS

9       odoc [COMMAND] …
10

COMMANDS: Compilation pipeline

12       compile [--child=CHILD] [--open=MODULE] [--resolve-fwd-refs] [OPTION]…
13       FILE
14           Compile a .cmti, .cmt, .cmi or .mld file to an .odoc file.
15
16       html-generate [OPTION]… FILE.odocl
17           Generate html files from a .odocl.
18
19       link [--open=MODULE] [OPTION]… FILE.odoc
20           Second stage of compilation. Link a .odoc into a .odocl.
21
22       support-files [--without-theme] [OPTION]…
23           Copy the support files (e.g. default theme, JavaScript files) to
24           the output directory.
25

COMMANDS: Alternative generators

27       latex-generate [--extra-suffix=SUFFIX] [--syntax=SYNTAX]
28       [--with-children=BOOL] [OPTION]… FILE.odocl
29           Generate latex files from a .odocl.
30
31       man-generate [--extra-suffix=SUFFIX] [--syntax=SYNTAX] [OPTION]…
32       FILE.odocl
33           Generate man files from a .odocl.
34

COMMANDS: Scripting

36       compile-deps [OPTION]… file.cm{i,t,ti}
37           List units (with their digest) which needs to be compiled in order
38           to compile this one. The unit itself and its digest is also
39           reported in the output. Dependencies between compile steps are the
40           same as when compiling the ocaml modules.
41
42       compile-targets [OPTION]… FILE
43           Print the name of the file produced by compile. If -o is passed,
44           the same path is printed but error checking is performed.
45
46       errors [OPTION]… FILE
47           Print errors that occurred while compiling or linking.
48
49       html-targets [OPTION]… FILE.odocl
50           Print the files that would be generated by html-generate.
51
52       html-url [OPTION]… REF
53           Resolve a reference and output its corresponding url.
54
55       latex-targets [--with-children=BOOL] [OPTION]… FILE.odocl
56           Print the files that would be generated by latex-generate.
57
58       latex-url [OPTION]… REF
59           Resolve a reference and output its corresponding url.
60
61       man-targets [OPTION]… FILE.odocl
62           Print the files that would be generated by man-generate.
63
64       support-files-targets [--without-theme] [OPTION]…
65           Lists the names of the files that odoc support-files outputs.
66

COMMANDS: Legacy pipeline

68       html [OPTION]… FILE.odoc
69           Render html files from a .odoc. link then html-generate should be
70           used instead.
71
72       html-fragment [--xref-base-uri=URI] [OPTION]… file.mld
73           Generates an html fragment file from an mld one.
74
75       latex [--syntax=SYNTAX] [--with-children=BOOL] [OPTION]… FILE.odoc
76           Render latex files from a .odoc. link then latex-generate should be
77           used instead.
78
79       link-deps [OPTION]… PKG_DIR
80           Lists a subset of the packages and modules which need to be in
81           odoc's load path to link the  odoc files in the given directory.
82           Additional packages may be required to resolve all references.
83
84       man [--syntax=SYNTAX] [OPTION]… FILE.odoc
85           Render man files from a .odoc. link then man-generate should be
86           used instead.
87

COMMANDS: Deprecated

89       css [--without-theme] [OPTION]…
90           DEPRECATED: Use odoc support-files to copy the CSS file for the
91           default theme.
92
93       html-deps [OPTION]… PKG_DIR
94           DEPRECATED: alias for link-deps
95

OPTIONS

97       --help[=FMT] (default=auto)
98           Show this help in format FMT. The value FMT must be one of auto,
99           pager, groff or plain. With auto, the format is pager or plain
100           whenever the TERM env var is dumb or undefined.
101
102       --version
103           Show version information.
104
105
106
107Odoc 11VERSION11                                                       ODOC(1)