[or-cvs] [bridgedb/master] Add some explanation on how this bucket stuff works

[nickm at torproject.org]

Author: Christian Fromme <kaner at strace.org>
Date: Sat, 25 Sep 2010 22:45:55 +0200
Subject: Add some explanation on how this bucket stuff works
Commit: 40ecff8f55c316a501b0a36637ea1a6e7c3cbcfb

---
 README               |   15 +++++++++++++++
 lib/bridgedb/Main.py |    2 +-
 2 files changed, 16 insertions(+), 1 deletions(-)

diff --git a/README b/README
index 70bfc8a..eac8520 100644
--- a/README
+++ b/README
@@ -16,6 +16,21 @@ To run:
  - When you have new lists of bridges, replace the old files and send the
    process a sighup.
 
+To extract bucket files with unallocated bridges:
+
+ -  Edit the configuration file value 'FILE_BUCKETS' according to your needs.
+    For example, the following is a possible configuration:
+
+            FILE_BUCKETS = { "name1": 10, "name2": 15, "foobar": 3 }
+
+    This configuration for buckets would result in 3 files being created for 
+    bridge distribution: name1-2010-07-17.brdgs, name2-2010-07-17.brdgs and 
+    foobar-2010-07-17.brdgs. The first file would contain 10 bridges from 
+    BridgeDB's 'unallocated' pool. The second file would contain 15 bridges 
+    from the same pool and the third one similarly 3 bridges. These files can 
+    then be handed out to trusted parties via mail or fed to other distribution
+    mechanisms such as twitter.
+
 To use with HTTPS:
  - Just connect to the appropriate port.
 
diff --git a/lib/bridgedb/Main.py b/lib/bridgedb/Main.py
index 7bf8f98..e620ffa 100644
--- a/lib/bridgedb/Main.py
+++ b/lib/bridgedb/Main.py
@@ -332,7 +332,7 @@ def run():
     if options.testing:
         configuration = CONFIG
     elif not options.configfile:
-        print "Syntax: %s [config file]" % sys.argv[0]
+        print "Syntax: %s -c CONFIGFILE" % sys.argv[0]
         sys.exit(1)
     else:
         configFile = options.configfile
-- 
1.7.1