.\" Pipe this output to groff -man -Tutf8 | less .\" .TH "OPAM-LIST" 1 "" "Opam 1.2.0" "Opam Manual" .\" Disable hyphenantion and ragged-right .nh .ad l .SH NAME .P opam\-list \- Display the list of available packages. .SH SYNOPSIS .P \fBopam list\fR [\fIOPTION\fR]... [\fIPATTERNS\fR]... .SH DESCRIPTION .P This command displays the list of installed packages when called without argument, or the list of available packages matching the given pattern. .P Unless the \fB\-\-short\fR switch is used, the output format 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. In color mode, root packages (eg. manually installed) are underlined. .P The full description can be obtained by doing \fBopam info \fR. You can search through the package descriptions using the \fBopam search\fR command. .SH ARGUMENTS .TP 4 \fIPATTERNS\fR List of package patterns. .SH OPTIONS .TP 4 \fB\-a\fR, \fB\-\-all\fR List all the packages which can be installed on the system. .TP 4 \fB\-A\fR, \fB\-\-unavailable\fR List all packages, even those which can't be installed on the system .TP 4 \fB\-\-depends\-on\fR=\fIPACKAGES\fR List only packages that depend on one of \fIPACKAGES\fR. .TP 4 \fB\-\-depopts\fR Include optional dependencies in dependency requests. .TP 4 \fB\-e\fR [\fITAGS\fR], \fB\-\-external\fR[=\fITAGS\fR] (default=) Instead of displaying the packages, display their external dependencies that are associated with any subset of the given \fITAGS\fR (OS, distribution, etc.). Common tags include `debian', `x86', `osx', `homebrew', `source'... Without \fITAGS\fR, display the tags and all associated external dependencies. .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\-\-recursive\fR With `\-\-depends\-on' and `\-\-required\-by', display all transitive dependencies rather than just direct dependencies. .TP 4 \fB\-\-required\-by\fR=\fIPACKAGES\fR List only the dependencies of \fIPACKAGES\fR. .TP 4 \fB\-S\fR, \fB\-\-sort\fR Sort the packages in dependency order. .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\-\-criteria\fR=\fICRITERIA\fR Specify user \fIpreferences\fR for dependency solving for this run. Overrides both \fB$OPAMCRITERIA\fR and \fB$OPAMUPGRADECRITERIA\fR. For details on the supported language, and the external solvers available, see \fI http://opam.ocaml.org/doc/Specifying_Solver_Preferences.html\fR. A general guide to using solver preferences can be found at \fI http://www.dicosmo.org/Articles/usercriteria.pdf\fR. The default value is \-count(down),\-count(removed),\-notuptodate(solution),\-count(new) for upgrades, and \-count(removed),\-notuptodate(request),\-count(down),\-notuptodate(changed),\-count(changed),\-notuptodate(solution) otherwise. .TP 4 \fB\-\-cudf\fR=\fIFILENAME\fR Debug option: Save the CUDF requests sent to the solver to \fIFILENAME\fR\-.cudf. .TP 4 \fB\-\-debug\fR Print debug message to stderr. This is equivalent to setting \fB$OPAMDEBUG\fR to "true". .TP 4 \fB\-\-debug\-level\fR=\fILEVEL\fR Like `\-\-debug', but allows specifying the debug level (`\-\-debug' sets it to 1). Equivalent to setting \fB$OPAMDEBUG\fR to a positive integer. .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\-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\-\-no\-self\-upgrade\fR OPAM will replace itself with a newer binary found at \fBOPAMROOT/opam\fR if present. This disables this behaviour. .TP 4 \fB\-q\fR, \fB\-\-quiet\fR Be quiet when installing a new compiler. .TP 4 \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\-\-safe\fR Make sure nothing will be automatically updated or rewritten. Useful for calling from completion scripts, for example. Will fail whenever such an operation is needed ; also avoids waiting for locks, skips interactive questions and overrides the OPAMDEBUG variable. .TP 4 \fB\-\-solver\fR=\fICMD\fR Specify the name of the external dependency \fIsolver\fR. The default value is aspcud .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\-\-use\-internal\-solver\fR, \fB\-\-no\-aspcud\fR Force use of internal heuristics, even if an external solver is available. .TP 4 \fB\-v\fR, \fB\-\-verbose\fR Be more verbose. Show output of all sub\-commands. This is equivalent to setting \fB$OPAMVERBOSE\fR to "true". .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 "true". .SH ENVIRONMENT VARIABLES .P OPAM makes use of the environment variables listed here. Boolean variables should be set to "0", "no" of "false" to disable, "1", "yes" or "true" to enable. .P \fIOPAMCOLOR\fR, when set to \fIalways\fR or \fInever\fR, sets a default value for the \-\-color option. .P \fIOPAMCRITERIA\fR specifies user \fIpreferences\fR for dependency solving.The default value is \-count(removed),\-notuptodate(request),\-count(down),\-notuptodate(changed),\-count(changed),\-notuptodate(solution). See also option \-\-criteria .P \fIOPAMCURL\fR can be used to define an alternative for the 'curl' command\-line utility to download files. .P \fIOPAMDEBUG\fR see options `\-\-debug' and `\-\-debug\-level'. .P \fIOPAMEXTERNALSOLVER\fR see option `\-\-solver'. .P \fIOPAMJOBS\fR sets the maximum number of parallel workers to run. .P \fIOPAMNOASPCUD\fR see option `\-\-no\-aspcud'. .P \fIOPAMNOSELFUPGRADE\fR see option `\-\-no\-self\-upgrade'. .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 \fIOPAMUPGRADECRITERIA\fR specifies user \fIpreferences\fR for dependency solving when performing an upgrade. Overrides \fIOPAMCRITERIA\fR in upgrades if both are set.The default value is \-count(down),\-count(removed),\-notuptodate(solution),\-count(new). See also option \-\-criteria .P \fIOPAMUTF8MSGS\fR use nice UTF8 characters in OPAM messages. .P \fIOPAMVERBOSE\fR see option `\-\-verbose'. .P \fIOPAMVAR_var\fR overrides the contents of the variable \fIvar\fR when substituting `%{var}%` strings in `opam` files. .P \fIOPAMVAR_package_var\fR overrides the contents of the variable \fIpackage:var\fR when substituting `%{package:var}%` strings in `opam` files. .P \fIOPAMUSEINTERNALSOLVER\fR see option `\-\-use\-internal\-solver'. .P \fIOPAMYES\fR see option `\-\-yes'. .SH FURTHER DOCUMENTATION .P See https://opam.ocaml.org. .SH AUTHORS .P Thomas Gazagnaire .sp -1 .P Anil Madhavapeddy .sp -1 .P Fabrice Le Fessant .sp -1 .P Frederic Tuong .sp -1 .P Louis Gesbert .sp -1 .P Vincent Bernardoff .sp -1 .P Guillem Rieu .sp -1 .P Roberto Di Cosmo .SH BUGS .P Check bug reports at https://github.com/ocaml/opam/issues.