.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CH-COMPLETION.BASH" "7" "2024-03-16 10:47 UTC" "0.37" "Charliecloud"
.SH NAME
ch-completion.bash \- Tab completion for the Charliecloud command line
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ source ch\-completion.bash
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fBch\-completion.bash\fP provides tab completion for the charliecloud
command line. Currently, tab completion is available for Bash users for the
executables \fBch\-image\fP, \fBch\-run\fP, and \fBch\-convert\fP\&.
.sp
We do not currently install the file if Charliecloud is built from source (see
\fI\%issue #1842\fP). In this
case, source it from the Charliecloud source code:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ source $CHARLIECLOUD_SOURCE_PATH/bin/ch\-completion.bash
.EE
.UNINDENT
.UNINDENT
.sp
If you installed with a distribution package, the procedure is probably nicer.
See your distro’s docs if you installed a package.)
.sp
Disable completion with the utility function \fBch\-completion\fP added to
your environment when the above is sourced:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ ch\-completion \-\-disable
.EE
.UNINDENT
.UNINDENT
.SH DEPENDENCIES
.sp
Tab completion has these additional dependencies:
.INDENT 0.0
.IP \(bu 2
Bash ≥ 4.3.0
.IP \(bu 2
\fBbash\-completion\fP library (\fI\%GitHub\fP, or it probably comes with your
distribution, \fI\%e.g.\fP)
.UNINDENT
.SH CH-COMPLETION
.sp
Utility function for \fBch\-completion.bash\fP\&.
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ ch\-completion [ OPTIONS ]
.EE
.UNINDENT
.UNINDENT
.SS Description
.sp
\fBch\-completion\fP is a function to manage Charliecloud’s tab completion.
It is added to the environment when completion is sourced. The option(s) given
specify what to do:
.INDENT 0.0
.TP
.B \fB\-\-disable\fP
Disable tab completion for all Charliecloud executables.
.TP
.B \fB\-\-help\fP
Print help message.
.TP
.B \fB\-\-version\fP
Print version of tab completion that’s currently enabled.
.TP
.B \fB\-\-version\-ok\fP
Verify that tab completion version is consistent with that of
\fBch\-image\fP\&.
.UNINDENT
.SH DEBUGGING
.sp
Tab completion can write debugging logs to \fB/tmp/ch\-completion.log\fP\&.
Enable this by setting the environment variable \fBCH_COMPLETION_DEBUG\fP\&.
(This is primarily intended for developers.)
.SH COPYRIGHT
2014–2023, Triad National Security, LLC and others
.\" Generated by docutils manpage writer.
.