Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added man-src, man, and a rule for Makefile

  • Loading branch information...
commit fc51e07709622b14df6d3478999bbdc39d23f9eb 1 parent a60c265
Vincent Bernardoff authored
View
6 Makefile
@@ -63,6 +63,11 @@ META: META.in
.PHONY: install
install:
$(MAKE) $(TARGETS:%=%-install)
+ mkdir -p $(PREFIX)/share/man/man1 && cp doc/man/* $(PREFIX)/share/man/man1
+
+uninstall:
+ rm -f $(PREFIX)/bin/opam*
+ rm -f $(PREFIX)/share/man/man1/opam*
doc: compile
mkdir -p doc/html/
@@ -71,6 +76,7 @@ doc: compile
-I _obuild/bat -I _obuild/unix -I _obuild/extlib \
-I _obuild/arg -I _obuild/graph \
src/*.mli -html -d doc/html/
+ $(MAKE) -C doc/man-src
trailing:
find src -name "*.ml*" -exec \
View
16 doc/man-src/Makefile
@@ -0,0 +1,16 @@
+SRC=$(wildcard *.md)
+DST=$(SRC:.md=.1)
+
+
+all: mkdir $(SRC) $(DST)
+
+mkdir:
+ mkdir -p ../man
+
+%.1: %.md
+ pandoc -s -t man -o ../man/$@ $^
+
+.PHONY: clean
+
+clean:
+ rm -rf ../man
View
66 doc/man-src/opam-config.md
@@ -0,0 +1,66 @@
+% OPAM-CONFIG(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-config - Getting package configuration
+
+# SYNOPSIS
+
+*opam config* -env
+
+*opam config* -list-vars
+
+*opam config* -var \<var\>
+
+*opam config* -subst \<filename\>...
+
+*opam config* [-r] -I \<name\>...
+
+*opam config* [-r] -bytecomp \<name\>[.\<lib\>]...
+
+*opam config* [-r] -asmcomp \<name\>[.\<lib\>]...
+
+*opam config* [-r] -bytelink \<name\>[.\<lib\>]...
+
+*opam config* [-r] -asmlink \<name\>[.\<lib\>]...
+
+# DESCRIPTION
+
+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. Apart from *opam config -env*, most
+of these commands are used by opam internally, and thus are of limited
+interest for the user.
+
+# OPTIONS
+
+-env
+: Set 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 *eval `opam config -env`*.
+
+-list-vars
+: Return the list of all variables defined in installed packages.
+
+-var \<var\>
+: Return the value associated with variable \<var\>
+
+-subst \<filename\>...
+: Substitute variables in file \<filename\>.in to create \<filename\>
+
+-I \<name\>...
+
+: Return the list of paths to include when compiling a project using
+ the package \<name\>. Using the -r option will take into account the
+ transitive closure of dependencies.
+
+-bytecomp|-asmcomp|-bytelink|-asmlink \<name\>[.\<lib\>]...
+: Return the associated value for section \<lib\> in the config file
+ for package \<name\>.
+
+# OPAM
+
+Part of the opam(1) suite
View
33 doc/man-src/opam-info.md
@@ -0,0 +1,33 @@
+% OPAM-INFO(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-info - Displays information about packages
+
+# SYNOPSIS
+
+*opam info* \<package\> [\<package\>...]
+
+# DESCRIPTION
+
+This command displays the information block for the selected
+package(s). 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. *opam list* can be used to display the list of
+available packages as well as a short description for each.
+
+# OPTIONS
+
+\<package\>...
+: Display the information block for multiple packages.
+
+# SEE ALSO
+
+**opam-list**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
43 doc/man-src/opam-init.md
@@ -0,0 +1,43 @@
+% OPAM-INIT(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-init - Creating a fresh client state
+
+# SYNOPSIS
+
+*opam init* [-kind \<kind\>] \<repo-name\> \<repo-address\>
+
+# DESCRIPTION
+
+This command creates a fresh client state, that is initialize opam
+configuration in $HOME/.opam and setup a default repository by calling
+*opam-\<kind\>-init*. Additional repositories can later be added by
+using the *opam remote* command. The local cache of a repository state
+can be updated by using *opam update*.
+
+# PARAMETERS
+
+\<repo-name\>
+: Name of the repository. Default value "default".
+
+\<repo-address\>
+: Address of the repository. Default value "http://opam.ocamlpro.com"
+
+# OPTIONS
+
+-kind \<kind\>
+: Specify the kind of the repository to be set. Possible
+ values: "http", "rsync", "git". Default value "http".
+
+
+# SEE ALSO
+
+**opam-remote**(1) **opam-update**(1) **opam-http-init**(1)
+ **opam-rsync-init**(1) **opam-git-init**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
39 doc/man-src/opam-install.md
@@ -0,0 +1,39 @@
+% OPAM-INSTALL(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-install - Install packages
+
+# SYNOPSIS
+
+*opam install* \<package\>...
+
+# DESCRIPTION
+
+This command installs one or more packages to the currently selected
+compiler. To install packages for another compiler, you need to switch
+compilers using *opam switch*. You can remove installed packages with
+*opam remove*, and list installed packages with *opam list
+-installed*.
+
+This command will make opam use the dependency solver to compute the
+transitive closure of dependencies to be installed, and will handle
+conflicts as well. If the dependency solver returns more than one
+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
+
+\<package\>...
+: Package(s) to be installed.
+
+# SEE ALSO
+
+**opam-remove**(1) **opam-switch**(1) **opam-list**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
44 doc/man-src/opam-list.md
@@ -0,0 +1,44 @@
+% OPAM-LIST(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-list - List packages
+
+# SYNOPSIS
+
+*opam list* [-short] [-installed] [\<packagepattern\>...]
+
+# DESCRIPTION
+
+This command displays the list of available packages, or the list of
+installed packages if the -installed switch is used.
+
+Unless the -short 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
+desctription. The full description can be obtained by doing *opam info
+<package>*. You can search into the package list with the *opam
+search* command.
+
+# OPTIONS
+
+\<packagepattern\>...
+: List only packages whose name matches at least one
+ \<packagepattern\>.
+
+-short
+: Output the names of packages separated by one whitespace instead of
+ using the usual formatting.
+
+-installed
+: List installed packages only.
+
+# SEE ALSO
+
+**opam-search**(1) **opam-info**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
43 doc/man-src/opam-pin.md
@@ -0,0 +1,43 @@
+% OPAM-PIN(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-pin - Pin a package to a specific version
+
+# SYNOPSIS
+
+*opam pin* \<package\> \<version\>
+
+*opam pin* \<package\> \<url\>
+
+*opam pin* \<package\> none
+
+# DESCRIPTION
+
+This command will "pin" a package to a specific version, or use a
+specific source path for installing and upgrading the package. Using
+*opam pin \<package\> none* will undo the "pinned" status of
+\<package\>.
+
+# PARAMETERS
+
+\<package\>
+: Specify package to pin or unpin.
+
+\<version\>
+: Pin the selected package to a specific version.
+
+\<url\>
+: Use the specified url for installing or upgrading the package. This
+ means that from now on, *opam install* and *opam upgrade* will use the
+ specified url to install (respectively upgrade) the package.
+
+none
+: Unpin the package, i.e. use the default sources and version for the
+ package.
+
+# OPAM
+
+Part of the opam(1) suite
View
51 doc/man-src/opam-remote.md
@@ -0,0 +1,51 @@
+% OPAM-REMOTE(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-remote - Manage OPAM repositories
+
+# SYNOPSIS
+
+*opam remote* -list
+
+*opam remote* -rm \<name\>
+
+*opam remote* -add [-kind \<kind\>] \<name\> \<address\>
+
+# DESCRIPTION
+
+This command is used to manage OPAM repositories. To synchronize OPAM
+with the last versions of the packages available in remote
+repositories, *opam update* should be used.
+
+# PARAMETERS
+
+-list
+: Lists all repositories used by OPAM.
+
+-rm \<name\>
+: Removes the repository named \<name\> from the list of repositories used by OPAM.
+
+-add \<name\> \<address\>
+: Add the repository \<name\> available at address \<address\> to
+ the list of repositories used by OPAM. The kind of the repository
+ can be specified with the *-kind* option, otherwise it will be
+ determined automatically.
+
+# OPTIONS
+
+-kind \<kind\>
+: Specify the kind of the repository to be added. If not used, *opam
+ remote add* will try to figure out automatically what kind of
+ repository to use.
+
+
+# SEE ALSO
+
+**opam-update**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
32 doc/man-src/opam-remove.md
@@ -0,0 +1,32 @@
+% OPAM-REMOVE(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-remove - Remove installed packages
+
+# SYNOPSIS
+
+*opam remove* [\<package\>...]
+
+# DESCRIPTION
+
+This command removes (i.e. uninstall) one or more packages currently
+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
+
+\<package\>...
+: Package(s) to be removed.
+
+
+# SEE ALSO
+
+**opam-install**(1) **opam-switch**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
33 doc/man-src/opam-search.md
@@ -0,0 +1,33 @@
+% OPAM-SEARCH(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-search - Search into the package database
+
+# SYNOPSIS
+
+*opam search* \<packagepattern\>...
+
+# 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.
+
+# OPTIONS
+
+\<packagepattern\>...
+: Search for packages whose name or description matches at least one
+ \<packagepattern\>. The case is not taken into account.
+
+# SEE ALSO
+
+**opam-list**(1) **opam-info**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
51 doc/man-src/opam-switch.md
@@ -0,0 +1,51 @@
+% OPAM-SWITCH(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-switch - Switch compiler version
+
+# SYNOPSIS
+
+*opam switch* -list
+
+*opam switch* [-no-base-packages] [-clone] [-alias \<alias\>] \<version\>
+
+# 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.
+
+# 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.
+
+-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.
+
+# OPAM
+
+Part of the opam(1) suite
View
26 doc/man-src/opam-update.md
@@ -0,0 +1,26 @@
+% OPAM-UPDATE(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-update - Synchronize repositories
+
+# SYNOPSIS
+
+*opam update*
+
+# DESCRIPTION
+
+This command updates each repository that has been previously set up
+by the *opam init* or *opam remote* commands. The list of packages
+that can be upgraded will be printed out, and the user can use *opam
+upgrade* to upgrade those.
+
+# SEE ALSO
+
+**opam-init**(1) **opam-remote**(1) **opam-upgrade**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
30 doc/man-src/opam-upgrade.md
@@ -0,0 +1,30 @@
+% OPAM-UPGRADE(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-upgrade - Upgrade installed packages
+
+# SYNOPSIS
+
+*opam upgrade*
+
+# DESCRIPTION
+
+This command upgrades the installed packages to their latest available
+versions. More precisely, this command call the dependency solver to
+find a consistent state where **most** of the installed packages are
+upgraded to their latest versions.
+
+# OPTIONS
+
+None
+
+# SEE ALSO
+
+**opam-remote**(1) **opam-update**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
35 doc/man-src/opam-upload.md
@@ -0,0 +1,35 @@
+% OPAM-UPLOAD(1) Opam Manual | Version 0.4
+% OCamlPro
+% September 03, 2012
+
+# NAME
+
+opam-upload - Upload a new package to a remote repository
+
+# SYNOPSIS
+
+*opam upload* -opam \<opam-file\> -descr \<descr-file\> -archive
+ \<name.version.tar.gz\> [-repo \<repository\>]
+
+# DESCRIPTION
+
+TODO: add description
+
+# PARAMETERS
+
+-opam \<opam-file\>
+: Specify the .opam file to use.
+
+-descr \<descr-file\>
+: Specify the .descr file to use.
+
+-archive \<name.version.tar.gz\>
+:
+
+# SEE ALSO
+
+**opam-remote**(1) **opam-upgrade**(1)
+
+# OPAM
+
+Part of the opam(1) suite
View
73 doc/man/opam-config.1
@@ -0,0 +1,73 @@
+.TH OPAM-CONFIG 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-config - Getting package configuration
+.SH SYNOPSIS
+.PP
+\f[I]opam config\f[] -env
+.PP
+\f[I]opam config\f[] -list-vars
+.PP
+\f[I]opam config\f[] -var <var>
+.PP
+\f[I]opam config\f[] -subst <filename>...
+.PP
+\f[I]opam config\f[] [-r] -I <name>...
+.PP
+\f[I]opam config\f[] [-r] -bytecomp <name>[.<lib>]...
+.PP
+\f[I]opam config\f[] [-r] -asmcomp <name>[.<lib>]...
+.PP
+\f[I]opam config\f[] [-r] -bytelink <name>[.<lib>]...
+.PP
+\f[I]opam config\f[] [-r] -asmlink <name>[.<lib>]...
+.SH DESCRIPTION
+.PP
+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.
+Apart from \f[I]opam config -env\f[], most of these commands are used by
+opam internally, and thus are of limited interest for the user.
+.SH OPTIONS
+.TP
+.B -env
+Set 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 \f[I]eval \f[C]opam\ config\ -env\f[]\f[].
+.RS
+.RE
+.TP
+.B -list-vars
+Return the list of all variables defined in installed packages.
+.RS
+.RE
+.TP
+.B -var <var>
+Return the value associated with variable <var>
+.RS
+.RE
+.TP
+.B -subst <filename>...
+Substitute variables in file <filename>.in to create <filename>
+.RS
+.RE
+.TP
+.B -I <name>...
+Return the list of paths to include when compiling a project using the
+package <name>.
+Using the -r option will take into account the transitive closure of
+dependencies.
+.RS
+.RE
+.TP
+.B -bytecomp|-asmcomp|-bytelink|-asmlink <name>[.<lib>]...
+Return the associated value for section <lib> in the config file for
+package <name>.
+.RS
+.RE
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
30 doc/man/opam-info.1
@@ -0,0 +1,30 @@
+.TH OPAM-INFO 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-info - Displays information about packages
+.SH SYNOPSIS
+.PP
+\f[I]opam info\f[] <package> [<package>...]
+.SH DESCRIPTION
+.PP
+This command displays the information block for the selected package(s).
+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.
+\f[I]opam list\f[] can be used to display the list of available packages
+as well as a short description for each.
+.SH OPTIONS
+.TP
+.B <package>...
+Display the information block for multiple packages.
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-list\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
47 doc/man/opam-init.1
@@ -0,0 +1,47 @@
+.TH OPAM-INIT 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-init - Creating a fresh client state
+.SH SYNOPSIS
+.PP
+\f[I]opam init\f[] [-kind <kind>] <repo-name> <repo-address>
+.SH DESCRIPTION
+.PP
+This command creates a fresh client state, that is initialize opam
+configuration in $HOME/.opam and setup a default repository by calling
+\f[I]opam-<kind>-init\f[].
+Additional repositories can later be added by using the \f[I]opam
+remote\f[] command.
+The local cache of a repository state can be updated by using \f[I]opam
+update\f[].
+.SH PARAMETERS
+.TP
+.B <repo-name>
+Name of the repository.
+Default value "default".
+.RS
+.RE
+.TP
+.B <repo-address>
+Address of the repository.
+Default value "http://opam.ocamlpro.com"
+.RS
+.RE
+.SH OPTIONS
+.TP
+.B -kind <kind>
+Specify the kind of the repository to be set.
+Possible values: "http", "rsync", "git".
+Default value "http".
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-remote\f[](1) \f[B]opam-update\f[](1)
+\f[B]opam-http-init\f[](1) \f[B]opam-rsync-init\f[](1)
+\f[B]opam-git-init\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
37 doc/man/opam-install.1
@@ -0,0 +1,37 @@
+.TH OPAM-INSTALL 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-install - Install packages
+.SH SYNOPSIS
+.PP
+\f[I]opam install\f[] <package>...
+.SH DESCRIPTION
+.PP
+This command installs one or more packages to the currently selected
+compiler.
+To install packages for another compiler, you need to switch compilers
+using \f[I]opam switch\f[].
+You can remove installed packages with \f[I]opam remove\f[], and list
+installed packages with \f[I]opam list -installed\f[].
+.PP
+This command will make opam use the dependency solver to compute the
+transitive closure of dependencies to be installed, and will handle
+conflicts as well.
+If the dependency solver returns more than one 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.
+.SH OPTIONS
+.TP
+.B <package>...
+Package(s) to be installed.
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-remove\f[](1) \f[B]opam-switch\f[](1) \f[B]opam-list\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
44 doc/man/opam-list.1
@@ -0,0 +1,44 @@
+.TH OPAM-LIST 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-list - List packages
+.SH SYNOPSIS
+.PP
+\f[I]opam list\f[] [-short] [-installed] [<packagepattern>...]
+.SH DESCRIPTION
+.PP
+This command displays the list of available packages, or the list of
+installed packages if the -installed switch is used.
+.PP
+Unless the -short 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
+desctription.
+The full description can be obtained by doing \f[I]opam info \f[].
+You can search into the package list with the \f[I]opam search\f[]
+command.
+.SH OPTIONS
+.TP
+.B <packagepattern>...
+List only packages whose name matches at least one <packagepattern>.
+.RS
+.RE
+.TP
+.B -short
+Output the names of packages separated by one whitespace instead of
+using the usual formatting.
+.RS
+.RE
+.TP
+.B -installed
+List installed packages only.
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-search\f[](1) \f[B]opam-info\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
47 doc/man/opam-pin.1
@@ -0,0 +1,47 @@
+.TH OPAM-PIN 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-pin - Pin a package to a specific version
+.SH SYNOPSIS
+.PP
+\f[I]opam pin\f[] <package> <version>
+.PP
+\f[I]opam pin\f[] <package> <url>
+.PP
+\f[I]opam pin\f[] <package> none
+.SH DESCRIPTION
+.PP
+This command will "pin" a package to a specific version, or use a
+specific source path for installing and upgrading the package.
+Using \f[I]opam pin <package> none\f[] will undo the "pinned" status of
+<package>.
+.SH PARAMETERS
+.TP
+.B <package>
+Specify package to pin or unpin.
+.RS
+.RE
+.TP
+.B <version>
+Pin the selected package to a specific version.
+.RS
+.RE
+.TP
+.B <url>
+Use the specified url for installing or upgrading the package.
+This means that from now on, \f[I]opam install\f[] and \f[I]opam
+upgrade\f[] will use the specified url to install (respectively upgrade)
+the package.
+.RS
+.RE
+.TP
+.B none
+Unpin the package, i.e.
+use the default sources and version for the package.
+.RS
+.RE
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
52 doc/man/opam-remote.1
@@ -0,0 +1,52 @@
+.TH OPAM-REMOTE 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-remote - Manage OPAM repositories
+.SH SYNOPSIS
+.PP
+\f[I]opam remote\f[] -list
+.PP
+\f[I]opam remote\f[] -rm <name>
+.PP
+\f[I]opam remote\f[] -add [-kind <kind>] <name> <address>
+.SH DESCRIPTION
+.PP
+This command is used to manage OPAM repositories.
+To synchronize OPAM with the last versions of the packages available in
+remote repositories, \f[I]opam update\f[] should be used.
+.SH PARAMETERS
+.TP
+.B -list
+Lists all repositories used by OPAM.
+.RS
+.RE
+.TP
+.B -rm <name>
+Removes the repository named <name> from the list of repositories used
+by OPAM.
+.RS
+.RE
+.TP
+.B -add <name> <address>
+Add the repository <name> available at address <address> to the list of
+repositories used by OPAM.
+The kind of the repository can be specified with the \f[I]-kind\f[]
+option, otherwise it will be determined automatically.
+.RS
+.RE
+.SH OPTIONS
+.TP
+.B -kind <kind>
+Specify the kind of the repository to be added.
+If not used, \f[I]opam remote add\f[] will try to figure out
+automatically what kind of repository to use.
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-update\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
29 doc/man/opam-remove.1
@@ -0,0 +1,29 @@
+.TH OPAM-REMOVE 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-remove - Remove installed packages
+.SH SYNOPSIS
+.PP
+\f[I]opam remove\f[] [<package>...]
+.SH DESCRIPTION
+.PP
+This command removes (i.e.
+uninstall) one or more packages currently installed in the currently
+selected compiler.
+To remove packages installed in another compiler, you need to switch
+compilers using \f[I]opam switch\f[].
+This command is the inverse of \f[I]opam-install\f[].
+.SH OPTIONS
+.TP
+.B <package>...
+Package(s) to be removed.
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-install\f[](1) \f[B]opam-switch\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
30 doc/man/opam-search.1
@@ -0,0 +1,30 @@
+.TH OPAM-SEARCH 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-search - Search into the package database
+.SH SYNOPSIS
+.PP
+\f[I]opam search\f[] <packagepattern>...
+.SH DESCRIPTION
+.PP
+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 \f[I]opam list\f[] command,
+except that packages get selected if their descriptions match the
+pattern, in addition of their names.
+.SH OPTIONS
+.TP
+.B <packagepattern>...
+Search for packages whose name or description matches at least one
+<packagepattern>.
+The case is not taken into account.
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-list\f[](1) \f[B]opam-info\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
59 doc/man/opam-switch.1
@@ -0,0 +1,59 @@
+.TH OPAM-SWITCH 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-switch - Switch compiler version
+.SH SYNOPSIS
+.PP
+\f[I]opam switch\f[] -list
+.PP
+\f[I]opam switch\f[] [-no-base-packages] [-clone] [-alias <alias>]
+<version>
+.SH DESCRIPTION
+.PP
+This command allows to switch between different compiler versions,
+installing the compiler if \f[I]opam switch\f[] 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.
+.SH PARAMETERS
+.TP
+.B <version>
+Switch to the compiler version <version>.
+The list of available versions is obtained by doing \f[I]opam switch
+-list\f[]
+.RS
+.RE
+.SH OPTIONS
+.TP
+.B -list
+Displays the list of available compilers.
+.RS
+.RE
+.TP
+.B -no-base-packages
+Will prevent \f[I]opam switch\f[] from installing the base packages.
+.RS
+.RE
+.TP
+.B -clone
+Will try to install the packages that were installed before switching
+(that are not currently installed).
+If not set, \f[I]opam switch\f[] will not install any package, thus
+creating a brand new state for the newly selected compiler.
+.RS
+.RE
+.TP
+.B -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.
+.RS
+.RE
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
21 doc/man/opam-update.1
@@ -0,0 +1,21 @@
+.TH OPAM-UPDATE 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-update - Synchronize repositories
+.SH SYNOPSIS
+.PP
+\f[I]opam update\f[]
+.SH DESCRIPTION
+.PP
+This command updates each repository that has been previously set up by
+the \f[I]opam init\f[] or \f[I]opam remote\f[] commands.
+The list of packages that can be upgraded will be printed out, and the
+user can use \f[I]opam upgrade\f[] to upgrade those.
+.SH SEE ALSO
+.PP
+\f[B]opam-init\f[](1) \f[B]opam-remote\f[](1) \f[B]opam-upgrade\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
25 doc/man/opam-upgrade.1
@@ -0,0 +1,25 @@
+.TH OPAM-UPGRADE 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-upgrade - Upgrade installed packages
+.SH SYNOPSIS
+.PP
+\f[I]opam upgrade\f[]
+.SH DESCRIPTION
+.PP
+This command upgrades the installed packages to their latest available
+versions.
+More precisely, this command call the dependency solver to find a
+consistent state where \f[B]most\f[] of the installed packages are
+upgraded to their latest versions.
+.SH OPTIONS
+.PP
+None
+.SH SEE ALSO
+.PP
+\f[B]opam-remote\f[](1) \f[B]opam-update\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
View
34 doc/man/opam-upload.1
@@ -0,0 +1,34 @@
+.TH OPAM-UPLOAD 1 "September 03, 2012" "Opam Manual" "Version 0.4"
+.SH NAME
+.PP
+opam-upload - Upload a new package to a remote repository
+.SH SYNOPSIS
+.PP
+\f[I]opam upload\f[] -opam <opam-file> -descr <descr-file> -archive
+<name.version.tar.gz> [-repo <repository>]
+.SH DESCRIPTION
+.PP
+TODO: add description
+.SH PARAMETERS
+.TP
+.B -opam <opam-file>
+Specify the .opam file to use.
+.RS
+.RE
+.TP
+.B -descr <descr-file>
+Specify the .descr file to use.
+.RS
+.RE
+.TP
+.B -archive <name.version.tar.gz>
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]opam-remote\f[](1) \f[B]opam-upgrade\f[](1)
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.
Please sign in to comment.
Something went wrong with that request. Please try again.