home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / x / volume19 / xodometer / part01 / evap / xodo.mm < prev   
Encoding:
Text File  |  1993-04-28  |  7.2 KB  |  196 lines
  1.  
  2. xodometer
  3.  
  4.     Track the total distance your pointing device and cursor
  5.     travel.  The distance can be displayed in various units.
  6.  
  7.     xodometer displays total distance and "trip" distance
  8.     since the application started (or since you clicked on
  9.     a trip reset button).
  10.  
  11.     xodometer requires certain information to ensure
  12.     accurate distance tracking.  Refer to the following
  13.     sections to learn about calibrating xodometer, and to
  14.     view a list of tested configurations.
  15.  
  16.     xodometer is typically started from the .xinitrc file.
  17.     Use the left button for selections.  Use the middle
  18.     button to reset both trip odometers simultaneously.
  19.  
  20.     Every xodometer command line parameter can have an
  21.     application resource in the xrdb database or .Xdefaults
  22.     file.  A resource follows this convention:
  23.  
  24.       xodo.parameter_name : parameter_value
  25.  
  26.     Therefore to specify xodometer's default font the
  27.     following resource entry could be specified:
  28.  
  29.       xodo.fontname : Rom8
  30.  
  31.     For further help try xodo -full_help.
  32.  
  33.     Examples:
  34.  
  35.       xodo -bd red -bg wheat1 -fg blue -g -0-0
  36.  
  37.       xodo -fn rom6 -o cursor -dwm 300 -dhm 234 
  38.  
  39.  
  40.     CALIBRATION
  41.  
  42.     xodometer requires the display dimensions in both pixels
  43.     and millimeters in order to correctly compute distances.
  44.     Look for this information in the appropriate hardware 
  45.     reference manual for your display.  If you cannot find
  46.     this information it's still easy to determine.  For the
  47.     display dimensions in pixels simply run xodometer, jam
  48.     the cursor in the bottom-right corner and note the X/Y
  49.     coordinates displayed at the bottom of the window - add
  50.     one to get the actual pixel count.  For the display
  51.     dimensions in millimeters just grab a tape measure and
  52.     measure your screen - if inches multiply by 25.4 and if
  53.     centimeters multiply by 10.  Select "About" and    verify
  54.     that xodometer is calibrated properly by using a ruler
  55.     to measure the calibration scale.  The default values
  56.     for these dimensions are suitable for an IBM RS/6000
  57.     machine with a 6091 19" color monitor.  Refer to the
  58.     next section for values of other tested    configurations.
  59.  
  60.     Assuming that the display dimension data is correct the
  61.     cursor distance can be accurately tracked.  The actual
  62.     distance that your pointing device, typically a mouse,
  63.     travels is INFERRED by accleration information provided
  64.     by the X server and pointer scaling information that
  65.     you must provide.  The default scale factor is 3.4,
  66.     meaning that the cursor travels 3.4 times as far as the
  67.     pointing device moves. This value is appropriate for an
  68.     IBM RS/6000 machine with a 6091 19" color monitor.
  69.     Refer to the next section for values of other tested
  70.     configurations.
  71.  
  72.     If you cannot find the correct scale factor for your
  73.     mouse then you must determine it by measuring.  It is
  74.     rather easy to do this:  first enter "xset m 1 1" to
  75.     set the X threshold and    acceleration to 1, then enter
  76.     "xodo -psf 1.0" to set xodometer's pointer scale factor
  77.     also to 1.  Once xodo is running pull-down the Units
  78.     menu and select "inches".  Then, using a ruler, place
  79.     the pointing device against one edge, click the second
  80.     button to reset the trip odometers, and then trace a
  81.     known distance, say, one inch.  The distance recorded
  82.     by the pointer's trip odometer is the proper scaling
  83.     factor.  Repeat the measurement several times for
  84.     accuracy.
  85.  
  86.     At the bottom of the xodometer window is a status line
  87.     that displays the current distance Units and the X/Y
  88.     cordinates of the cursor.  In the "About" window the
  89.     pointer    Scale factor, and the X Threshold and
  90.     Acceleration are displayed.
  91.  
  92.     All the calibration information you supply is either
  93.     passed on the command line, stored in environment
  94.     variables, or placed in your .Xdefaults file.  The
  95.     applicable environment variables are:
  96.     
  97.       D_XODO_DWM    display_width_millimeters
  98.       D_XODO_DHM    display_height_millimeters
  99.       D_XODO_DWP    display_width_pixels
  100.       D_XODO_DHP    display_height_pixels
  101.       D_XODO_PSF    pointer_scale_factor
  102.  
  103.  
  104.         TESTED CONFIGURATIONS    
  105.  
  106.     For each machine, Operating System/window manager and
  107.     display configuration, a sample xodometer command line
  108.     is given:
  109.  
  110.     - IBM RS/6000, AIX 3.2.3/mwm, 16" color
  111.       xodo -dwm 300 -dhm 234 -dwp 1280 -dhp 1024 -psf 3.0
  112.  
  113.     - IBM RS/6000, AIX 3.2.3/mwm, 19" color
  114.       xodo -dwm 350 -dhm 274 -dwp 1280 -dhp 1024 -psf 3.4
  115.  
  116.     - IBM RS/6000, AIX 3.2.3/mwm, 23" color
  117.       xodo -dwm 430 -dhm 340 -dwp 1280 -dhp 1024 -psf 4.0
  118.  
  119.     - Sun SPARC 1+, SunOS 4.1.1/twm, 17" monochrome
  120.       xodo -dwm 292 -dhm 232 -dwp 1152 -dhp  900 -psf 2.0      
  121.  
  122.     - Sun SPARC 1+, SunOS 4.1.1/twm, 19" color
  123.       xodo -dwm 358 -dhm 274 -dwp 1152 -dhp  900 -psf 4.0      
  124. .display
  125.     The X display name; default is the DISPLAY variable.
  126. .display_width_millimeters
  127.     The width in millimeters of the X display.  The default
  128.     is 350 mm (an IBM 6091 19" color monitor).
  129. .display_height_millimeters
  130.     The height in millimeters of the X display.  The default
  131.     is 274 mm (an IBM 6091 19" color monitor).
  132. .display_width_pixels
  133.     The width of the X display in pixels.  The default
  134.     is 1280 pixels (an IBM 6091 19" color monitor).
  135. .display_height_pixels
  136.     The height of the X display in pixels.  The default
  137.     is 1024 pixels (an IBM 6091 19" color monitor).
  138. .pointer_scale_factor
  139.     The scale factor to convert pointer movement to cursor
  140.     movement.  A scale factor of 2.0 means that for every D
  141.     units of distance the pointing device moves, the cursor
  142.     moves 2 * D units.  The default is 3.4, suitable for an
  143.     IBM 6091 19" color monitor.
  144. .border
  145.     xodometer's border color.
  146. .background
  147.     xodometer's background color.
  148. .foreground
  149.     xodometer's foreground color.
  150. .fontname
  151.     xodometer's odometer font.  An extremely small font
  152.     is "rom6" while a rather large font is "helvr30".
  153. .fontname2
  154.     xodometer's button font.  In general you should NOT
  155.     change this font since the action buttons do not
  156.     change size.  Another suitable font is "Rom8", but
  157.     that is not available on all X servers.
  158. .geometry
  159.     Specifies the X geometry in the standard notation.
  160.     The width and height are not normally specified since
  161.     xodometer calculates them based on the fontname.  If
  162.     an "offset" value is positive it is measured from the
  163.     top or left edge of the display, and if negative it is
  164.     measured from the bottom or right edge of the screen.
  165.     So, to start xodometer in the bottom-right corner a
  166.     geometry string of "-0-0" would be specified.
  167. .iconic
  168.     If specified xodometer starts up already iconified.
  169. .microsecond_interval_time
  170.     The number of microseconds between odometer updates.  The
  171.     default value of 100,000 means that the pointer position
  172.     is sampled 10 times per second, which seems to provide
  173.     accurate distance measurements without consuming
  174.     excessive amounts of your machine's resources.
  175. .odometer
  176.     A keyword that specifies whether to display both
  177.     odometers, or just one of them, and if just one,
  178.     which one.
  179. .odometer_file
  180.     The path name of the file to record total mouse distance
  181.     (in millimeters) and other application information.  This
  182.     file is read during xodometer startup to initialize the
  183.     distance totals and establish the distance units.  When
  184.     you "Quit" xodometer the updated distance/unit data is
  185.     written to this file.
  186. .odometer_autosave_time
  187.     Specifies the time interval in minutes between odometer
  188.     file updates.  This is just for good luck, as xodometer
  189.     updates the odometer file when these event are received:
  190.  
  191.       - control/c
  192.       - window close
  193.       - window manager exit
  194. .title
  195.     The xodometer window title line.
  196.