summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorVille Skyttä <ville.skytta@iki.fi>2009-10-13 22:35:42 +0300
committerVille Skyttä <ville.skytta@iki.fi>2009-10-13 22:35:42 +0300
commitcabaca41d0b046737ebe7e056900891dbae2a319 (patch)
treec1b401b1fc5a12848a90bec650cf47fb5bd946f4 /README
parente31f8d8b8167425d3119464ca8028256fdd4e3d2 (diff)
downloadbash-completion-cabaca41d0b046737ebe7e056900891dbae2a319.tar.gz
Various updates.
Diffstat (limited to 'README')
-rw-r--r--README47
1 files changed, 26 insertions, 21 deletions
diff --git a/README b/README
index f307ebbf..9328cb02 100644
--- a/README
+++ b/README
@@ -1,11 +1,11 @@
INSTALLATION
------------
-The easiest way to install this software is to use a package, such as
-the RPM that I maintain for Red Hat Linux, the .deb package for
-Debian/GNU Linux or Ubuntu, etc. You still need to source it from either
-/etc/bashrc or ~/.bashrc (or any other file sourcing those). You can do
-this by simply using:
+The easiest way to install this software is to use a package; it is available
+in many operating system distributions. The package's name is usually
+bash-completion. Depending on the package, you may still need to source it
+from either /etc/bashrc or ~/.bashrc (or any other file sourcing those). You
+can do this by simply using:
# Use bash-completion, if available
if [ -f /etc/bash_completion ]; then
@@ -88,8 +88,8 @@ maintainer:
If you get errors about 'complete' not accepting the -o flag, you are
probably running bash 2.04. In this case, you should upgrade to bash
-2.05a or later. However, I have endeavoured to make the code detect
-this version of bash and work around this issue, so please inform me
+2.05a or later. However, we have endeavoured to make the code detect
+this version of bash and work around this issue, so please inform us
if you still encounter this error.
Copies of the patches and prepatched versions of bash are available
@@ -100,7 +100,7 @@ from:
If you find that a given function is producing errors under certain
circumstances when you attempt completion, try running 'set -v' or
'set -x' prior to attempting the completion again. This will produce
-useful debugging output that will aid me in fixing the problem if you
+useful debugging output that will aid us in fixing the problem if you
are unable to do so yourself. Turn off the trace output by running
either 'set +v' or 'set +x'.
@@ -142,7 +142,7 @@ If you are seeing 'unbound variable' warnings from bash when hitting
somewhere in your start-up files. This causes bash to flag the use of
any uninitialised shell variables as an error.
-Whilst I try to avoid references to uninitialised variables in the
+Whilst we try to avoid references to uninitialised variables in the
code, there seem to be at least some cases where bash issues this
warning even though the variable in question has been initialised.
@@ -241,7 +241,7 @@ Q. When doing tar completion on a file within a tar file like this:
correctly. The slashes are removed and everything looks like it's
in a single directory. Why is this?
-A. It's a choice I had to make. bash's programmable completion is
+A. It's a choice we had to make. bash's programmable completion is
limited in how it handles the list of possible completions it
returns.
@@ -335,7 +335,7 @@ A. The readline(3) library offers a few settings that can make tab
set show-all-if-ambiguous on
This will allow single tab completion as opposed to requiring a
- double tab. This makes things much more pleasant, in my opinion.
+ double tab. This makes things much more pleasant, in our opinion.
set visible-stats on
@@ -343,7 +343,7 @@ A. The readline(3) library offers a few settings that can make tab
denoting its type, in a similar way to ls(1) with -F or --classify.
set page-completions off
-
+
This turns off the use of the internal pager when returning long
completion lists.
@@ -355,7 +355,7 @@ A. If you're a registered freshmeat.net user, take a moment to rate the
http://freshmeat.net/projects/bashcompletion
- Of course, writing to me and letting me know how you feel also works.
+ Of course, writing to us and letting us know how you feel also works.
Patches and new completion routines are most welcome, too.
Q. How can I stay abreast of new releases?
@@ -410,7 +410,7 @@ guidelines in mind:
Similarly, 3.0 added the use of the regex operator '=~', commonly
found in Perl and Ruby. Whilst this is very useful, it's not yet
safe to assume its ubiquity.
-
+
On the other hand, extended globs were added in bash 2.02 and often
enable you to avoid the use of external programs, which are
expensive to fork and execute, so do make full use of those:
@@ -484,13 +484,18 @@ guidelines in mind:
particular problems. Read the bash man page for details of all the
programming tools available to you within the shell.
-- Please test your code thoroughly before sending it to me. I don't
- have access to all the commands for which I am sent completion
- functions, so I am unable to test them all personally. If your code
+- Please test your code thoroughly before sending it to us. We don't
+ have access to all the commands for which we are sent completion
+ functions, so we are unable to test them all personally. If your code
is accepted into the distribution, a lot of people will try it out,
so try to do a thorough job of eradicating all the bugs before you
- send it to me.
-
+ send it to us.
+
+- File bugs, enhancement requests (preferably with patches attached) at
+ the project tracker at https://alioth.debian.org/projects/bash-completion/
+ Sending them to the developers list usually works too, but bits are more
+ likely to fall through the cracks that way compared to the tracker.
+
--
-Ian Macdonald
-ian@caliban.org
+bash-completion developers
+bash-completion-devel@lists.alioth.debian.org