home *** CD-ROM | disk | FTP | other *** search
/ Chip Hitware 6 / Chip_Hitware_Vol_06.iso / chiphit6 / freizeit / 95wearth / wearth.txt < prev    next >
Text File  |  1996-07-04  |  21KB  |  521 lines
  1.  
  2.  
  3.  
  4.  wearth()                                                           wearth()
  5.  
  6.  
  7.  
  8.  
  9.  NAME
  10.       wearth - displays a shaded image of the Earth in the root window
  11.  
  12.  
  13.  SYNOPSIS
  14.       wearth [-proj proj_type ] [-pos pos_spec ] [-rot angle ] [-sunpos
  15.       sun_pos_spec ] [-mag factor ] [-size size_spec ] [-shift shift_spec ]
  16.       [-shade|-noshade] [-stars|-nostars] [-starfreq frequency ] [-bigstars
  17.       percent ] [-grid|-nogrid] [-grid1 grid1 ] [-grid2 grid2 ] [-day pct ]
  18.       [-night pct ] [-term pct ] [-gamma gamma_value ] [-wait secs ]
  19.       [-timewarp timewarp_factor ] [-time fixed_time ] [-onepix|-twopix]
  20.       [-mono|-nomono] [-ncolors num_colors ] [-once|-noonce] [-nice priority
  21.       ] [-gif] [-ppm] [-version]
  22.  
  23.  
  24.  DESCRIPTION
  25.       Wearth sets the Windows Desktop wallpaper to an image of the Earth, as
  26.       seen from your favorite vantage point in space, correctly shaded for
  27.       the current position of the Sun. By default, wearth updates the
  28.       displayed image every five minutes. The time between updates can be
  29.       changed with the -wait option (see below); updates can be disabled
  30.       completely by using the -once option (see below).  Wearth can also
  31.       render directly into PPM and GIF files instead of drawing in the root
  32.       window; see the -ppm and -gif options (below).
  33.  
  34.       This man page documents version 1.0 of wearth.
  35.  
  36.  
  37.  OPTIONS
  38.       Wearth understands the following command line options
  39.  
  40.  
  41.       -proj proj_type
  42.            Specify the projection type wearth should use. Supported
  43.            projection types are mercator and orthographic; these can either
  44.            be spelled out in full or abbreviated to merc or orth,
  45.            respectively. Wearth uses an orthographic projection by default.
  46.  
  47.  
  48.       -pos pos_spec
  49.            Specify the position from which the Earth should be viewed. The
  50.            pos_spec (position specifier) consists of a keyword, possibly
  51.            followed by additional arguments. Valid keywords are: fixed,
  52.            sunrel, orbit, and random. (If you're having problems getting
  53.            wearth to accept a position specifier as a command line argument,
  54.            make sure and read the comments about position specifier
  55.            delimiters and using explicit quoting in the fifth paragraph
  56.            following this one.)
  57.  
  58.            The position specifier keyword fixed should be followed by two
  59.            arguments, interpreted as numerical values indicating the
  60.  
  61.  
  62.                                     - 1 -           Formatted:  July 4, 1996
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  wearth()                                                           wearth()
  70.  
  71.  
  72.  
  73.  
  74.            latitude and longitude (expressed in decimal degrees) of a
  75.            viewing position that is fixed with respect to the Earth's
  76.            surface. Positive and negative values of latitude correspond to
  77.            positions north and south of the equator, respectively. Positive
  78.            and negative values of longitude correspond to positions east and
  79.            west of Greenwich, respectively.
  80.  
  81.            The position specifier keyword sunrel should be followed by two
  82.            arguments, interpreted as numerical values indicating the offsets
  83.            in latitude and longitude (expressed in decimal degrees) of a
  84.            viewing position that is fixed with respect to the position of
  85.            the Sun. Positive and negative values of latitude and longitude
  86.            are interpreted as for the fixed keyword.
  87.  
  88.            The position specifier keyword orbit should be followed by two
  89.            arguments, interpreted as numerical values indicating the period
  90.            (in hours) and orbital inclination (in decimal degrees) of a
  91.            simple circular orbit; the viewing position follows this orbit.
  92.            Astute readers will surely note that these parameters are not
  93.            sufficient to uniquely specify a single circular orbit. This
  94.            problem is solved by limiting the space of possible orbits to
  95.            those positioned over 0 degrees latitude, 0 degrees longitude at
  96.            time zero (the Un*x epoch, see time(3)).
  97.  
  98.            The position specifier keyword random should not be followed by
  99.            any arguments. When this keyword is used, the viewing position is
  100.            selected at random each time an update occurs.
  101.  
  102.            Components of a position specifier are delimited by either
  103.            whitespace, forward slashes (/), or commas. Note that using
  104.            whitespace to separate position specifier components when
  105.            invoking wearth from a shell may require explicit quoting to
  106.            ensure the entire position specifier is passed as a single
  107.            argument. For example, if you want to use spaces to delimit
  108.            components and are using a "typical" shell, you'd need to use
  109.            something like:
  110.  
  111.                -pos "fixed 42.33 -71.08"
  112.  
  113.            or
  114.  
  115.                -pos 'fixed 42.33 -71.08'
  116.  
  117.            to make things work. If you'd rather not have to explicitly quote
  118.            things, you can use forward slashes or commas instead of spaces
  119.            to separate components, as shown below.
  120.  
  121.                -pos fixed,42.33,-71.08
  122.                -pos fixed/42.33/-71.08
  123.  
  124.            If a position specifier is not provided, wearth uses a default
  125.  
  126.  
  127.                                     - 2 -           Formatted:  July 4, 1996
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  wearth()                                                           wearth()
  135.  
  136.  
  137.  
  138.  
  139.            position specifier of "sunrel 0 0" (such that the entire day side
  140.            of the Earth is always visible).
  141.  
  142.  
  143.       -rot angle
  144.            Specify a rotated viewing position such that the north is not
  145.            "straight up" in the center of the rendered image. Positive
  146.            values of angle rotate the rendered image counterclockwise;
  147.            negative values rotate the rendered image clockwise. The default
  148.            value of angle is 0.
  149.  
  150.  
  151.       -sunpos sun_pos_spec
  152.            Specify a fixed point on the Earth's surface where the Sun is
  153.            always directly overhead. The sun_pos_spec (Sun position
  154.            specifier) consists of two components, both numerical values;
  155.            these components are interpreted as the latitude and longitude
  156.            (in decimal degrees) of the point where the Sun is directly
  157.            overhead.
  158.  
  159.            The details provided for position specifiers (see above) about
  160.            the interpretation of positive and negative latitude and
  161.            longitude values and the characters used to delimit specifier
  162.            components apply to Sun position specifiers as well.
  163.  
  164.            By default, wearth calculates the actual position of the Sun and
  165.            updates this position with the progression of time.
  166.  
  167.  
  168.       -mag factor
  169.            Specify the magnification of the displayed image. When the
  170.            orthographic projection is in use, the diameter of the rendered
  171.            Earth image is factor times the shorter of the width and height
  172.            of the image (see the -size option, below). For the mercator
  173.            projection, the width of the rendered image is factor times the
  174.            width of the image (see the -size option, below). The default
  175.            magnification factor is 1.
  176.  
  177.  
  178.       -size size_spec
  179.            Specify the size of the image to be rendered. The size_spec (size
  180.            specifier) consists of two components, both positive integers;
  181.            these components are interpreted as the width and height (in
  182.            pixels) of the image.
  183.  
  184.            The details provided for position specifiers (see above) about
  185.            the characters used to delimit specifier components apply to size
  186.            specifiers as well.
  187.  
  188.            When rendering into the wallpaper, these values default to the
  189.            dimensions of the root window. When producing a PPM or GIF file
  190.  
  191.  
  192.                                     - 3 -           Formatted:  July 4, 1996
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  wearth()                                                           wearth()
  200.  
  201.  
  202.  
  203.  
  204.            instead of drawing in the window (see the -ppm and -gif options,
  205.            below), both values default to 512.
  206.  
  207.  
  208.       -shift shift_spec
  209.            Specify that the center of the rendered Earth image should be
  210.            shifted by some amount from the center of the image. The
  211.            shift_spec (shift specifier) consists of two components, both
  212.            integers; these components are interpreted as the offsets (in
  213.            pixels) in the X and Y directions.
  214.  
  215.            The details provided for position specifiers (see above) about
  216.            the characters used to delimit specifier components apply to
  217.            shift specifiers as well.
  218.  
  219.            By default, the center of the rendered Earth image is aligned
  220.            with the center of the image.
  221.  
  222.  
  223.       -shade | -noshade
  224.            Enable/disable shading. When shading is enabled, the surface of
  225.            the Earth is shaded according to the current position of the Sun
  226.            (and the values provided for the -day, -night, and -term options,
  227.            below). When shading is disabled, use flat colors (green and
  228.            blue) to render land and water. Shading is enabled by default.
  229.  
  230.  
  231.       -stars | -nostars
  232.            Enable/disable stars. If stars are enabled, the black background
  233.            of "space" is filled with a random pattern of "stars" (individual
  234.            white pixels). The fraction of background pixels that are turned
  235.            into stars can be controlled with the -starfreq option (see
  236.            below). Stars are enabled by default.
  237.  
  238.  
  239.       -starfreq frequency
  240.            Set the density of the random star pattern (see -stars, above);
  241.            frequency indicates the fraction of background pixels that should
  242.            be turned into "stars". The default value of frequency is 0.002.
  243.  
  244.  
  245.       -bigstars percent
  246.            Set the percentage of double-width stars (see -stars, above); by
  247.            default, all stars are a single pixel, but this option can be
  248.            used to create some stars that are composed of two horizontal
  249.            pixels.  This provides a slightly less uniform look to the "night
  250.            sky".
  251.  
  252.  
  253.       -grid | -nogrid
  254.            Enable/disable the display of a longitude/latitude grid on the
  255.  
  256.  
  257.                                     - 4 -           Formatted:  July 4, 1996
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  wearth()                                                           wearth()
  265.  
  266.  
  267.  
  268.  
  269.            Earth's surface. The spacing of major grid lines and dots between
  270.            major grid lines can be controlled with the -grid1 and -grid2
  271.            options (see below). Grid display is disabled by default.
  272.  
  273.  
  274.       -grid1 grid1
  275.            Specify the spacing of major grid lines if grid display (see
  276.            -grid, above) is enabled; major grid lines are drawn with a
  277.            90/grid1 degree spacing. The default value for grid1 is 6,
  278.            corresponding to 15 degrees between major grid lines.
  279.  
  280.  
  281.       -grid2 grid2
  282.            Specify the spacing of dots along major grid lines if grid
  283.            display (see -grid, above) is enabled. Along the equator and
  284.            lines of longitude, grid dots are drawn with a 90/(grid1 x grid2)
  285.            degree spacing. The spacing of grid dots along parallels (lines
  286.            of latitude) other than the equator is adjusted to keep the
  287.            surface distance between grid dots approximately constant. The
  288.            default value for grid2 is 15; combined with the default grid1
  289.            value of 6, this corresponds to placing grid dots on a one degree
  290.            spacing.
  291.  
  292.  
  293.       -day pct
  294.            Specify the brightness that should be used to shade the day side
  295.            of the Earth when shading is enabled. Pct should be an integer
  296.            between 0 and 100, inclusive, where 0 indicates total darkness
  297.            and 100 indicates total illumination. This value defaults to 100.
  298.  
  299.  
  300.       -night pct
  301.            Specify the brightness that should be used to shade the night
  302.            side of the Earth when shading is enabled. Pct should be an
  303.            integer between 0 and 100, inclusive, where 0 indicates total
  304.            darkness and 100 indicates total illumination. This value
  305.            defaults to 5 (if this seems overly dark, you may want to
  306.            double-check that appropriate gamma correction is being employed;
  307.            see -gamma, below).
  308.  
  309.  
  310.       -term pct
  311.            Specify the shading discontinuity at the terminator (day/night
  312.            line). Pct should be an integer between 0 and 100, inclusive. A
  313.            value of x indicates that the shading should immediately jump x
  314.            percent of the difference between day and night shading values
  315.            (see -day and -night, above) when crossing from the night side to
  316.            the day side of the terminator. Thus a value of 0 indicates no
  317.            discontinuity (the original wearth behavior), and a value of 100
  318.            yields a maximal discontinuity (such that the entire day side of
  319.            the earth is shaded with the -day shading value). This value
  320.  
  321.  
  322.                                     - 5 -           Formatted:  July 4, 1996
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  wearth()                                                           wearth()
  330.  
  331.  
  332.  
  333.  
  334.            defaults to 1.
  335.  
  336.  
  337.       -gamma gamma_value
  338.            When wearth is rendering into the wallpaper, adjust the colors
  339.            wearth uses by a gamma value. Values less than 1.0 yield darker
  340.            colors; values greater than 1.0 yield brighter colors. The
  341.            default gamma_value is 1.0, appropriate for use on systems with
  342.            built-in gamma correction. For systems without built-in gamma
  343.            correction, appropriate gamma values are often in the 2.3 to 2.6
  344.            range.
  345.  
  346.            See the GAMMA-TEST file included with the wearth source
  347.            distribution for information about a simple test that allows you
  348.            to directly estimate the gamma of your display system (see
  349.            OBTAINING THE WEARTH SOURCE DISTRIBUTION, below).
  350.  
  351.  
  352.       -wait secs
  353.            When rendering into the wallpaper, wait secs seconds between
  354.            updates. This value defaults to 300 seconds (five minutes).
  355.  
  356.  
  357.       -timewarp timewarp_factor
  358.            Scale the apparent rate at which time progresses by
  359.            timewarp_factor. The default value of timewarp_factor is 1.0.
  360.  
  361.  
  362.       -time fixed_time
  363.            Instead of using the current time to determine the "value" of
  364.            time-dependent positions (e.g., the position the sun), use a
  365.            particular fixed_time (expressed in seconds since the Un*x epoch
  366.            (see time(3)).
  367.  
  368.  
  369.       -onepix | -twopix
  370.            Specify whether wearth should use one or two pixmaps when
  371.            rendering into the wallpaper. If only one pixmap is used, partial
  372.            redraws may be visible at times in the root window (when areas of
  373.            the root window are exposed and redrawn during the time wearth is
  374.            rendering the next image). If two pixmaps are used, wearth uses
  375.            them to double-buffer changes such that partial redraws are
  376.            (almost?) never seen.
  377.  
  378.  
  379.       -mono | -nomono
  380.            If rendering into the wallpaper enable/disable monochrome mode.
  381.            Monochrome mode is enabled by default on systems with one-bit
  382.            framebuffers (see the "depth of root window" information provided
  383.            by xdpyinfo(1)) and disabled by default otherwise.
  384.  
  385.  
  386.  
  387.                                     - 6 -           Formatted:  July 4, 1996
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  wearth()                                                           wearth()
  395.  
  396.  
  397.  
  398.  
  399.       -ncolors num_colors
  400.            If rendering into the wallpaper or a GIF output file, specify the
  401.            number of colors that should be used. (If markers are enabled
  402.            (see -markers, above), the actual number of colors used may be
  403.            one larger than num_colors.) The default value of num_colors is
  404.            64.
  405.  
  406.            When rendering into the wallpaper, the maximum allowable value
  407.            for num_colors is 1024. In practice, using values of num_colors
  408.            larger than twice the number of distinct shades of red, green, or
  409.            blue supported by your hardware is likely to provide little
  410.            additional benefit, or, in some cases, produce "banding" effects
  411.            in the image. Thus, on systems that can support 256 distinct
  412.            shades of red, green, or blue (eight bits per component), the
  413.            largest practical value of num_colors is around 512. Similarly,
  414.            on systems that support only five or six bits per component
  415.            (e.g., many systems with 16-bit displays), the largest practical
  416.            value of num_colors is probably around 64.
  417.  
  418.            When rendering into a GIF output file, the maximum allowable
  419.            value for num_colors is 256.
  420.  
  421.  
  422.       -once | -noonce
  423.            Disable/enable updates. If updates are enabled and wearth is
  424.            rendering into the wallpaper, wearth updates the displayed image
  425.            periodically (the time between updates can be controlled via the
  426.            -wait option, above). If updates are disabled, wearth only
  427.            renders an image once and then exits. Updates are enabled by
  428.            default.
  429.  
  430.  
  431.       -nice priority
  432.            Run the wearth process with priority priority (see nice(1) and
  433.            setpriority(2)). By default, wearth runs at the priority of the
  434.            process that invoked it, usually 0.
  435.  
  436.  
  437.       -gif Instead of drawing in the wallpaper, write a GIF file (eight-bit
  438.            color) to standard out.
  439.  
  440.  
  441.       -ppm Instead of drawing in the wallpaper, write a PPM file (24-bit
  442.            color) to standard out.
  443.  
  444.  
  445.       -version
  446.            Print what version of wearth this is.
  447.  
  448.  
  449.  
  450.  
  451.  
  452.                                     - 7 -           Formatted:  July 4, 1996
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  wearth()                                                           wearth()
  460.  
  461.  
  462.  
  463.  
  464.  COPYRIGHT
  465.       Copyright (C) 1995, 1996 by Erwin Yu Copyright (C) 1989, 1990, 1993,
  466.       1994, 1995 by Kirk Lauritz Johnson
  467.  
  468.       Portions of the wearth source code, as marked, are:
  469.  
  470.         Copyright (C) 1989, 1990, 1991 by Jim Frost
  471.         Copyright (C) 1992 by Jamie Zawinski <jwz@lucid.com>
  472.  
  473.       Permission to use, copy, modify and freely distribute wearth for non-
  474.       commercial and not-for-profit purposes is hereby granted without fee,
  475.       provided that both the above copyright notice and this permission
  476.       notice appear in all copies and in supporting documentation.
  477.  
  478.       Unisys Corporation holds worldwide patent rights on the Lempel Zev
  479.       Welch (LZW) compression technique employed in the CompuServe GIF image
  480.       file format as well as in other formats. Unisys has made it clear,
  481.       however, that it does not require licensing or fees to be paid for
  482.       freely distributed, non-commercial applications (such as wearth) that
  483.       employ LZW/GIF technology. Those wishing further information about
  484.       licensing the LZW patent should contact Unisys directly at
  485.       (lzw_info@unisys.com) or by writing to
  486.  
  487.         Unisys Corporation
  488.         Welch Licensing Department
  489.         M/S-C1SW19
  490.         P.O. Box 500
  491.         Blue Bell, PA 19424
  492.  
  493.       The author makes no representations about the suitability of this
  494.       software for any purpose. It is provided "as is" without express or
  495.       implied warranty.
  496.  
  497.       THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  498.       INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  499.       EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  500.       CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  501.       USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  502.       OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  503.       PERFORMANCE OF THIS SOFTWARE.
  504.  
  505.  
  506.  AUTHOR
  507.         Kirk Johnson <tuna@cag.lcs.mit.edu>
  508.         MIT Laboratory for Computer Science
  509.  
  510.       Patches, bug reports, and suggestions are welcome, but I can't
  511.       guarantee that I'll get around to doing anything about them in a
  512.       timely fashion.
  513.  
  514.  
  515.  
  516.  
  517.                                     - 8 -           Formatted:  July 4, 1996
  518.  
  519.  
  520.  
  521.