.\" Pipe this output to groff -m man -K utf8 -T utf8 | less -R
.\"
.mso an.tmac
.TH "OPAM-HELP" 1 "" "Opam 2.3.0" "Opam Manual"
.\" Disable hyphenation and ragged-right
.nh
.ad l
.SH NAME
.P
opam\N'45'help \N'45' Display help about opam and opam commands\N'46'
.SH SYNOPSIS
.P
\fBopam help\fR [\fB\N'45'\N'45'man\N'45'format\fR=\fIFMT\fR] [\fIOPTION\fR]… [\fITOPIC\fR]
.SH DESCRIPTION
.P
Prints help about opam commands\N'46'
.P
Use `\fBopam\fR help topics\N'39' to get the full list of help topics\N'46'
.SH ARGUMENTS
.TP 4
\fITOPIC\fR
The topic to get help on\N'46'
.SH OPTIONS
.TP 4
\fB\N'45'\N'45'man\N'45'format\fR=\fIFMT\fR (absent=\fBpager\fR)
Show output 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'
.SH COMMON OPTIONS
.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'\N'45'version\fR
Show version information\N'46'
.SH EXIT STATUS
.P
\fBopam help\fR exits with:
.TP 4
0
on success\N'46'
.TP 4
123
on indiscriminate errors reported on standard error\N'46'
.TP 4
124
on command line parsing errors\N'46'
.TP 4
125
on unexpected internal errors (bugs)\N'46'
.SH SEE ALSO
.P
opam(1)