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

NAME

6       odoc
7

SYNOPSIS

9       odoc [COMMAND] …
10

COMMANDS

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       compile-deps [OPTION]… file.cm{i,t,ti}
17           List units (with their digest) which needs to be compiled in order
18           to compile this one. The unit itself and its digest is also
19           reported in the output.
20
21       compile-targets [OPTION]… FILE
22           TODO: Fill in.
23
24       css [--without-theme] [OPTION]…
25           DEPRECATED: Use `odoc support-files' to copy the CSS file for the
26           default theme.
27
28       errors [OPTION]… FILE
29           Print errors that occurred while an .odoc file was generated.
30
31       html [OPTION]… file.odoc
32           Render html files from an odoc one
33
34       html-deps [OPTION]… PKG_DIR
35           DEPRECATED: alias for link-deps
36
37       html-fragment [--xref-base-uri=URI] [OPTION]… file.mld
38           Generates an html fragment file from an mld one
39
40       html-generate [OPTION]… file.odoc
41           Generate html files from an odocl one
42
43       html-targets [OPTION]… file.odoc
44           TODO: Fill in.
45
46       html-url [--root-url=VAL] [OPTION]… REF
47           Resolve a reference and output its corresponding url
48
49       latex [--syntax=SYNTAX] [--with-children=BOOL] [OPTION]… file.odoc
50           Render latex files from an odoc one
51
52       latex-generate [--extra-suffix=SUFFIX] [--syntax=SYNTAX]
53       [--with-children=BOOL] [OPTION]… file.odoc
54           Generate latex files from an odocl one
55
56       latex-targets [--with-children=BOOL] [OPTION]… file.odoc
57           TODO: Fill in.
58
59       latex-url [OPTION]… REF
60           Resolve a reference and output its corresponding url
61
62       link [--open=MODULE] [OPTION]… file.odoc
63           Link odoc files together
64
65       link-deps [OPTION]… PKG_DIR
66           lists the packages which need to be in odoc's load path to link the
67           .odoc files in the given directory
68
69       man [--syntax=SYNTAX] [OPTION]… file.odoc
70           Render man files from an odoc one
71
72       man-generate [--extra-suffix=SUFFIX] [--syntax=SYNTAX] [OPTION]…
73       file.odoc
74           Generate man files from an odocl one
75
76       man-targets [OPTION]… file.odoc
77           TODO: Fill in.
78
79       support-files [--without-theme] [OPTION]…
80           Copy the support files (e.g. default theme, JavaScript files) to
81           the output directory.
82
83       support-files-targets [--without-theme] [OPTION]…
84           Lists the names of the files that 'odoc support-files' outputs.
85

OPTIONS

87       --help[=FMT] (default=auto)
88           Show this help in format FMT. The value FMT must be one of auto,
89           pager, groff or plain. With auto, the format is pager or plain
90           whenever the TERM env var is dumb or undefined.
91
92       --version
93           Show version information.
94
95
96
97Odoc 11VERSION11                                                       ODOC(1)
Impressum