forked from ocaml/opam
-
Notifications
You must be signed in to change notification settings - Fork 4
/
opam-search.1
133 lines (133 loc) · 4.31 KB
/
opam-search.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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
.\" Pipe this output to groff -man -Tutf8 | less
.\"
.TH "OPAM-SEARCH" 1 "" "Opam 1.1.1" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
.SH NAME
.P
opam\-search \- Search into the package list.
.SH SYNOPSIS
.P
\fBopam search\fR [\fIOPTION\fR]... [\fIPATTERNS\fR]...
.SH DESCRIPTION
.P
This command displays the list of available packages that match one of the package patterns specified as arguments.
.P
Unless the \fB\-\-short\fR flag is used, the output format is the same as the \fBopam list\fR command. It displays one package per line, and each line contains the name of the package, the installed version or \-\- if the package is not installed, and a short description.
.P
The full description can be obtained by doing \fBopam info <package>\fR.
.SH ARGUMENTS
.TP 4
\fIPATTERNS\fR
List of package patterns.
.SH OPTIONS
.TP 4
\fB\-c\fR, \fB\-\-case\-sensitive\fR
Force the search in case sensitive mode.
.TP 4
\fB\-i\fR, \fB\-\-installed\fR
List installed packages only.
.TP 4
\fB\-\-installed\-roots\fR
Display only the installed roots.
.TP 4
\fB\-s\fR, \fB\-\-short\fR
Output the names separated by one whitespace instead of using the usual formatting.
.SH COMMON OPTIONS
.P
These options are common to all commands.
.TP 4
\fB\-\-color\fR=\fIWHEN\fR (absent=auto)
Colorize the output. \fIWHEN\fR must be `always', `never' or `auto'.
.TP 4
\fB\-\-compat\-mode\-1.0\fR
Compatibility mode with OPAM 1.0
.TP 4
\fB\-\-debug\fR
Print debug message on stdout. This is equivalent to setting \fB$OPAMDEBUG\fR to a non\-empty value.
.TP 4
\fB\-\-git\-version\fR
Print the git version if it exists and exit.
.TP 4
\fB\-\-help\fR[=\fIFMT\fR] (default=pager)
Show this help in format \fIFMT\fR (pager, plain or groff).
.TP 4
\fB\-\-no\-aspcud\fR
Do not use the external aspcud solver, even if available.
.TP 4
\fB\-\-no\-base\-packages\fR
Do not install base packages (useful for testing purposes). This is equivalent to setting \fB$OPAMNOBASEPACKAGES\fR to a non\-empty string.
.TP 4
\fB\-q\fR, \fB\-\-quiet\fR
Be quiet when installing a new compiler.
.TP 4
\fB\-r\fR \fIROOT\fR, \fB\-\-root\fR=\fIROOT\fR (absent=~/.opam)
Use \fIROOT\fR as the current root path. This is equivalent to setting \fB$OPAMROOT\fR to \fIROOT\fR.
.TP 4
\fB\-\-strict\fR
Fail whenever an error is found in a package definition or a configuration file. The default is to continue silently if possible.
.TP 4
\fB\-\-switch\fR=\fISWITCH\fR
Use \fISWITCH\fR as the current compiler switch. This is equivalent to setting \fB$OPAMSWITCH\fR to \fISWITCH\fR.
.TP 4
\fB\-v\fR, \fB\-\-verbose\fR
Be more verbose. This is equivalent to setting \fB$OPAMVERBOSE\fR to a non\-empty value.
.TP 4
\fB\-\-version\fR
Show version information.
.TP 4
\fB\-y\fR, \fB\-\-yes\fR
Disable interactive mode and answer yes to all questions that would otherwise be asked to the user. This is equivalent to setting \fB$OPAMYES\fR to a non\-empty string.
.SH ENVIRONMENT VARIABLES
.P
OPAM makes use of the environment variables listed here. Boolean variables are considered true when set to a non\-empty string.
.P
\fIOPAMCOLOR\fR, when set to \fIalways\fR or \fInever\fR, sets a default value for the \-\-color option.
.P
\fIOPAMCURL\fR can be used to define an alternative for the 'curl' command\-line utility to download files.
.P
\fIOPAMDEBUG\fR see option `\-\-debug'.
.P
\fIOPAMJOBS\fR sets the maximum number of parallel workers to run.
.P
\fIOPAMNOASPCUD\fR see option `\-\-no\-aspcud'.
.P
\fIOPAMROOT\fR see option `\-\-root'. This is automatically set by `opam config env \-\-root=DIR' when DIR is non\-default.
.P
\fIOPAMSOLVERTIMEOUT\fR change the time allowance of the internal solver.
.P
\fIOPAMSWITCH\fR see option `\-\-switch'. Automatically set by `opam config env \-\-switch=SWITCH'.
.P
\fIOPAMUTF8MSGS\fR use nice UTF8 characters in OPAM messages.
.P
\fIOPAMVERBOSE\fR see option `\-\-verbose'.
.P
\fIOPAMYES\fR see option `\-\-yes'.
.SH FURTHER DOCUMENTATION
.P
See https://opam.ocaml.org.
.SH AUTHORS
.P
Thomas Gazagnaire <thomas@gazagnaire.org>
.sp -1
.P
Anil Madhavapeddy <anil@recoil.org>
.sp -1
.P
Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
.sp -1
.P
Frederic Tuong <tuong@users.gforge.inria.fr>
.sp -1
.P
Louis Gesbert <louis.gesbert@ocamlpro.com>
.sp -1
.P
Vincent Bernardoff <vb@luminar.eu.org>
.sp -1
.P
Guillem Rieu <guillem.rieu@ocamlpro.com>
.SH BUGS
.P
Check bug reports at https://github.com/ocaml/opam/issues.