Skip to content
Browse files

Updated man-pages: added a man page for opam(1), cosmetics in others

  • Loading branch information...
1 parent d47bb90 commit 899d8676479e0f5188825096ccb1c798776d9606 Vincent Bernardoff committed
View
6 doc/man-src/opam-init.md
@@ -13,7 +13,7 @@ opam-init - Creating a fresh client state
# DESCRIPTION
This command creates a fresh client state, that is initialize opam
-configuration in $HOME/.opam and setup a default repository by calling
+configuration in ~/.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*.
@@ -35,8 +35,8 @@ can be updated by using *opam update*.
# SEE ALSO
-**opam-remote**(1) **opam-update**(1) **opam-http-init**(1)
- **opam-rsync-init**(1) **opam-git-init**(1)
+**opam-remote**(1), **opam-update**(1), **opam-http-init**(1),
+ **opam-rsync-init**(1), **opam-git-init**(1)
# OPAM
View
2 doc/man-src/opam-install.md
@@ -45,7 +45,7 @@ be performed.
# SEE ALSO
-**opam-remove**(1) **opam-switch**(1) **opam-list**(1) **opam-pin**(1)
+**opam-remove**(1), **opam-switch**(1), **opam-list**(1), **opam-pin**(1)
# OPAM
View
2 doc/man-src/opam-list.md
@@ -37,7 +37,7 @@ search* command.
# SEE ALSO
-**opam-search**(1) **opam-info**(1)
+**opam-search**(1), **opam-info**(1)
# OPAM
View
2 doc/man-src/opam-reinstall.md
@@ -21,7 +21,7 @@ This command does *opam remove* followed by *opam install*.
# SEE ALSO
-**opam-install**(1) **opam-remove**(1) **opam-switch**(1) **opam-list**(1)
+**opam-install**(1), **opam-remove**(1), **opam-switch**(1), **opam-list**(1)
# OPAM
View
2 doc/man-src/opam-remove.md
@@ -24,7 +24,7 @@ installed in another compiler, you need to switch compilers using
# SEE ALSO
-**opam-install**(1) **opam-switch**(1)
+**opam-install**(1), **opam-switch**(1)
# OPAM
View
2 doc/man-src/opam-search.md
@@ -24,7 +24,7 @@ the \<packagepattern\>s specified as arguments.
# SEE ALSO
-**opam-list**(1) **opam-info**(1)
+**opam-list**(1), **opam-info**(1)
# OPAM
View
2 doc/man-src/opam-update.md
@@ -19,7 +19,7 @@ upgrade* to upgrade those.
# SEE ALSO
-**opam-init**(1) **opam-remote**(1) **opam-upgrade**(1)
+**opam-init**(1), **opam-remote**(1), **opam-upgrade**(1)
# OPAM
View
2 doc/man-src/opam-upgrade.md
@@ -23,7 +23,7 @@ None
# SEE ALSO
-**opam-remote**(1) **opam-update**(1)
+**opam-remote**(1), **opam-update**(1)
# OPAM
View
2 doc/man-src/opam-upload.md
@@ -34,7 +34,7 @@ if the remote repository is not read-only.
# SEE ALSO
-**opam-remote**(1) **opam-upgrade**(1)
+**opam-remote**(1), **opam-upgrade**(1)
# OPAM
View
121 doc/man-src/opam.md
@@ -0,0 +1,121 @@
+% OPAM(1) opam 0.6.0 | OPAM Manual
+% OCamlPro
+% 10/09/2012
+
+# NAME
+
+opam - The OCaml Package Manager
+
+# SYNOPSIS
+
+*opam* [--version] [--help] [--debug] [--verbose] [--quiet] [--yes] [--makecmd] [--root] [--no-checksums] \<command\>
+
+# DESCRIPTION
+
+OPAM is a package manager for OCaml. It uses the powerful mancoosi
+tools to handle dependencies, including support for version
+constraints, optional dependencies, and conflicts management. It has
+support for different repository backends such as HTTP, rsync and
+git. It handles multiple OCaml versions concurrently, and is flexible
+enough to allow you to use your own repositories and packages in
+addition of the ones it provides.
+
+# OPTIONS
+
+--version
+: Print version information and exit.
+
+--help
+: Display help and exit.
+
+--debug
+: Print debug messages on stdout.
+
+--verbose
+: Be more verbose.
+
+--quiet
+: Be less verbose.
+
+--yes
+: Disable interactive mode and answer yes to all questions that would
+ otherwise be asked to the user.
+
+--makecmd \<command\>
+: Use \<command\> instead of the standard *make* (*make* on Linux,
+ *gmake* on BSDs) to build packages in opam.
+
+--root \<root-path\>
+: Change root path (default is ~/.opam).
+
+--no-checksum
+: Do not verify packages checksum on download.
+
+# COMMANDS
+
+To obtain help about any of these commands, use *opam* \<command\>
+--help
+
+**init**
+: Initialize OPAM state in ~/.opam, or in the directory specified as
+ argument of the --root option.
+
+## Query packages
+
+**list**
+: Display a list of packages.
+
+**search**
+: Search repositories for packages.
+
+**info**
+: Display information about packages.
+
+## Manage packages
+
+**install**
+: Install packages.
+
+**reinstall**
+: Reinstall packages.
+
+**upgrade**
+: Upgrade your packages.
+
+**remove**
+: Remove packages.
+
+## Manage repositories
+
+**remote**
+: Manage remote repositories.
+
+**update**
+: Fetch latest packages from remote repositories.
+
+**upload**
+: Upload packages to repositories.
+
+## Advanced
+
+**pin**
+: Pin a package to a specific version.
+
+**switch**
+: Manage multiple compiler installations.
+
+**config**
+: Manage various configuration options about opam and packages.
+
+# SEE ALSO
+
+**curl**(1), **wget**(1), **git**(1), **rsync(1)**
+
+# LINKS
+
+* **http://opam.ocamlpro.com**
+* **http://www.mancoosi.org**
+
+# OPAM
+
+Part of the opam(1) suite
View
6 doc/man/opam-init.1
@@ -8,7 +8,7 @@ opam-init - Creating a fresh client state
.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
+configuration in ~/.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.
@@ -37,8 +37,8 @@ Default value "http".
.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-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
View
2 doc/man/opam-install.1
@@ -42,7 +42,7 @@ To install "lwt" version 2.4.0, do:
\f[C]$\ opam\ install\ lwt.2.4.0\f[]
.SH SEE ALSO
.PP
-\f[B]opam-remove\f[](1) \f[B]opam-switch\f[](1) \f[B]opam-list\f[](1)
+\f[B]opam-remove\f[](1), \f[B]opam-switch\f[](1), \f[B]opam-list\f[](1),
\f[B]opam-pin\f[](1)
.SH OPAM
.PP
View
2 doc/man/opam-list.1
@@ -37,7 +37,7 @@ List installed packages only.
.RE
.SH SEE ALSO
.PP
-\f[B]opam-search\f[](1) \f[B]opam-info\f[](1)
+\f[B]opam-search\f[](1), \f[B]opam-info\f[](1)
.SH OPAM
.PP
Part of the opam(1) suite
View
4 doc/man/opam-reinstall.1
@@ -17,8 +17,8 @@ Package(s) to be installed.
.RE
.SH SEE ALSO
.PP
-\f[B]opam-install\f[](1) \f[B]opam-remove\f[](1) \f[B]opam-switch\f[](1)
-\f[B]opam-list\f[](1)
+\f[B]opam-install\f[](1), \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
View
2 doc/man/opam-remove.1
@@ -21,7 +21,7 @@ Package(s) to be removed.
.RE
.SH SEE ALSO
.PP
-\f[B]opam-install\f[](1) \f[B]opam-switch\f[](1)
+\f[B]opam-install\f[](1), \f[B]opam-switch\f[](1)
.SH OPAM
.PP
Part of the opam(1) suite
View
2 doc/man/opam-search.1
@@ -19,7 +19,7 @@ The case is not taken into account.
.RE
.SH SEE ALSO
.PP
-\f[B]opam-list\f[](1) \f[B]opam-info\f[](1)
+\f[B]opam-list\f[](1), \f[B]opam-info\f[](1)
.SH OPAM
.PP
Part of the opam(1) suite
View
2 doc/man/opam-update.1
@@ -13,7 +13,7 @@ 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)
+\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
View
2 doc/man/opam-upgrade.1
@@ -17,7 +17,7 @@ upgraded to their latest versions.
None
.SH SEE ALSO
.PP
-\f[B]opam-remote\f[](1) \f[B]opam-update\f[](1)
+\f[B]opam-remote\f[](1), \f[B]opam-update\f[](1)
.SH OPAM
.PP
Part of the opam(1) suite
View
2 doc/man/opam-upload.1
@@ -38,7 +38,7 @@ Defaults to the default repository.
.RE
.SH SEE ALSO
.PP
-\f[B]opam-remote\f[](1) \f[B]opam-upgrade\f[](1)
+\f[B]opam-remote\f[](1), \f[B]opam-upgrade\f[](1)
.SH OPAM
.PP
Part of the opam(1) suite
View
159 doc/man/opam.1
@@ -0,0 +1,159 @@
+.TH OPAM 1 "10/09/2012" "opam 0.6.0" "OPAM Manual"
+.SH NAME
+.PP
+opam - The OCaml Package Manager
+.SH SYNOPSIS
+.PP
+\f[I]opam\f[] [--version] [--help] [--debug] [--verbose] [--quiet]
+[--yes] [--makecmd] [--root] [--no-checksums] <command>
+.SH DESCRIPTION
+.PP
+OPAM is a package manager for OCaml.
+It uses the powerful mancoosi tools to handle dependencies, including
+support for version constraints, optional dependencies, and conflicts
+management.
+It has support for different repository backends such as HTTP, rsync and
+git.
+It handles multiple OCaml versions concurrently, and is flexible enough
+to allow you to use your own repositories and packages in addition of
+the ones it provides.
+.SH OPTIONS
+.TP
+.B --version
+Print version information and exit.
+.RS
+.RE
+.TP
+.B --help
+Display help and exit.
+.RS
+.RE
+.TP
+.B --debug
+Print debug messages on stdout.
+.RS
+.RE
+.TP
+.B --verbose
+Be more verbose.
+.RS
+.RE
+.TP
+.B --quiet
+Be less verbose.
+.RS
+.RE
+.TP
+.B --yes
+Disable interactive mode and answer yes to all questions that would
+otherwise be asked to the user.
+.RS
+.RE
+.TP
+.B --makecmd <command>
+Use <command> instead of the standard \f[I]make\f[] (\f[I]make\f[] on
+Linux, \f[I]gmake\f[] on BSDs) to build packages in opam.
+.RS
+.RE
+.TP
+.B --root <root-path>
+Change root path (default is ~/.opam).
+.RS
+.RE
+.TP
+.B --no-checksum
+Do not verify packages checksum on download.
+.RS
+.RE
+.SH COMMANDS
+.PP
+To obtain help about any of these commands, use \f[I]opam\f[] <command>
+--help
+.TP
+.B \f[B]init\f[]
+Initialize OPAM state in ~/.opam, or in the directory specified as
+argument of the --root option.
+.RS
+.RE
+.SS Query packages
+.TP
+.B \f[B]list\f[]
+Display a list of packages.
+.RS
+.RE
+.TP
+.B \f[B]search\f[]
+Search repositories for packages.
+.RS
+.RE
+.TP
+.B \f[B]info\f[]
+Display information about packages.
+.RS
+.RE
+.SS Manage packages
+.TP
+.B \f[B]install\f[]
+Install packages.
+.RS
+.RE
+.TP
+.B \f[B]reinstall\f[]
+Reinstall packages.
+.RS
+.RE
+.TP
+.B \f[B]upgrade\f[]
+Upgrade your packages.
+.RS
+.RE
+.TP
+.B \f[B]remove\f[]
+Remove packages.
+.RS
+.RE
+.SS Manage repositories
+.TP
+.B \f[B]remote\f[]
+Manage remote repositories.
+.RS
+.RE
+.TP
+.B \f[B]update\f[]
+Fetch latest packages from remote repositories.
+.RS
+.RE
+.TP
+.B \f[B]upload\f[]
+Upload packages to repositories.
+.RS
+.RE
+.SS Advanced
+.TP
+.B \f[B]pin\f[]
+Pin a package to a specific version.
+.RS
+.RE
+.TP
+.B \f[B]switch\f[]
+Manage multiple compiler installations.
+.RS
+.RE
+.TP
+.B \f[B]config\f[]
+Manage various configuration options about opam and packages.
+.RS
+.RE
+.SH SEE ALSO
+.PP
+\f[B]curl\f[](1), \f[B]wget\f[](1), \f[B]git\f[](1), \f[B]rsync(1)\f[]
+.SH LINKS
+.IP \[bu] 2
+\f[B]http://opam.ocamlpro.com\f[]
+.IP \[bu] 2
+\f[B]http://www.mancoosi.org\f[]
+.SH OPAM
+.PP
+Part of the opam(1) suite
+.SH AUTHORS
+OCamlPro.

0 comments on commit 899d867

Please sign in to comment.
Something went wrong with that request. Please try again.