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

NAME

6       odoc
7

SYNOPSIS

9       odoc COMMAND ...
10

COMMANDS

12       compile
13           Compile a cmti, cmt, cmi or mld file to an odoc file.
14
15       compile-deps
16           List units (with their digest) which needs to be compiled in order
17           to compile this one. The unit itself and its digest is also
18           reported in the output.
19
20       compile-targets
21           TODO: Fill in.
22
23       css DEPRECATED: Use `odoc support-files' to copy the CSS file for the
24           default theme.
25
26       errors
27           Print errors that occurred while an .odoc file was generated.
28
29       html
30           Render html files from an odoc one
31
32       html-deps
33           DEPRECATED: alias for link-deps
34
35       html-fragment
36           Generates an html fragment file from an mld one
37
38       html-generate
39           Generate html files from an odocl one
40
41       html-targets
42           TODO: Fill in.
43
44       html-url
45           Resolve a reference and output its corresponding url
46
47       latex
48           Render latex files from an odoc one
49
50       latex-generate
51           Generate latex files from an odocl one
52
53       latex-targets
54           TODO: Fill in.
55
56       latex-url
57           Resolve a reference and output its corresponding url
58
59       link
60           Link odoc files together
61
62       link-deps
63           lists the packages which need to be in odoc's load path to link the
64           .odoc files in the given directory
65
66       man Render man files from an odoc one
67
68       man-generate
69           Generate man files from an odocl one
70
71       man-targets
72           TODO: Fill in.
73
74       support-files
75           Copy the support files (e.g. default theme, JavaScript files) to
76           the output directory.
77
78       support-files-targets
79           Lists the names of the files that 'odoc support-files' outputs.
80

OPTIONS

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