aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorW. Trevor King <wking@drexel.edu>2011-05-25 08:54:53 -0400
committerW. Trevor King <wking@drexel.edu>2011-05-25 08:54:53 -0400
commitad098c3d1bef935350cee87eb585ba7597293b0a (patch)
tree4f3d24b23c65b844a8c94211220cf431d284b060
parent2426c5f118b7e9c6f58e800da459554499b2950e (diff)
downloadbugseverywhere-ad098c3d1bef935350cee87eb585ba7597293b0a.tar.gz
Add 'Power features' page to the docs.
-rw-r--r--doc/index.txt1
-rw-r--r--doc/power.txt27
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/index.txt b/doc/index.txt
index e8d8f07..7745d0c 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -27,6 +27,7 @@ Contents:
email
http
distributed_bugtracking
+ power
hacking
spam
libbe/libbe
diff --git a/doc/power.txt b/doc/power.txt
new file mode 100644
index 0000000..b0e93ea
--- /dev/null
+++ b/doc/power.txt
@@ -0,0 +1,27 @@
+**************
+Power features
+**************
+
+BE comes with a number of additional utilities and features that may
+be useful to power users. We'll try to keep an up to date list here,
+but your best bet may be poking around in the source on your own.
+
+Autocompletion
+==============
+
+:file:`misc/completion` contains completion scripts for common shells
+(if we don't have a completion script for your favorite shell, submit
+one!). Basic instructions for installing the completion file for a
+given shell should be given in the completion script comments.
+
+Packagers should install these completion scripts in their system's
+usual spot (on Gentoo it's :file:`/etc/bash_completion.d/`).
+
+XML-handling utilities
+======================
+
+Email threads are quite similar to the bugs/issues that BE tracks.
+There are a number of useful scripts in :file:`misc/xml` to go back
+and forth between the two formats using BE's XML format. The commands
+should be well documented. Use the usual ``<command> --help`` for
+more details on a given command.