csonto/bash-completion
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation tweaks.

Browse Source
This commit is contained in:
Ville Skyttä 2011-08-16 11:52:52 +03:00
parent c46c916077
commit 05f2114735
2 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/bash_completion.txt
View File

@ -11,7 +11,6 @@ Environment variables
data. If unset or null (default), `configure` completion will strip data. If unset or null (default), `configure` completion will strip
everything after the '=' when returning completions. everything after the '=' when returning completions.
*COMP_CVS_REMOTE*:: *COMP_CVS_REMOTE*::
If set and not null, `cvs commit` completion will try to complete on If set and not null, `cvs commit` completion will try to complete on
remotely checked-out files. This requires passwordless access to the remotely checked-out files. This requires passwordless access to the
@ -23,19 +22,17 @@ Environment variables
*COMP_KNOWN_HOSTS_WITH_HOSTFILE*:: *COMP_KNOWN_HOSTS_WITH_HOSTFILE*::
If set and not null (default), known hosts completion will complement If set and not null (default), known hosts completion will complement
hostnames from ssh's known_hosts_files with hostnames taken from the file hostnames from ssh's known_hosts files with hostnames taken from the file
specified by the HOSTFILE shell variable (compgen -A hostname). If null, specified by the HOSTFILE shell variable (compgen -A hostname). If null,
known_hosts completion will omit hostnames from HOSTFILE. Omitting known hosts completion will omit hostnames from HOSTFILE. Omitting
hostnames from HOSTFILE is useful if HOSTFILE contains many entries for hostnames from HOSTFILE is useful if HOSTFILE contains many entries for
local web development or ad-blocking. local web development or ad-blocking.
*COMP_KNOWN_HOSTS_WITH_AVAHI*:: *COMP_KNOWN_HOSTS_WITH_AVAHI*::
If set and not null, known hosts completion will try to use `avahi-browse` If set and not null, known hosts completion will try to use `avahi-browse`
for additional completions. This may be a slow operation in some setups. for additional completions. This may be a slow operation in some setups.
Default is unset. Default is unset.
*COMP_TAR_INTERNAL_PATHS*:: *COMP_TAR_INTERNAL_PATHS*::
If set and not null *before* sourcing bash_completion, `tar` completion If set and not null *before* sourcing bash_completion, `tar` completion
will do correct path completion for tar file contents. If unset or null, will do correct path completion for tar file contents. If unset or null,

6
doc/styleguide.txt
View File

@ -45,11 +45,11 @@ you absolutely need to (example: a long sed regular expression, or the
like). This also holds true for the documentation and the testsuite. like). This also holds true for the documentation and the testsuite.
Other files, like ChangeLog, or COPYING, are exempt from this rule. Other files, like ChangeLog, or COPYING, are exempt from this rule.
$(...) vs `...` $(...) vs \`...`
--------------- ----------------
When you need to do some code substitution in your completion script, When you need to do some code substitution in your completion script,
you *MUST* use the $(...) construct, rather than the `...`. The former you *MUST* use the $(...) construct, rather than the \`...`. The former
is preferable because anyone, with any keyboard layout, is able to is preferable because anyone, with any keyboard layout, is able to
type it. Backticks aren't always available, without doing strange type it. Backticks aren't always available, without doing strange
key combinations. key combinations.