← Back to branch summary

~ubuntu-branches/ubuntu/trusty/bash-completion/trusty-updates

« back to all changes in this revision

Viewing changes to doc/bash_completion.txt

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-07-23 16:07:59 UTC
  • mfrom: (5.1.12 sid)
  • Revision ID: package-import@ubuntu.com-20120723160759-lt9vn33dl3nak9l0
Tags: 1:2.0-1ubuntu1
https://launchpad.net/bugs/311525
https://launchpad.net/bugs/743208
https://launchpad.net/bugs/720541
* debian/maintscript, debian/postinst:
  - clean etc conffiles on upgrade since completion files are in /usr
    with the new version
* Resync with Debian, remaining diff
  * debian/patches/disable-avahi-browse.diff: Disable avahi-browse since
    it scales poorly in the current form: refresh patch
  * patches/101_bash_completion.oga_ogv.patch: Increase support for other
    OGG formats including .oga, .ogx, etc. (LP: #311525)
  * patches/103_colormake.patch: Add support for colormake to the make
    completion rules. (LP: #743208)
* Dropped changes:
  * Add conffile upgrade handling for a run of conffiles that were dropped
    since lucid: lucid upgrades are only supported to precise.
* Those fixes are in the new version
  * debian/patches/apt-get-changelog.patch:
  * Drop whitelists if they fail to produce any results:
  * patches/apt-get-download.patch: Add download as an apt-get
    sub-command (LP: #720541)
  * patches/102_manpager.patch: Override MANPAGER when generating perldoc
    completions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/bash_completion.txt
 
1
Bash completion
 
2
===============
 
3
 
 
4
Configuration files
 
5
-------------------
 
6
 
 
7
*~/.bash_completion*::
 
8
    Sourced late by bash_completion, pretty much after everything else.
 
9
    Use this file for example to load additional completions, and to remove
 
10
    and override ones installed by bash_completion.
 
11
 
 
12
*$XDG_CONFIG_HOME/bash_completion*::
 
13
    Sourced by the bash_completion.sh profile.d script.  This file is
 
14
    suitable for definitions of all `COMP_*` environment variables
 
15
    below.  If `$XDG_CONFIG_HOME` is unset or null, `~/.config` is
 
16
    used instead of it.
 
17
 
 
18
Environment variables
 
19
---------------------
 
20
 
 
21
*COMP_CONFIGURE_HINTS*::
 
22
    If set and not null, `configure` completion will return the entire option
 
23
    string (e.g.  `--this-option=DESCRIPTION`) so one can see what kind of data
 
24
    is required and then simply delete the descriptive text and add one's own
 
25
    data.  If unset or null (default), `configure` completion will strip
 
26
    everything after the '=' when returning completions.
 
27
 
 
28
*COMP_CVS_REMOTE*::
 
29
    If set and not null, `cvs commit` completion will try to complete on
 
30
    remotely checked-out files.  This requires passwordless access to the
 
31
    remote repository.  Default is unset.
 
32
 
 
33
*COMP_FILEDIR_FALLBACK*::
 
34
    If set and not null, completions that look for filenames based on their
 
35
    "extensions" will fall back to suggesting all files if there are none
 
36
    matching the sought ones.
 
37
 
 
38
*COMP_IWLIST_SCAN*::
 
39
    If set and not null, `iwconfig` completion will try to complete on
 
40
    available wireless networks identifiers.  Default is unset.
 
41
 
 
42
*COMP_KNOWN_HOSTS_WITH_HOSTFILE*::
 
43
    If set and not null (default), known hosts completion will complement
 
44
    hostnames from ssh's known_hosts files with hostnames taken from the file
 
45
    specified by the HOSTFILE shell variable (compgen -A hostname). If null,
 
46
    known hosts completion will omit hostnames from HOSTFILE.  Omitting
 
47
    hostnames from HOSTFILE is useful if HOSTFILE contains many entries for
 
48
    local web development or ad-blocking.
 
49
 
 
50
*COMP_KNOWN_HOSTS_WITH_AVAHI*::
 
51
    If set and not null, known hosts completion will try to use `avahi-browse`
 
52
    for additional completions.  This may be a slow operation in some setups.
 
53
    Default is unset.
 
54
 
 
55
*COMP_TAR_INTERNAL_PATHS*::
 
56
    If set and not null *before* sourcing bash_completion, `tar` completion
 
57
    will do correct path completion for tar file contents.  If unset or null,
 
58
    `tar' completion will do correct completion for paths to tar files.  See
 
59
    also README.