<html>
<head>
<title>rpcCalc ReadMe</title>
</head>
<body>
<center>
<h1>ReadMe file for rpcCalc</h1>
<h2>a reverse polish notation calculator</h2>
<p>Written by Doug Bell<br>
Version 0.1.2<br>
November 24, 2003</p>
</center>
<h2>Contents</h2>
<ul>
<li><a href="background">Background</a></li>
<li><a href="features">Features</a></li>
<li><a href="legal">Legal Issues</a></li>
<li><a href="sysreq">System Requirements</a></li>
<li><a href="install">Installation</a></li>
<li><a href="using">Using rpcCalc</a>
<ul><li><a href="basics">Basics</a></li>
<li><a href="info-win">Information Window</a></li>
<li><a href="revs">Revision History</a></li>
<li><a href="contact">Questions, Comments, Criticisms?</a></li>
</ul>
<h2><a name="background"></a>Background</h2>
<p>rpcCalc is the console version of my rpCalc RPN calculator. It is based on Python's curses module, so it starts quickly, has few dependencies, and runs in any console or terminal. But it's still easy to use, showing buttons for every available command. The commands can be typed, or a mouse can be used (if supported by the terminal).</p>
<p>Since I'm not in the software business, I'm making this program free for anyone to use, distribute and modify, as long as it is not incorporated into any proprietary programs. If you like the software, feel free to let others know about it. And let me know what you think - my e-mail address is doug101 AT bellz DOT org</p>
<h2><a name="features"></a>Features</h2>
<ul>
<li>Uses reverse polish notation, similar to most Hewlett-Packard calculators.</li>
<li>The number, operator or command text on any key can be typed, or the mouse can be used to hit the key (if supported by the terminal).</li>
<li>An info window can be displayed showing the contents of the four registers, the ten memory registers and a recent equation history.</li>
<li>The mouse can be used (with the shift button) to cut and paste numbers in the display.</li>
<li>Options can be set to control the display of numbers and the angular unit.</li>
</ul>
<h2><a name="legal"></a>Legal Issues</h2>
<p>rpcCalc is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either Version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. See the <tt>LICENSE</tt> file provided with this program for more information.</p>
<h2><a name="sysreq"></a>System Requirements</h2>
<p>rpcCalc requires Python (Version 2.2 or higher) and the ncurses library. This library is usually standard on Linux/Unix variants, but not on other systems.</p>
<h2><a name="install"></a>Installation</h2>
<p>Extract the source files from the rpccalc tar file, then change to the <tt>rpcCalc</tt> directory in a terminal. For a basic installation, simply execute the following command as root: <tt>python install.py</tt></p>
<p>To see all install options, use: <tt>python install.py -h</tt></p>
<p>To install rpcCalc with a different prefix (the default is <tt>/usr/local</tt>), use: <tt>python install.py -p /prefix/path</tt></p>
<h2><a name="using"></a>Using rpcCalc</h2>
<h3><a name="basics"></a>Basics</h3>
<p>If you know how to use an RPN calculator (like Hewlett-Packard models), you know how to use rpcCalc. It stores previous results in four registers (usually labeled X, Y, Z and T), and the numbers are entered before the operators.</p>
<p>The quickest way to enter numbers and the four basic operators is to use the number pad on the keyboard. For the other keys, the name on the key can be typed (not case-sensitive). What has been typed shows up in the box below the keys. The tab key may be used to automatically complete a partially typed command. Of course, the mouse may also be used to hit any key.</p>
<p>A few keys have unusual labels to allow them to be typed: "RCIP" is 1/X, "tn^X" is 10^X, "R<" rolls the stack back (or down), "R>" rolls the stack forward (or up), "x<>y" is exchange, "CLR" clears the registers, "DEG" toggles between degrees and radians, and "<-" is backspace.</p>
<p>A few commands ("STO", "RCL" and "PLCS") prompt for a number from zero through nine. This number will be the memory register number or the number of decimal places for the display.</p>
<p>Options for controlling the numeric display include the previously mentioned "PLCS" for entering the number of decimal places, and "SCI", which toggles between normal and scientific notation. There is also the "SHOW" command, which temporarily displays scientific notation with more than 12 significant figures, then goes back to normal when the next command (or a repeated "SHOW" command) is given.</p>
<h3><a name="info-win"></a>Information Window</h3>
<p>An information window is displayed if the "INFO" command is given. Initially, this shows the contents of the four registers and the ten memory registers. Typing an "H" changes it to a history view, showing equations for recent calculations. Typing an "R" takes it back to the register view. Any other key closes the info window, going back to the calculator.</p>
<h2><a name="revs"></a>Revision History</h2>
<h3>November 24, 2003 - Release 0.1.2</h3>
<ul><b>Updates:</b>
<li>Allow the use of either periods or commas as decimal points to accomodate European keyboards and customs.</li>
<li>Added an installation script.</li>
</ul>
<h3>May 1, 2003 - Release 0.1.1</h3>
<ul><b>Bug Fixes:</b>
<li>Crashes caused by some calculation overflows have been fixed.</li>
</ul>
<h3>February 28, 2003 - Release 0.1.0</h3>
<ul>
<p>Initial release.</p>
</ul>
<h2><a name="contact"></a>Questions, Comments, Criticisms?</h2>
<p>I can be contacted by email at: doug101 AT bellz DOT org<br> I welcome any feedback, including reports of any bugs you find. Also, you can periodically check back to <www.bellz.org> for any updates.</p>
</body>
</html>