wmcalc/wmcalc.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH WMCALC 1 "September 20, 2001"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 wmcalc \- dockable calculator application
  20 .SH SYNOPSIS
  21 .B wmcalc
  22 [\-g \fIgeometry\fP] [\-d \fIdisplay\fP] [\-v] [\-f \fIconfigfile\fP] [\-h]
  23
  24 .SH DESCRIPTION
  25 This manual page documents briefly the
  26 .B wmcalc
  27 command.
  28 This manual page was written for the Debian GNU/Linux distribution
  29 because the original program does not have a manual page.
  30 .PP
  31 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  32 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  33 .\" respectively.
  34 \fBwmcalc\fP is a program designed to act as a simple calculator offering basic operations like addition, subtraction, multiplication, division, square and squareroot.  It is different from other calculator programs, however in that it is designed to take up very little desktop space.  As such, it can be left running on the desktop at all times.  It is intended to placed in the WindowMaker dock, or in Wharf under Afterstep, though it should run as well under any window manager.
  35
  36 \fB*IMPORTANT*\fP: this calculator, due to its simple target, does not respect the proper mathematical operations order, and they are executed in the order they are inserted.
  37
  38 Buttons are defined as:
  39 .nf
  40  ____________________
  41 |       x00          |  x = 1 for Left Mouse Button
  42 | 0 1 2 3 4 5 6 7 8 9|  x = 2 for Middle Mouse Button
  43 |--------------------|  x = 3 for Right Mouse Button
  44 |x01 x02 x03 x04 x05 |
  45 |x06 x07 x08 x09 x10 |  Note: the numbers 0..9 are the
  46 |x11 x12 x13 x14 x15 |         indicators for memory cells
  47 |x16 x17 x18 x19 x20 |         0..9 respectively
  48  --------------------
  49 .fi
  50 .TP
  51 Button Functions:
  52 .TP
  53 .B 100
  54 Reinitialize the calculator. (100 = Left Mouse Button on Display)
  55 .TP
  56 .B 200
  57 Clear all the memory registers (0..10)
  58 .TP
  59 .B 300
  60 Clear the current number being entered only
  61 .TP
  62 .B x11
  63 Start a program defined by CalcStart variable in config file
  64 .TP
  65 .B 1yy
  66 Perform function shown on button
  67 .TP
  68 .B 2yy
  69 Recall number from memory location [0-9] to display for calculation if yy = 2,3,4, 7,8,9, 12, 13, 14, 17 otherwise, can run a user-defined function (not implemented)
  70 .TP
  71 .B 3yy
  72 Store Displayed number in memory location [0-9] if yy = 2,3,4, 7,8,9, 12,13,14, 17 otherwise, can run a user-defined function (not implemented)
  73 .TP
  74 .B 1xx
  75 Hopefully the other functions are obvious from their button graphics.
  76
  77
  78 .SH OPTIONS
  79 .TP
  80 .B \-g <geometry>
  81 Window Geometry - ie: 64x64+10+10
  82 .TP
  83 .B \-d  <display>
  84 Display -  ie: 127.0.0.1:0.0
  85 .TP
  86 .B \-f  <filename>
  87 Full path to configuration file.
  88 .TP
  89 .B \-v
  90 Verbose Mode.
  91 .TP
  92 .B \-h
  93 Help.
  94 .SH FILES
  95 .TP
  96 .I /etc/wmcalc.conf
  97 system wide wmcalc configuration file which will be used for all users who start wmcalc the first time.
  98 .TP
  99 .I ~/.wmcalc
 100 The configuration file (.wmcalc) is written by wmcalc whenever the user requests to store a number to memory. This file is automatically created the first time a user launches wmcalc with /etc/wmcalc.conf as template. As a part of this process, a file is written to /tmp. If /tmp is not accessible, it tries in the user's home directory, as defined by the environment variable HOME. This file is erased as soon as it is written over the main configuration file.
 101 .SH CONFIGURATION
 102 .TP
 103 The configuration file is case sensitive. A # starts a comment, and lines consisting entirely of whitespace are ignored. The syntax is simply:
 104 .TP
 105 .B <variable> <content>
 106 Where <variable> and <content> need to be separated by a Tab \\t and \fBnot\fP spaces.
 107 .TP
 108 \fBmem0 - mem9\fP Calculator Memory Locations. These must all exist, though they may be in any order.
 109 .TP
 110 \fBCalcStart\fP The CalcStart variable is intended to allow the user to start a larger calculator for more complicated needs.  Everything after the tab '\\t' character is sent unmodified in a system() call, so anything you can type at the command prompt may be put here.
 111 .TP
 112 \fBImagChar\fP The ImagChar variable allows the user to choose between 'i' and 'j' to represent the sqrt(\-1).
 113
 114 .SH AUTHOR
 115 wmcalc was written by Edward H. Flora <ehflora@access1.net>, and is licensed under the terms of the GNU  General Public License.
 116 .TP
 117 This manual page was written by Gordon Fraser <gordon@freakzone.net>, for the Debian GNU/Linux system (but may be used by others).
 118