wmglobe/wmglobe.1

   1 .TH WMGlobe 1.3   "august 2001"
   2 .SH NAME
   3 WMGlobe - The Whole Earth spinning on you desktop...
   4 as a dockable app for WindowMaker
   5 .SH SYNOPSIS
   6 .B wmglobe
   7 .I "[-options]"
   8 .SH "DESCRIPTION"
   9 WMGlobe is a WindowMaker dock.app that displays the earth on an icon. It's
  10 an adaptation of XGlobe to WMaker environnement. WMGlobe uses a map which is
  11 rendered on a sphere by raytracing. Yes, for a 64x64 pixel result:-)
  12 .SH "OPTIONS"
  13 .TP
  14 .B \-v
  15 version. Currently, this should display :
  16
  17 WMGlobe v.1.3  12 aug 2001 <jerome.dumonteil@linuxfr.org>
  18 .TP
  19 .B \-h
  20 short help
  21 .TP
  22 .B \-zoom \fI zoom_value\fP
  23 Value > 1 to magnify the view, value < 1 to lower. Default: 1.0
  24 .TP
  25 .B \-pos \fI latitude longitude\fP
  26 Initial viewing fixed at this position, don't follow
  27 the sun rotation. Accepted values in the form 45°12'36 or 45.21 or 45:12:36 .
  28 Default: the initial position is "under" the sun, and
  29 the point of view follows the sun.
  30 .TP
  31 .B \-sun
  32 The point of view follows the Sun (default).
  33 .TP
  34 .B \-moon
  35 The point of view follows the Moon (i.e. you see the Earth as you
  36 were on the Moon).
  37 .TP
  38 .B \-rand
  39 New random position at every refresh of screen.
  40 .TP
  41 .B \-map \fI map_file\fP
  42 Map used for the rendering. Can be JPEG, GIF, XPM
  43 PNM, TIFF but none BMP.
  44 Default: use internal map of earth.
  45 .TP
  46 .B \-nimap \fI night_file\fP
  47 Map used for the dark side of the earth. Must be of
  48 the same width x height as the day side map.
  49 Default: if the default internal day map is used, use
  50 a default internal night file (see -nonimap option).
  51 .TP
  52 .B \-defnimap
  53 Use the default night map (with a custom map).
  54 .TP
  55 .B \-nonimap
  56 Don't use the default night map.
  57 .TP
  58 .B \-delay \fI seconds\fP
  59 Time in seconds between each calculation of a new
  60 position. Limited to 0.04 at compile time (25 frames
  61 per second should be enough). The sun position move
  62 only once per minute, so if you use wmglobe without
  63 -dlong or -accel option, the CPU cost of WMGlobe is
  64 *very* low. The use of very low value for -delay plus
  65 -dlong and -accel can be CPU costly (but very nice...).
  66 Default: 1.0 sec.
  67 .TP
  68 .B \-dlat \fI delta_latitude\fP
  69 Move the point of view by delta_lat degrees per second,
  70 with a value of 6 the earth make a full rotation in
  71 one minute. The value can be formated as -pos option.
  72 Default: 0°0'0
  73 .TP
  74 .B \-dlong \fI delta_long\fP
  75 Move the point of view by delta_long degrees per
  76 second. With a value of -0°0'15" the earth make a full
  77 rotation in 24 hours toward the west. By default,
  78 -dlong and -dlat are null. If they are used, the view
  79 follow their values. Going back to "follow sun" mode
  80 in parameters screen put -dlat and -dlong to zero.
  81 .TP
  82 .B \-light \fI light_value\fP
  83 Level of light of the dark side when there is no
  84 night map, from 0 to 1.
  85 Default: 0.25
  86 .TP
  87 .B \-dawn \fI dawn_value\fP
  88 Level of continuity for dawn limit, from 0 to 1. With
  89 a value of 1, the border line between night and day is
  90 at maximum contrast.
  91 Default: 0.2
  92 .TP
  93 .B \-bord \fI border_num\fP
  94 0 1 or 2. There are 3 different borders for the icon.
  95 Default: 2
  96 .TP
  97 .B \-accel \fI time_multi\fP
  98 Time warp factor. With -accel 24, the sun make a full
  99 rotation in one hour (or the earth, I'm not sure). Default: 1.0
 100 .TP
 101 .B \-time \fI seconds\fP
 102 Time to display in seconds since 01-01-1970 (see the
 103 date command). Necessary if you need to be sure that
 104 WMGlobe is Y2K compliant without changing system time.
 105 Negative values for dates before 1970 accepted.
 106 Default: not set, use current time.
 107 .TP
 108 .B \-mk \fI latitude longitude\fP
 109 Put a fixed marker at latitude/longitude.
 110 -mk sun : put a marker under the Sun position.
 111 -mk moon : put a marker under the Moon.
 112 5 markers can be defined simultaneously, so you can
 113 use wmglobe to predict when Moon will meet the Sun :-)
 114 .TP
 115 .B \-fun \fI dx dy\fP
 116 Move the earth image by dx dy pixels in the icon. See
 117 puzzle.sh to understand why.
 118 .TP
 119 .B \-oz
 120 Start in "austral" mode (for "down under" people)
 121 .TP
 122 .B \-stable
 123 Keep the globe from going over the poles.
 124 .TP
 125 .B \-d \fI display\fP
 126 Select another display
 127 .TP
 128 .B \-w  \-shape
 129 Useless, since it is set by default (WMaker dockable
 130 application)
 131 .SH "MOUSE OPTIONS"
 132 .TP
 133 .B left button
 134 Change longitude while pressed, change longitude &
 135 latitude if shift+left button.
 136 .TP
 137 .B middle button
 138 Zoom in, shift + middle button: zoom out
 139 .TP
 140 .B right button
 141 Displays 7 screens of parameters. On every screen, just
 142 clic with left or right button on the figures to change
 143 their value. The TIME screen shows an approximation
 144 of date and time of the earth zone currently displayed,
 145 using GMT time + longitude offset, it's close to the
 146 real local time by one or two hours. Others options
 147 don't need more help. Intuitive they said...
 148 .SH "FILES"
 149 .TP
 150 .B MAPS
 151 Like XGlobe, WMGlobe needs a longitude/latitude map to work. By default,
 152 it uses a low quality built-in map of earth. But you will probably want
 153 to use better ones.
 154 You can get maps usable with WMGlobe on the net. See the links below.
 155
 156 using custom maps:
 157
 158 For the image to be mapped correctly, position 0°North 0°West must be in
 159 the center of the image and the latitude must be linear from 90°N to 90°S.
 160 When using a night map, make sure that day and night map have the same
 161 dimensions.
 162 .TP
 163 .B Links: Where to find maps and similar softs
 164
 165 where to find the sources of wmglobe:
 166 the web page of WMGlobe (made by Sylvestre Taburet):
 167
 168 <http://perso.linuxfr.org/jdumont/wmg/>
 169
 170
 171 where to find maps and similar softs:
 172
 173 Earth image by a cgi:
 174
 175 <http://www.fourmilab.ch/cgi-bin/uncgi/Earth>
 176
 177 two softs running under X:
 178
 179 XGlobe Homepage: (many links to map of earth)
 180
 181 <http://www.uni-karlsruhe.de/~uddn/xglobe>
 182
 183
 184 Xearth Homepage:
 185
 186 <http://www.cs.colorado.edu/~tuna/xearth/>
 187
 188 By the way, you can use maps of Mars, Luna ... and text.
 189
 190 .SH "ENVIRONMENT"
 191 .LP
 192 WMGlobe uses the setlocale(3) function, so you LANG environment need to be ok.
 193
 194 You need WindowMaker 0.62 or higher to use WMGlobe. (use WMGlobe 1.0 for
 195 older versions of WindowMaker).
 196 .SH "SEE ALSO"
 197 .LP
 198 The Window Maker User Guide
 199
 200 The Window Maker FAQ
 201
 202 .SH "AUTHOR"
 203 jerome dumonteil  <jerome.dumonteil@linuxfr.org>
 204
 205 Patches,  bug  reports, and suggestions are welcome.
 206
 207 .SH "CREDITS"
 208 WMGlobe is Copyright (C) 1998,99 by Jerome Dumonteil and licensed through
 209 the GNU General Public License.
 210 Read the COPYING file for the complete GNU license.
 211
 212 Original idea, tests, logos:
 213
 214 Sylvestre Taburet <Sylvestre.Taburet@free.fr>
 215
 216 WindowMaker 0.62 fix : Charles G Waldman <cgw@fnal.gov>
 217
 218 The code in 'sunpos.cpp' is taken from Xearth by Kirk Lauritz Johnson.
 219
 220 /*
 221 sunpos.c
 222 kirk johnson
 223 july 1993
 224
 225 code for calculating the position on the earth's surface for which
 226 the sun is directly overhead (adapted from _practical astronomy
 227 with your calculator, third edition_, peter duffett-smith,
 228 cambridge university press, 1988.)
 229
 230
 231 Copyright (C) 1989, 1990, 1993, 1994, 1995 Kirk Lauritz Johnson
 232
 233 Parts of the source code (as marked) are:
 234   Copyright (C) 1989, 1990, 1991 by Jim Frost
 235   Copyright (C) 1992 by Jamie Zawinski <jwz@lucid.com>
 236
 237 Permission to use, copy, modify and freely distribute xearth for
 238 non-commercial and not-for-profit purposes is hereby granted
 239 without fee, provided that both the above copyright notice and this
 240 permission notice appear in all copies and in supporting
 241 documentation.
 242 */
 243
 244
 245 The rendering engine is taken from XGlobe by Thorsten Scheuermann
 246 XGlobe Homepage: http://www.uni-karlsruhe.de/~uddn/xglobe
 247
 248 Raster graphics library by Alfredo K. Kojima, & stuff of Window Maker
 249 <http://windowmaker.org> by A. K. Kojima, Dan Pascu, Matthew Hawkins & team
 250
 251
 252 .SH "BUGS"
 253 .LP
 254 If you use the  --enable-single-icon compile time option of WindowMaker,
 255 you can not display more than one WMGlobe.
 256
 257 WMGlobe hopes that an overflow of a long integer dont generate an error
 258 and that LONG_MAX +1 = LONG_MIN . This happens with high values of -accel
 259 when the date go over year 2038. The expected result is wmglobe
 260 continuing smoothly from 1901.
 261
 262 Using WMGlobe at high speed through a LAN may induce some load on the net.
 263
 264