summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVille Skyttä <ville.skytta@iki.fi>2011-09-03 23:25:26 +0300
committerVille Skyttä <ville.skytta@iki.fi>2011-09-03 23:25:26 +0300
commit8cb5d6560ed9a73302a4f4a1213e7e84bfc64501 (patch)
tree5d0e601ed23f5ad599c595a6c78aca15d3f97b03
parent914da74d2cd4858b0926bb27b0e2b642d7d80790 (diff)
downloadbash-completion-8cb5d6560ed9a73302a4f4a1213e7e84bfc64501.tar.gz
Document ~/.bash_completion and $XDG_CONFIG_HOME/bash_completion.
-rw-r--r--doc/bash_completion.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/bash_completion.txt b/doc/bash_completion.txt
index a58351c5..1d1e2cf6 100644
--- a/doc/bash_completion.txt
+++ b/doc/bash_completion.txt
@@ -1,6 +1,20 @@
Bash completion
===============
+Configuration files
+-------------------
+
+*~/.bash_completion*::
+ Sourced late by bash_completion, pretty much after everything else.
+ Use this file for example to load additional completions, and to remove
+ and override ones installed by bash_completion.
+
+*$XDG_CONFIG_HOME/bash_completion*::
+ Sourced by the bash_completion.sh profile.d script. This file is
+ suitable for definitions of all `COMP_*` environment variables
+ below. If `$XDG_CONFIG_HOME` is unset or null, `~/.config` is
+ used instead of it.
+
Environment variables
---------------------