forked from ocaml/opam
-
Notifications
You must be signed in to change notification settings - Fork 4
/
opam-config.1
73 lines (73 loc) · 1.8 KB
/
opam-config.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.TH OPAM-CONFIG 1 "10/09/2012" "opam 0.6.0" "OPAM Manual"
.SH NAME
.PP
opam-config - Getting package configuration
.SH SYNOPSIS
.PP
\f[I]opam config\f[] -env
.PP
\f[I]opam config\f[] -list-vars
.PP
\f[I]opam config\f[] -var <var>
.PP
\f[I]opam config\f[] -subst <filename>...
.PP
\f[I]opam config\f[] [-r] -I <name>...
.PP
\f[I]opam config\f[] [-r] -bytecomp <name>[.<lib>]...
.PP
\f[I]opam config\f[] [-r] -asmcomp <name>[.<lib>]...
.PP
\f[I]opam config\f[] [-r] -bytelink <name>[.<lib>]...
.PP
\f[I]opam config\f[] [-r] -asmlink <name>[.<lib>]...
.SH DESCRIPTION
.PP
This command uses opam state to output information on how to use
installed libraries, updating the user's $PATH, and substitute variables
used in opam packages.
Apart from \f[I]opam config -env\f[], most of these commands are used by
opam internally, and thus are of limited interest for the user.
.SH OPTIONS
.TP
.B -env
Set the environment variables PATH, MANPATH, OCAML_TOPLEVEL_PATH and
CAML_LD_LIBRARY_PATH according to the current selected compiler.
The output of this command is meant to be evaluated by a shell, for
example by doing \f[I]eval \f[C]opam\ config\ -env\f[]\f[].
.RS
.RE
.TP
.B -list-vars
Return the list of all variables defined in installed packages.
.RS
.RE
.TP
.B -var <var>
Return the value associated with variable <var>
.RS
.RE
.TP
.B -subst <filename>...
Substitute variables in file <filename>.in to create <filename>
.RS
.RE
.TP
.B -I <name>...
Return the list of paths to include when compiling a project using the
package <name>.
Using the -r option will take into account the transitive closure of
dependencies.
.RS
.RE
.TP
.B -bytecomp|-asmcomp|-bytelink|-asmlink <name>[.<lib>]...
Return the associated value for section <lib> in the config file for
package <name>.
.RS
.RE
.SH OPAM
.PP
Part of the opam(1) suite
.SH AUTHORS
OCamlPro.