Add 'Power features' page to the docs.
authorW. Trevor King <wking@drexel.edu>
Wed, 25 May 2011 12:54:53 +0000 (08:54 -0400)
committerW. Trevor King <wking@drexel.edu>
Wed, 25 May 2011 12:54:53 +0000 (08:54 -0400)
doc/index.txt
doc/power.txt [new file with mode: 0644]

index e8d8f077c3110e2cb105587aa22eaf7465f34aa9..7745d0cbb91cb406c11ddb3747728646954f12c2 100644 (file)
@@ -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 (file)
index 0000000..b0e93ea
--- /dev/null
@@ -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.