.\" Pipe this output to groff -m man -K utf8 -T utf8 | less -R
.\"
.mso an.tmac
.TH "CMDLINER-INSTALL-TOOL-COMPLETION" 1 "" "Cmdliner v2.1.1" "Cmdliner Manual"
.\" Disable hyphenation and ragged-right
.nh
.ad l
.SH NAME
.P
cmdliner\-install\-tool\-completion \- Install tool completion scripts
.SH SYNOPSIS
.P
\fBcmdliner install tool\-completion\fR [\fIOPTION\fR]… \fITOOLNAME\fR… \fISHAREDIR\fR
.SH DESCRIPTION
.P
\fBcmdliner install tool\-completion\fR installs tool completion script of given tools and shells in a \fBshare\fR directory according to specific shell conventions\N'46' Directories are created if needed\N'46' Use option \fB\-\-dry\-run\fR to see which paths would be written\N'46' Example:
.P
.nf
\fBcmdliner install tool\-completion\fR \fBmytool\fR \fB/usr/local/share\fR  # All supported shells
.fi
.sp -1
.P
.nf
\fBcmdliner install tool\-completion\fR \fB\-\-shell zsh mytool /usr/local/share\fR
.fi
.P
Note that the command \fBinstall tool\-support\fR also installs completions like this command does\N'46' To inspect the actual scripts use the command \fBtool\-completion\fR\N'46'
.SH ARGUMENTS
.TP 4
\fISHAREDIR\fR (required)
\fISHAREDIR\fR is the \fBshare\fR directory to install to\N'46'
.TP 4
\fITOOLNAME\fR (required)
\fITOOLNAME\fR is the name of the tool to complete\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\-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\-\-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\-completion\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)