wmglobe/wmglobe.1

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