.\" Pipe this output to groff -m man -K utf8 -T utf8 | less -R
.\"
.mso an.tmac
.TH "OPAM-INSTALLER" 1 "" "Opam-installer 2.1.5" "Opam-installer Manual"
.\" Disable hyphenation and ragged-right
.nh
.ad l
.SH NAME
.P
opam\N'45'installer \N'45' Handles (un)installation of package files following instructions from opam *\N'46'install files\N'46'
.SH SYNOPSIS
.P
\fBopam\N'45'installer\fR [\fIOPTION\fR]… [\fIPKG\N'46'install\fR]
.SH ARGUMENTS
.TP 4
\fIPKG\N'46'install\fR
The opam \N'46'install file to read for installation instructions
.SH OPTIONS
.TP 4
\fB\N'45'\N'45'docdir\fR=\fIPATH\fR
Documentation dir\N'46' Relative to \fBprefix\fR or absolute\N'46' By default \fI$prefix/doc\fR\N'46'
.TP 4
\fB\N'45'\N'45'help\fR[=\fIFMT\fR] (default=\fBauto\fR)
Show this help in format \fIFMT\fR\N'46' The value \fIFMT\fR must be one of \fBauto\fR, \fBpager\fR, \fBgroff\fR or \fBplain\fR\N'46' With \fBauto\fR, the format is \fBpager\fR or \fBplain\fR whenever the \fBTERM\fR env var is \fBdumb\fR or undefined\N'46'
.TP 4
\fB\N'45'i\fR, \fB\N'45'\N'45'install\fR
Install the package (the default)
.TP 4
\fB\N'45'\N'45'libdir\fR=\fIPATH\fR
OCaml lib dir\N'46' Relative to \fBprefix\fR or absolute\N'46' By default \fI$prefix/lib\fR ; sometimes setting this to \fI$(ocamlc \N'45'where\fR) is preferable\N'46'
.TP 4
\fB\N'45'\N'45'mandir\fR=\fIPATH\fR
Manpages dir\N'46' Relative to \fBprefix\fR or absolute\N'46' By default \fI$prefix/man\fR\N'46'
.TP 4
\fB\N'45'\N'45'name\fR=\fINAME\fR
Specify the package name\N'46' Used to set install directory under `share/\N'39', etc\N'46' By default, basename of the \N'46'install file
.TP 4
\fB\N'45'\N'45'prefix\fR=\fIPREFIX\fR (absent=\fB/usr/local\fR)
The prefix to install to\N'46' You can use eg \N'39'$PREFIX\N'39' to output a relocatable script
.TP 4
\fB\N'45'\N'45'script\fR
Don\N'39't execute the commands, but output a shell\N'45'script (experimental)
.TP 4
\fB\N'45'\N'45'stubsdir\fR=\fIPATH\fR
Stubs installation dir\N'46' Relative to \fBprefix\fR or absolute\N'46' By default \fI$libdir/stublibs\fR\N'46'
.TP 4
\fB\N'45'\N'45'topdir\fR=\fIPATH\fR
Toplevel install dir\N'46' Relative to \fBprefix\fR or absolute\N'46' By default \fI$libdir/toplevel\fR\N'46'
.TP 4
\fB\N'45'u\fR, \fB\N'45'\N'45'uninstall\fR, \fB\N'45'\N'45'remove\fR
Remove the package
.TP 4
\fB\N'45'\N'45'version\fR
Show version information\N'46'