xpl - convenient and versatile wrapper for xplanet
xpl [xplanet-options...] [config=value...] [extra-options...]
xpl is a wrapper for xplanet(1) which makes all config file options
tunable on the command line and provides a number of convenience features.
The options for xpl are as for xplanet(1)
with the following additions.
Firstly, any options in the environment variable $XPLANETOPTS
are prefixed to the command line arguments.
xpl takes a copy of your configuration file (specified by the environment variable $XPLANETCONFIG, defaulting to $XPLANETDIR/config) and applies command line settings to it, then runs xplanet with this amended copy. Generally, any command line argument of the form:
param=value
is appended to the ``current'' clause in the config file. Initially this clause is [default]. Use of the -body and -origin options causes the clause to match the chosen body or origin, and subsequent param=value arguments are appended to that new clause. The extra option -clause may also be used to switch clauses without specifying a body or origin.
The following directives have extended functionality:
In xplanet these directives specify the pathname of an image file. In xpl they may also be simple names like ``earth'' or ``mars-thermal''; such a name will be resolved by searching recursively the directories specified by the envionment variable $XPLANETIMPATH for, in the former example, files named ``earth'', ``earth.png'' or ``earth.jpg''. The pathname so found will be written into the configuration.
Additionally, any name beginning with ``random'' will use the rbg script to choose an image using the keywords following the word ``random''. Example:
xpl -bg 'random nebulae'
will use rbg to choose a random image whose pathname includes the word ``nebulae''.
Xplanet command line options are passed on to xplanet. Additionally, the following options are extra or have extended functionality:
Converted into ``-num_times 1'' and passed to xplanet.
names is a space or comma separated list, of course usually just a single name. Subsequent param=value configuration directives will be appended to each [name] clause listed. Also the special names stars, planets and moons are expanded to the known bodies of that type.
Also see the -body and -origin options below.
Converted into ``-output pathname'' and passed to xplanet.
Create a JPEG or PNG of the view and print its pathname on standard output.
Passed to xplanet.
Converted into ``-geometry geom'' and passed to xplanet with the same extended functionality as -geometry, below.
Passed to xplanet. Additionally the value ``screen'' for geom will use the preferred screen backdrop size as returned by the bgsize script. This is handy when using xpl to make screen backdrop images.
Converted into ``-background image'' and passed to xplanet. with the same extended functionality as -background, below.
The image specified has the same extended facilities as for the ``image=name'' etc directives described earlier; searching in $XPLANETIMPATH and the ``random keywords...'' special name. Additionally, the name ``last'' may be used to specify the last background chosen with xpl.
Converted into ``-latitude latitude'' and passed to xplanet with the same extended functionality as -latitude, below.
The latitude is either an ordinary latitude between -90 and 90 or the word ``random'' which picks an arbitrary value in that range.
The longitude is either an ordinary longitude between -180 and 180 or the word ``random'' which picks an arbitrary value in that range.
Passed to xplanet. Additionally, these options change the clause into which subsequent ``param=value'' directives are inserted. The special names stars, planets and moons clause a random body of that type to be chosen. Also see the -clause option above.
Passed to xplanet. If not supplied, ``body from origin'' is used.
Passed to xplanet. Additionally, this path is prepended to the environment variable $XPLANETIMPATH, used to locate short image names.
Don't use the -vroot|-xscreensaver, -window or -output modes; handy if you've put such a mode in your $XPLANETOPTS variable (which I do to avoid damaging my root backdrop by accident).
Passes -transparency to xplanet and sets -root mode (above).
$TMPDIR, where temporary files are made. Also handed to xplanet as its -tmpdir argument.
$XPLANETDIR, where configuration files are expected.
Default: $HOME/.xplanet.
$XPLANETCONFIG, the default base configuration.
Default: $XPLANETDIR/config.
$XPLANETOPTS, default xpl options prefixed to the command line.
$XPLANETIMPATH, a colon separated list of directories
to search for image files.
Default: $XPLANETDIR/images.
$XPLANETDIR/config, the base configuration file
xplanet(1), the program that does the real work: http://freshmeat.net/projects/xplanet/
Cameron Simpson <cs@zip.com.au> July 2004