Command line options

Command line options

The script has many options than can be modified. Some of them can be passed on command line (mostly if you want to test the script). After you settled with a configuration that yields results that are aesthetically pleasing for your wallpaper, you can put these values in the script itself (setting the internal variable directly, see [Extended options].

OPTIONS can be passed as options to the script itself, and are described below:

-bs=, --background-source=/path/to/file/or/folder
A valid path that points to an image file (JPEG, PNG, BMP, PPM, TGA) or a folder that contains image files. This image file will be used as a desktop background, with Earth and/or Moon rendered on top of it.

If the path is a folder, a random image from it will be used.
No modification is done to the original file provided.

-ss=, --screen-size=WIDTHxHEIGHT
The size (in pixels) of the final output images.
For instance, if your desktop size is 1024 by 768 pixels, this option is -ss=1024x768

The screen size cannot be safely found from the script; if it is run from a cron job or from a system-wide account, the X11 server cannot be easily queried. Different logged in users can have different X server geometries set, so setting this variable is the safest choice.

-ns, --no-stretch
Do not stretch the input image to screen size. Default is to stretch it (i.e. takes the input image and stretches it until fit the screen-size.

-bms=, --background-max-size=WIDTHxHEIGHT
if no-stretch is enabled, this will be the maximum resize of the input image. Default 640x480

-ps1=, --planet1_size=WIDTH
The size (in pixels) of the square area containing the 1st body (Earth); default 300

-ps2=, --planet2_size=WIDTH
The size (in pixels) of the square area containing the 2nd body (Moon); default 200

-pa=, --planets-align=TYPE
Planets alignment in relation to whole wallpaper (center or corners)
Possible values of TYPE are (clockwise from top-left corner): NorthWest, North, NorthEast, East, SouthEast,South, SouthWest, West; also Center
Default is NorthEast (positioned on top-right corner).

-ps=, --planets-stacking=TYPE
Arrange the planets on relationship with each other (side-by-side or on top of each other.
Possible values for TYPE are horizontal, vertical.
Default is vertical.

-psa=, --planets-stacking-alignment=TYPE
Finely tune if the planets are on the same line (Center) or aligned in respect to border of the screen.
Possible values for TYPE are like those from -pa (see above).
Default is NorthEast (aligned to right border, top corner)

-dp1, --disable-planet1
Do not draw the Earth; default is to draw it.

-dp2, --disable-planet2
Do not draw the Moon; default is to draw it.

-epom, --enable-pom
Do tell in a written text bellow the Moon it's phase, with percent.
Default is not to draw it.

-d, --debug
Turn the script very verbose; all path and temporary files are in the script's output.
It is useful to track down something that went wrong.

-h, --help
prints a help message.