Permalink
Browse files

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

  • Loading branch information...
1 parent a60c265 commit fc51e07709622b14df6d3478999bbdc39d23f9eb Vincent Bernardoff committed Sep 5, 2012
View
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
Oops, something went wrong.

0 comments on commit fc51e07

Please sign in to comment.