summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPhilipp Gesang <pgesang@ix.urz.uni-heidelberg.de>2012-02-23 21:19:26 +0100
committerPhilipp Gesang <pgesang@ix.urz.uni-heidelberg.de>2012-02-23 21:19:26 +0100
commit8d93a4c0ccbfb9b3fb1f17ccecdc5bf430f18154 (patch)
treecd0a62723d969cc966f9edca2ac1bf38eb815216 /doc
parent93e1c741d591be11d4782ec359d33a3f1b54bf8c (diff)
downloadenigma-8d93a4c0ccbfb9b3fb1f17ccecdc5bf430f18154.tar.gz
docstrings; manual stub
Diffstat (limited to 'doc')
-rw-r--r--doc/context/third/enigma/enigma_manual.tex50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/context/third/enigma/enigma_manual.tex b/doc/context/third/enigma/enigma_manual.tex
new file mode 100644
index 0000000..281ae93
--- /dev/null
+++ b/doc/context/third/enigma/enigma_manual.tex
@@ -0,0 +1,50 @@
+\startdocchapter[title=Example: Encrypted Document]
+
+Encrypt the text of your document using the script interface. For
+a start try out the settings as given in below listing.
+
+\starttyping
+mtxrun --script mtx-t-enigma \
+ --setup="other_chars = ok, \
+ day_key = B I II III 01 01 01, \
+ rotor_setting = xyz, \
+ verbose=0" \
+ --text="Nobody can read this."
+\stoptyping
+
+This will result in the thoroughly scrambled string
+\type{zdkbxwwnwkazpokvgr}.
+Then, use the same settings you encrypted the text with in your
+document.
+
+\startcontexttyping
+\usemodule[enigma]
+\defineenigma [secretmessage]
+\setupenigma [secretmessage] [
+ other_chars = ok,
+ day_key = B I II III 01 01 01,
+ rotor_setting = xyz,
+ verbose=3,
+]
+
+\starttext
+
+\startsecretmessage
+zdkbxwwnwkazpokvgr
+\stopsecretmessage
+
+\stoptext
+\stopcontexttyping
+
+If you compile this document with \CONTEXT, the plain text will
+reappear.
+Notice that punctuation is substituted with the letter “x” before
+encryption and that spaces are omitted.
+
+\stopdocchapter
+
+\startdocchapter[title=Acknowledgements]
+The Enigma module was inspired by Arno Trautmann’s
+\identifier{chickenize} package.
+Without \LUATEX, encryption on node-level would not have been possible.
+\stopdocchapter