[Pgp-tools-commit] r628 - in trunk/keyart/doc: . examples

[Aaron Toponce]

Author: atoponce-guest
Date: 2014-05-18 00:01:02 +0000 (Sun, 18 May 2014)
New Revision: 628

Added:
   trunk/keyart/doc/examples/
   trunk/keyart/doc/examples/party.sh
   trunk/keyart/doc/party-worksheet
Log:
Add documentation and example script

* Add simple Bash shell script for creating keyart with 5 keys per line.
* Add documentation about how to create a key signing party worksheet.


Added: trunk/keyart/doc/examples/party.sh
===================================================================
--- trunk/keyart/doc/examples/party.sh	                        (rev 0)
+++ trunk/keyart/doc/examples/party.sh	2014-05-18 00:01:02 UTC (rev 628)
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+FILE="art.txt"
+LEN="$(wc -l $FILE | awk '{print $1}')"
+I=1
+
+while [[ $I -le $LEN ]]; do
+    LINE1=$(sed -n "$((I+00))p" $FILE)
+    LINE2=$(sed -n "$((I+13))p" $FILE)
+    LINE3=$(sed -n "$((I+26))p" $FILE)
+    LINE4=$(sed -n "$((I+39))p" $FILE)
+    LINE5=$(sed -n "$((I+52))p" $FILE)
+    echo "${LINE1}${LINE2}${LINE3}${LINE4}${LINE5}"
+    if [ $((I%13)) -eq 0 ]; then I=$((I+52)); fi
+    I=$((I+1))
+done


Property changes on: trunk/keyart/doc/examples/party.sh
___________________________________________________________________
Added: svn:executable
   + *

Added: trunk/keyart/doc/party-worksheet
===================================================================
--- trunk/keyart/doc/party-worksheet	                        (rev 0)
+++ trunk/keyart/doc/party-worksheet	2014-05-18 00:01:02 UTC (rev 628)
@@ -0,0 +1,35 @@
+BASICS
+------
+To create a worksheet for a keysigning party, you will need to export each of
+the participants keys to their own file in a directory. If you've been storing
+them in a separate keyring, this should be easy.
+
+Once each key is in its own file, create a single "art.txt" file with all the
+keys. Something like:
+
+    $ for KEY in *.gpg; do keyart $KEY; done > art.txt
+
+In the examples/ directory of this documentation, is a 'party.sh' script that
+can transform that art.txt file to 5 key art per line. It will print the output
+to STDOUT. So, you could redirect to a file with:
+
+    $ ./party.sh > worksheet.txt
+
+Open 'worksheet.txt' in a text editor, and add newlines as necessary, so the
+key art is not broken by a page break. Use your text editor 'print preview' for
+help.
+
+Print off your modified 'worksheet.txt' for each key signing party attendee.
+
+COLOR WORKSHEET
+---------------
+If you would like to create an ANSI colored worksheet, you can install the
+Python "ansi2html" library, and redirect your output to an HTML file, which
+could then be used to print the worksheet:
+
+    $ sudo easy_install ansi2html
+    $ for KEY in *.gpg; do keyart -a $KEY; done > art.txt
+    $ ./party.sh | ansi2html > worksheet.html
+
+You may need to make some HTML adjustments to prevent the printer from breaking
+up the key art on the page break. Use your browser's 'print preview' for help.