.\" Pipe this output to groff -m man -K utf8 -T utf8 | less -R
.\"
.mso an.tmac
.TH "CMDLINER-INSTALL-TOOL-SUPPORT" 1 "" "Cmdliner v2.1.1" "Cmdliner Manual"
.\" Disable hyphenation and ragged-right
.nh
.ad l
.SH NAME
.P
cmdliner\-install\-tool\-support \- Install both tool completion and manpages
.SH SYNOPSIS
.P
\fBcmdliner install tool\-support\fR [\fIOPTION\fR]… \fITOOLEXEC[:NAME]\fR… \fIPREFIX\fR
.SH DESCRIPTION
.P
\fBcmdliner install tool\-support\fR combines commands \fBinstall tool\-completion\fR and \fBinstall tool\-manpages\fR to install all tool support files in a given \fIPREFIX\fR which is assumed to follow the Filesystem Hierarchy Standard\N'46' Use options \fB\-\-sharedir\fR and/or \fB\-\-mandir\fR if that is not the case (e\N'46'g\N'46' in \fBopam\fR as of writing)\N'46' Use option \fB\-\-dry\-run\fR to see which paths would be written\N'46' Example:
.P
.nf
\fBcmdliner install tool\-support\fR \fB\N'46'/mytool /usr/local\fR
.fi
.sp -1
.P
.nf
\fBcmdliner install tool\-support\fR \fB\-\-update\-opam\-install=mypkg\N'46'install\fR \N'92' 
         \fB_build/mytool _build/prefix\fR
.fi
.SH ARGUMENTS
.TP 4
\fIPREFIX\fR (required)
\fIPREFIX\fR is the install prefix\N'46' For example \fB/usr/local\fR\N'46'
.TP 4
\fITOOLEXEC[:NAME]\fR (required)
\fITOOLEXEC\fR is the tool executable\N'46' Searched in the \fBPATH\fR unless an explicit file path is specified\N'46' \fINAME\fR is the tool name, if unspecified derived from \fITOOLEXEC\fR by taking the basename and stripping any \fB\N'46'exe\fR extension\N'46' Repeatable\N'46'
.SH OPTIONS
.TP 4
\fB\-\-dry\-run\fR
Do not install, output paths that would be written\N'46'
.TP 4
\fB\-\-mandir\fR=\fIMANDIR\fR (absent=\fISHAREDIR\fR\fB/man\fR)
\fIMANDIR\fR is the root \fBman\fR directory to install to\N'46'
.TP 4
\fB\-s\fR \fISHELL\fR, \fB\-\-shell\fR=\fISHELL\fR (absent=All supported shells)
\fISHELL\fR the shell to support, must be one of \fBbash\fR, \fBzsh\fR or \fBpwsh\fR\N'46' Repeatable\N'46'
.TP 4
\fB\-\-sharedir\fR=\fISHAREDIR\fR (absent=\fIPREFIX\fR\fB/share\fR)
\fISHAREDIR\fR is the \fBshare\fR directory to install to\N'46'
.TP 4
\fB\-\-standalone\-completion\fR
Generate standalone completion scripts\N'46' These scripts do not depend on the generic cmdliner completion scripts\N'46' For some shells this may result in slower completion\N'46'
.TP 4
\fB\-\-update\-opam\-install\fR=\fIPKG\N'46'install\fR
Update or create an opam \fB\N'46'install\fR file \fIPKG\N'46'install\fR with install moves from the installed files to the corresponding opam install sections\N'46' Also performed if \fB\-\-dry\-run\fR is specified\N'46'
.SH COMMON OPTIONS
.TP 4
\fB\-\-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\-\-version\fR
Show version information\N'46'
.SH EXIT STATUS
.P
\fBcmdliner install tool\-support\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
cmdliner(1)