.\" Pipe this output to groff -man -Tutf8 | less .\" .TH "OPAM-INIT" 1 "" "Opam 1.2.2" "Opam Manual" .\" Disable hyphenation and ragged-right .nh .ad l .SH NAME .P opam\-init \- Initialize OPAM state. .SH SYNOPSIS .P \fBopam init\fR [\fIOPTION\fR]... [\fINAME\fR] [\fIADDRESS\fR] .SH DESCRIPTION .P The \fBinit\fR command creates a fresh client state. This initializes OPAM configuration in \fI~/.opam\fR (or the given \fB\-\-root\fR) and configures the initial remote package repository. .P Once the fresh client has been created, OPAM will ask the user if he wants \fI~/.profile\fR (or \fI~/.zshrc\fR, etc. depending on his shell) and \fI~/.ocamlinit\fR to be updated. If \fB\-\-auto\-setup\fR is used, OPAM will modify the configuration files automatically, without asking the user. If \fB\-\-no\-setup\fR is used, OPAM will *NOT* modify anything outside of \fI~/.opam\fR. .P Additional repositories can be added later by using the \fBopam repository\fR command. .P The state of repositories can be synchronized by using \fBopam update\fR. .P The user and global configuration files can be setup later by using \fBopam config setup\fR. .SH ARGUMENTS .TP 4 \fIADDRESS\fR (absent=https://opam.ocaml.org) Address of the repository. .TP 4 \fINAME\fR (absent=default) Name of the repository. .SH OPTIONS .TP 4 \fB\-a\fR, \fB\-\-auto\-setup\fR Automatically setup all the global and user configuration options for OPAM. .TP 4 \fB\-b\fR, \fB\-\-keep\-build\-dir\fR Keep the build directory. This is equivalent to setting \fB$OPAMKEEPBUILDDIR\fR to "true". .TP 4 \fB\-\-compiler\fR=\fIVERSION\fR (absent=system) Which compiler version to use. .TP 4 \fB\-d\fR, \fB\-\-build\-doc\fR Build the package documentation. This is equivalent to setting \fB$OPAMBUILDDOC\fR to "true". .TP 4 \fB\-\-dot\-profile\fR=\fIFILENAME\fR Name of the configuration file to update instead of \fI~/.profile\fR or \fI~/.zshrc\fR based on shell detection. .TP 4 \fB\-\-dry\-run\fR Simulate the command, but don't actually perform any changes. .TP 4 \fB\-e\fR \fITAGS\fR, \fB\-\-external\fR=\fITAGS\fR Display the external packages associated to the given tags. This is deprecated, use `opam list \-\-external' instead .TP 4 \fB\-\-fake\fR This option registers the actions into the OPAM database, without actually performing them. WARNING: This option is dangerous and likely to break your OPAM environment. You probably want `\-\-dry\-run'. You've been warned. .TP 4 \fB\-j\fR \fIJOBS\fR, \fB\-\-jobs\fR=\fIJOBS\fR Set the maximal number of concurrent jobs to use. You can also set it using the \fB$OPAMJOBS\fR environment variable. .TP 4 \fB\-j\fR \fIJOBS\fR, \fB\-\-jobs\fR=\fIJOBS\fR (absent=4) Number of jobs to use when building packages. .TP 4 \fB\-\-json\fR=\fIFILENAME\fR Save the result output of an OPAM run in a computer\-readable file .TP 4 \fB\-k\fR \fIKIND\fR, \fB\-\-kind\fR=\fIKIND\fR Specify the kind of the repository to be used (one of `http', `local', `git', `darcs' or `hg'). .TP 4 \fB\-m\fR \fIMAKE\fR, \fB\-\-make\fR=\fIMAKE\fR Use \fIMAKE\fR as the default 'make' command. .TP 4 \fB\-n\fR, \fB\-\-no\-setup\fR Do not update the global and user configuration options to setup OPAM. .TP 4 \fB\-\-no\-checksums\fR Do not verify the checksum of downloaded archives.This is equivalent to setting \fB$OPAMNOCHECKSUMS\fR to "true". .TP 4 \fB\-\-require\-checksums\fR Reject the installation of packages that don't provide a checksum for the upstream archives. This is equivalent to setting \fB$OPAMREQUIRECHECKSUMS\fR to "true". .TP 4 \fB\-\-shell\fR=\fISHELL\fR (absent=bash) Sets the configuration mode for OPAM environment appropriate for \fISHELL\fR. One of one of `bash', `sh', `csh', `zsh' or `fish'. .TP 4 \fB\-\-show\-actions\fR Call the solver and display the actions. Don't perform any changes. .TP 4 \fB\-t\fR, \fB\-\-build\-test\fR Build and \fBrun\fR the package unit\-tests. This is equivalent to setting \fB$OPAMBUILDTEST\fR to "true". .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 one of `always', `never' or `auto'. .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),\-sum(solution,version\-lag),\-count(new) for upgrades, and \-count(removed),\-notuptodate(request),\-sum(request,version\-lag),\-count(down),\-notuptodate(changed),\-count(changed),\-notuptodate(solution),\-sum(solution,version\-lag) 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. Either 'aspcud', 'packup' or a custom command that may contain the variables %{input}%, %{output}% and %{criteria}% .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 package sub\-commands and their output. Repeat to see more. Repeating \fIn\fR times is equivalent to setting \fB$OPAMVERBOSE\fR to "\fIn\fR". .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),\-sum(request,version\-lag),\-count(down),\-notuptodate(changed),\-count(changed),\-notuptodate(solution),\-sum(solution,version\-lag). See also option \-\-criteria .P \fIOPAMCURL\fR can be used to select a given 'curl' program. See \fIOPAMFETCH\fR for more options. .P \fIOPAMDEBUG\fR see options `\-\-debug' and `\-\-debug\-level'. .P \fIOPAMDOWNLOADJOBS\fR sets the maximum number of simultaneous downloads. .P \fIOPAMEXTERNALSOLVER\fR see option `\-\-solver'. .P \fIOPAMFETCH\fR specifies how to download files: either `wget', `curl' or a custom command where variables \fB%{url}%\fR, \fB%{out}%\fR, \fB%{retries}%\fR, \fB%{compress}%\fR and \fB%{checksum}%\fR will be replaced. Overrides the 'download\-command' value from the main config file. .P \fIOPAMJOBS\fR sets the maximum number of parallel workers to run. .P \fIOPAMLOCKRETRIES\fR sets the number of tries after which OPAM gives up acquiring its lock and fails. <= 0 means infinite wait. .P \fIOPAMNO\fR answer no to any question asked. .P \fIOPAMNOASPCUD\fR see option `\-\-no\-aspcud'. .P \fIOPAMNOSELFUPGRADE\fR see option `\-\-no\-self\-upgrade'. .P \fIOPAMPINKINDAUTO\fR if set, version control systems are detected when pinning to a local path. .P \fIOPAMREQUIRECHECKSUMS\fR see option `\-\-require\-checksums'. .P \fIOPAMRETRY\fR sets the number of tries before failing downloads. .P \fIOPAMROOT\fR see option `\-\-root'. This is automatically set by `opam config env \-\-root=DIR' when DIR is non\-default or OPAMROOT is already defined. .P \fIOPAMSAFE\fR see option `\-\-safe' .P \fIOPAMSKIPVERSIONCHECKS\fR bypasses some version checks. Unsafe, for compatibility testing only. .P \fIOPAMSOLVERTIMEOUT\fR change the time allowance of the internal solver. .P \fIOPAMSTATUSLINE\fR display a dynamic status line showing what's currently going on on the terminal. (one of one of `always', `never' or `auto') .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),\-sum(solution,version\-lag),\-count(new). See also option \-\-criteria .P \fIOPAMUSEINTERNALSOLVER\fR see option `\-\-use\-internal\-solver'. .P \fIOPAMUTF8\fR use UTF8 characters in output (one of one of `always', `never' or `auto'). By default `auto', which is determined from the locale). .P \fIOPAMUTF8MSGS\fR use extended UTF8 characters (camels) in OPAM messages. Implies \fIOPAMUTF8\fR. This is set by default on OSX only. .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 \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 .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.