Mercurial > public > m209

changeset 57:859dc6624ab7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Roughed out docs table of contents. Added references.
author Brian Neal <bgneal@gmail.com>
date Sat, 06 Jul 2013 17:06:16 -0500
parents 21627ec5b1ad
children 902f14d7e032
files docs/commandline.rst docs/index.rst docs/library.rst
diffstat 3 files changed, 40 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/commandline.rst	Sat Jul 06 17:06:16 2013 -0500
@@ -0,0 +1,2 @@
+Command-line Reference
+======================
--- a/docs/index.rst	Sat Jul 06 16:27:47 2013 -0500
+++ b/docs/index.rst	Sat Jul 06 17:06:16 2013 -0500
@@ -17,6 +17,12 @@
 Introduction
 ------------
 
+The `M-209`_ is a mechanical cipher machine used by the US military during
+World War II and up to the Korean War. The M-209 is also known as the CSP-1500
+by the US Navy. The M-209 is an example of a Hagelin device, a family of
+mechanical cipher machines created by Swedish inventor `Boris Hagelin`_, where
+it is known as the C-38.
+
 ``m209`` is a complete `M-209`_ simulation library and command-line application
 written in Python 3. ``m209`` is historically accurate, meaning that it can
 exchange messages with an actual M-209 cipher machine.
@@ -37,6 +43,8 @@
 
 .. toctree::
    tutorial
+   commandline
+   library
    :maxdepth: 2
 
 
@@ -71,6 +79,33 @@
 All support takes place at the `m209 Bitbucket page`_. Please enter any
 feature requests or bugs into the `issue tracker`_.
 
+References
+----------
+
+All of the resources listed below were useful to me in the creation of the
+``m209`` library. In particular, I want to thank Mark J. Blair for his detailed
+explanations of the M-209's operation and procedures. The official training
+film was also highly instructive.
+
+#. `M-209 at Wikipedia <http://en.wikipedia.org/wiki/M-209>`_
+#. `Mark J. Blair's Converter M-209-B <http://www.nf6x.net/2009/02/converter-m-209-b/>`_
+#. `1942 M-209 Manual <http://maritime.org/tech/csp1500inst.htm>`_
+#. `1944 M-209 Manual scan <http://www.ilord.com/m209manual.html>`_
+#. `Official M-209 Training Film <http://www.youtube.com/playlist?list=PLCPgncK_sTnEny2-uoTV-1_GC72zo-vKq>`_ - This is a 4 video YouTube playlist of an actual 1940's era US War Department training film. Demonstrates the M-209 and operational procedures. Very interesting!
+#. `Transcript of Training Film <http://www.ilord.com/m209-training.html>`_ -
+   Transcript of the above film.
+#. `Mark J. Blair's M-209 Cipher Machine Group <http://www.nf6x.net/groups/m209group/>`_ -
+   Informal club for M-209 enthusiasts. Includes detailed explanations of the
+   device and how to use it. Very useful.
+#. `Dirk Rijmenants' M-209 Simulator <http://users.telenet.be/d.rijmenants/en/m209sim.htm>`_ -
+   Graphical M-209 simulator
+#. `Mark J. Blair's Hagelin project suite at GitHub <https://github.com/NF6X/hagelin>`_
+   - M-209 simulator written in C++
+#. `Jean-François BOUCHAUDY's Crypto Pages <http://www.jfbouch.fr/crypto/>`_
+   - Includes another Python-based M-209 simulator and a M-209 challenge. In French.
+#. `The C-38 / M-209 Cipher Machine <http://hem.passagen.se/tan01/c38.html>`_
+   - Another M-209 page. This one has useful info on creating key lists and a C-38 simulator written in C.
+
 Indices and tables
 ==================
 
@@ -80,6 +115,7 @@
 
 
 .. _M-209: http://en.wikipedia.org/wiki/M-209
+.. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin
 .. _Python: http://www.python.org
 .. _Python Package Index: http://pypi.python.org/pypi/m209/
 .. _m209 Bitbucket page: https://bitbucket.org/bgneal/m209
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/library.rst	Sat Jul 06 17:06:16 2013 -0500
@@ -0,0 +1,2 @@
+Library Reference
+=================