File: register-python-argcomplete.1

package info (click to toggle)
python-argcomplete 2.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 532 kB
  • sloc: python: 2,512; makefile: 27; sh: 19
file content (48 lines) | stat: -rw-r--r-- 1,480 bytes parent folder | download | duplicates (3)
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
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH REGISTER-PYTHON-ARGCOMPLETE "1" "January 2017" "register-python-argcomplete 1.8.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,tcsh}]
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
.SS "positional arguments:"
.TP
executable
executable to completed (when invoked by exactly this
name)
.SS "optional arguments:"
.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
.TP
\fB\-\-complete\-arguments\fR ...
arguments to call complete with; use of this option
discards default options
.TP
\fB\-s\fR {bash,tcsh}, \fB\-\-shell\fR {bash,tcsh}
output code for the specified shell
.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/