1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH REGISTER-PYTHON-ARGCOMPLETE "1" "November 2023" "register-python-argcomplete 3.1.4-1" "User Commands"
.SH NAME
register-python-argcomplete \- register-python-argcomplete - argcomplete utility script
.SH DESCRIPTION
usage: register\-python\-argcomplete [\-h] [\-\-no\-defaults]
.TP
[\-\-complete\-arguments ...]
[\-s {bash,zsh,tcsh,fish,powershell}]
[\-e EXTERNAL_ARGCOMPLETE_SCRIPT]
executable [executable ...]
.PP
Register a Python executable for use with the argcomplete module.
.PP
To perform the registration, source the output of this script in your bash shell
(quote the output to avoid interpolation).
.PP
Example:
.IP
\f(CW$ eval "$(register-python-argcomplete my-favorite-script.py)"\fR
.PP
For Tcsh
.IP
\f(CW$ eval `register-python-argcomplete --shell tcsh my-favorite-script.py`\fR
.PP
For Fish
.IP
\f(CW$ register-python-argcomplete --shell fish my-favourite-script.py > ~/.config/fish/my-favourite-script.py.fish\fR
.SS "positional arguments:"
.TP
executable
executable to completed (when invoked by exactly this
name)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-no\-defaults\fR
when no matches are generated, do not fallback to
readline's default completion (affects bash only)
.TP
\fB\-\-complete\-arguments\fR ...
arguments to call complete with; use of this option
discards default options (affects bash only)
.TP
\fB\-s\fR {bash,zsh,tcsh,fish,powershell}, \fB\-\-shell\fR {bash,zsh,tcsh,fish,powershell}
output code for the specified shell
.TP
\fB\-e\fR EXTERNAL_ARGCOMPLETE_SCRIPT, \fB\-\-external\-argcomplete\-script\fR EXTERNAL_ARGCOMPLETE_SCRIPT
external argcomplete script for auto completion of the
executable
.SH AUTHORS
.B argcomplete
module was written by Andrey Kislyuk
.SH "SEE ALSO"
Full documentation for
.B argccomplete
module is stored at https://argcomplete.readthedocs.org/en/latest/
|
