Mercurial > public > m209

comparison docs/index.rst @ 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 6acd17898381
comparison
equal deleted inserted replaced
56:21627ec5b1ad 57:859dc6624ab7
14 :Documentation: http://m209.readthedocs.org/ 14 :Documentation: http://m209.readthedocs.org/
15 :Support: https://bitbucket.org/bgneal/m209/issues 15 :Support: https://bitbucket.org/bgneal/m209/issues
16 16
17 Introduction 17 Introduction
18 ------------ 18 ------------
19
20 The `M-209`_ is a mechanical cipher machine used by the US military during
21 World War II and up to the Korean War. The M-209 is also known as the CSP-1500
22 by the US Navy. The M-209 is an example of a Hagelin device, a family of
23 mechanical cipher machines created by Swedish inventor `Boris Hagelin`_, where
24 it is known as the C-38.
19 25
20 ``m209`` is a complete `M-209`_ simulation library and command-line application 26 ``m209`` is a complete `M-209`_ simulation library and command-line application
21 written in Python 3. ``m209`` is historically accurate, meaning that it can 27 written in Python 3. ``m209`` is historically accurate, meaning that it can
22 exchange messages with an actual M-209 cipher machine. 28 exchange messages with an actual M-209 cipher machine.
23 29
35 41
36 Contents: 42 Contents:
37 43
38 .. toctree:: 44 .. toctree::
39 tutorial 45 tutorial
46 commandline
47 library
40 :maxdepth: 2 48 :maxdepth: 2
41 49
42 50
43 Requirements 51 Requirements
44 ------------ 52 ------------
69 ---------------- 77 ----------------
70 78
71 All support takes place at the `m209 Bitbucket page`_. Please enter any 79 All support takes place at the `m209 Bitbucket page`_. Please enter any
72 feature requests or bugs into the `issue tracker`_. 80 feature requests or bugs into the `issue tracker`_.
73 81
82 References
83 ----------
84
85 All of the resources listed below were useful to me in the creation of the
86 ``m209`` library. In particular, I want to thank Mark J. Blair for his detailed
87 explanations of the M-209's operation and procedures. The official training
88 film was also highly instructive.
89
90 #. `M-209 at Wikipedia <http://en.wikipedia.org/wiki/M-209>`_
91 #. `Mark J. Blair's Converter M-209-B <http://www.nf6x.net/2009/02/converter-m-209-b/>`_
92 #. `1942 M-209 Manual <http://maritime.org/tech/csp1500inst.htm>`_
93 #. `1944 M-209 Manual scan <http://www.ilord.com/m209manual.html>`_
94 #. `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!
95 #. `Transcript of Training Film <http://www.ilord.com/m209-training.html>`_ -
96 Transcript of the above film.
97 #. `Mark J. Blair's M-209 Cipher Machine Group <http://www.nf6x.net/groups/m209group/>`_ -
98 Informal club for M-209 enthusiasts. Includes detailed explanations of the
99 device and how to use it. Very useful.
100 #. `Dirk Rijmenants' M-209 Simulator <http://users.telenet.be/d.rijmenants/en/m209sim.htm>`_ -
101 Graphical M-209 simulator
102 #. `Mark J. Blair's Hagelin project suite at GitHub <https://github.com/NF6X/hagelin>`_
103 - M-209 simulator written in C++
104 #. `Jean-François BOUCHAUDY's Crypto Pages <http://www.jfbouch.fr/crypto/>`_
105 - Includes another Python-based M-209 simulator and a M-209 challenge. In French.
106 #. `The C-38 / M-209 Cipher Machine <http://hem.passagen.se/tan01/c38.html>`_
107 - Another M-209 page. This one has useful info on creating key lists and a C-38 simulator written in C.
108
74 Indices and tables 109 Indices and tables
75 ================== 110 ==================
76 111
77 * :ref:`genindex` 112 * :ref:`genindex`
78 * :ref:`modindex` 113 * :ref:`modindex`
79 * :ref:`search` 114 * :ref:`search`
80 115
81 116
82 .. _M-209: http://en.wikipedia.org/wiki/M-209 117 .. _M-209: http://en.wikipedia.org/wiki/M-209
118 .. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin
83 .. _Python: http://www.python.org 119 .. _Python: http://www.python.org
84 .. _Python Package Index: http://pypi.python.org/pypi/m209/ 120 .. _Python Package Index: http://pypi.python.org/pypi/m209/
85 .. _m209 Bitbucket page: https://bitbucket.org/bgneal/m209 121 .. _m209 Bitbucket page: https://bitbucket.org/bgneal/m209
86 .. _pip: http://www.pip-installer.org 122 .. _pip: http://www.pip-installer.org
87 .. _Mercurial: http://mercurial.selenic.com/ 123 .. _Mercurial: http://mercurial.selenic.com/