mention NOTMUCH_CONFIG in the notmuch docstring

1 files changed, 6 insertions, 1 deletions

diff --git a/notmuch b/notmuch
index 5862b9a..acebe38 100755
--- a/notmuch
+++ b/notmuch
@@ -1,5 +1,10 @@
 #!/usr/bin/env python
-"""This is a notmuch implementation in python. It's goal is to allow running the test suite on the cnotmuch python bindings."""
+"""This is a notmuch implementation in python. It's goal is to allow running the test suite on the cnotmuch python bindings.
+
+This "binary" honors the NOTMUCH_CONFIG environmen variable for reading a user's
+notmuch configuration (e.g. the database path)
+
+This code is licensed under the GNU GPL v3+."""
 import sys, os, re, logging
 from cnotmuch.notmuch import Database, Query
 PREFIX=re.compile('(\w+):(.*$)')