README

e17XPlanet README file

Version 1.04
Copyright © 2005-2008 Steve Jones
http://www.squaregoldfish.co.uk/software/e17xplanet
steve@squaregoldfish.co.uk

See the end of this file for licence details.

Requirements

XPlanet – http://xplanet.sourceforge.net
e17 – http://www.enlightenment.org

Installation

Installation is performed by the install.sh script, which performs the following steps:

  1. Installs the actual script into a location of your choice.
  2. Create a .desktop file to launch the script
  3. Add the .desktop file to your e17 startup items

The installation script will try to locate the programs it needs automatically, which it should do if you’ve got e17 and XPlanet installed. If it can’t find something it needs, it will ask you to enter the relevant path yourself.

You will be prompted for the installation directory by the script. It is designed to be installed under your home directory, not in a system-accessible directory.

Most of the variables at the top of the script should be left alone. However, you can edit the following values to suit your tastes:

NICE The script runs XPlanet at a low priority to help prevent it from taking over your machine while it runs. Set the priority level here.
SLEEP_TIME The time to wait (in seconds) between rendering new backgrouds.
XPLANET_OPTIONS This is where you enter your XPlanet command line options. The only options you shouldn’t specify are:

  • output
  • geometry
  • num_times
  • wait

These entries are either irrelevant, or set automatically by the script. I give no guarantees as to what will happen if you set these values.
DISPLAY Specifies the DISPLAY environment variable. You should probably leave this alone.
TEMP_LOCATION Specifies the directory in which the script’s temporary and debugging files are created.

Disabling e17XPlanet

To prevent e17XPlanet from starting when e17 starts, run the e17XPlanet_disable script from the installation directory.

To re-enable e17XPlanet at a later date, run the e17XPlanet_enable script.

Two .desktop files have been included in the installation so you can add these functions to your menu if you wish. They are e17XPlanet_disable.desktop and e17XPlanet_enable.desktop, and installed in ~/.local/share/applications.

Uninstallation

To completely remove e17XPlanet from your system, run the uninstall.sh script from the installation directory.

Copyright © 2005-2008 Steve Jones (steve@squaregoldfish.co.uk)
See http://www.squaregoldfish.co.uk/software/e17xplanet

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details, supplied in gpl.txt.