Cody Boone Ferguson
2ca6dc4021
With this commit I should be able to return to the other entries though as Landon pointed out I might never finish this and this is a reason it might not have been as thorough as I could have been (another part is it's long). Nevertheless the formatting should now be okay along the lines of what was requested for all the winning entry markdown files.
80 lines
3.6 KiB
Groff
80 lines
3.6 KiB
Groff
.TH enigma 1 "16 April 2023" "enigma" "IOCCC 2020"
|
|
.SH NAME
|
|
enigma \- A German Enigma simulator for IOCCC 2020
|
|
.SH SYNOPSIS
|
|
\fBenigma [-]\fP
|
|
.SH DESCRIPTION
|
|
\fBenigma\fP is a German Enigma simulator written for IOCCC 2020.
|
|
It only supports the Heer (army) and Luftwaffe (air force) machines.
|
|
Its default settings are as follows:
|
|
\fBWheel order (Walzenlage)\fP \fII, II, III\fP; \fBRing settings (Ringstellung)\fP \fIABC\fP; \fBInitial positions (Grundstellung)\fP \fIBBC\fP; \fBReflector (Umkehrwalze, UKW)\fP \fIB\fP; and the \fBplugboard (Steckerbrett)\fP is empty (no pairings).
|
|
.PP
|
|
There are no options per se; if not passed a \fB\-\fP (in the first argument) then it will use the default settings, waiting for input (unless input is piped to it e.g. from the recode program, echo or redirecting a file as stdin).
|
|
Otherwise it will prompt you for the settings and then wait for input to encipher/decipher.
|
|
.SH FILES
|
|
\fIprog.c\fP
|
|
.RS
|
|
Source file to the simulator.
|
|
.RE
|
|
\fIrecode.c\fP
|
|
.RS
|
|
Source code to the configuration tool (not required but recommended).
|
|
.RE
|
|
\fIrecode.md\fP
|
|
.RS
|
|
Markdown file with examples on how to use the recode program (along with the Enigma program).
|
|
.RE
|
|
\fIREADME.md\fP
|
|
.RS
|
|
More information on the Enigma simulator IOCCC entry.
|
|
.RE
|
|
\fIchocolate\-cake.md\fP
|
|
\fIchocolate\-cake.html\fP
|
|
.RS
|
|
A file with a recipe of a delicious Double-layered Chocolate Fudge Cake that has been enciphered with one of 16 Enigma settings given in \fIrecode.md\fP which should give enough information on how to make use of the two programs in order to unlock this recipe.
|
|
I recommend the html version for formatting.
|
|
.RE
|
|
\fIenigma.1\fP
|
|
.RS
|
|
I don't think you need help here! :)
|
|
.RE
|
|
\fIrecode.1\fP
|
|
.RS
|
|
The recode.c man page.
|
|
.RE
|
|
.SH BUGS
|
|
.PP
|
|
Rudimentary parser allows for easily piping into the simulator settings (and file to encipher/decipher) but which also can be a bit confusing, unintuitive and does not handle too much input that well.
|
|
.PP
|
|
There is one thing in particular I was unsure of when writing the simulator as far as how it is supposed to work: I believe I have it but there might be one issue. See \fIREADME.md\fP for more information.
|
|
.PP
|
|
It was written by a human being.
|
|
.PP
|
|
Not a bug as some might want to believe, maybe: figuring out how the recode.c program works won't help you figure out how this works.
|
|
.PP
|
|
The critical flaw in the Enigma machine that I referred to in the \fIREADME.md\fP obviously has to be in the program.
|
|
.PP
|
|
For more please see \fIREADME.md\fP.
|
|
.SH EXAMPLES
|
|
.PP
|
|
Please see the \fIrecode.md\fP and \fIREADME.md\fP files for examples and other information.
|
|
.SH AUTHOR
|
|
Written by Cody Boone Ferguson for IOCCC 2020 (the 27th IOCCC).
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBrecode(1)\fP
|
|
.PP
|
|
\fB\<https://ioccc.xexyl.net/2020/enigma\>\fP The 27th IOCCC 'Most enigmatic'.
|
|
.PP
|
|
\fB\<https://web.archive.org/web/20200710094321/http://users.telenet.be/d.rijmenants/en/enigmaproc.htm\>\fP Enigma Message Procedures for the Heer (Army), Luftwaffe (Air Force) and Kriegsmarine (Navy).
|
|
.PP
|
|
\fB\<http://enigmaco.de/enigma/enigma.html\>\fP Online interactive Enigma simulator.
|
|
.PP
|
|
\fB\<https://web.archive.org/web/20200621180323/http://www.codesandciphers.co.uk/enigma/index.htm\>\fP Tony Sale's (original curator of the Bletchley Park Museum) pages on The Enigma cipher machine.
|
|
.PP
|
|
\fB\<https://web.archive.org/web/20200710094303/http://users.telenet.be/d.rijmenants/en/enigmatech.htm\>\fP Technical Details of the Enigma Machine.
|
|
.PP
|
|
\fB\<https://web.archive.org/web/20200710094243/http://users.telenet.be/d.rijmenants/en/enigma.htm\>\fP The German Enigma Cipher Machine.
|
|
.PP
|
|
\fB\<http://www.ellsbury.com/enigma3.htm\>\fP How the Enigma was Set Up and Operated.
|