Update man pages

doc/man/opam-config.1

@@ -1,6 +1,6 @@
 .\" Pipe this output to groff -man -Tutf8 | less
 .\"
-.TH "OPAM-CONFIG" 1 "" "Opam 0.8.2" "Opam Manual"
+.TH "OPAM-CONFIG" 1 "" "Opam 0.9.0" "Opam Manual"
 .\" Disable hyphenantion and ragged-right
 .nh
 .ad l
@@ -9,39 +9,39 @@
 opam\-config \- Display configuration options for packages.
 .SH SYNOPSIS
 .P
-\fBopam config\fR [\fIOPTION\fR]... \fICOMMAND\fR [\fIARG\fR]...
+\fBopam config\fR [\fIOPTION\fR]... [\fIDOMAIN\fR] [\fIARG\fR]...
 .SH DESCRIPTION
 .P
 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.
 .P
 Apart from \fBopam config env\fR, most of these commands are used by opam internally, and thus are of limited interest for the casual user.
 .SH ARGUMENTS
 .TP 4
-\fICOMMAND\fR
-Name of the sub\-command. See the \fBCOMMANDS\fR section for more info.
+\fIDOMAIN\fR
+Name of the sub\-command. See the \fBDOMAINS\fR section for more info.
 .SH OPTIONS
 .TP 4
 \fB\-c\fR, \fB\-\-csh\fR
 Use csh\-compatible output mode.
 .TP 4
-\fB\-\-no\-base\-packages\fR
-Do not install base packages (useful for testing purposes).
+\fB\-e\fR \fIVAL\fR
+Backward\-compatible option, equivalent to \fBopam config env\fR.
 .TP 4
-\fB\-r\fR, \fB\-\-rec\fR
+\fB\-R\fR, \fB\-\-rec\fR
 Recursive query.
-.SH COMMANDS
+.SH DOMAINS
 .TP 4
 \fBenv\fR
 returns 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 \fBeval `opam config env`\fR.
 .TP 4
 \fBvar\fR
-returns the value associated with the given variable.
+returns the value associated with the given variable. If the variable contains a colon such as \fIpkg:var\fR, then the left element will be understood as the package in which the variable is defined. The variable resolution is done as follows: first, OPAM will check whether \fB$var\fR exists; for package variables, it will look for \fB$pkg_var\fR. If the variable is not found, OPAM will then check whether the variable is implicit. There are two global implicit variables: \fIocaml\-version\fR and \fIpreinstalled\fR and two implicit variables per package: \fIpkg:installed\fR which is either \fB"true"\fR or \fB"false"\fR, and \fIpkg:enable\fR which is either \fB"enable"\fR or \fB"disable"\fR. Finally, OPAM will look into its global and package config files to find whether these variables exist.
 .TP 4
 \fBlist\fR
-returns the list of all variables defined in the listed packages (no package = all).
+returns the list of all variables defined in the listed packages. It is possible to filter the list of variables by giving package names (use \fBglobals\fR to get the list of global variables). No parameter means displaying all the variables.
 .TP 4
 \fBsubst\fR
-substitutes variables in the given files.
+substitutes variables in the given files. The strings \fI%{var}%\fR are replaced by the value of the variable \fIvar\fR (see the documentation associated to \fBopam config var\fR).
 .TP 4
 \fBincludes\fR
 returns include options.
@@ -62,31 +62,46 @@ returns assembly compile options.
 These options are common to all commands.
 .TP 4
 \fB\-\-debug\fR
-Print debug message on stdout.
+Print debug message on stdout. This is equivalent to setting \fB$OPAMDEBUG\fR to a value greater or equal to 2.
 .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\-q\fR, \fB\-\-quiet\fR
-Be quiet.
+Be quiet when installing a new compiler.
 .TP 4
 \fB\-r\fR \fIROOT\fR, \fB\-\-root\fR=\fIROOT\fR (absent=/Users/tgazagna/.opam)
-Use \fIROOT\fR as the current root path.
+Use \fIROOT\fR as the current root path. This is equivalent to setting \fB$OPAMROOT\fR to \fIROOT\fR.
 .TP 4
 \fB\-s\fR \fISWITCH\fR, \fB\-\-switch\fR=\fISWITCH\fR
-Use \fISWITCH\fR as the current compiler switch.
+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.
+Be more verbose. This is equivalent to setting either \fB$OPAMDEBUG\fR to a value greater or equal to 1 or \fB$OPAMVERBOSE\fR to a non\-empty string.
 .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 beasked to the user.
+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 FURTHER DOCUMENTATION
+.P
+See http://opam.ocamlpro.com.
 .SH AUTHORS
 .P
 Thomas Gazagnaire <thomas.gazagnaire@ocamlpro.com>
+.sp -1
+.P
+Frederic Tuong <frederic.tuong@inria.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/OCamlPro/opam/issues.

doc/man/opam-help.1

@@ -1,18 +1,18 @@
 .\" Pipe this output to groff -man -Tutf8 | less
 .\"
-.TH "OPAM-HELP" 1 "" "Opam 0.8.2" "Opam Manual"
+.TH "OPAM-HELP" 1 "" "Opam 0.9.0" "Opam Manual"
 .\" Disable hyphenantion and ragged-right
 .nh
 .ad l
 .SH NAME
 .P
-opam\-help \- display help about opam and opam commands.
+opam\-help \- Display help about OPAM and OPAM commands.
 .SH SYNOPSIS
 .P
 \fBopam help\fR [\fIOPTION\fR]... [\fITOPIC\fR]
 .SH DESCRIPTION
 .P
-Prints help about opam commands.
+Prints help about OPAM commands.
 .P
 Use `opam help topics' to get the full list of help topics.
 .SH ARGUMENTS

doc/man/opam-info.1

@@ -1,6 +1,6 @@
 .\" Pipe this output to groff -man -Tutf8 | less
 .\"
-.TH "OPAM-INFO" 1 "" "Opam 0.8.2" "Opam Manual"
+.TH "OPAM-INFO" 1 "" "Opam 0.9.0" "Opam Manual"
 .\" Disable hyphenantion and ragged-right
 .nh
 .ad l
@@ -14,47 +14,58 @@ opam\-info \- Display information about specific packages.
 .P
 This command displays the information block for the selected package(s).
 .P
-The information block consists in the name of the package, the installed version if this package is installed in the current selected compiler, the list of available (installable) versions, and a complete description.
+The information block consists in the name of the package, the installed version if this package is installed in the currently selected compiler, the list of available (installable) versions, and a complete description.
 .P
 \fBopam list\fR can be used to display the list of available packages as well as a short description for each.
 .SH ARGUMENTS
 .TP 4
 \fIPATTERNS\fR
 List of package patterns.
-.SH OPTIONS
-.TP 4
-\fB\-\-no\-base\-packages\fR
-Do not install base packages (useful for testing purposes).
 .SH COMMON OPTIONS
 .P
 These options are common to all commands.
 .TP 4
 \fB\-\-debug\fR
-Print debug message on stdout.
+Print debug message on stdout. This is equivalent to setting \fB$OPAMDEBUG\fR to a value greater or equal to 2.
 .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\-q\fR, \fB\-\-quiet\fR
-Be quiet.
+Be quiet when installing a new compiler.
 .TP 4
 \fB\-r\fR \fIROOT\fR, \fB\-\-root\fR=\fIROOT\fR (absent=/Users/tgazagna/.opam)
-Use \fIROOT\fR as the current root path.
+Use \fIROOT\fR as the current root path. This is equivalent to setting \fB$OPAMROOT\fR to \fIROOT\fR.
 .TP 4
 \fB\-s\fR \fISWITCH\fR, \fB\-\-switch\fR=\fISWITCH\fR
-Use \fISWITCH\fR as the current compiler switch.
+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.
+Be more verbose. This is equivalent to setting either \fB$OPAMDEBUG\fR to a value greater or equal to 1 or \fB$OPAMVERBOSE\fR to a non\-empty string.
 .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 beasked to the user.
+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 FURTHER DOCUMENTATION
+.P
+See http://opam.ocamlpro.com.
 .SH AUTHORS
 .P
 Thomas Gazagnaire <thomas.gazagnaire@ocamlpro.com>
+.sp -1
+.P
+Frederic Tuong <frederic.tuong@inria.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/OCamlPro/opam/issues.

doc/man/opam-init.1

@@ -1,20 +1,20 @@
 .\" Pipe this output to groff -man -Tutf8 | less
 .\"
-.TH "OPAM-INIT" 1 "" "Opam 0.8.2" "Opam Manual"
+.TH "OPAM-INIT" 1 "" "Opam 0.9.0" "Opam Manual"
 .\" Disable hyphenantion and ragged-right
 .nh
 .ad l
 .SH NAME
 .P
-opam\-init \- Initialize opam.
+opam\-init \- Initialize OPAM state.
 .SH SYNOPSIS
 .P
 \fBopam init\fR [\fIOPTION\fR]... [\fINAME\fR] [\fIADDRESS\fR]
 .SH DESCRIPTION
 .P
-The init command creates a fresh client state, that is initialize opam configuration in ~/.opam and setup a default repository.
+The \fBinit\fR command creates a fresh client state. This initializes OPAM configuration in \fI~/.opam\fR and configures a default package repository.
 .P
-Additional repositories can later be added by using the \fBopam repository\fR command.
+Additional repositories can be added later by using the \fBopam repository\fR command.
 .P
 The local cache of a repository state can be updated by using \fBopam update\fR.
 .SH ARGUMENTS
@@ -33,40 +33,52 @@ Which compiler version to use.
 Number of process to use when building packages.
 .TP 4
 \fB\-k\fR \fIKIND\fR, \fB\-\-kind\fR=\fIKIND\fR
-Specify the kind of the repository to be set (the main ones are 'http', 'local' or 'git').
-.TP 4
-\fB\-\-no\-base\-packages\fR
-Do not install base packages (useful for testing purposes).
+Specify the kind of the repository to be set (the main ones are 'http', 'local', 'git' or 'darcs').
 .SH COMMON OPTIONS
 .P
 These options are common to all commands.
 .TP 4
 \fB\-\-debug\fR
-Print debug message on stdout.
+Print debug message on stdout. This is equivalent to setting \fB$OPAMDEBUG\fR to a value greater or equal to 2.
 .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\-q\fR, \fB\-\-quiet\fR
-Be quiet.
+Be quiet when installing a new compiler.
 .TP 4
 \fB\-r\fR \fIROOT\fR, \fB\-\-root\fR=\fIROOT\fR (absent=/Users/tgazagna/.opam)
-Use \fIROOT\fR as the current root path.
+Use \fIROOT\fR as the current root path. This is equivalent to setting \fB$OPAMROOT\fR to \fIROOT\fR.
 .TP 4
 \fB\-s\fR \fISWITCH\fR, \fB\-\-switch\fR=\fISWITCH\fR
-Use \fISWITCH\fR as the current compiler switch.
+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.
+Be more verbose. This is equivalent to setting either \fB$OPAMDEBUG\fR to a value greater or equal to 1 or \fB$OPAMVERBOSE\fR to a non\-empty string.
 .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 beasked to the user.
+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 FURTHER DOCUMENTATION
+.P
+See http://opam.ocamlpro.com.
 .SH AUTHORS
 .P
 Thomas Gazagnaire <thomas.gazagnaire@ocamlpro.com>
+.sp -1
+.P
+Frederic Tuong <frederic.tuong@inria.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/OCamlPro/opam/issues.

doc/man/opam-install.1

@@ -1,6 +1,6 @@
 .\" Pipe this output to groff -man -Tutf8 | less
 .\"
-.TH "OPAM-INSTALL" 1 "" "Opam 0.8.2" "Opam Manual"
+.TH "OPAM-INSTALL" 1 "" "Opam 0.9.0" "Opam Manual"
 .\" Disable hyphenantion and ragged-right
 .nh
 .ad l
@@ -22,46 +22,58 @@ List of package names.
 .SH OPTIONS
 .TP 4
 \fB\-b\fR, \fB\-\-keep\-build\-dir\fR
-Keep the build directory.
+Keep the build directory. This is equivalent to setting \fB$OPAMKEEPBUILDIR\fR to a non\-empty string.
 .TP 4
-\fB\-m\fR \fIMAKE\fR, \fB\-\-makecmd\fR=\fIMAKE\fR, \fB\-\-make\fR=\fIMAKE\fR
+\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\-checksums\fR
-Do not verify the checksum of downloaded archives.
-.TP 4
-\fB\-\-no\-base\-packages\fR
-Do not install base packages (useful for testing purposes).
+Do not verify the checksum of downloaded archives. This is equivalent to setting \fB$OPAMNOCHECKSUMS\fR to a non\-empty string.
 .SH COMMON OPTIONS
 .P
 These options are common to all commands.
 .TP 4
 \fB\-\-debug\fR
-Print debug message on stdout.
+Print debug message on stdout. This is equivalent to setting \fB$OPAMDEBUG\fR to a value greater or equal to 2.
 .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\-q\fR, \fB\-\-quiet\fR
-Be quiet.
+Be quiet when installing a new compiler.
 .TP 4
 \fB\-r\fR \fIROOT\fR, \fB\-\-root\fR=\fIROOT\fR (absent=/Users/tgazagna/.opam)
-Use \fIROOT\fR as the current root path.
+Use \fIROOT\fR as the current root path. This is equivalent to setting \fB$OPAMROOT\fR to \fIROOT\fR.
 .TP 4
 \fB\-s\fR \fISWITCH\fR, \fB\-\-switch\fR=\fISWITCH\fR
-Use \fISWITCH\fR as the current compiler switch.
+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.
+Be more verbose. This is equivalent to setting either \fB$OPAMDEBUG\fR to a value greater or equal to 1 or \fB$OPAMVERBOSE\fR to a non\-empty string.
 .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 beasked to the user.
+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 FURTHER DOCUMENTATION
+.P
+See http://opam.ocamlpro.com.
 .SH AUTHORS
 .P
 Thomas Gazagnaire <thomas.gazagnaire@ocamlpro.com>
+.sp -1
+.P
+Frederic Tuong <frederic.tuong@inria.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/OCamlPro/opam/issues.