1. Create a folder c:\popeye.
2. Go to the Popeye home page (see above link).
3. Download one of the zipped files (*.zip or *.tar.gz).
4. Extract the zipped file to c:\popeye. You may require WinZip to extract.

NOTE: When you extract (for example) Popeye version 3.77, a sub-folder \py-3.77 will be created. Thus, the full pathname will now be c:\popeye\py-3.77. Remember this!

1. Click My Computer and navigate to the Popeye folder.
2. Double-click to executable file. A DOS-like window will open.
3. Enter the command "beginproblem" (or just "begi").
4. Enter other commands and parameters according to the documentation below.
5. Strongly recommended: specify "opti movenum maxsol 99 beep 3" for any type of problem.
6. Strongly recommended: specify "opti movenum maxsol 99 beep 3 intel" for any h#n, h=n, ser-h#n or ser-h=n problem.
7. Be sure to specify a "protocol" (or "prot") command to capture Popeye's output.
8. When finished, enter "endproblem" (or just "endp"); Popeye will begin solving.

1. Create an empty text file:
a. Enter "begi" on the first line.
b. Enter other commands and parameters according to the documentation below.
c. Strongly recommended: specify "opti movenum maxsol 99 beep 3" for any type of problem.
d. Strongly recommended: specify "opti movenum maxsol 99 beep 3 intel" for any h#n, h=n, ser-h#n or ser-h=n problem.
e. Specify a "prot" command if you want Popeye's output to go to a different file. Otherwise, output will go to the input file.
f. Enter the "endp" command at the end.

2. Save your file in your Popeye folder (eg. c:\popeye\py-3.77). Let's call the file infile (no file extension) for this test.
3. Exit to DOS (eg. click Start, Programs, Accessories, Command Prompt).
4. Type: cd\
5. Type: cd popeye\py-3.77
6. To run Popeye with default RAM settings (2Mb), type: py infile
7. Let's say you want Popeye to use 100Mb of RAM; type: py -maxmem 100M infile
8. After Popeye runs, check the file you specified in the "prot" for test results.

If you need any further help installing or running Popeye, please contact Dan Meinking. If you have questions about Popeye's documentation below, please contact the programmers as specified at the bottom.

Stopping Popeye: press CTRL + C key combination

Note: For the Popeye 'batch' commands below, parameters are in blue type and keywords are in bold red type.

The input to Popeye is not case sensitive. Every input to Popeye starts with the reserved word `Begin Problem'. After entering this command to Popeye, following commands may be used:

- remark: this keyword introduces a comment. Everything up to the end of the line will be ignored and has no further effects.
- author: The parameter to this command is the author of the problem. All Text up to end of line will be put above the diagram in the output. This input is completely optional and has no effect to the other capabilities of the program. All the input of multiple author commands will be placed on the output.
- origin: All the same as the author command.
- title: All the same as the author command.
- protocol: The parameter to his command is interpreted as filename, and all further output of Popeye on the screen is also placed in the given file. If the file exists already, the output of Popeye is appended to the file. The file will not be deleted.
- condition: All the conditions necessary for the problem, separated by blanks or new line, should be given to this command. Through combination of single conditions you can get other already existing conditions; for example: Circe and Immunchess results in StrictCirce

The following conditions are implemented:

RexInclusiv
Circe
MirrorCirce
Madrasi
Volage
Hypervolage
BichromChess
MonochromChess
GridChess
KoeKo
BlackEdgemover
WhiteEdgemover
Leofamily
ChineseChess
Patrouille
PWC
NoCapture
ImmunChess
MirrorImmunChess
ContactGridChess
Imitator
CavalierMajeur
HaanerChess
CouscousCirce
ChameleonCirce
EquipollentsCirce
FileCirce
Sentinelles
BlackMaximummer
WhiteMaximummer
BlackMinimummer
WhiteMinimummer
MagicSquares
DiagramCirce
Tibet
DoubleTibet
Hole (= a field where you cannot move to)
BlackMustCapture
WhiteMustCapture
TransmutedKings
BlackFollowMyLeader
WhiteFollowMyLeader
DuellistChess
ParrainCirce
SymmetryCirce
NoIProm (No Promotion to Imitator allowed)
VogtlaenderChess
EinsteinChess
Bicolores
NewKoeko
CirceClone
AntiCirce
MirrorFileCirce
AntipodenCirce
MirrorCirceClone
MirrorAntiCirce
DiagramAntiCirce
FileAntiCirce
SymmetryAntiCirce
MirrorAntiCirce
AntipodenAntiCirce
EquipollentsAntiCirce
FileImmunChess
DiagramImmunChess
MirrorFileImmunChess
SymmetryImmunChess
AntipodenImmunChess
EquipollentsImmunChess
ReversalEinsteinChess
SuperCirce
RelegationChess
NorskSjakk
TraitorChess
AndernachChess
BlackForcedSquare
WhiteForcedSquare
BlackConsequentForcedSquare
WhiteConsequentForcedSquare
ReflectiveKings
ChameleonChess
FunctionaryChess
GlasgowChess
AntiAndernachChess
FrischaufCirce
VerticalMirrorCirce
Isardam
ChecklessChess
DiametralCirce
PromOnly
ExclusiveChess
Marscirce
MarsMirrorCirce
PhantomChess
WhiteTransmutedKing
BlackTransmutedKing
WhiteReflectiveKing
BlackReflectiveKing
AntiEinsteinChess
MirrorCouscousCirce
BlackRoyalSquare
WhiteRoyalSquare
CirceAssassin
PlusChess
BrunnerChess
CentralChess
ExtinctionChess
RepublicanChess
ActuatedRevolvingBoard
MessignyChess
Woozles
BiWoozles
Heffalumps
BiHeffalumps
WhitePromSquares
BlackPromSquares
NoWhitePromotion
NoBlackPromotion
EiffelChess
ActuatedRevolvingCentre
Maximummer
UltraSchachZwang
WhiteUltraSchachZwang
BlackUltraSchachZwang
ShieldedKings
StingChess
NoWhiteCapture
NoBlackCapture
AprilChess
AlphabeticChess
LineChameleonChess
CirceTurncoats
CirceDoubleAgents
AMU
SingleBox

- option: Everything which should be in effect should be given here as blank seperated list. The following is recognized:

Try calculate if a move is a try.
Defence this option is followed by a number indicating the number of defences which should be taken into consideration. For instance Defence 1 all real tries are calculated.
SetPlay calculate setplay.
Threat for moremovers: This option must be followed by an integer. The opposit party has defended when there is no threat in less or equal this number of moves.
WhiteToPlay white starts moving in helpplay.
Variation show threats and variations.
MoveNumbers Movenumber, already calculated move and cumulated
solving time on output.
StartMoveNumber This option is followed by the Movenumber Popeye was interrupted at.
NoWk without white king
NoBk without black king
Duplex calculate stipulation for both sides
NoThreat calculate variations without calculating threats
MaxSolutions This option must be followed by an integer. Popeye stops calculating if this number of solutions are reached.
MaxFlightsquares for moremovers: This option must be followed by an integer. The opposite party has defended when the number of flightsquares for it's king are more or equal this number.
EnPassant Must be followed by at most two fields. A possible enpassant-key to this field(s) is calculated.
NoBoard The chessboard is not printed to screen or into file.
NoShortVariations Short variations are suppressed on output.
HalfDuplex calculate stipulation only for the opponent side.
PostKeyPlay The position entered is considered to be the position after the key. Just the solution play is analysed.
NonTrivial m n A special option to solve/cook/test long self and (semi)reflex problems. The second argument n determines which black moves are considered to be trivial - a move that can be met by a s#n (or r=n resp.). In long problems (more than n moves) black has at every stage at least one nontrivial move. ie. a move that does not lead to a s#n. The first argument m determines how many additional nontrivial moves can be granted to black by white during the whole solving procedure. Example: nontr 0 1. This is the most restrictive option. White forced to play moves that leave black with only one move not met by a s#1.
Intelligent intelligent (quick) solving of helpmate-moremovers. After the intelligent option, the maximum number of solutions per mating position can be given. MaxTime This option must be followed by an integer. Popeye stops calculating if this number of seconds solving time are reached.
NoCastling This option must be followed by the fields of those pieces, that cannot castle anymore in the diagram position.
Quodlibet In s# or r# also direct mates are a solution.
StopOnShortSolutions Calculation is terminated after detecting of short solutions.
Beep This option can be followed by an integer. Each time Popeye has found a solution it beeps a number of times.

- stipulation: Popeye knows the following stipulations:

#3 mate in three moves
HZg74 help-targetfield-g7 in 4 moves
S+2 self-check in 2 moves
R==3 reflex-doublestalemate in 3 moves
HS#3 helpselfmate in 3 moves (= help forced selfmate)
SER-+7 series-check in 7 movesn
SEMI-R+4 semi-reflex-check in 4 moves
x3 Capture in 3 moves
RECI-H#2 reciprocal helpmate in 2 (= Grazer helpmate)
SER-%4 series-Win_a_Piece in 4 moves
H##!4 help-"gegenmatt" in 4 moves
SER-H##3 series-help-"beidmatt" in 3 moves
2->ser-h#4 white makes 2 moves, then ser-h#4
h003 help-castling in 3 moves
dia6.5 Shortest Proofgame in 13 halfmoves (after the seventh move of white)
ser-dia9 Series-Proofgame in 9 moves
reci-h(=)#4 helpalternative(stale)mate in 4 moves
ser-!=7 Series-AutoStalemate in 7 moves
ser-ct10 Series-direct circuit (switchback) in 10 moves (of W piece)
h<>3 help exchange place in 3 moves (Bl helps W swap 2 pieces from diagram)
ser-sctr2 series self circuit by rebirth in 2 moves (W forces Bl to complete switchback of a W piece)
ser-h<>r5 series help exchange place by rebirth in 5 moves (Bl helps W complete by rebirth the exchange of two Bl pieces)
#=2 mate or stalemate in 2 moves
h~1 any helpmove

SEMI is valid only in combination with direct reflex-play. All these stipulations must be followed by a number giving the count of moves.

- forsyth: With this command you can enter the position in forsyth notation.

- pieces: This command specifies all the pieces belonging to the problem. After this keyword, the color of the following pieces must be given:

This is one of:
White
Black
Neutral

After the color specification:
Chameleon
Jigger
Kamikaze
Paralysing
Royal
Volage
Functionary
HalfNeutral
HurdleColourChanging (only for hoppers !)

15 1,5-leaper
16 1,6-leaper
24 2,4-leaper
25 2,5-leaper
35 3,5-leaper
36 3,6-leaper
37 3,7-leaper
ag Andernach grasshopper
al alfil
am amazon
an antelope
ao maorider
ar archbishop
b bishop
be bishop eagle
bh bishop hopper
bi bison 1,3+2,3 leaper
bk bouncy knight
bl bishop-lion
bm bishop moose
bo bob
bp berolina pawn
br bishop/rook hunter
bs berolina superpawn
bt boyscout
bu root-25-leaper (bucephale)
bw bishop sparrow
c cardinal
ca camel
cg contra grashopper
ch camelrider hopper
cr camelrider
ct CAT (cavalier trojan)
cy charybdis
da dabbabba
dg doublegrashopper
do dolphin grashopper + kangaroo
dr dragon
ds ("Diagonalspiralspringer")
du dummy
ea eagle
eh edgehog
ek erlking
em empress
eq equihopper
et elephant 0,1+1,1+1,2 rider
f friend
fe fers
fr fersrider like bishop, but different rebirthsquare
g grashopper
g2 grashopper-2
g3 grashopper-3
gh gnurider hopper
gi giraffe
gl gral alfil + rookhopper
gn gnu
gr gnurider
gt girlscout
ha hamster
k king
ka kangaroo
kh kinghopper
l locust
lb bishop locust
le leo
li lion
ln nightrider locust
lr rook locust
m moose
ma mao
mg marguerite g+sw+ea+m+ha
ml maorider lion
mm moarider lion
mo moa
n nightrider
na nao chinese nightrider
nd nereide
ne nonstop equihopper
nh nightrider hopper
nl nightrider lion
o orphan
oa moarider
ok okapi knight + zebra
or Orix English equihopper on queen lines
p pawn
pa pao
pr princess
q queen
r rook
ra rao chinese rose
rb reflecting bishop
re rook eagle
rf root-50-leaper
rh rook hopper
rl rook-lion
rm rook moose
rn rose-lion
rp rose-hopper
ro rose
rr rook/bishop hunter
rt rabbit
rw rook sparrow
s knight
si sirene
sk skylla
so scorpion
sp superpawn
sq squirrel
ss ("Spiralspringer")
sw sparrow
tr triton
uu ubiubi
va vao
wa waran
we wazir
wr wazirrider like rook, but different rebirthsquare
z zebra
zh zebrarider hopper
zr zebrarider

- twin: Solving/testing of positions obtained by small changes of the initial position. The following specifications are supported:

Stipulation ...: The stipulation is changed. See the repective basic command.
Condition ...: Change of fairy conditions. The old conditions are subsituted by those put in.
Move <square1> <square2>: Move the piece from square1 to square2. A piece accidentally standing on square2 will be removed. Example: twin move a3 b4.
Exchange <square1> <square2>: The pieces on <square1> and <square2> exchange places. Example: twin exchange a3 b4.
Remove <square>: The piece located on the square specified is removed. Example: twin remove e5.
Substitute <piece1> <piece2>: All pieces of type 1 are replaced by pieces of type 2. Colour and further piece specification (like paralysing etc.) are not effected. Example: twin substitute R B. All rooks are replaced by bishops.
Add <colour> <piecespecs> <type><fieldlist>: Adding pieces. Example: twin add black para NHa6 - a black paralysing NightriderHopper is added on a6. See the basic command "pieces".
Rotate n: Turns the board by n degrees to the left (n=90, 180, 270). Example: twin rotate 180. Mirror a1<-->h1: Mirrors the position on the vertical middle line.
Mirror a1<-->a8: Mirrors the position on the horizontal middle line.
Mirror a1<-->h8: Mirrors the position on the diagonal a8-h1.
Mirror h1<-->a8: Mirrors the position on the diagonal a1-h8. So, not the mirror line is given, but square into which a1 (or h1) is turned into.
Shift <square1> <square2>: Shift the whole position into the direction determined by the two squares entered. Example: twin shift a1 a2 - all pieces are moved one square up.
PolishType: All pieces change colour.

More than one change may be specified, for example twin rem e7 add white qe8. As you can see the twinning commands can abreviated. By default the changes refer to the position initially set. Alternatively the changes can be applied to the position solved most recently. Just enter "continued" (or "cont") immediately after "twin". Example twin cont rem a1.

ZeroPosition: This command can be used alternatively to the command "twin". It indicates that the initial position is not for solving. The command must be followed by the changes for the first position to be solved. Example: zero move b4 d5 twin move c5 b5.

When all data have been entered to describe completely the problem, the solving may be started by giving the keyword `endproblem' to Popeye. Immediately after reading this, provided no input errors were discovered, Popeye starts to solve the problem. Here comes a sample:

BeginProblem
Author Unknown
Origin Also Unknown
Stipulation #2
Pieces White Ka3 Ra8
Black Kb1
Option MoveNumbers Try Set Variation
EndProblem

Begi
Auth Unknown
Orig Also Unkown
Stip #2
Piec Whit Ka3 Ra8
Blac Kb1
Opti Move Try Set Vari
Endp

In the future the minimum length of unique shortages changes, when Popeye's capabilities are increased. But we try to keep all keywords uniq within the first four characters. If they are now uniq with less than four, its not guaranteed for the future.

If there are more problems to be solved in one run, you can replace the `EndProblem' directive with `NextProblem'. After this, Popeye expects an new problem specification, after he has solved the previous one. The last problem specification should be finished with `EndProblem'.