Updated man pages

doc/man-src/opam-config.md

@@ -1,6 +1,6 @@
-% OPAM-CONFIG(1) Opam Manual | Version 0.4
+% OPAM-CONFIG(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 

doc/man-src/opam-info.md

@@ -1,14 +1,14 @@
-% OPAM-INFO(1) Opam Manual | Version 0.4
+% OPAM-INFO(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 
 opam-info - Displays information about packages
 
 # SYNOPSIS
 
-*opam info* \<package\> [\<package\>...]
+*opam info* \<package\>...
 
 # DESCRIPTION
 

doc/man-src/opam-init.md

@@ -1,6 +1,6 @@
-% OPAM-INIT(1) Opam Manual | Version 0.4
+% OPAM-INIT(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 

doc/man-src/opam-install.md

@@ -1,6 +1,6 @@
-% OPAM-INSTALL(1) Opam Manual | Version 0.4
+% OPAM-INSTALL(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 
@@ -25,7 +25,7 @@ solution, opam will ask which one should be selected. If dependencies
 are to be installed, opam will ask if the installation should really
 be performed.
 
-# OPTIONS
+# PARAMETERS
 
 \<package\>...
 :   Package(s) to be installed.

doc/man-src/opam-list.md

@@ -1,14 +1,14 @@
-% OPAM-LIST(1) Opam Manual | Version 0.4
+% OPAM-LIST(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 
 opam-list - List packages
 
 # SYNOPSIS
 
-*opam list* [-short] [-installed] [\<packagepattern\>...]
+*opam list* [-short] [-installed] [\<package-name\>...]
 
 # DESCRIPTION
 
@@ -24,9 +24,9 @@ search* command.
 
 # OPTIONS
 
-\<packagepattern\>...
-:   List only packages whose name matches at least one
-    \<packagepattern\>. 
+\<package-name\>...
+:   List only packages whose name exactly matches at least one
+    \<package-name\>. 
 
 -short
 :   Output the names of packages separated by one whitespace instead of

doc/man-src/opam-pin.md

@@ -1,6 +1,6 @@
-% OPAM-PIN(1) Opam Manual | Version 0.4
+% OPAM-PIN(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 

doc/man-src/opam-reinstall.md

@@ -0,0 +1,28 @@
+% OPAM-REINSTALL(1) opam 0.6.0 | OPAM Manual
+% OCamlPro
+% 10/09/2012
+
+# NAME
+
+opam-reinstall - Re-install packages
+
+# SYNOPSIS
+
+*opam reinstall* \<package\>...
+
+# DESCRIPTION
+
+This command does *opam remove* followed by *opam install*.
+
+# PARAMETERS
+
+\<package\>...
+:   Package(s) to be installed.
+
+# SEE ALSO
+
+**opam-install**(1) **opam-remove**(1) **opam-switch**(1) **opam-list**(1)
+
+# OPAM
+
+Part of the opam(1) suite

doc/man-src/opam-remote.md

@@ -1,6 +1,6 @@
-% OPAM-REMOTE(1) Opam Manual | Version 0.4
+% OPAM-REMOTE(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 

doc/man-src/opam-remove.md

@@ -1,14 +1,14 @@
-% OPAM-REMOVE(1) Opam Manual | Version 0.4
+% OPAM-REMOVE(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 
 opam-remove - Remove installed packages
 
 # SYNOPSIS
 
-*opam remove* [\<package\>...]
+*opam remove* \<package\>...
 
 # DESCRIPTION
 
@@ -17,12 +17,11 @@ installed in the currently selected compiler. To remove packages
 installed in another compiler, you need to switch compilers using
 *opam switch*. This command is the inverse of *opam-install*.
 
-# OPTIONS
+# PARAMETERS
 
 \<package\>...
 :   Package(s) to be removed.
 
-
 # SEE ALSO
 
 **opam-install**(1) **opam-switch**(1)

doc/man-src/opam-search.md

@@ -1,6 +1,6 @@
-% OPAM-SEARCH(1) Opam Manual | Version 0.4
+% OPAM-SEARCH(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 
@@ -13,16 +13,14 @@ opam-search - Search into the package database
 # DESCRIPTION
 
 This command displays the list of available packages that match one of
-the \<packagepattern\>s specified as arguments. This command is almost
-identical to the *opam list* command, except that packages get
-selected if their descriptions match the pattern, in addition of their
-names.
+the \<packagepattern\>s specified as arguments. 
 
 # OPTIONS
 
 \<packagepattern\>...
-:   Search for packages whose name or description matches at least one
-    \<packagepattern\>. The case is not taken into account.
+:   Search for packages whose name or description matches (in the "glob"
+    sense) at least one \<packagepattern\>. The case is not taken into
+    account.
 
 # SEE ALSO
 

doc/man-src/opam-switch.md

@@ -1,6 +1,6 @@
-% OPAM-SWITCH(1) Opam Manual | Version 0.4
+% OPAM-SWITCH(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 
@@ -10,42 +10,83 @@ opam-switch - Switch compiler version
 
 *opam switch* -list
 
-*opam switch* [-no-base-packages] [-clone] [-alias \<alias\>] \<version\>
+*opam switch* -current
+
+*opam switch* \<alias\>
+
+*opam switch* [-no-base-packages] -install \<alias\> [-alias-of \<alias\>]
+
+*opam switch* -remove \<alias\>
+
+*opam switch* [-no-base-packages] -clone \<alias\>
 
 # DESCRIPTION
 
 This command allows to switch between different compiler versions,
 installing the compiler if *opam switch* is used to switch to that
 compiler for the first time. The different compiler versions are
 totally independant from each other, meaning that OPAM maintains a
-separate state (e.g. list of installed packages...) for each.
+separate state (e.g. list of installed packages...) for each. See
+the EXAMPLES section to learn how to use this command.
 
 # PARAMETERS
 
-\<version\>
-:   Switch to the compiler version \<version\>. The list of available
-    versions is obtained by doing *opam switch -list*
-
-# OPTIONS
-
 -list
 :   Displays the list of available compilers.
 
+-current
+:   Displays the current compiler in use.
+
+\<alias\>
+:   Switch to the compiler version \<alias\>, installing it if it is not
+    already installed. This is a shortcut to *opam switch -install
+    \<alias\>*. The list of available versions is obtained by doing
+    *opam switch -list*.
+
+-install \<alias\>
+:   Install a compiler version \<alias\>. See EXAMPLES.
+
+-remove \<alias\>
+:   Remove the compiler \<alias\>.
+
+-clone \<alias\>
+:   Install all packages installed in compiler \<alias\> into the
+    currently selected compiler.
+
+# OPTIONS
+
 -no-base-packages
 :   Will prevent *opam switch* from installing the base packages.
 
--clone
-:   Will try to install the packages that were installed before
-    switching (that are not currently installed). If not set, *opam
-    switch* will not install any package, thus creating a brand new
-    state for the newly selected compiler.
 
--alias \<alias\>
-:   Will switch to requested compiler version, but use the alternative
-    name \<alias\> instead of the the default compiler version’s
-    name. This is useful to create multiple instances of the same compiler
-    version.
+-alias-of \<alias\>
+:   Will switch to compiler version \<alias\>, but use the name
+    specified as an argument to -install instead of \<alias\>. This is
+    useful to create multiple instances of the same compiler
+    version. See EXAMPLES.
+
+# EXAMPLES
+
+* To install a brand new OCaml 4.00.0 and switch into it as the current
+compiler, do:
+
+`$ opam switch -install 4.00.0`
+
+* To remove OCaml 3.12.1, do:
+
+`$ opam switch -remove 3.12.1`
+
+* To install OCaml 4.00.0 under alias "foo" such that you will have
+  two instances of OCaml 4.00.0, each with its own environment
+  (i.e. list of installed packages, and so on):
+
+`$ opam switch -install foo -alias-of 4.00.0`
+
+* To install in "foo" all packages that are installed in "4.00.0":
 
+`$ opam switch foo
+ $ opam switch -clone 4.00.0
+`
 # OPAM
 
 Part of the opam(1) suite

doc/man-src/opam-update.md

@@ -1,6 +1,6 @@
-% OPAM-UPDATE(1) Opam Manual | Version 0.4
+% OPAM-UPDATE(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 

doc/man-src/opam-upgrade.md

@@ -1,6 +1,6 @@
-% OPAM-UPGRADE(1) Opam Manual | Version 0.4
+% OPAM-UPGRADE(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 

doc/man-src/opam-upload.md

@@ -1,6 +1,6 @@
-% OPAM-UPLOAD(1) Opam Manual | Version 0.4
+% OPAM-UPLOAD(1) opam 0.6.0 | OPAM Manual
 % OCamlPro
-% September 03, 2012
+% 10/09/2012
 
 # NAME
 
@@ -13,18 +13,24 @@ opam-upload - Upload a new package to a remote repository
 
 # DESCRIPTION
 
-TODO: add description
+This command uploads an already built package to a remote repository,
+if the remote repository is not read-only.
 
 # PARAMETERS
 
 -opam \<opam-file\>
-:   Specify the .opam file to use.
+:   Specify the .opam file that will be uploaded to repo://packages/name.version/opam
 
 -descr \<descr-file\>
-:   Specify the .descr file to use.
+:   Specify the .descr file that will be uploaded to repo://packages/name.version/descr
 
 -archive \<name.version.tar.gz\>
-:   
+:   Specify the archive that will be uploaded to repo://archives/name.version+opam.tar.gz
+
+# OPTIONS
+
+-repo \<repository\>
+:   Specify the repository to upload to. Defaults to the default repository.
 
 # SEE ALSO
 

doc/man/opam-config.1

@@ -1,4 +1,4 @@
-.TH OPAM-CONFIG 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.TH OPAM-CONFIG 1 "10/09/2012" "opam 0.6.0" "OPAM Manual"
 .SH NAME
 .PP
 opam-config - Getting package configuration

doc/man/opam-info.1

@@ -1,10 +1,10 @@
-.TH OPAM-INFO 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.TH OPAM-INFO 1 "10/09/2012" "opam 0.6.0" "OPAM Manual"
 .SH NAME
 .PP
 opam-info - Displays information about packages
 .SH SYNOPSIS
 .PP
-\f[I]opam info\f[] <package> [<package>...]
+\f[I]opam info\f[] <package>...
 .SH DESCRIPTION
 .PP
 This command displays the information block for the selected package(s).

doc/man/opam-init.1

@@ -1,4 +1,4 @@
-.TH OPAM-INIT 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.TH OPAM-INIT 1 "10/09/2012" "opam 0.6.0" "OPAM Manual"
 .SH NAME
 .PP
 opam-init - Creating a fresh client state