# HG changeset patch # User Brian Neal # Date 1373148376 18000 # Node ID 859dc6624ab781a230f362ca528f182d60d994f0 # Parent 21627ec5b1adee661090a32a715c0743b2bd1673 Roughed out docs table of contents. Added references. diff -r 21627ec5b1ad -r 859dc6624ab7 docs/commandline.rst --- /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 +====================== diff -r 21627ec5b1ad -r 859dc6624ab7 docs/index.rst --- 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 `_ +#. `Mark J. Blair's Converter M-209-B `_ +#. `1942 M-209 Manual `_ +#. `1944 M-209 Manual scan `_ +#. `Official M-209 Training Film `_ - 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 `_ - + Transcript of the above film. +#. `Mark J. Blair's M-209 Cipher Machine Group `_ - + Informal club for M-209 enthusiasts. Includes detailed explanations of the + device and how to use it. Very useful. +#. `Dirk Rijmenants' M-209 Simulator `_ - + Graphical M-209 simulator +#. `Mark J. Blair's Hagelin project suite at GitHub `_ + - M-209 simulator written in C++ +#. `Jean-François BOUCHAUDY's Crypto Pages `_ + - Includes another Python-based M-209 simulator and a M-209 challenge. In French. +#. `The C-38 / M-209 Cipher Machine `_ + - 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 diff -r 21627ec5b1ad -r 859dc6624ab7 docs/library.rst --- /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 +=================