%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %main XaoS
Welcome to XaoS - a real-time fractal zoomer.
About XaoS
Learn who's behind XaoS and how you can help.
Getting started
Start here to learn how to use XaoS's basic features.
Getting support
How to report problems and get help from the XaoS community.
User formulas
Learn how to render your own formulas in XaoS.
Encoding videos
Learn how to create videos from your XaoS animations.
Platform-specific documentation
XaoS runs on many platforms. Read instructions specific to yours.
XaoS's file format
Learn how to tweak your saved fractals and animations.
Menus, commands and parameter index
An in-depth discussion of all of XaoS's commands.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %about About XaoS XaoS is free software. You are welcome to redistribute it under the terms of the GNU General Public License. This also means that you may get sources and help improve XaoS through an open development process. Credits (alphabetically)
Lucio Henrique de Araujo (lucio.matema@gmail.com)
Brazilian/Portuguese translation
Eric Courteau (ecourteau@cplus.fr)
francais.cat (translation of tutorials)
Jean-Pierre Demailly (Jean-Pierre.Demailly@ujf-grenoble.fr)
Updates for French translation
Radek Doulik (rodo@atrey.karlin.mff.cuni.cz)
TK interface, windowid patches
Martin Dozsa (madsoft@centrum.cz)
cs.po (Czech translation of menus)
Arpad Fekete (Fekete.Arpad.2@stud.u-szeged.hu)
some new fractals, and the 'More formulae' menu
Zelia Maria Horta Garcia (zeliagarcia@seed.pr.gov.br)
Brazilian/Portuguese translation
Tim Goodwin (tgoodwin@cygnus.co.uk)
english.cat corrections
Ben Hines
autoconf suggestions, Mac OS X port
Jan Hubicka (jh@ucw.cz)
Zooming routines, ugly interface, palettes, drivers, autopilot, filters, documentation, tutorials etc.
Jens Kilian (jjk@acm.org)
BeOS driver, deutsch.cat
Thomas A. K. Kjaer (takjaer@imv.aau.dk)
OS/2 ports (320x200 graphics and AA-lib)
Zoltan Kovacs (kovzol@math.u-szeged.hu)
Internationalization, Hungarian translations, finalizing version 3.1, bug fixes, web design, current maintainer
Zsigmond Kovacs (kovzsi@gmail.com)
Fractal examples
J.B. Langston III (jb-langston@austin.rr.com)
Native Mac OS X port (from version 3.2.2); web redesign; co-maintainer
Andreas Madritsch (amadritsch@datacomm.ch)
New fractal types, bailout, many fixes
Mateusz Malczak (xaos@malczak.info)
User formula evaluation library
Giorgio Marazzi (gmarazzi@vtr.net)
Improvements and fixes for espanhol.cat
Thomas Marsh (thomas.marsh2@gmail.com)
First zoomer, formulae, planes, X11 driver, inversions, many ideas
Dominic Mazzoni (dmazzoni@cs.cmu.edu)
Macintosh port (version 2.0)
David Meleedy
Grammatical and spelling fixed version of xaos.6
Paul Nasca (zynaddsubfx@yahoo.com)
Ministatus improvement
Nix (nix@esperi.demon.co.uk)
Grammatical and spelling fixed version of xaos.hlp and other files
Terje Pedersen (terjepe@login.eunet.no)
Amiga port
Cesar Perez (oroz@users.sourceforge.net)
Spanish translations
Fabrice Premel (premelfa@etu.utc.fr)
Periodicity checking
Jan Olderdissen (jan@olderdissen.com)
Win32 port
Ilinca Sitaru (ilinca.sitaru@gmail.com)
Romanian translation
Daniel Skarda
Fractal examples
Andrew Stone (Stone Design - www.stone.com)
Videator Support, Cocoa improvements, performance mode, bug fixes
Marton Torok (marton.torok@gmail.com)
Small fixes for pipes
Pavel Tzekov (paveltz@csoft.bg)
Win32 support
Charles Vidal
Tcl/Tk interface
Tapio K. Vocaldo (taps@rmx.com)
Macintosh port
Tormod Volden
Fixes for X11 driver to improve compatability with Xorg, XScreenSaver, Beryl and Compiz
Philippe Wautelet (p.wautelet@fractalzone.be)
Bug fixes for version 3.1.1, French translation, gcc 4.0 fixes
Sergio Zanchetta
Italian translation
Included Software XaoS uses the following libraries. These libraries may be included with some binary distributions of XaoS.

gettext 0.17
Website: http://www.gnu.org/software/gettext/
Copyright (C) 1995-1997, 2000-2007 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later (http://gnu.org/licenses/gpl.html)
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

GNU Scientific Library 1.11
Website: http://www.gnu.org/software/gsl/
Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 The GSL Team.
License GPLv3+: GNU GPL version 3 or later (http://gnu.org/licenses/gpl.html)
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

libpng 1.2.25
Website: http://www.libpng.org/pub/png/libpng.html
Copyright (c) 1998-2008 Glenn Randers-Pehrson
Copyright (c) 1996-1997 Andreas Dilger
Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %start Getting Started Basic controls
Learn the basic commands to control XaoS.

An introduction to fractals
Try this animated tutorial if you don't know what a fractal is. If you are new to XaoS you should try it too, since it is quite a good example of XaoS's features.

XaoS features overview
Watch this tutorial to discover more of XaoS's features.

Both the tutorials are divided into chapters and available from help menu, so you don't need to watch them all at once (they are about half an hour long).

XaoS Overview
A written introduction to all of XaoS's features. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %support Support XaoS is a community-supported free software project. Home Page Site: http://xaos.sourceforge.net

Check the Xaos home page for the latest news and information about XaoS and to download the latest versions. Users' Discussion Group Site: http://groups.google.com/group/xaos-users

The xaos-users discussion group on Google Groups provides a place for XaoS users to help each other get the most out of XaoS. XaoS developers also monitor this discussion and answer questions from time to time.

You can browse the archives freely but you must join the group in order to post. However, Google Groups provides a range of options for participation from a traditional mailing list to a completely web-based forum, so you don't have to get emails if you don't want to.

If you have a question or problem, please feel free to ask for help. We also encourage you to share examples (.xaf or .xpf files), hints and tips. If you have a gallery of images created using XaoS, feel free to post a link to the group. Developers' Discussion Group Site: http://groups.google.com/group/xaos-devel

The xaos-devel discussion group on Google Groups is where XaoS developers discuss and coordinate the further development of XaoS. XaoS users are welcome to monitor this forum as well, but general discussion and requests for help should be posted to the Users' Discussion Group instead. Issue Tracker Site: http://code.google.com/p/gnuxaos/issues/list

Issues are tracked on Google Code. If you think you have found a bug in XaoS or have an idea for a great new feature, please let us know about it. However, if you're not sure how to submit a useful issue report, please ask on the xaos-users discussion group first (see above).

Please don't submit duplicate issues. Search the existing ones first to make sure nobody has already reported it. You can add additional information about a bug by entering a comment on an existing bug. You can also express your interest in an issue by using the "Star" function on Google Code. This lets the developers know how many users are interested in an issue and also allows you receive status updates.

The developers will do their best to respond to issues in a timely manner. However, keep in mind that XaoS is developed on a volunteer basis and the developers work on it in their spare time. Therefore, we can't guarantee that issues will be addressed in a certain timeframe.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %devel Development XaoS is free software. One of the most significant rights its license grants to you is the right to freely get, study and improve its source code, which is available from the XaoS homepage.

XaoS has an open development model. All development is coordinated via Google Code at http://gnuxaos.googlecode.com/. Development versions are available via Subversion at https://sourceforge.net/scm/?type=svn&group_id=5771, so if you are interested in the future of XaoS, give the latest source a try! We also have a several discussion groups, which you can join if you want to discuss XaoS with others or participate in the development process.

If you want to do some development, you are encouraged to send your work back to the authors; if it is well done, it will be added to the next release. All changes should be submitted to the Google Code issue tracker.

XaoS is quite easily extensible. You might want to read a bit about its internals in the file doc/xaosdev.info. XaoS is also portable, so if it doesn't work on your favorite platform (or there is just an old version available), you could quite easily port it.

Volunteer Opportunities XaoS needs volunteers to make it the best fractal program it can be! You don't have to be a programmer to help. The following tasks open to volunteers:

Improving the documentation via the Wiki (and improving the DokuWiki converter).

Compiling binaries for your favorite operating system.

Reviewing the source code, adding comments, and checking lines which generate warnings during compilation.

Creating additional tutorials and examples.

Translating XaoS into your language.

Implementing feature requests.

Fixing outstanding bugs.

If you would like to volunteer, join the discussion groups and let us know. We would be happy to help you get started! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %sffe usrform usrformInit Using user formulas

XaoS supports entering your own custom formulas. Select User formula from the Fractal menu to define a custom fractal formula. Select User initialization to change the sequence starting point z0. By default z0 is set to 0. User formulas should be interpreted as functions in the form
Z(n+1) = formula (Z(n), Z(n-1), C).

In user formulas, as shown above, three variables are available:

z
current sequance point Z(n)
c
current plane 'point'
p
previous sequence point Z(n-1)

Format for complex numbers is {re;im}
eg. {3;2} is complex number 3+2i.

Available functions are listed below:

basic operations
+, -, *, /

basic trigonometry
sin, cos, tan, cot
asin, acos, atan, acot
sinh, cosh, tanh, coth

Exponential and logarithmic functions
exp
log - natural logarithm
log2, log10
logN (base, z) - logarithm of base N (where N is integer)
logCN (base, z) - logarithm of base CN (where CN is complex)

power functions
powi - power with integer exponent (fastest)
powd - power with real exponent
powdc - power with complex exponent
pow - same as powd
sqr - square

square functions
sqrt - square root of a complex number
rtni (z, n, i) - i-th root of n-th orgder

other functions
rand (max) - random real number in range [0, max)
inv - inverse
abs - absolute value
re - real part
im - imaginary part

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %video How to encode video files from XaoS

To create a video, make and xaf file first (the easiest way to do this is to use the record function in the file menu). Then you need to render the animation. XaoS can output sequences of ordinary PNG images, that can later be used by a video encoder.

Generating image sequences for video

To generate an image sequence, choose Render Animation from the Misc menu. You can also use the following command on the command line:

xaos -render [filename] -size 352x240 -antialiasing -renderframerate 24 -basename [basename]

File to render ([filename]) is the name of the xaf file, Basename ([basename]) is the name used as the base filename for rendered images. This should also include the path where you want to save the images. XaoS adds a four digit sequence number and .png extension to this name automatically.

You might also want to change the resolution. Make sure that the resolution you choose is supported by the video codec you wish to use.

The framerate can also be altered. Make sure you choose a framerate that is supported by the video codec you wish to use.

Antialiasing (-antialiasing) is used to produce anti-aliased images. It takes a much longer time and much more memory to calculate them, but resulting images are better for video compression and they result in a much smaller video file. (the same is true of JPEG images)

On the other hand, the other XaoS rendering option Always Recalculate (-alwaysrecalc) (which disables XaoS's zooming optimizations) is not recommended. If that's used, the sequence of animation then contains quite a lot of extra information, which increases size of video file, but because of the codec's lossy compression it is hard to see any difference, so it's not worth it. Rendered files Once you start it, XaoS will generate thousands of frames. They take quite a long time to calculate and save, and consume plenty of disk space. (e.g. to render part 1 of the tutorial you need about 60MB and half an hour of time).

All images are named [basename]framenum.png. For example intro0001.png is the first frame of the animation intro. If consecutive frames are the same, XaoS doesn't save them, so some frames may be missing. If your encoder can't handle that, you will need to write a simple script which will fill in the gaps by means of mv or symbolic linking.

A list of all filenames is saved into the file [basename].par, where each line is the name of one frame. The names repeat here if necessary, so you can use this file to supply filenames to the encoder. Encoding videos Once XaoS has generated the png files for each frame of the animation, you can use a third-party video encoder to convert the sequence of images into a video file. We currently recommend the following encoders, which support a wide variety of video codecs and file formats:

ffmpeg
Available from: http://ffmpeg.mplayerhq.hu/
Instructions: http://ffmpeg.mplayerhq.hu/faq.html#SEC12
mencoder
Part of mplayer, available from: http://www.mplayerhq.hu/
Instructions: http://www.mplayerhq.hu/DOCS/HTML/en/menc-feat-enc-images.html
These are both command line tools. If you prefer a graphical tool, you may prefer Quicktime Pro from Apple (http://www.apple.com/quicktime/pro/). However, this software costs approximately US$30, and the authors of XaoS have no experience with it. Although QuickTime may be easier to use, the two free encoders above are just as capable once you learn how to use them.

Note: we used to recommend Berkeley parallel MPEG encoder to encode the generated png files into MPEG videos. We have kept the instructions mainly for historic purposes. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %berkeley Berkeley parallel MPEG encoder This is the encoder we used to recommend. However, it has not been updated for a very long time and no longer appears to compile on modern systems. Also, there are much more modern codecs available that provide better video quality and compression rates. Still, we have kept the following instructions mainly for historic purposes.

It is available at Berkeley's FTP site mm-ftp.CS.Berkeley.EDU and called mpeg_encode1.5b

It has lots of options to tune, so you should spend quite a lot of time playing with this. The configuration I use is in file doc/mpeg.param.

I've also made some patches that makes possible to use the pattern and motion files generated from XaoS. The patch is in doc/mpeg_encode.patch. So if you want to use these features (they are EXPERIMENTAL) you might apply this patch and recompile the encoder.

Once you filled the mpeg.param file (see comments inside), you should render sequence using mpeg_encode [filename] and with luck you are done. Pattern file Some other files are generated as well. A pattern file is generated, which contains a recommended order of P, B and I frames.

MPEG sequence consist of these three frames. The I frames are just images saved in a format similar to JPEG files.

The P frames are images which are constructed as a delta from the previous one (the latest I or P frame). In case consecutive frames are similar (and in animations they often are), a P frame takes much less disk space than an I frame.

The B frames are constructed from the nearest previous P or I frame and the next P or I frame. They take even less disk space, but they are quite hard to encode. Also they are not used as previous frames, so their information is lost once they are displayed. They are usually rendered at lower quality than a P or I frame and used just to interpolate nearest frame and make animation smoother. It is generally not a good idea to make a whole sequence just from B frames.

Using just P frames is generally not a good idea. It makes the file shorter, but to jump into Nth frame of animation you need to recalculate all P and B frames since latest I frame. Decoders often want to jump to some frame (when the user asks, or when they can't decode a sequence in time and must skip some), so you need to have some I frames in the animation to make this possible. The latter reason means that you need to place them quite often. Usually they are used for every 15th frame or thereabouts. Because they cost quite a lot, in my animations I usually use every 27th frame. To set this distance use -iframedist option. It should be a multiple of 3.

XaoS generates a recommended order of frames based on its knowledge of fractal motion. Situations where the screen doesn't move at all are rendered just from P frames (since jumping is usually not required here); in situations where the screen changes completely (at least in XaoS's opinion) I frames are used and in other cases, a standard sequence IBBPBBPBBPBBP... is used.

If your encoder supports this, you should supply this pattern for encoding to squeeze out some bytes. Motion vector files XaoS also generates a motion vector recommendation for the encoder. This is useful for encoding of B and P frames.

If some objects on the screen are moving at a constant speed, motion vectors can store that speed, so no image needs to be saved to represent that change.

Calculating this motion vector is a very significant task. If you guess them well, you increase quality and reduce file size, which is always great. Calculation also takes lots of CPU and it is hard to get optimal vectors (it just takes too long).

XaoS knows how the fractals move, so it can calculate this vectors quite easily. XaoS saves this information into *.p and *.b files. (*.p are for P frames, *.b are for B frames). If your encoder supports this, you should provide this vector to increase quality. They are not exact (XaoS can make mistakes); the encoder should try to find its own vectors, then try XaoS's ones, and pick whichever is better.

This technique saves quite a lot of bytes in fast zooming/un-zooming animations (where images move more than 3 or 5 pixels per frame--since most programs look 10-20 pixels around each point for motion vectors).

To enable saving of motion vector files, add the option -rendervectors. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %controls Basic controls By default the mouse buttons work in the following way:

left
zoom in
right
zoom out
middle
move fractal in a drag-and-drop fashion

Note: Since most Macs only have one button mice, these controls are emulated on Mac OS X using modifier keys. See the help section on Mac OS X for details.

This behavior can change. If you enable rotation, the first button is used for rotating fractals. Also, in fast Julia mode, the first button is used to change the seed.

If you don't have a middle button, press both buttons to enable emulation.

After few minutes of zooming you will probably exceed the precision and the fractals will get boring. If you are getting strange big rectangles on the screen, you probably reached the numeric limit: there is no way to avoid this except un-zoom back and choose a different area. It doesn't hurt so much, since you have zoomed approximately 64 051 194 700 380 384 times, so there are quite a lot of areas to explore. Algorithms with unlimited precision exist, but they are still too slow for real-time zooming.

The other possibility is that you have reached the iteration limit. The fractal is calculated approximately, and in this case you need to increase number of iterations used for approximation (and decrease the speed in the process). This is done from the menu or using the arrow keys Left and Right.

An Up and Down keys should be used to change zooming speed. Note that higher speed costs more and image will be blocky.

This behavior can also change. With palette cycling enabled, Left and Right keys change cycling speed; in continuous rotation they change rotation speed.

All other functions are available from the menu, which (in the default configuration) are displayed when you move the mouse to the top of the screen/window. It is useful to learn the shortcut keys, which are shown in gray next to the menu items they trigger. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %writehelp How to write XaoS help files XaoS help is stored in the file help/xaos.hlp. It is divided into parts, each part being started by a keyword. In the help file keywords are written as %keyword

If you are writing documentation about some command in the XaoS function registry, use the same keyword as the name of the command in order to make context sensitive help work.

The help file is written in a special format called xshl. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %xshl xshl Xshl stands for XaoS simple hypertext language. It uses similar tags to HTML. It is simpler and more restrictive in order to make it easy to parse using various scripts. In C code you can use the library present in src/util/xshl.c to parse it.

The following tags are supported:

head
make headings (should be at the beginning of the page, at least)
emph
emphasize
tt
Use non proportional font
br
Break line
p
Next paragraph
dl
Definition list
dt
Definition tag (should be used only inside a definition list)
dd
Definition description (should be used only inside a definition list)
center
align to center
right
align to right
red
change color to red (should not be used in help files)
black
change color to black (should not be used in help files)
white
change color to white (should not be used in help files)
a name
link to other help page
tutor name
activate tutorial
notex
Ignore this in texinfo manuals
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %format XaoS's file format This section describes the format used by XaoS for animations, configuration files and saved positions. All these files have a common format, designed to be easily readable, to allow manual editing of files and easy conversion by other programs.

I also taken care to make it easily extensible for future versions of XaoS so I hope there will not be many incompatibilities between various XaoS versions.

The format is a simple set of commands executed sequentially. XaoS does not provide any variables/cycles as usual scripting languages do, but future extension to full-blown Scheme should be easy since the format uses Scheme-like syntax. The syntax of every command is:

(command_name [param1] [param2])

where parameters are optional and separated by whitespace (an arbitrary number of spaces, tabs and newlines). The parameters can have the following types:

integer
number w/o decimal point (123)
float
floating point number in decimal notation with optional exponent (1.23E2)
keyword
text started by quote '. It is used to pass various string constants like formula name ('mandel) Quote is required for scheme compatibility
string
Text inside double quotes. The only parameter that should contain whitespace
boolean
#t for true or #f for false

There is a complete description of all XaoS functions (with some examples) and an index of functions in the XaoS registry. You may particularly want to read about the animation functions. Also, the following functions are significant:

load
This function loads and interprets a file. It works similarly to #include in C.
initstate
Available in version 3.0 and above, this function resets XaoS's state to default values. This command should be at the beginning of each animation file, since otherwise some stuff previously enabled by user could cause unexpected effects. State is not reset by default before playing animations since it would make it impossible to write macros. Current versions don't really need macros, but in future versions, when the Scheme programming language will be available, this should be a much more interesting subject.
usleep
This function waits for a selected amount of time(in usec) before processing the next command. The screen is recalculated and displayed at the beginning of the sleep if necessary. The remaining time is spent by waiting, calculating if necessary, or performing any animation you entered via animation commands.
wait
Waits until the animation or image rendering is complete. Do not call this function when zoom, or continuous rotation is active otherwise deadlock happens. It is a good idea to call it immediately before text subtitles are displayed, since it looks ugly when they are displayed over a blocky unfinished fractal. Because the degree of blockiness at a given instant is a function of your machine speed, it may look nice for you but ugly for others with slower machines. Also you should call this after an animation is performed, before the switch to another fractal happens; since the switch involves calculation, the screen is stopped for a while and an unfinished fractal there looks ugly. You should also call it, when you want to do something as soon as possible.

Example:

;configure everything for the first frame
(inistate)
(palette 1 1163254293 0) ;custom palette
(cycling #t) ;enable cycling
(cyclingspeed 7)
(maxiter 276) ;higher number of iterations
(range 3) ;default range for solid guessing
(usleep 1000000) ;second frame starts here
(moveview -1.8101154154614007889 -8.2687205907162041209E-05)
;just move the image
(usleep 1000000) ;third frame
(morphview -1.8101154154614007889 -8.2687205907162041209E-05
6.277210971069452361E-10 6.2772109785334669875E-10)
;10 seconds of zooming into selected
rectangle
(usleep 100000000)

The best way to learn XaoS command language is probably to read position files and modify them. For example, to create zooming animation from the original file:

(initstate)
(defaultpalette 0)
(formula 'mandel)
(view -1.64128273713 -5.50393226816E-05 9.69332308848E-08
9.69332308834E-08)

Just change the view command to morphview, and add usleep:

(initstate)
(defaultpalette 0)
(formula 'mandel)
(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08
9.69332308834E-08)
(usleep 10000000)

The following code produces Julia morphing in the real axis:

(initstate)
(fastjulia #t)
(juliaseed -2 0)
(morphjulia 2 0)
(usleep 2000000)

And following is the ``rotozooming'' animation:

(initstate)
(fastrotate #t)
(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08
9.69332308834E-08)
(morphangle 300)
(usleep 10000000)
(wait)
(fastrotate #f)

XaoS gallery I plan to make a gallery of animations and position files on the XaoS home-page, so please send any nice animations and images you created using XaoS to the mailing list or upload them to our website. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %drivers Platform-specific documentation XaoS is portable and works on many different platforms. Since not all platforms are exactly the same, there are some differences between the behavior of XaoS on different platforms. Here is documentation about each specific port.

X11 driver

Mac OS X driver

Win32 driver

DirectX windowed driver

DirectX fullscreen driver

AA-lib driver

MS-DOS driver

GGI driver

plan9 driver

SVGAlib driver

DGA driver

BeOS drivers (BeOS, DirectWindow, WindowScreen)

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %cocoa Mac OS X port XaoS has full support for Mac OS X including native menus, dialogs, help, Finder integration, drag and drop, and basic AppleScript support.

The Mac OS X port of XaoS strives to provide a Mac-like experience, while retaining compatibility with other platforms. Some Mac-specific details are outlined below. Zooming Since most Macs have one button mice, the middle and right buttons are emulated with modifier keys. This means there are multiple ways to perform basic zooming operations:

Zoom in
Hold down the main mouse button.
Zoom out
1. Hold down the Ctrl key while pressing the main mouse button.
2. Use the right mouse button if you have one.
3. On laptops with gestures enabled, place two fingers on your trackpad and press the main mouse button.
Pan
1. Hold down the Shift key while dragging with the main mouse button.
2. Drag with the center button if you have one.
3. Use the scroll wheel or ball if you have one to pan up/down and left/right.
4. On laptops with gestures enabled, swipe two fingers across the trackpad to pan horizontally or vertically.
Keyboard Shortcuts XaoS menu functions have been mapped to commonly used Mac keyboard shortcuts. For example, Open is Cmd-O and Undo is Cmd-Z, just as you would expect.

However, XaoS also has its own long-standing tradition of cross-platform keyboard shortcuts. These keyboard shortcuts are also displayed in the menus inside parentheses. For example, the menu item "Autopilot (a)" means that you can press a (with no modifier keys) to activate Autopilot. All of these traditional XaoS shortcuts do not use modifier keys, so they do not conflict with any standard Mac OS X shortcuts.

In some cases, the same function may be performed with both a traditional XaoS shortcut and a Mac OS X-specific shortcut. You can choose whichever one is more comfortable for you. Full Screen Mode The Mac OS X port supports a full screen mode. To enter it, select Mac OS X Full Screen Driver from the UI -> Driver submenu. Once you enter full screen mode, the menu bar will automatically hide. To access the menu bar, move your mouse to the top of the screen and the menu bar will slide into view. When you move your mouse away, it will automatically disappear again. To return to windowed mode, select Mac OS X Windowed Driver from the UI -> Driver submenu. Videator Support XaoS for Mac OS X can send a live video stream to Stone Design's Videator (http://stone.com/Videator/), which can then do post-processing using Mac OS X's core video technology. This combination creates mind-blowing visuals that are great for VJing (live video performance art).

To turn on output to Videator, select Videator Output from the UI menu. See http://stone.com/Videator/VJ.html for more details on how using Videator with XaoS. Known Issues

Catseye fractal does not render properly.
Workaround: Set the bailout to just over 4 (e.g., 4.000000001). After changing this setting, the fractal renders as expected.

The Mac OS X driver was written by J.B. Langston, 2006-2008. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %aa AA-lib driver The AA driver is currently the most advanced and portable driver for XaoS. It is based on AAlib--a high quality ASCII-art library developed by the AA-project. (see http://aa-project.sf.net)

It is a fully featured XaoS driver for text mode displays. It supports 256 colors and the mouse where possible.

It also has some extended features available from the UI menu:

Attributes
AA-lib may use character attributes to improve image quality. By default it uses normal, dim and bold characters where possible, but you can also enable different attributes like reversed or bold font characters. You may also enable usage of non ansii/reversed characters if your device supports it.
Font
AA-lib uses a bitmap image of the font to prepare the approximation table used for ASCII art rendering. This bitmap is expected to be same as the one used by your device. AAlib performs detection where possible however some devices (like UNIX text terminals or MDA) do not support this. AAlib has few font images compiled in, so in this case you should try to use one of them to achieve best results.
Inversion
Some devices use inverse video: use this to get correct results on such devices.
Dithering mode
Dithering is an way to get more exact color in approximations, by combining more characters; but this method can produce ugly looking noise on certain images. Use this menu to disable or tune it.
Palette options
By default AA driver uses the XaoS palette to render images, but it quite often looks ugly on text displays. Here you can choose a special text palette instead. Note that with filters enabled, the results may be rather ugly. This function is available from the palette menu.
Save text screen
The normal save function will generate a PNG image instead of nice ASCII-art. To save ASCII art use this function instead. It supports many text file formats like HTML, ANSI, more, etc... It will also ask you for font and attributes(see above). It is available from the file menu.

The AA-lib driver also provides the full set of standard AA-lib's command line options. You may use them to tune parameters like gamma correction, and so on. See xaos -help or the AA-lib documentation for details.

The AA driver was written by Jan Hubicka, 1997. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %dos DOS driver This is a fully featured driver for DJGPP and allegro. It supports many VGA modes, VESA 1.0--3.0, VBE/AF, S3 and some other cards.

The following problems may occur:

Some DPMI servers may cause problems
Some DPMI servers like the one from Novell/Dr/Open DOS are buggy. Use clean DOS instead and XaoS will automatically start cwsdpmi. Under Open Dr DOS use dpmi off at command line to disable it.
Higher resolutions don't work
If your videocard has enough memory for the selected resolution, you most probably have an unsupported videocard. Please use a VESA BIOS extension on this videocard. (See the note about VESA at the end of this section.)
XaoS needs a coprocessor
I don't distribute a coprocessor library linked into XaoS because it is too slow for a real-time zoomer. Coprocessor emulation will not help, because xaos works in protected mode.
XaoS needs mouse driver to be usable
XaoS works slowly in higher resolution
This could also be caused by Allegro's slow driver or your videocard's VESA BIOS. You could try some other VESA BIOS extension instead. Look at the http://www.talula.demon.co.uk for the FreeBE project or Scitech Display Doctor package. (See the note about VESA at the end of this section.)
VESA VESA is a standard for using higher resolutions in DOS. Many videocards have VESA support in the BIOS so you don't need any additional software, while others need support from a special program. Also some VESA BIOS implementations are buggy or suboptimal; there are 3 different versions, version 1.0 is many times slower than 2.0, which has support for protected mode and linear framebuffers. So if you have problems with higher resolutions, or some graphics modes are not available (like 320x200 truecolor), you might try some software package which emulates VESA.

The most famous VESA emulating program is Scitech Display Doctor. It has support for many videocards and is quite reliable. It's disadvantage is that it is shareware and works for only 30 days. You might also look on ftp.simtel.net, where there are many VESA emulation packages such as s3vbe or the new FreeBe project at http://www.talula.demon.co.uk

DOS driver was written by Jan Hubicka, 1997. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %ggi GGI driver GGI stands for General Graphics Interface. Part of this project is to develop libggi, a portable graphics library, and XaoS's GGI driver uses that. It is experimental, since the API of libggi is not stabilized yet. There are some problems with keyboard handling--the shift key doesn't work yet.

Everything else might work well, but there are no guarantees. It is alpha quality software.

GGI driver was written by Jan Hubicka, 1998. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %plan9 Plan9 driver Plan9 is a very nice small operating system by the authors of Unix at Bell Labs. It is very incompatible with other operating systems; even the C compiler and header files are different, but XaoS should work well there (even on the limited free demo installation without any POSIX compatibility stuff)

There are a few limitations: the file selector and image saving don't work. You can save position files and then later render them on the other OS, or save screenshots.

Plan9 terminals also don't provide any way to catch the arrow keys, so you can't use them. Use the mouse to navigate in the menus. Also, getting the screen resolution is impossible, so use -pixelwidth and -pixelheight instead of -screenwidth and -screenheight.

By default XaoS changes the colormap. This will collide with other colorful programs like Mortha. You can disable this behavior using -nopalette switch, but this will slow down XaoS.

Plan9 driver was written by Jan Hubicka, 1997. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %SVGAlib SVGAlib driver This is a driver for Linux SVGAlib. I really like this driver, because I much prefer full screen zooming instead of a small 320x320 window in X11. It was one of the first drivers for XaoS and is fully featured. The following problems can occur:

XaoS doesn't initialize graphics mode
when started under users other than root SVGAlib requires root privileges to directly access the hardware. When you really want to start XaoS as a normal user, enable the suid bit (chmod +s) at XaoS executable. note that I take care to disable all security holes caused by this bit so I believe it is safe.
Mouse doesn't work
Screen is blank at higher resolutions
Both this problems are probably caused by misconfiguration of SVGAlib. Please configure it in etc/vga/libvga.cong or /usr/local/lib/libvga.conf GPM can also cause problems. Try to kill it before starting XaoS.
When I switch console I can't switch back
This is another typical SVGAlib bug. Try to hold F key longer than alt. It helps on my computer. On older SVGAlib there was a famous ``enter bug'' that caused a crash after pressing enter. Try to update to a newer release.

SVGAlib driver was written by Jan Hubicka, 1997. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %win32 Win32 driver This is a driver for Windows 9x and NT. It is new since version 3.1 and because of some oddities of Windows API it may be rather unstable. Please report all bugs. In case of problems you could use the DOS version of XaoS instead.

The driver should work in all bit depths, but 16 color mode is not natively supported by the XaoS engine. XaoS internally works in 32k colors and the result is converted to 16 colors by Windows. Because Windows conversion routines are slow and ugly, the result is slow and ugly. Please configure your display to another bit depth to ``solve'' this problem.

Use -size WIDTHxHEIGHT command line option to change the default window size.

This driver also maps to native Windows look and feel. There is a small problem with combo boxes in dialogs. They are expected to give you a choice between a few strings. The keyboard controls (changing choice by arrow keys) work, but mouse selection is broken. If you know how to solve this bug, please let me know.

XaoS is a UNIX application and has many command line options. Some features are not available from the GUI. Because Windows applications can't have normal output, most of the critical messages are displayed in message boxes, but some longer messages are omitted. The most significant omission is the help about command line options that you can find in doc/cmdopts.txt.

One thing that might be confusing is that animation rendering mode doesn't display anything, but only renders images. Start the rendering, and a message box will inform you that XaoS is entering the calculation loop. Relax and wait for the message box signaling the end of the loop.

Note that XaoS also supports the DirectX API.

Win32 driver was written by Jan Hubicka, Jan Olderdissen and Pavel Tzekov, 1999. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %dX-window DirectX windowed driver This is a driver for Windows 9x and NT. It is new since version 3.1 and because of some oddities of Windows API and kludges in DirectX it may be rather unstable. Please report all bugs. In case of problems you could use the DOS version of XaoS instead.

The DirectX driver is an alternative to the windowed win32 driver. If you have DirectX installed, this driver is used by default. It has almost the same behaviour as the win32 driver so please read its documentation for more details. The only difference should be the display speed.

The driver supports only hicolor and truecolor modes. There is no support for 256 and 16 color modes because of palette collision problems. The win32 driver will be used in these cases by default, so this should cause no problems.

If you are experiencing problems with this driver, you might want to use the win32 driver by default; to do this, use the -driver win32 command line option.

DirectX driver was written by Jan Hubicka, Jan Olderdissen and Pavel Tzekov, 1999. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %dX-fullscreen DirectX fullscreen driver This is da river for Windows 9x and NT. It is new since version 3.1 and because of some oddities of Windows API and kludges in DirectX it may be rather unstable. Please report all bugs. In case of problems you could use the DOS version of XaoS instead.

This driver allows the Windows port of XaoS to run in full screen mode. The driver supports 256, 65536 and 16777216 color modes (24bpp and 32bpp) in all resolutions supported by DirectX. You can change graphics mode by pressing the = key (or by using the UI/Resize menu). If the selected mode is not supported, the driver will restore the previous setting.

Use the -mode WIDTHxHEIGHTxDEPTH (like -mode 640x480x16) command line option to change graphics mode.

If you want to start XaoS in DirectX, use the -driver dX-fullscreen option.

See the Win32 driver documentation for some more Windows releated information.

DirectX driver was written by Jan Hubicka, Jan Olderdissen and Pavel Tzekov, 1999. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %BeOS DirectWindow WindowScreen BeOS support XaoS has pretty advanced support for BeOS R4. It works on both PowerPC and Intel platforms, supports multithreading, the clipboard, file dragging, has native look and feel and can work as an image translator from XaoS files to images.

The first version of the BeOS driver was written by Jens Kilian and later extended by Jan Hubicka.

Installation

You can start the installation script to do everything for you. If you want something special, read this section.

In order for XaoS to work you need to keep the executable together with its data files (help, examples, catalogs and the tutorials directory)

When first started, XaoS registers two new mime types called image/x-xaos-position for XaoS Position Files and video/x-xaos-animation for XaoS Animation Files, registers icons for them and sets itself as default application.

Available display drivers

XaoS supports following drivers:

BeOS
Standard windowed driver using application server
DirectWindow
Driver done using Game Kit's direct window class
WindowScreen
Fullscreen driver.

By default, XaoS starts in windowed mode and uses the application server for output. You could change the driver to DirectWindow to use direct access to video RAM. Note that this mode is slower in most cases, and not supported by some videocards.

The BeOS driver by default chooses the most similar bitmap supported by XaoS to achieve best and fastest results. In the UI menu you can change this default choice to another one if you wish. Also you can ask the BeOS and DirectWindow to resize to fullscreen mode.

XaoS also supports real fullscreen mode using the BWindowScreen API. To switch XaoS to this driver, use the UI menu. If you want to use this mode by default, use the -driver WindowScreen command line option.

This driver differs a lot from windowed ones. It use direct access to the video card, allowing you to change video mode. Also, the 256 color mode can access the palette, so it is not dithered like the windowed mode. Because BeOS can't do GUI in fullscreen mode, XaoS uses its own toolkit. I hope you will feel confortable in it.

XaoS as translator

You should be able to open XaoS files in graphics applications such as ShowImage or ArtPaing. In Preferences you can find the DataTranslations program, that can be used to set the size, type and DPI of the resulting image. Also antialiasing can be enabled.

Note that translation can take a while. So be patient and wait for the result.

If the translator doesn't work, ensure that you have a link to the XaoS executable in /boot/beos/system/add-ons/Translators/. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %X11 X11 driver This was the first driver done for XaoS. It supports many visuals, shared colormaps and MitSHM extension.

Bugs/limitations:

XaoS makes some X servers too busy
Sometimes XaoS generates images faster than X can display them. In this case XaoS responds poorly to the mouse, and other applications slow down too. This happens especially often on old R4 servers. Use -sync to avoid this problem. Note that -sync does not make all communication with X asynchronous; it just adds one additional XSync call. So the slowdown is not as large as you might expect.
Does not work on all visuals
This driver supports only 8bpp pseudocolor/grayscales, 15,16,24 and 32bpp truecolor, 1bpp and 8bpp staticolor visuals.
Palette rotating does not work for 8bpp pseudocolor w/o private palette

X11 driver was written by Jan Hubicka and Thomas Marsh, 1997. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %DGA DGA driver This is the driver for DGA (Direct Graphics Architecture) extension used by XFree86 X servers. It is pretty new so it could be buggy.

Bugs/limitations:

In 8bpp mode, XaoS has problems with the palette with certain window managers
I don't know why this happens. Just let me know what's wrong, or use another window manager.
Banked modes are not supported.
I don't have any card to test this with, so it doesn't work in the current version.

DGA driver was written by Jan Hubicka, 1999. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %tutorial XaoS tutorial This is a brief introduction to the basic XaoS features. How to zoom The main advantage of XaoS is that after a few seconds' delay to calculate the first image, you may choose any point with the mouse and press the left button. The image will start to zoom smoothly into the point you choose. You may move the mouse and zoom smoothly into interesting areas. By pressing the middle button (or left+right buttons) you may also move the image using ``drag & drop'' if you missed an interesting place. Unzooming is also possible by using the right button, but it is much slower because optimizations are not so effective as for zooming.

In case you think that the default speed is boring (it is quite slow, to make XaoS smooth on a slow computer) you may change it by pressing arrow up/down. But faster zooming is more expensive, so if the speed is too high you will see little but funny colorful blinking rectangles. Autopilot To make XaoS yet more impressive we made a special autopilot that automatically drives into interesting boundaries of the set. So you can press A, play your favorite music, drink coffee and relax. I never tried this but it should be really relaxing! Many pictures in the XaoS gallery were discovered using the autopilot.

The autopilot also has some additional features. It turns back when the zoomed picture stops being interesting, and is able to spot when it's zoomed into a really boring part (or has reached the limit of floating point numbers) and restart zooming from the top.

Various fractal formulae XaoS also supports formulae other than the Mandelbrot set. You may change formula using the number keys or SHIFT+letters.

On keys 1 to 5 are Mandelbrot sets of various power. The ``normal'' Mandelbrot set is on key 1.

On key 6 is a fractal called Newton. It is Newton's famous formula for finding roots.

On key 7 is the fourth ordered Newton fractal.

On key 8 is a fractal called Barnsley.

On key 9 is Barnsley's second fractal.

On key 0 is Barnsley's third fractal.

With keys SHIFT-A you can display a fractal called octo. It is a fractal that Thomas discovered in fractint.

With keys SHIFT-B you can display a fractal called Phoenix. It is a very nice and quite famous fractal.

With keys SHIFT-C you can display a fractal called Magnet. This fractal has quite a complex formula so it is a bit slow.

With keys SHIFT-D you can display the Magnet2 fractal.

The rest of the built-in fractals are accessible through an other menu, but you can still use the hotkeys.

On SHIFT-E is a fractal called Triceratops found by Arpad.

On SHIFT-F is a fractal called Catseye found by Arpad. This is more interesting if you change the bailout value.

On SHIFT-G is a fractal called Mandelbar. It was in Gnofract4d, and they found it at: http://mathworld.wolfram.com/MandelbarSet.html

On SHIFT-H is the Lambda fractal.

On SHIFT-I and SHIFT-J are the Manowar and Spider fractals, they were found by users of fractint. (Scott Taylor or Lee Skinner) It was on http://spanky.triumf.ca/www/fractint/ taylor_skinner_type.html

The next 3 fractals are famous classic fractals.

On SHIFT-K is the Sierpinski Gasket. You can change its shape by selecting another Julia seed. (This is for technical reasons.)

On SHIFT-L is the Sierpinski Carpet. It's shape can also be changed by selecting another Julia seed.

On SHIFT-M is the Koch Snowflake.

Out-coloring modes To make fractals yet more interesting, more coloring modes for points outside the set are provided. ``Classical coloring mode'' uses the number of iterations that the orbit required to escape to (nearly) infinity. You can change this mode from the Fractal menu or by pressing key C To see more about coloring modes, try the tutorial on Incoloring modes from the XaoS features overview.

Those cryptic names for coloring modes are mathematical formulae, where iter means number of iterations, real means real coordinate of last orbit, and imag means imaginary coordinate of last orbit.

In-coloring mode In-coloring mode is similar to out-coloring, except that it changes how things inside the set are displayed. This can also be changed from the fractal menu or by pressing F.

You might also want to see the tutorial on Out-coloring modes from the XaoS features overview. Planes All fractals displayed by XaoS are functions with a complex parameter. It can be displayed in the normal complex plane, where x is the real part of the number, and y is the imaginary part; but it can also be displayed in a number of other planes. You can select the plane to use from the Fractal menu, or by pressing I.

Like the coloring modes, planes have cryptic names. You guessed it, they're mathematical formulae. Here mu means coordinates in the normal complex plane. If you have coordinates in 1/mu plane, and you need coordinates in the a complex plane (to calculate the Mandelbrot set) you simply use the coordinates as mu. Lambda is another plane that can be converted to mu using a similar formula.

mu
normal mode.
1/mu
Inversion: infinity goes to 0 and 0 goes to infinity.
1/(mu+0.25)
Similar to inversion, but moves the center outside of the Mandelbrot set so that it looks parabolic.
lambda
Lambda plane.
1/lambda
Inversion of lambda plane.
1/lambda-1
Inversion with moved center.
1/(mu-1.40115)
A very interesting mode for the Mandelbrot set. It makes small things big, so you can browse the set's details easily.

Mandelbrot/Julia switching Most of the fractals displayed by XaoS (currently all of them) have two forms: Mandelbrot and Julia. Every point in a Mandelbrot set has its own Julia set. To see more about this correspondence, try the tutorial on Julia set from the Introduction to fractals.

In the Mandelbrot mode, you can get a corresponding Julia by moving the mouse to an interesting point and pressing M. To get back press M again. Some fractals (Barnsley and phoenix) are already in their Julia versions, because the Mandelbrot ones are boring. But by pressing M in such fractal you should get the Mandelbrot version, and by choosing another point as the base point and pressing M again you should get a completely different fractal. The most interesting points for Julia sets are at the boundaries of the Mandelbrot set. Most of the Julias inside or outside the set are boring.

Fast Julia preview mode Fast Julia mode is a quick way to find a point to use as a base for the Julia set.. Just press J and a small Julia set will be displayed in the top left corner. Then move the mouse around with button 1 depressed, and the Julia for the point the mouse is over will be automatically generated. Palette If you think that the default XaoS colors are ugly or you are just bored by them you can change it by pressing P. XaoS will automatically generate random palettes. Many of them look ugly, so press P again to get another one until you find one you like.

Filters Many interesting effects are done by post-calculation filters. XaoS has filters that do everything from embossing, through motion-blurring, right through to turning the fractal into a stereogram. To enable them use the filter menu or press E.

Palette cycling This is a very old trick that makes the Mandelbrot set a little flashier. You may enable or disable it using Y. In the truecolor modes you need to enable the palette emulator filter first. This is done via the E key, or from the filter menu.

Changing number of iterations To calculate fractals perfectly, you need an infinite number of iterations. XaoS does just the first few of them, so after lots of zooming you may get into a place that looks quite boring, and the boundaries of the set are rounded, without any interesting details. This can be changed by changing the number of iterations:

Press and hold arrow right and wait until iterations are high enough. This may slow down calculation much. To reduce number of iterations press arrow left. Changing resolution XaoS usually starts in a low resolution (320x200 or thereabouts) to make calculations faster. If you have a fast computer or you need to save bigger .gif images, you may change the resolution. This can be done by pressing = in the full screen drivers, or simply by resizing the XaoS window. Changing driver XaoS usually has more than one driver available. You may change it on the fly in case you want a different one. For example, XaoS started in X11 can be switched at runtime to use the AA driver. This can be done from the UI menu.

This action is bit dangerous, because XaoS can crash during initialization if there is some problem with initialization; XaoS tries to initialize a new driver, and if it fails it attempts to return back to the original. Sometimes this is impossible, and all XaoS can do is terminate.. Other features XaoS has many other features, but they don't fit into this tutorial. Most of them are available from the menu, so you can experiment with them. You might also want to see the animated tutorials from the help menu, to have an idea what XaoS can do. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %menus

Menus, functions and command line parameters
All XaoS functions are referenced by a central function registry. The scripting language, menus, dialogs and command line options are built from this database. This section contains information about all functions available in this registry.

Root menu

Animation root menu

Replay only commands %end

Line drawing functions

Animation functions

Timing functions

File

Edit

Fractal

Calculation

Filters

UI

Misc

Help

Horizontal text position

Vertical text position

Formulae

Palette

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %root Root menu This menu is usually displayed at the top of the screen or window. It contains all currently available submenus. During animation another menu is displayed--the Animation root menu.

File

Fractal

Calculation

Filters

UI

Misc

Help

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %animroot Animation root menu This menu is displayed at the top of the screen when animation replay is active.

File

Stop replay

Help

UI

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %stopreplay Stop replay Terminate animation replay.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %plc Replay only commands Some commands, such as timing primitives or animation functions, are available only in animation files.

Line drawing functions

Animation functions

Timing functions

Include file

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %load Include file

Syntax:(load file)

This function lets you include another file in your script. It works similarly to #include in C or load in Scheme. The file is searched for in the same directory as the current source file.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %linemenu Line drawing functions XaoS has support for drawing lines. These functions are available only in animations and could be used to show some parts of fractals or draw simple diagrams. See the tutorial ``Introduction to fractals'' for examples of this feature.

Lines can be drawn in screen coordinates, where 0,0 is the top left corner and 1,1 is bottom right, scaled coordinates, which are similar, but scaled to keep 0,0--1,1 rectangular, or Fractal coordinates, to draw a line at an exact position on the screen.

The color of the line should be specified by the color command. You might draw an arbitrary number of lines and, later, morph them. Each line is identified by a unique numeric key; the current key can be set using linekey. Commands for changing lines operate on the line with the current key. (Lines drawn in sequence have consecutive numbers.)

For example:

(color 'red)
(line 'scaled 0.3 0.5 0.7 0.5)
(line 'scaled 0.3 0.5 0.7 0.5)
(line 'scaled 0.3 0.5 0.3 0.5)
(line 'scaled 0.7 0.5 0.7 0.5)
(linekey 0)
(morphline 'scaled 0.3 0.3 0.7 0.3)
(morphline 'scaled 0.3 0.7 0.7 0.7)
(morphline 'scaled 0.3 0.3 0.3 0.7)
(morphline 'scaled 0.7 0.3 0.7 0.7)
(usleep 1000000)

Creates line morphing to rectangle.

Draw line

Morph line

Morph last line

Set line key

Clear line

Clear all lines

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %line Draw line

Syntax:(line keyword complex complex)

Draw line between two points. keyword specifies type of coordinates and should be one of the following: `fractal, `screen or `scaled. This function also increases the line key.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %morphline Morph line

Syntax:(morphline keyword complex complex)

Morph current line to given coordinates. keyword specifies type of coordinates and should be one of the following: `fractal, `screen or `scaled. The line will start moving at the next timing command, and reach the final position before the end of it. This function also increases the line key.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %morphlastline Morph last line

Syntax:(morphlastline keyword complex complex)

This function has the same functionality as morphline, but it doesn't increase the line key, and touches the line with the previous key. This is useful when you want to move a just-drawn line--you don't need to set linekey back.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %linekey Set line key

Syntax:(linekey integer)

Set current line key.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %clearline Clear line

Syntax:(clearline)

Clear current line. This function also increases the line key.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %clearlines Clear all lines

Syntax:(clearlines)

Clear all displayed lines. Lines can also be cleared using the clearscreen or display commands available from the Misc menu.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %animf Animation functions These functions are used to animate fractal state--to zoom, unzoom and morph various parameters. They should be used only in animation files. Animations are usually performed for a time selected by an immediately following timing function. For example:

(view 0 0 1 1)
(morphview 0 0 2 2)
(usleep 5000000)

Will do a 5 second long unzooming animation.

Animate view

Smooth morphing

Morph view

Morph julia

Move view

Morph angle

Zooming functions

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %animateview Animate view

Syntax:(animateview float float float float)

This function is almost identical to function view. It expects that the view will be changed only slightly, so recalculation is done with ANIMATE priority. This means that dynamic resolution is used by default.

Viewport is selected by the center and two radiuses (real and imaginary). See view for more information.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %smoothmorph Smooth Morphing

Syntax:(morphview keystring starttime endtime) This function lets you smoothly start and stop morphing. Specify starttime and stoptime as nonzero, and morphing will speed up and slow down for that number of usecs.

The keystring is used to select what morphing you want to control. It is one of the following:

'view
control morphview
'angle
control morphangle
'julia
control morphjulia
'line
control morphline
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %morphview Morph view

Syntax:(morphview float float float float) For the time selected by the next usleep or other timing function, the viewpoint is smoothly morphed from the current one to that selected by morphview.

Viewport is selected by the center and two radiuses (real and imaginary). See view for more information.

This function can easily be used for creating zooming/unzooming animations using position files. This is an example position file generated by XaoS:

(initstate)
(defaultpalette 0)
(formula 'mandel)
(view -1.64128273713 -5.50393226816E-05 9.69332308848E-08 9.69332308834E-08)

By replacing the view command with morphview and adding usleep you can create a zooming animation:

(initstate)
(defaultpalette 0)
(formula 'mandel)
(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08 9.69332308834E-08)
(usleep 10000000)

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %morphjulia Morph Julia

Syntax:(morphjulia complex) For the time selected by the next usleep or other timing function, the Julia seed is smoothly interpolated from the current one to that selected by morphjulia. By default this will cause recalculation of the whole screen. To avoid this, use fast Julia mode.

A simple animation morphing Julia seed in the X axis:

(initstate)
(fastjulia #t)
(juliaseed -2 0)
(morphjulia 2 0)
(usleep 2000000)

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %moveview Move view

Syntax:(moveview complex) Smoothly move the image center to another position.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %morphangle Morph angle

Syntax:(morphangle float) Smoothly rotate the image to another angle. By default rotation causes recalculation of the whole screen. To avoid this you need to enable fast rotate mode. Don't forget to disable it later, since it slows down other animations.

A simple ``rotozooming'' animation:

(initstate)
(fastrotate #t)
(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08
9.69332308834E-08)
(morphangle 300)
(usleep 10000000)
(wait)
(fastrotate #f)

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %zoom zoom unzoom stop Zooming functions

The functions for zooming/unzooming were created mainly for recording animations. In manually created animation files, it is easier to use morphview.

Syntax:(zoomcenter complex) This function sets the center to zoom in on. The center is given as a position in fractal coordinates.

Available as: command

Syntax:(zoom) Start zooming to the area specified by zoomcenter.

The speed of zooming should be controlled by the function speed or in a more exact way by maxstep and speedup.

Syntax:(unzoom)

Start unzooming from the area specified by zoomcenter.

Available as: command

Syntax:(stop) Stop zooming or unzooming.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %time Timing functions Timing functions are used to control the animation replay daemon. It can wait for a given time, or wait until calculation is complete. The animation functions are controlled by such waiting; animations that are running while delays start keep running through the delay.

Usleep

Wait for text

Wait for complete image

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %usleep Usleep

Syntax:(usleep integer)

This function waits for a given amount of time (in usec) before processing the next command. The screen is recalculated and displayed at the beginning of usleep if necessary necessary. The remaining time is spent in waiting or performing animation.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %textsleep Wait for text

Syntax:(textsleep)

This function's behavior is very similar to usleep, but the time is calculated from the number of letters currently displayed onscreen. If you want to wait just long enough for the user to read the subtitle, use this function. The user can alter the replay speed as desired using letterspersec. This value can be changed during replay with the arrow keys.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %wait Wait for complete image

Syntax:(wait)

Wait until the image is complete. You should always use this function after zooming or unzooming when dynamic resolution is in use. This ensures that the image calculation will be complete so the user can see the result before the animation continues. It may also be useful in combination with filters like motion blur.

This function deadlocks if used with animation functions; don't do that.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %file File

Load

Save

Record

Replay

Save image

Load random example

Save configuration

Quit

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %loadpos Load XaoS position file

Load a XaoS position file (*.xpf). See the format description for more information.

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %savepos Save XaoS position file

Syntax:(savepos file)

Save current state to a XaoS position file (*.xpf). This file is human-readable, and can easily be improved by hand after saving, or used as a base for animations. See the format description for more information.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %record Record animation

Syntax:(record bool [ file ])

e Toggle recording to a XaoS animation file (*.xaf). This file is human-readable, and can easily be improved by hand after recording. See the format description for more information.

From the scripting language, (record #t) enables recording, and (record #f) disables it.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %play Replay animation

Replay a XaoS animation file (.xaf).

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %saveimg Save image

Syntax:(saveimg file)

Save current state to an image file. This file is in .png (portable network graphics) format, which can be read by many applications varying from graphics programs all the way to Web browsers.

This function needs an external library called libpng. If the library wasn't available during compilation, this function is unavailable too. Please see INSTALL for more information about obtaining libpng and recompiling XaoS.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %loadexample Load random example

Syntax:(loadexample)

Choose random .xpf file from the examples directory and load it. You might use it as the starting point for next exploration.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %savecfg Save configuration

Syntax:(savecfg)

Save current configuration to ~/.xaosrc (under Unix) or xaos.cfg (under DOS and Windows). XaoS automatically reloads the configuration from this file when it starts.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %quit quitmenu noquit Quit

Syntax:(quit)

Quit XaoS.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %edit Edit A fairly ordinary Edit menu.

Undo

Redo

Copy

Paste

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %undo Undo Undo last operation. `Last operation' is quite hard to define in XaoS (where changes are continuous), so it might be surprising. I hope it will do what you want.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %redo Redo Redo last undone operation. See undo.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %copy Copy Copy fractal to clipboard. This is a platform-dependent operation that may not have an analogue on your platform (e.g. there is no concept of a clipboard under aalib).

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %paste Paste Paste fractal from clipboard. This is a platform-dependent operation that may not have an analogue on your platform (e.g. there is no concept of a clipboard under aalib).

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %fractal Fractal This menu contains all functions related to fractal parameters and display; you can change things like the formula used, coloring modes, seeds and much else.

Formula

formulae

Incoloring mode

Outcoloring mode

Plane

Palette

Mandelbrot mode

Perturbation

View

Reset to defaults

True-color coloring modes

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %formula Formula

Syntax:(formula keyword)

Set the current fractal formula. keyword should be one of the following:

'mandel
Standard Mandelbrot set.
'mandel3
Mandelbrot set, power 3.
'mandel4
Mandelbrot set, power 4.
'mandel5
Mandelbrot set, power 5.
'mandel6
Mandelbrot set, power 6.
'newton
Newton's approximation method.
'barnsley
First Barnsley's formula.
'octo
Fractint's octo.
'phoenix
Phoenix.
'magnet
Magnet.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %uimandelbrot julia juliaseed Mandelbrot/Julia mode

Most fractals rendered by XaoS can be represented as Mandelbrot sets or Julias. Each point in the Mandelbrot set has its own Julia set. To learn more about this correspondence, see the tutorial on the Julia set.

This function switches between Mandelbrot and Julia representations. When switching to Julia, you need to set the seed--a point selected from the Mandelbrot set.

If you run this function from the menu, you are prompted for the Julia seed as a number. Often, this can be clumsy, and it would be easier to specify a point with the mouse pointer. If you hit the M key instead of using the menu, the current mouse position is used.

Good seedpoints lie at the boundaries of the Mandelbrot set; other seeds usually generate quite a boring fractal. You can also explore various seeds at high speed using the Fast Julia mode.

Not all fractals have Julias, but XaoS can generate fake Julia sets for those that do not, which use some Julia-like modification of the formula; so this function is currently usable for all fractal types.

Available as: menu item

Syntax:(julia bool)

This function is used to enable/disable julia mode in animation files.

Available as: command line option, command

Syntax:(juliaseed complex)

Select the current julia seed.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %uiperturbation perturbation Perturbation

Perturbation is a simple trick which changes the point at which orbits start. Traditionally zero is used, but other values can generate interesting results too.

On enabling this function from the menu, you will be asked for a complex number specifying the perturbation. It is a toggle; selecting it again resets the perturbation to zero without prompting.

It can be used to specify a complex number representing a point on the screen. If you hit the B key instead of using the menu, the current mouse position is used. This too is a toggle, so B again will disable perturbation by setting it to zero.

This function only has an effect for certain formulae (like the Mandelbrot set) and only then in Mandelbrot mode.

Available as: menu item

Syntax:(perturbation complex)

This is the scripting-language variation of the perturbation function. Instead of toggling, you always specify the perturbation to use. Use 0 0 to disable perturbation.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %bailout bailout Bailout

Bailout is the value which is checked for each point of the orbit if the point is far enough from the complex zero point in the current iteration. If the point is far enough, then the iteration immediately stops and the starting point on the screen will be painted with a given colour, depending on the fractal type and many other settings.

For the Mandelbrot set this value is 4. Other fractal types usually have the same bailout value. For most fractals many bailout values give more or less similar output. E.g., for the second order Mandelbrot set one can prove that the sequence |z| (z:=z^2+c) tends to infinity if and only if |z|>2 for some element z of this sequence. In XaoS program, Bailout value is the square of this 2, i.e. you can change this to any value greater than 2 for similar results.

Other fractal types may use other bailout values. The default is 4 for each types.

Available as: menu item, command line option, command

Syntax:(bailout float)

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %uiview view angle View

Set your current viewpoint in the fractal. This function is useful when you have found some interesting coordinates somewhere (on a web page, perhaps) and you want to see that position in XaoS.

In the dialog you will be asked for the center, radius and angle of the image.

The center specifies the point which is displayed at the center of the screen. The radius is the radius of a circle around this point; XaoS will size the image so that this circle only just fits on the screen. The angle gives the rotation of the image in degrees.

People specify fractal coordinates in many ways. Some people use the coordinates of the upper-left and lower-right visible points, specifying the coordinates as four numbers x1, y1, x2, y2. To set the same viewpoint in XaoS, set the real portion of the center to (x1+x2)/2, the imaginary part of center to (y1+y2)/2, and the radius to the greater of x2-x1 and y2-y1.

Other programs use a zoom factor instead of a radius. For these, you can set the radius to 2/zoom.

Available as: menu item

Syntax:(view float float float float)

This function is used to set the visible area of fractal in animation files. It doesn't let let you specify the angle, (for that, see the separate function angle), but lets you specify an ellipse instead of a circle. You can specify both a real and an imaginary radius, so you have better control over the area that will be visible. XaoS will size the image so that the ellipse only just fits on the screen.

Available as: command line option, command

Syntax:(angle float)

Set the rotation angle in degrees. By default this causes recalculation of the screen. You can enable the fast rotation mode, which lets you rotate the screen without recalculation; but it slows down other things, so don't forget to disable it later.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %initstate Reset to defaults

Syntax:(initstate)

This function resets most of XaoS's values to their defaults. It is useful when you get lost and want to start from the beginning. It should also be used as the first command of every animation file, to ensure that the file is always played with the same settings in effect.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %plane mplane plane0 plane1 plane2 plane3 plane4 plane5 plane6 plane7 plane8 plane9 plane10 Plane

Syntax:(plane integer)

All fractals displayed by XaoS are functions with a complex parameter. They can be be displayed in the normal complex plane where the x coordinate is the real part of the number and the y is imaginary; but they can also be displayed differently:

mu
Normal complex plane (default)
1/mu
Inversion--infinity is at 0 and 0 is at infinity.
1/(mu+0.25)
Similar to inversion, but moves the center outside the Mandelbrot set, so it looks parabolic.
lambda plane, 1/lambda, 1/lambda-1
Lambda plane and its inversion, and with a different center.
1/(mu-1.40115)
A very interesting mode for the Mandelbrot set, this makes small things large, for easier browsing of the set's details.
The tutorial about planes has some examples.

In the scripting language, the planes are numbered as follows:

0
mu
1
1/mu
2
1/(mu+0.25)
3
lambda
4
1/lambda
5
1/(lambda-1)
6
1/(mu-1.40115)

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %incoloring mincoloring in1 in2 in3 in4 in5 in6 in7 in8 in9 in10 in0 Inside coloring mode

Syntax:(incoloring integer)

Areas inside the set are usually filled in black, but this is only a convention; you could color them in differently to make the fractal look more interesting. The only method available to make areas inside the set visible is to display the value of the latest orbit as the value of each pixel.

The tutorial on incoloring has more information and examples.

XaoS has many different ways to show that value. The cryptic names of the modes are mathematical formulae, where real means the real part of the latest orbit, and imag means the imaginary part. zmag uses the magnitude of the value. The Decomposition-like method uses the angle of the orbit. Also, truecolor incoloring modes are available, that display one value in each of the red, blue and green color planes (or, for some modes, in each of the hue, saturation and value planes). In the scripting language, the incoloring mode is specified by one of the following integers:

0
0 (default)
1
zmag
2
Decomposition-like
3
real/imag
4
abs(abs(c)-abs(r))
5
cos(mag)
6
mag*cos(real^2)
7
sin(real^2-imag^2)
8
atan(real*imag*creal*cimag)
9
squares
10
Truecolor. To set exact parameters for truecolor coloring use the tcolor command.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %outcoloring moutcoloring out1 out2 out3 out4 out5 out6 out7 out8 out9 out10 out0 Outside coloring mode

Syntax:(outcoloring integer)

Outcoloring modes are similar to incoloring modes, but indicate how to display the areas outside the set instead. As with incoloring modes, the value of the latest orbit can be used to determine the color of each pixel, but the default is to use the number of iterations needed for the value at that point to become recognisably divergent as the color.

The tutorial on outcoloring has more information and examples.

The cryptic names of the modes are mathematical formulae, where iter means the number of iterations required for the value to become recognisably divergent, real means the real part of the latest orbit, and imag means the imaginary part. binary decomposition uses a different color when the imaginary part of the orbit is lower than zero, and smooth attempts to remove stripes and discontinuities. Also, truecolor outcoloring modes are available, that display one value in each of the red, blue and green color planes (or, for some modes, in each of the hue, saturation and value planes).

In the scripting language, the outcoloring mode is specified by one of the following integers:

0
iter (default)
1
iter+real
2
iter+imag
3
iter+real/imag
4
iter+real+imag+real/imag
5
binary decomposition
6
biomorphs
7
potential
8
color decomposition
9
smooth
10
True-color outcoloring mode. To set exact parameters for truecolor coloring use outtcoloring.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %tcolor intcoloring outtcoloring tincoloring toucoloring int0 int1 int2 int3 int4 int5 int6 int7 int8 int9 int10 int11 outt0 outt1 outt2 outt3 outt4 outt5 outt6 outt7 outt8 outt9 outt10 outt11 Truecolor coloring mode

Syntax:(intcoloring integer)

Syntax:(outtcoloring integer)

Truecolor coloring modes are similar to incolor and outcolor coloring modes; but instead of using a palette, they directly calculate the red, green and blue components of the color. This lets you display more parameters at once, and produces interesting and often attractive results. On 8bpp displays you need to enable the palette emulator filter first to see anything, amd the quality won't be so good, as far fewer colors are available per parameter.

The tutorial on truecolor coloring modes has more information and examples.

The cryptic names of the modes are always three mathematical formulae (one for each color component), where real means the real part of the latest orbit, and imag means the imaginary part.

To enable inside/outside truecolor coloring mode in the scripting language, set incoloring/outcoloring value to 10 (truecolor coloring mode) before (or after) calling intcoloring or outtcoloring.

In the scripting language, the coloring mode is specified by one of the following integers:

0
black
1
re*im sin(re^2) angle
2
sin(re) sin(im) sin(square)
3
hsv
4
hsv2
5
cos(re^c) cos(im^2) cos(square)
6
abs(re^2) abs(im^2) abs(square)
7
re*im re*re im*im
8
abs(im*cim) abs(re*cre) abs(re*cim)
9
abs(re*im-csqr) abs(re^2-csqr) abs(im^2-csqr)

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %calc Calculation This menu contains functions that control calculation parameters such as the maximum iteration count and periodicity checking.

Solid guessing

Dynamic resolution

Periodicity checking

Iterations

Bailout

Fast Julia mode

Dynamic resolution

Rotation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %range mguess guess0 guess1 guess2 guess3 guess4 guess5 guess6 guess7 guess8 guess9 guessall Solid guessing range

Syntax:(range integer)

XaoS has a solid guessing optimization: if all corners of a rectangle have the same color, it assumes that the whole rectangle is a solid colored block, and doesn't calculate points inside the rectangle. This optimization saves lots of calculation, but sometimes introduces errors. This value alters the maximum size of the rectangle that can be guessed at one time. The default value is 3; use 0 to disable the optimization.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %periodicity Periodicity checking

Syntax:(periodicity bool)

Periodicity checking is one way to speed up the calculation. Areas inside the set always need maxiter iterations to determine that the point is probably inside the set (while it is rare for areas outside to need anywhere near that much). Often the orbital trajectory falls into a periodic, repeating cycle; if that can be detected, the calculation can be stopped early, as there's no way that the orbit can ever leave the cycle again (hence it cannot diverge, hence the point must be inside the set).

Implementating this method efficiently is quite problematic. It slows down the cases where cycles are not found, because cycle-checking is quite hard work and has to take place for all points, even those that don't become cyclic. Because of the inexactness of floating-point calculations, the cycles are never exact, so you need to use an error value. Higher error values mean that cycles will be detected sooner, while lower error values increase the exactness of the calculation. Higher values can introduce serious errors, especially at the front of the Mandelbrot set. XaoS detects this automatically and corrects for it in most cases, but sometimes it might be wrong. Also, other optimizations in XaoS (such as boundary tracing) don't give this method much of a chance to run, since areas inside the set are usually not calculated at all.

That's why the advantages of this optimization are questionable. You should probably experiment with enabling and disabling it. Sometimes XaoS is faster with this enabled, sometimes when disabled. Also, this method works only when incoloring methods are disabled, and only for some fractal types (some fractal types, e.g. newton, don't have any concept of an area `inside the set' at all.)

The tutorial chapter ``Escape time fractals'' has more information on fractal calculation in XaoS, and there is a lengthy section in the hacker's manual (xaosdev.texinfo) devoted to the subject.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %maxiter Iterations

Syntax:(maxiter integer)

When the fractal set is calculated, a orbital trajectory is examined for each point. If the orbit diverges to infinity, the point is outside the set. Otherwise, the point is inside the set. For exact calculations, you need to know the entire orbital trajectory, which is infinitely long for areas inside the set, so fractals cannot be calculated exactly. By default, XaoS calculates at most 170 positions (iterations) and then gives up; if the point is still inside the bail-out value, it guesses that the point is inside the set.

When zoomed into a detailed area, especially one close to the set boundary, this value could become too low, and the fractal will become boring. You might try increasing this value if you want to get the image interesting again; but this necessarily slows down the calculation at the same time.

The tutorial chapter ``Escape time fractals'' has more information on fractal calculation in XaoS, and there is a lengthy section in the hacker's manual (xaosdev.texinfo) devoted to the subject.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %fastjulia Fast Julia mode

Syntax:(fastjulia bool)

By default, changing the seed for the Julia set requires recalculation of the image (which is quite slow). It's a nice effect to change the seed smoothly and show the Julia set morphing as the seed changes. XaoS has a special algorithm which can calculate such morphings in realtime. It is very inexact, but it is good enough for a fast preview.

If you want to select a good seedpoint, enable fast Julia mode and find a nice place by dragging with the first mouse button depressed; then change to the Julia mode to see the exact image.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %dynamic nodynamic dynamicanimation dynamicnew fastmode Dynamic resolution

Syntax:(fastmode keyword)

XaoS performs many optimizations, but fairly often this is not enough. In order to keep a high framerate, XaoS automatically lowers the resolution of the image, increasing it when there is time for more calculation. This feature is enabled by default when animating, but you might also like to enable it for new images (which makes the image `come into focus' when it is recalculated from scratch for whatever reason), or disable it completely if you don't like it.

In the scripting languge, the keyword should be one of the following:

'never
Disable dynamic resolution
'animate
Use only for animations (default)
'new
Use also for new images
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %rotate norotate controtate mouserotate rotationspeed autorotate fastrotate Image rotation XaoS has support for rotation of the image to any angle. By default, changing the angle requires recalculation of the whole screen, but when fast rotation mode is enabled, the angle can be changed smoothly. In this mode XaoS calculates a larger non-rotated image and rotates it when needed, so it increases memory requirements and slows XaoS down; hence, it should be disabled when rotation is not being used.

The user interface provides two rotation modes--rotate by mouse which allows the angle to be changed by dragging with the first mouse button depressed, and continuous rotation mode, where the image is rotated clockwise continuously, and the arrow keys can be used to change the rotiation speed.

Syntax:(fastrotate bool)

This function is used to enable and disable fast rotation mode. Available as: command line option, command Automatic rotation

Syntax:(autorotate bool)

Use this function to enable continuous rotation. In the scripting language you can also use morphangle to get an outwardly similar but more controllable effect.

Syntax:(rotationspeed float)

Specify the speed of continuous rotation, in degrees per second. Negative values are allowed and rotate anticlockwise.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %mfilter Filters Filters are a post-calculation effect applied to the resulting image. They can do things like motion blurring, edge detection, emulation of palettes or truecolor on displays that can't handle them, and such things. There is a tutorial chapter about them.

Filter command

Edge detection

Edge detection2

Starfield

Random dot stereogram

Interlace filter

Motion blur

Emboss

Palette emulator

Antialiasing

Truecolor emulator

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %filter Filter command

Syntax:(filter keyword bool)

This command is used to enable or disable filters. The keyword specifies the filter to change, and should be one of the following:

'edge
Edge detection
'edge2
Edge detection2
'starfield
Starfield
'stereogram
Random dot stereogram
'interlace
Interlace filter
'blur
Motion blur
'emboss
Emboss
'palette
Palette emulator
'anti
Antialiasing
'truecolor
Truecolor

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %edge Edge detection

This filter is a standard edge detection algorithm; solid areas are filled in black. Some fractals look very interesting with this filter (and some areas of some fractals just look like noise). This version of the filter produces relatively wide lines, so is useful at higher resolutions. The filter edge detection2 makes thinner lines, for the low resolution modes.

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %edge2 Edge detection2

This filter is a standard edge detection algorithm; solid areas are filled in black. Some fractals look very interesting with this filter (and some areas of some fractals just look like noise). This version of the filter produces relatively tight lines, so is useful at lower resolutions. The filter edge detection makes thinner lines, for the high resolution modes.

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %starfield Starfield

The starfield filter generates random stars whose density depends on the iteration count. Choose your favorite spiral fractal and enable this filter to get a Grand Design spiral galaxy :)

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %stereogram Random dot stereogram

Fractal images are good as a base for random dot stereograms. In case you don't know what these are, please point your browser to Google or another search engine and find some articles about such images, because learning to read such images takes some effort. They make it possible to generate three dimensional images on a normal monitor without any additional hardware, by exploiting bugs in the human brain (although you need two working eyes, and some people never learn to see them; they can simply ignore this feature).

XaoS is able to generate these images in animations, so you may use all normal XaoS functions (except palette changing and palette rotation, which makes no sense applied to a stereogram). To make the animation yet more exciting, XaoS emulates ``falling'' into the set; while you zoom in, your distance from the set drops and drops--but you never hit it; when the set reaches the level of your monitor, the distance is changed again so you are far away.

To make this work right, XaoS needs to know the exact size of your monitor. Because most platforms have no way to determine this, you need to use command line options to tune it. If it's not set or is wrong, the stereograms will probably be impossible to see (if your monitor is too big or resolution too low), or the images will seem to be shallow (if your monitor is too small or resolution too high).

By default XaoS expects my 15" monitor (29.0cm x 21.5 cm). Another cause of problems is the virtual screen supported by some windowed environments (like some X servers) that makes a program think that the resolution is higher than it actually is, and you see only part of this extra-large screen.

The worst thing you could possibly do is to run full-screen XaoS in some graphical windowing system (OS/2 on top of Windows or Wine on top of Linux, perhaps) where XaoS can't tell the real size of its window at all. In such cases, it's normally better (not to mention faster) to run XaoS natively, rather than under such an emulation layer.

The following command line options are provided to specify sizes:

-screenwidth, -screenheight
Lets you specify the size of your screen in centimeters. Note that you need to specify the size of the visible image on the monitor, not the size with edge borders, or the size of the tube. The simplistic `my monitor is 17", just turn 17" into centimeters' doesn't work; that 17" is a marketing figure and has only a vague connection to reality. Get out a ruler and measure it.
-pixelwidth, -pixelheight
Lets you specify the exact size of a single pixel, if XaoS cannot determine this for itself from your screen size.

These options are used by some other parts of XaoS as well, so you should use them even when you don't want to see stereograms. You should probably write a small starting script (or alias, or shortcut; whatever your environment uses) that passes the correct parameters to XaoS.

If the window is smaller than 8cm in any direction, you will probably be unable to see anything; make the window bigger. The correct way to see XaoS stereograms is:

1
Start XaoS with options specifying the exact size of your screen or one pixel on it
2
Sit 60cm away from monitor
3
If you use a windowed environment, resize XaoS's window to make it wider than, say, 15 cm.
4
Enable the filter (by pressing E)
5
focus on a point far away from the monitor (try to use your own reflection, if your monitor's not antireflective); the random blurring should eventually fall into the pattern of a Mandelbrot set.
6
Carefully use your mouse to zoom into interesting areas (it is easy to lose concentration when you are not trained; but you can use the autopilot...)
7
Enjoy animation :)

If you still can't see the stereograms, it could be that the fractal, or your eye, is deformed. A deformed fractal can be caused by your specifying your monitor size wrongly. Visual problems that damage depth perception, as well as problems like astigmatism, can make it impossible to see stereograms at all.

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %interlace Interlace filter

The interlace filter halves the horizontal resolution, and in each frame alternates between drawing only the even and only the odd lines. This speeds up the calculation, and in higher resolutions produces a motion-blur-like effect.

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %blur Motion blur

Motion blur mixes the current frame with previous ones to produce a motion-blur effect. It might be rather slow in 16bpp truecolor modes. The best results can probably be seen in 8bpp modes, so you might want to enable the palette filter first.

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %emboss Emboss

This is a standard emboss filter, as seen in programs such as the GIMP or Photoshop. It produces especially nice results with the smooth outcoloring mode.

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %palettef Palette emulator

XaoS can work in either palette or truecolor mode. Both modes have advantages and disadvantages. Palette mode allows effects such as palette rotation, while truecolor mode allows smoother incoloring and outcoloring modes and the truecolor coloring modes. If your display is truecolor, you can enable this filter to get palette emulation (albeit not as cheaply as in a real paletted mode).

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %anti Antialiasing

Antialiasing is a technique to increase image quality by eliminating jagged edges. XaoS calculates four values for each pixel (on the subpixel boundaries) and uses the average of them for the pixel value.

This filter slows XaoS down a lot and greatly increases memory requirements. It is useful mainly when you want to save images and want to make them look as nice as possible. Antialiasing also helps a lot when you want to encode JPEG or MPEG files; they are much shorter if antialiased (MPEG and JPEG hate jagged edges).

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %truecolor Truecolor emulator

XaoS can work in either palette or truecolor mode. Both modes have advantages and disadvantages. Palette mode allows effects such as palette rotation, while truecolor mode allows smoother incoloring and outcoloring modes and the truecolor coloring modes. If your display is 8bpp, you can enable this filter to get truecolor emulation (but, obviously, not with as many colors as a real truecolor display).

More information about filters

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %ui uia UI This menu contains functions to control the user interface layer of XaoS: zooming speed, the autopilot, realtime status information, and so on.

Zooming speed

Letters per second

Autopilot

Recalculate

Interrupt

Disable XaoS's builtin GUI

Status

Ministatus

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %speed speedup maxstep Zooming speed

Syntax:(speed float)

Change zooming speed, where 1 is the default, 2 means twice as fast, and so on.

Available as: menu item, command line option, command

In the scripting language you can use the following functions for better control:

Syntax:(maxstep float)

Selects the zooming/unzooming speed. The parameter specifies how much of the range will be removed each twentieth of a second; 0 means nothing, 1 means everything (the parameter obviously has to be less than 1). Higher values mean faster zooming.

Available as: command

Syntax:(speedup float) When zooming/unzooming, every twentieth of a second the speedup value is added to the current step until maxstep is reached. So this value selects the rate at which zooming stops and starts. Both these functions are more for internal use of XaoS then for manually written scripts, but they could come in useful nonetheless.

Available as: command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %letterspersec animletterspersec Letters per second

Syntax:(letterspersec integer)

Speed of subtitles for the textsleep function. The user can set this value to suit; it can also be changed with the left and right arrow keys during animation replay.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %autopilot Autopilot

Syntax:(autopilot bool)

To make XaoS yet more impressive, we made a special autopilot mode that automatically drives into interesting boundaries of the set; you should press A, play your favorite music, drink coffee and relax. I never tried this but it should be really relaxing! Many pictures in the XaoS gallery were discovered using the autopilot.

The autopilot also has some additional features. It backtracks if the zoomed picture is not interesting anymore, and can detect when it's zoomed into really a boring part of the fractal or reached the limit of floating point arithmetic on the platform, and restart zooming from the top.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %recalculate Recalculate

Syntax:(recalculate)

Recalculate current fractal. This should be used when the fractal on the screen is strange because of error propagation caused by solid guessing.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %interrupt animinterrupt Interrupt

Syntax:(interrupt)

Interrupt current calculation.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %nogui Disable XaoS's builtin GUI

Syntax:(nogui bool)

Disable XaoS menus and dialogs. This function should be used by external GUI programs; these manipulate XaoS via a pipe, so the internal GUI should be disabled at the same time. See the hacker's manual (xaosdev.texinfo) for more details.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %status animstatus Status

Syntax:(status bool)

Enable/disable status information. This displays some useful information about the current fractal, such as viewpoint etc. (In low-resolution modes it also almost completely obscures the current fractal...)

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %ministatus animministatus Ministatus

Syntax:(ministatus bool)

Enable/disable status line. This contains basic information such as how much you are zoomed and the framerate.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %misc Misc Miscellaneous functions.

Command

Render animation

Clear screen

Display fractal

Display text

Color

Horizontal text position

Vertical text position

Text position

Message

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %command Command

You can invoke all XaoS functions using a simple command language reminiscent of Scheme. This option lets you run a single command. If you want to run more than one, you might want to use an XaoS animation file instead; they are written in the same language.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %renderanim Render animation

Render an animation to image files. See How to encode video files for more information.

Available as: menu item, %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %clearscreen Clear screen

Syntax:(clearscreen)

Clear the screen. To display the fractal again, use display. This function is mainly useful in tutorials and similar animations.

Available as: menu item, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %display Display fractal

Syntax:(display)

Display fractal. This functions reverses the effect of the clearscreen, line drawing and text output functions.

Available as: menu item, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %text Display text

Syntax:(text string)

Display the given text on the screen. This function is mainly useful in tutorials. Text should be cleared by printing lots of spaces, or using the clearscreen or display functions. You might also want to use the textposition function to select the part of the screen to display the text on.

To wait for the user to read the text, you can use the textsleep function.

Example:

(clearscreen)
(textposition 'center 'middle)
(text "Welcome into my animation")
(textsleep)
(display)

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %color Color

Syntax:(color keyword)

Change text and line color. keyword should be one of 'white, 'black and 'red.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %textposition Text position

Syntax:(textposition keyword keyword)

Select text position. The first keyword specifies the horizontal position, the second the vertical position. The horizontal position should be one of 'left, 'center, and 'right. The vertical should be one of 'top, 'middle, and 'bottom.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %message Message

Syntax:(message string)

This function is almost identical to the text function, except that it uses message catalogs in the catalog directory to translate messages into other languages. It should be used only in the multi-lingual XaoS tutorials.

Available as: command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %helpmenu Help This menu contains help and tutorials.

Help

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %help Help

Syntax:(help)

Display the main help page.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %xtextpos Horizontal text position Select the horizontal position used to display text. It can be placed at the left, in the center or at the right.

Left

Center

Right

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %xtextleft Left

Draw text at the left side of the screen.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %xtextcenter Center

Draw text in the center of the screen.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %xtexteight Right

Draw text at the right side of the screen.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %ytextpos Vertical text position Select the vertical position used to display text. It can be placed at the top, in the middle or at the bottom of the screen.

Up

Middle

Bottom

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %ytextup Up

Draw text at the top of the screen.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %ytextmiddle Middle

Draw text in the middle of the screen.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %ytextbottom Bottom

Draw text at the bottom of the screen.

Available as: menu item %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %mformula formulae

Each escape time fractal has its own formula. XaoS supports the following formulae:

Mandelbrot

Mandelbrot^3

Mandelbrot^4

Mandelbrot^5

Mandelbrot^6

Octal

Newton

Barnsley1

Phoenix

Magnet

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %mandel Mandelbrot

The Mandelbrot set is the most famous escape time fractal ever. It has the simple formula z=z^2+c. See the tutorial chapter.

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %mandel3 mandel4 mandel5 mandel6 Mandelbrot^3--Mandelbrot^6

This fractal is a simple modification of the standard Mandelbrot set formula, using z=z^3+c instead of z=z^2+c.

Other derivations of the Mandelbrot set (Mandelbrot^4 and so on) use even higher powers. See the tutorial chapter.

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %octal Octal

This is a less well-known fractal that Thomas discovered in Fractint. It has an interesting shape when displayed in the alternative planes. See the tutorial chapter.

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %newton Newton

This is Newton's approximation method for finding the roots of a polynomial. It uses the polynomial x^3=1 and counts the number of iterations needed to reach the approximate value of the root. See the tutorial chapter.

This fractal doesn't have Julia sets, but XaoS is able to generate Julia-like sets which are also very interesting (they are sometimes called ``Nova formulae'').

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %barnsley Barnsley1

This is a formula by Michael Barnsley. It produces very nice crystalline Julia sets. See the tutorial chapter.

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %phoenix Phoenix

This formula produces very nice Julia sets. See the tutorial chapter.

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %magnet Magnet

This is a formula that comes from theoretical physics. It is derived from the study of theoretical lattices in the context of magnetic renormalization transformations. See the tutorial chapter.

Available as: menu item, command line option %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %palettemenu Palette This menu contains functions to change the palette the fractal is displayed with.

Default palette

Random palette

Custom palette

Color cycling

Shift palette

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %defpalette Default palette

Syntax:(defaultpalette number)

Create a default palette. In the scripting language, number specifies how much the palette is shifted by.

Note that changing the palette in truecolor modes forces recalculation of the whole screen. To avoid this, you can enable the palette emulation filter first.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %randompalette Random palette

Syntax:(randompalette)

Create a random palette. XaoS will automatically pick one of its palette-generation algorithms and create one.

Note that changing the palette in truecolor modes forces recalculation of the whole screen. To avoid this, you can enable the palette emulation filter first.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %palette Custom palette

Syntax:(palette integer integer integer)

A custom palette lets you re-create some of the random palettes. The first value specifies the algorithm, which should currently be one of the following:

0
Default palette
1
Black to color gradient
2
Black to color to white gradient
3
Cubistic-like algorithm.
The seed specifies a random seed for the palette; different seeds generate different palettes. The last value is the amount by which the palette is shifted.

Note that changing the palette in the truecolor modes forces recalculation of the whole screen. To avoid this, you can enable the palette emulation filter first.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %cycling rcycling cyclingspeed Color cycling

Syntax:(cycling bool)

Color cycling is an old and simple effect to animate fractals. The Mandelbrot set looks particularly nice when color-cycled. On truecolor displays, color cycling fails to initialize (since those displays don't have a palette). You can enable palette emulation filter to make it possible.

Available as: menu item, command line option, command

In the user interface, colors can also be cycled in the opposite direction with the ``Reversed color cycling'' function.

To control the cycling speed, you coan use arrow keys or the ``Color cycling speed'' function.

Available as: menu item

Syntax:(cyclingspeed integer)

The parameter specifies the number of skips per second. It can be negative to cycle in the opposite direction.

Available as: menu item, command line option, command %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %shiftpalette fshift bshift Shift palette

Syntax:(shiftpalette integer)

Shift palette by the specified number of cells. This can be used to tune the palette's position on the fractal. You can also use the Shift one forward and Shift one backward functions for fine-tuning. Note that shifted and rotated palettes could look different on different displays (because they may have different palette sizes).

Shifting the palette on truecolor displays causes a recalculation of the screen. To avoid this, you could use palette emulation filter.

Available as: menu item, command line option, command %endmenus %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %gpl GNU GENERAL PUBLIC LICENSE

Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc.
675 Mass Ave, Cambridge, MA 02139, USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

b) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.

(one line to give the program's name and a brief idea of what it does.)
Copyright (C) 19yy (name of author)

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.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.

(signature of Ty Coon), 1 April 1989 Ty Coon, President of Vice

This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %end