diff options
| author | Bernie Innocenti <bernie@codewiz.org> | 2010-05-03 21:53:47 (GMT) |
|---|---|---|
| committer | Bernie Innocenti <bernie@codewiz.org> | 2010-05-03 21:53:47 (GMT) |
| commit | 1030dc837b10a03a02a85d5504cbeec168ce49e2 (patch) | |
| tree | 698eefa87ac437deaf36a4141b326f8ce7986692 /help | |
Import XaoS r489 (trunk after version 3.5)
Diffstat (limited to 'help')
155 files changed, 10360 insertions, 0 deletions
diff --git a/help/Makefile.in b/help/Makefile.in new file mode 100644 index 0000000..e793a99 --- /dev/null +++ b/help/Makefile.in @@ -0,0 +1,14 @@ +all: rtf html + +rtf: xaos.hlp + ./rtfconv + +chm: xaos.hlp + ./winhelpconv + hhc xaoshelp.hhp + +html: xaos.hlp + ./htmlconv + +clean: + rm -f *.html xaoswin.rtf diff --git a/help/README b/help/README new file mode 100644 index 0000000..80fb051 --- /dev/null +++ b/help/README @@ -0,0 +1,29 @@ +README file for help/ directory +------------------------------- + +Zoltan Kovacs <kovzol@math.u-szeged.hu> + +Last modification information: +$Header: /home/jblang/XaoS-cvsbackup/XaoS/help/README,v 1.1 2003-02-03 10:16:51 kovzol Exp $ + + +This directory contains several files for documentation of XaoS. + +The main file is xaos.hlp. From this will all scripts generate +documentation files. + +To create HTML documentation (many .html files), please run +"make html". + +To create TeX documentation (.dvi files) or .info files, go to ../doc +and type "make". + +To create .rtf documentation, type "make rtf" or run "rtfconv.bat" (on +Windows/CygWin development system). You will need xaoswin.rtf in order +to generate xaoswin.hlp for your running Windows executable. + +To create xaoswin.hlp, you need the HCW package. Note that you also need +xaoswin.Hpj and xaoswin.rtf (xaoswin.rtf must be generated with +"make rtf" or using the "rtfconv.bat" utility). + +Finally, "make" will generate both .html and .rtf documentation. diff --git a/help/applehelpconv b/help/applehelpconv new file mode 100755 index 0000000..051ce1b --- /dev/null +++ b/help/applehelpconv @@ -0,0 +1,77 @@ +#!/bin/sh +processline() +{ + echo "- $1 -" + name="$1" + anchors="<A NAME=\"$1\"></A>" + title="" + stylesheet="../style/xaoshelp.css" + shift + while [ "$1" != "" ] ; do + if [ "$1" != "$name" ] ; then + anchors="$anchors <A NAME=\"$1\"></A>" + fi + shift + done + if [ "$name" == "main" ]; then + title='<meta name="AppleTitle" content="XaoS Help">' + stylesheet="style/xaoshelp.css" + fi + # I changed "0" to "$" because my sed + # doesn't want to understand "0". + # -- Zoltan + cat xaos.hlp | sed '/%'"$name"'/H' | sed '1,/%'"$name"'/d;/^%/,$ d' | sed \ +'1,3s_<head>\([^<]*\)</head>_\ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\ +<HTML>\ +<HEAD>\ + <TITLE>\1</TITLE>\ + '"$title"'\ + <LINK HREF="'"$stylesheet"'" REL="stylesheet" TYPE="text/css">\ +</HEAD>\ +<BODY>\ +'"$anchors"'\ +<H1>\1</H1>\ +_g +s_<head>_<H2>_g +s_</head>_</H2>_g +s_<center>__g +s_</center>__g +s_<emph>_<STRONG>_g +s_<submenu>__g +s_<menuhead>__g +s_</menuhead>__g +s_<mainmenu>__g +s_<main>__g +s_<math>__g +s_<menuitems>__g +s_<notex>__g +s_</notex>__g +s_<node.*>__g +s_</emph>_</STRONG>_g +s_<tt>_<CODE>_g +s_</tt>_</CODE>_g +s_<tutor \([^>]*\)>_<A HREF="help:runscript=/scripts/tutorial.scpt%20string=\1">_g +s_</tutor>_</A>_g +s_<a \([^>]*\)>_<A HREF="help:anchor=\1 bookID=XaoS Help">_g +s/'\'\''/"/g +s/``/"/g' > $name.html + echo "</BODY></HTML>" >> $name.html + tidy -qm $name.html + case $name in + main) mv $name.html XaoSHelp/XaoSHelp.html;; + *) mv $name.html XaoSHelp/pages;; + esac +} +process() +{ + while read line ; do + eval "processline $line" + done +} +rm -rf XaoSHelp +mkdir -p XaoSHelp/{images,pages,scripts,style} +cp tutorial.scpt XaoSHelp/scripts +cp xaoshelp.css XaoSHelp/style +grep "^%" xaos.hlp | sed '/%%/d;s/%//g' | process +/Developer/Applications/Utilities/Help\ Indexer.app/Contents/MacOS/Help\ Indexer "XaoSHelp" -PantherIndexing YES -IndexAnchors YES -TigerIndexing YES diff --git a/help/conv b/help/conv new file mode 100755 index 0000000..2cf3a22 --- /dev/null +++ b/help/conv @@ -0,0 +1,118 @@ +#!/bin/sh +#cut at given keyword +keyword() +{ + # I changed "0" to "\$" because my sed + # doesn't want to understand "0". + # -- Zoltan + sed "1,/^%$1/ d;/^%/,\$ d" +} +menus() +{ + # I changed "0" to "\$" because my sed + # doesn't want to understand "0". + # -- Zoltan + sed "1,/^%menus/ d;/^%endmenus/,\$ d" +} + +#convert xshl tags into texinfo +totexinfo1() +{ + sed 's/@/@@/g + s/^[ ]*//g + s/[ ]*$//g + s/[ ][ ]*/ /g + s/{/@{/g + s/}/@}/g + s/^%%%*//g + s/^\%[a-z_0-9 ]*$//g + ' +} +totexinfo() +{ + sed ' + s/<submenu>//g + s/<noprint>/@ifinfo/g + s/<\/noprint>/@end ifinfo/g + /<menuitems>/, /<\/menuitems>/ s/<p><a \([^>]*\)>\([^<]*\)<\/a>/* \1:: \2/g + s/<menuitems>/@menu /g + s/<\/menuitems>/@end menu /g + s/<tutor [^>]*>//g + s/<\/tutor>//g + /<notex>/,/<\/notex>/ d + s/--/---/g + s/^<p><tt>$/\ +\ +@example/g + s/^<\/tt><p>$/@end example\ +\ +/g + s/<math>/@math{/g + s/<\/math>/}/g + s/<tt>/@code{/g + s/<\/tt>/}/g + s/<emph>/@emph{/g + s/<\/emph>/}/g + s/^<p>$// + s/<p>/\ +\ +/g + s/<dl>/@table @strong/g + s/<\/dl>/@end table/g + s/<dt>/@item /g + s/<br>//g + s/^<dd>//g + s/<dd>/\ +/g + s/<node \([^,]*\),\([^,]*\),\([^,]*\),\([^>]*\)>/@node \1, \3, \2, \4/g + s/<a \([^>]*\)>\(.*\)<\/a>\./\2. @xref{\1}./g + s/<a \([^>]*\)>\(.*\)<\/a>/\2/g + ' +} +#convert headers to make new chapter +chapter() +{ + sed '1,/<\/head>/ s/<head>/@chapter /g + s/<\/head>//g + s/<head>/@section /g + ' +} +menu() +{ + sed ' + s/<p><emph>Syntax<\/emph>:(\([^)]*\))/@defun \1 \ +@end defun/g + s/<main><head>/@appendix /g + s/<menuhead><head>/@appendixsec /g + s/<head>/@appendixsubsec /g + s/<center>//g + s/<\/center>//g + s/<\/head>//g + s/<\/main>//g + s/<\/menuhead>//g + ' + #s/<main><head>/@chapter /g + #s/<menuhead><head>/@section /g + #s/<head>/@subsection /g + #s/<head>/@unnumberedsubsec /g +} +section() +{ + sed '1,/<\/head>/ s/<head>/@section /g + s/<\/head>//g + s/<head>/@subsection /g + ' +} +appendix() +{ + sed '1,/<\/head>/ s/<head>/@appendix /g + s/<\/head>//g + s/<head>/@subsection /g + ' +} +case "$1" in +chapter) keyword $2 | totexinfo1 | totexinfo | chapter ;; +section) keyword $2 | totexinfo1 | totexinfo | section ;; +appendix) keyword $2 | totexinfo1 | totexinfo | appendix ;; +menus) menus | totexinfo1 | menu | totexinfo ;; +esac diff --git a/help/dokuwikiconv b/help/dokuwikiconv new file mode 100755 index 0000000..83a75c7 --- /dev/null +++ b/help/dokuwikiconv @@ -0,0 +1,82 @@ +#!/bin/sh +processline() +{ + echo "- $1 -" + name="$1" + # I changed "0" to "$" because my sed + # doesn't want to understand "0". + # -- Zoltan + cat xaos.hlp | sed '1,/%'"$1"'/d;/^%/,$ d' | sed \ +'s_<p><tt>_<code>_g +s_</tt><p>_</code>_g +s/'\'\''/"/g +s/``/"/g +s_LICENSE<p>_LICENSE - _g' | sed \ +'1,2s_<head>\([^<]*\)</head>_====== \1 ======\ +_g +s_<emph>_**_g +s_<p>_\ +_g +s_<head>_===== _g +s_</head>_ =====\ +_g +s_<center>__g +s_</center>__g +s_<i>_//_g +s_</i>_//_g +s_<submenu>__g +s_<menuhead>__g +s_</menuhead>__g +s_<mainmenu>__g +s_<menuitems>__g +s_</menuitems>__g +s_<notex>__g +s_</notex>__g +s_<dl>__g +s_</dl>__g +s_<dd>__g +s_</dd>__g +s_<br>_\ +_g +s_ [ ]*_ _g +s_<math>_//_g +s_</math>_//_g +s_<dt>_ * _g +s_</dt>__g +s_<node.*>__g +s_</emph>_**_g +s_<tt>_'\'\''_g +s_</tt>_'\'\''_g +s_<tutor [^>]*>_//_g +s_</tutor>_//_g +s_<a \([^>]*\)>_[[\1|_g +s_</a>_]]_g' > $1.txt + + tolower=`echo $1 | awk '{print tolower($1)}'` + if [ "$1" != "$tolower" ] ; then + ln -sf $1.txt $tolower.txt + fi + + shift + while [ "$1" != "" ] ; do + echo Link "$1" "$name" + if [ "$1" != "$name" ] ; then + ln -sf $name.txt $1.txt + fi + + tolower=`echo $1 | awk '{print tolower($1)}'` + if [ "$1" != "$tolower" ] ; then + ln -sf $1.txt $tolower.txt + fi + + + shift + done +} +process() +{ + while read line ; do + eval "processline $line" + done +} +grep "^%" xaos.hlp | sed '/%%/d;s/%//g' | process diff --git a/help/help.jpg b/help/help.jpg Binary files differnew file mode 100644 index 0000000..b299b1f --- /dev/null +++ b/help/help.jpg diff --git a/help/hlp2rtf b/help/hlp2rtf new file mode 100755 index 0000000..a97f2c5 --- /dev/null +++ b/help/hlp2rtf @@ -0,0 +1,74 @@ +#!/bin/sh +echo '{\rtf1 +{\fonttbl +\f0\fswiss Arial; +\f1\froman Times New Roman +\f2\fmodern Courier New; +\f3\fswiss MS Sans Serif; +\f4\froman MS Serif; +} +\deff0 +\ds18 +' + sed ' + s_\\__g + s_'"''"'_"_g + s_``_"_g + s_</tt>_}_g + s/<br>/\\par/g + s/<main//g + s_</main>__g + s/<red>//g + s/<math>//g + s_</math>__g + s/<white>//g + s/<black>//g + s/<dl>/{\\trgraph360\\cellx2880\\cellx10760 \\intbl\\cell/g + s_<dt>_\\cell\\row \\intbl _g + s_<dd>_\\cell _g + s_</dl>_\\cell\\row\\pard}_g + s_</tt>_}_g + s/<tt>/{\\f2 /g + s/<submenu>/{\\b >}/g + s/<menuhead>//g + s_</menuhead>__g + s/<menuitems>//g + s_</notex>__g + s/<notex>//g + s_</menuitems>__g + s/<center>/\\par{\\qc /g + s_</center>_\\par}_g + s/<tutor [^>]*>/{\\b /g + s_</tutor>_}_g + s/<emph>/{\\i /g + s_</emph>_}_g + s/^%%\(.*$\)//g + s/^%\(main\)/\\keepn\ +#{\\footnote \1}\ +#{\\footnote CONTENTS}\ +${\\footnote Contents}\ +K{\\footnote Contents}\ +/g + s/^%\(.[^ ]*\)\(.*$\)/\\page\ +\\keepn\ +#{\\footnote \1\2}\ +${\\footnote \1}\ +K{\\footnote \1\2}\ +/g + s/<p>$/\\par/g + s/<p>/\\par /g + s/<node.*>//g + s/<head>/{\ +\\par\ +\\b\ +\\fs32\ +\\tab\ +/g + s_</head>_}\\par\\pard\\sb150 _g + s_<a \(.*\)>\(.*\)</a>_{\\uldb \2{\\v \1}}_g + s/\(.*\)$/\1 /g + s/ / /g + s/^ *//g + s/ */ /g + ' +echo '}' diff --git a/help/htmlconv b/help/htmlconv new file mode 100755 index 0000000..caaa6e1 --- /dev/null +++ b/help/htmlconv @@ -0,0 +1,60 @@ +#!/bin/sh +processline() +{ + echo "- $1 -" + name="$1" + # I changed "0" to "$" because my sed + # doesn't want to understand "0". + # -- Zoltan + cat xaos.hlp | sed '1,/%'"$1"'/d;/^%/,$ d' | sed \ +'1,2s_<head>\([^<]*\)</head>_<!-- X-URL: http://xaos.sf.net/help/'"$1"' -->\ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\ +<HTML>\ +<HEAD>\ + <LINK rev=made href="mailto:jh@ucw.cz">\ + <META name="description" content="XaoS online help '"$1"'>\ + <META name="keywords" content="XaoS, realtime, fractal, zoomer">\ + <TITLE>XaoS online help - \1</TITLE>\ +</HEAD>\ +<BODY BGCOLOR="#ffffff" TEXT="#594941">\ +<CENTER><A HREF="main.html"><IMG BORDER=0 ALT="XaoS online help" SRC="help.jpg"></A>\ +<H1><A NAME="body">\1</A></H1></CENTER>\ +_g +s_<head>_<center><H2>_g +s_</head>_</H2></center>_g +s_<emph>_<strong>_g +s_<submenu>__g +s_<menuhead>__g +s_</menuhead>__g +s_<mainmenu>__g +s_<menuitems>__g +s_<notex>__g +s_</notex>__g +s_<node.*>__g +s_</emph>_</strong>_g +s_<tt>_<code>_g +s_</tt>_</code>_g +s_<tutor [^>]*>_<i>_g +s_</tutor>_</i>_g +s_<a \([^>]*\)>_<A HREF="\1.html#body">_g +s/'\'\''/"/g +s/``/"/g' > $1.html + echo "</BODY></HTML>" >> $1.html + shift + while [ "$1" != "" ] ; do + echo Link "$1" "$name" + if [ "$1" != "$name" ] ; then + ln -sf $name.html $1.html + fi + shift + done +} +process() +{ + while read line ; do + eval "processline $line" + done +} +grep "^%" xaos.hlp | sed '/%%/d;s/%//g' | process +rm -f index.html +ln -s main.html index.html diff --git a/help/multfix b/help/multfix new file mode 100755 index 0000000..e62d369 --- /dev/null +++ b/help/multfix @@ -0,0 +1,37 @@ +#!/bin/sh +sed 's/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g +s/\(.\){\\footnote \([^ }]*\) \(.*\)}/\1{\\footnote \2}\ +\1{\\footnote \3}\ +/g' diff --git a/help/rest/Makefile b/help/rest/Makefile new file mode 100644 index 0000000..7f81b34 --- /dev/null +++ b/help/rest/Makefile @@ -0,0 +1,88 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest + +help: + @echo "Please use \`make <target>' where <target> is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf _build/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html + @echo + @echo "Build finished. The HTML pages are in _build/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml + @echo + @echo "Build finished. The HTML pages are in _build/dirhtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in _build/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in _build/qthelp, like this:" + @echo "# qcollectiongenerator _build/qthelp/XaoS.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile _build/qthelp/XaoS.qhc" + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex + @echo + @echo "Build finished; the LaTeX files are in _build/latex." + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ + "run these through (pdf)latex." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes + @echo + @echo "The overview file is in _build/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in _build/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in _build/doctest/output.txt." diff --git a/help/rest/X11.txt b/help/rest/X11.txt new file mode 100644 index 0000000..7653c07 --- /dev/null +++ b/help/rest/X11.txt @@ -0,0 +1,31 @@ +.. _X11: + +.. index:: + pair: driver; X11 + pair: platform; Unix + +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. diff --git a/help/rest/aa.txt b/help/rest/aa.txt new file mode 100644 index 0000000..803476c --- /dev/null +++ b/help/rest/aa.txt @@ -0,0 +1,68 @@ +.. index:: + pair: driver; AA-lib + pair: platform; Unix + +.. _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`_. + +.. _`AA-project`: + http://aa-project.sourceforge.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. diff --git a/help/rest/about.txt b/help/rest/about.txt new file mode 100644 index 0000000..ce2e3f2 --- /dev/null +++ b/help/rest/about.txt @@ -0,0 +1,164 @@ +.. _about: + +.. index:: About Xaos, Credits, Included Software + +About XaoS +========== + +.. toctree:: + + background + gpl + volunteer + +XaoS is free software. You are welcome to redistribute it and/or modify it under the terms of +the :ref:`GNU General Public License <gpl>`. In return, we need :ref:`volunteers <volunteer>` to help +improve and support XaoS. + +Credits +------- + +(alphabetically) + +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 + +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_ + | Copyright (C) 1995-1997, 2000-2007 Free Software Foundation, Inc. + | License GPLv3+: `GNU GPL version 3 or later`_ + | 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`_ + | 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`_ + | This is free software: you are free to change and redistribute it. + | There is NO WARRANTY, to the extent permitted by law. + +libpng_ + | Copyright (c) 1998-2008 Glenn Randers-Pehrson + | Copyright (c) 1996-1997 Andreas Dilger + | Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. + +.. _gettext: + http://www.gnu.org/software/gettext/ + +.. _`GNU Scientific Library`: + http://www.gnu.org/software/gsl/ + +.. _libpng: + http://www.libpng.org/pub/png/libpng.html + +.. _`GNU GPL version 3 or later`: + http://gnu.org/licenses/gpl.html
\ No newline at end of file diff --git a/help/rest/addformula.txt b/help/rest/addformula.txt new file mode 100644 index 0000000..6a19e28 --- /dev/null +++ b/help/rest/addformula.txt @@ -0,0 +1,82 @@ +Adding Built-in Formulas +======================== + +.. highlight:: c + +This provides developers an overview of how XaoS handles built-in formulas +and how to add one. + +Built-in formulas are defined in :file:`/src/engine/formulas.c`. + +Defining the Formula +-------------------- + +Each formula is defined by a block of ``#defines``, followed by ``#include "docalc.c"``, +like this:: + + #ifdef __i386__ + #define UNCOMPRESS + #endif + #define USEHACKS + #define PRETEST 0 + #define FORMULA \ + rp = zre * (rp - 3 * ip); \ + zim = zim * (3 * zre * zre - ip) + pim; \ + zre = rp + pre; \ + rp = zre * zre; \ + ip = zim * zim; + #define BTEST less_than_4(rp+ip) + #define SMOOTH + #define SCALC smand3_calc + #define SPERI smand3_peri + #define CALC mand3_calc + #define PERI mand3_peri + #define JULIA mand3_julia + #define RANGE 2 + #define RPIP + #include "docalc.c" + +Every time you include :file:`docalc.c`, it means something different depending +on how you have defined the macros. + +Adding the Formula Description +------------------------------ + +After you have defined the macros, there are two other things are to do: + +You must put the description of your formula at the end of +the structure named "formulas". You can make it to be similar to the +other formula descriptions. + + 1. FORMULAMAGIC + 2. CALC function + 3. PERI function + 4. SCALC function + 5. SPERI function + 6. JULIA function + 7. {"Name of Mandelbrot", "Name of Julia"} + 8. "short name" + 9. point of view: {x_translate, y_translate, ?, scale} + 10. hassymmetry + 11. isMandelbrot (or Julia, at startup) + 12. pre -- real part of Julia seed + 13. pim -- imag part of Julia seed + 14. {{}{}... structures about the symmetries of the outcoloring modes} + 15. {{}{}... structures about the symmetries of the incoloring modes} + + The symmetry structures take the form: + {vertical_symmetry, horizontical_symmetry, size_of_other_symmetries, other_symmetries} + + Horizontical and vertical symmetries can be INT_MAX or 0, + INT_MAX means no symmetry, 0 means symmetry + The next two is like: {... 2, sym6} {... 2, sym8} or {... 6, sym16} + + 16. some FLAGS, (I still don't know what they mean.) + + +Adding Function Calls to the Formula +------------------------------------ + +When this is done, you must put your new functions in the four switch commands at the end of the file. + +After compiling XaoS, you should find your fractal at the "More Formulae" menu. diff --git a/help/rest/animateview.txt b/help/rest/animateview.txt new file mode 100644 index 0000000..dc54101 --- /dev/null +++ b/help/rest/animateview.txt @@ -0,0 +1,18 @@ +.. _animateview: + +.. index:: + pair: command; animateview + +Animate view +============ + +**Syntax**:(animateview float float float float) + +This function is almost identical to function :ref:`view <uiview>`. 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 +:ref:`view <uiview>` for more information. + +**Available as**: command diff --git a/help/rest/animf.txt b/help/rest/animf.txt new file mode 100644 index 0000000..716979d --- /dev/null +++ b/help/rest/animf.txt @@ -0,0 +1,28 @@ +.. _animf: + +.. index:: + pair: functions; animation + +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 :ref:`timing +function <time>`. For example:: + + (view 0 0 1 1) + (morphview 0 0 2 2) + (usleep 5000000) + +Will do a 5 second long unzooming animation. + +.. toctree:: + + animateview + smoothmorph + morphview + morphjulia + moveview + morphangle + zoom diff --git a/help/rest/animroot.txt b/help/rest/animroot.txt new file mode 100644 index 0000000..dd04ec7 --- /dev/null +++ b/help/rest/animroot.txt @@ -0,0 +1,17 @@ +.. _animroot: + +.. index:: + pair: menu; Animation root + +Animation root menu +=================== + +This menu is displayed at the top of the screen when animation replay is +active. + +.. toctree:: + + file + stopreplay + ui + helpmenu diff --git a/help/rest/anti.txt b/help/rest/anti.txt new file mode 100644 index 0000000..8a05848 --- /dev/null +++ b/help/rest/anti.txt @@ -0,0 +1,23 @@ +.. _anti: + +.. index:: + pair: command line option; anti + pair: menu item; Antialiasing + pair: filter; Anitaliasing + +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). + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/autopilot.txt b/help/rest/autopilot.txt new file mode 100644 index 0000000..31cb159 --- /dev/null +++ b/help/rest/autopilot.txt @@ -0,0 +1,24 @@ +.. _autopilot: + +.. index:: + pair: menu item; Autopilot + pair: command line option; autopilot + pair: 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 diff --git a/help/rest/background.txt b/help/rest/background.txt new file mode 100644 index 0000000..db61062 --- /dev/null +++ b/help/rest/background.txt @@ -0,0 +1,49 @@ +.. index:: Background + +Background +========== + +What is XaoS? +------------- + +XaoS is a realtime interactive fractal zoomer. This means that it lets you +zoom smoothly into any place in the fractal you choose without the many hours +of calculation required by most other fractal generators. It now has many +other features too, like different fractal types, autopilot, special coloring +modes, support for various bit depths (8bpp, truecolor, hicolor and realcolor), +random palette generation, color cycling, etc. + +Why yet another fractal generator? +---------------------------------- + +We decided to make XaoS, because all fractal browsers we know of take a +long time to calculate each image. You may browse nice images +generated by them but real impressions of fractals --- the self +similarity and infinite zooming into the nice parts of fractals --- +can be seen only in animations. There are many programs available that +make nice animations, but they take a long time to calculate and lots +of space on disk. Most such animations are quite ugly because their +authors can't see them without many hours of calculations. + +A natural question is: is it possible to generate such animations in +real-time? The answer was negative for many years, since the Mandelbrot set is +very computationally expensive. Things are changing. Today's computers +are fast enough to calculate approx. 10.000 of pixels per frame, +which is enough +for a very low resolution animation (100x100). Several programs doing that +are available. But 100x100 animation still looks quite ugly. To make +animation nice you need at least 320x200 pixels. And that is 6 times more! +One possibility is to wait until computers will be fast enough, but +it will take many years, and then 320x200 animations will be obsolete +and everyone will want 1024x768 resolution instead or more. + +We found a special algorithm that saves up to 99.98% of calculations during +zooming by reusing pixels already calculated in previous frames. There were +some programs doing similiar tricks before but we don't know about any able +to do zooming interactively with a speed similar to XaoS. Many other tricks +were later implemented XaoS to achieve yet higher framerates. Now XaoS does +up to 120 frames per second on a 120Mhz pentium in a fullscreen 320x200 +animation, and calculates an average of 160 (0.24%) pixels per frame. This makes +XaoS fast enough to achieve its primary goal, realtime animation, but there +are still many areas that could improve, since more complex fractals, +higher resolutions, or slower computers still bring many problems. diff --git a/help/rest/bailout.txt b/help/rest/bailout.txt new file mode 100644 index 0000000..38ca4b8 --- /dev/null +++ b/help/rest/bailout.txt @@ -0,0 +1,30 @@ +.. _bailout: + +.. index:: + pair: menu item; Bailout + pair: command line option; bailout + pair: command; 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 :ref:`Mandelbrot set <mandel>` 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) diff --git a/help/rest/barnsley.txt b/help/rest/barnsley.txt new file mode 100644 index 0000000..2bc3aef --- /dev/null +++ b/help/rest/barnsley.txt @@ -0,0 +1,14 @@ +.. _barnsley: + +.. index:: + pair: menu item; Barnsley1 + pair: command line option; barnsley + pair: formula; Barnsley1 + +Barnsley1 +========= + +This is a formula by Michael Barnsley. It produces very nice crystalline Julia +sets. See the :tutor:`tutorial chapter <barnsley.xaf>`. + +**Available as**: menu item, command line option diff --git a/help/rest/blur.txt b/help/rest/blur.txt new file mode 100644 index 0000000..691ba3a --- /dev/null +++ b/help/rest/blur.txt @@ -0,0 +1,18 @@ +.. _blur: + +.. index:: + pair: menu item; Motion blur + pair: command line option; blur + pair: filter; Motion 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 :ref:`palette +filter <palettef>` first. + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/calc.txt b/help/rest/calc.txt new file mode 100644 index 0000000..c22dd29 --- /dev/null +++ b/help/rest/calc.txt @@ -0,0 +1,21 @@ +.. _calc: + +.. index:: + pair: menu; Calculation + +Calculation +=========== + +This menu contains functions that control calculation parameters such as the +maximum iteration count and periodicity checking. + +.. toctree:: + + range + dynamic + periodicity + maxiter + bailout + fastjulia + dynamic + rotate diff --git a/help/rest/clearline.txt b/help/rest/clearline.txt new file mode 100644 index 0000000..7082b48 --- /dev/null +++ b/help/rest/clearline.txt @@ -0,0 +1,13 @@ +.. _clearline: + +.. index:: + pair: command; clearline + +Clear line +========== + +**Syntax**:(clearline) + +Clear current line. This function also increases the line key. + +**Available as**: command diff --git a/help/rest/clearlines.txt b/help/rest/clearlines.txt new file mode 100644 index 0000000..7bb9b46 --- /dev/null +++ b/help/rest/clearlines.txt @@ -0,0 +1,14 @@ +.. _clearlines: + +.. index:: + pair: 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 :ref:`Misc menu <misc>`. + +**Available as**: command diff --git a/help/rest/clearscreen.txt b/help/rest/clearscreen.txt new file mode 100644 index 0000000..b653062 --- /dev/null +++ b/help/rest/clearscreen.txt @@ -0,0 +1,15 @@ +.. _clearscreen: + +.. index:: + pair: menu item; Clear screen + pair: command; clearscreen + +Clear screen +============ + +**Syntax**:(clearscreen) + +Clear the screen. To display the fractal again, use :ref:`display <display>`. +This function is mainly useful in tutorials and similar animations. + +**Available as**: menu item, command diff --git a/help/rest/cocoa.txt b/help/rest/cocoa.txt new file mode 100644 index 0000000..e17ce52 --- /dev/null +++ b/help/rest/cocoa.txt @@ -0,0 +1,95 @@ +.. _cocoa: + +.. index:: + pair: driver; Cocoa + pair: platform; Mac OS X + +Mac OS X +======== + +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_, +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). + +.. _Videator: + http://stone.com/Videator/ + +To turn on output to Videator, select **Videator Output** from the **UI** menu. +See these instructions_ for more details on using Videator with XaoS. + +.. _instructions: + http://stone.com/Videator/VJ.html + +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. diff --git a/help/rest/color.txt b/help/rest/color.txt new file mode 100644 index 0000000..e71a19c --- /dev/null +++ b/help/rest/color.txt @@ -0,0 +1,17 @@ +.. _color: + +.. index:: + pair: menu item; Color + pair: command line option; color + pair: 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 diff --git a/help/rest/command.txt b/help/rest/command.txt new file mode 100644 index 0000000..d62c14f --- /dev/null +++ b/help/rest/command.txt @@ -0,0 +1,15 @@ +.. _command: + +.. index:: + pair: menu item; Command + pair: command; 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 :ref:`XaoS animation file <format>` instead; +they are written in the same language. + +**Available as**: menu item diff --git a/help/rest/conf.py b/help/rest/conf.py new file mode 100644 index 0000000..b6f6d5b --- /dev/null +++ b/help/rest/conf.py @@ -0,0 +1,194 @@ +# -*- coding: utf-8 -*- +# +# XaoS documentation build configuration file, created by +# sphinx-quickstart on Tue Mar 31 21:07:33 2009. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.append(os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.todo', 'sphinx.ext.pngmath', 'xaosspecific'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.txt' + +# The encoding of source files. +#source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'XaoS' +copyright = u'2009, XaoS Development Team' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '4.0' +# The full version, including alpha/beta/rc tags. +release = '4.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +exclude_trees = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_use_modindex = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'XaoSdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'XaoS.tex', u'XaoS Documentation', + u'XaoS Development Team', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/help/rest/controls.txt b/help/rest/controls.txt new file mode 100644 index 0000000..6afdd64 --- /dev/null +++ b/help/rest/controls.txt @@ -0,0 +1,55 @@ +.. _controls: + +.. index:: Basic Controls + +Basic Controls +============== + +You can use the mouse to zoom in and out. The pan function allows you to drag and drop the image in any direction to change the center without zooming in or out. The button you press determines the action performed: + +========================= ================================== ========================= +Action Mouse Button Mac Equivalent +========================= ================================== ========================= +Zoom in :kbd:`Left` :kbd:`Click` +Zoom out :kbd:`Right` :kbd:`Ctrl+Click` +Pan :kbd:`Center` or :kbd:`Left+Right` :kbd:`Shift+Click` +========================= ================================== ========================= + +On Macs with a single button mouse, use the Mac equivalents to simulate the other buttons. XaoS offers two additional ways to pan on a Mac: + +* On a Mac laptop, `swipe two fingers`__ across your trackpad to pan in any direction. +* If you have a Mighty Mouse, you can pan the image using your scroll ball. + +__ http://support.apple.com/kb/HT3448 + +.. note:: + + The behavior of the mouse buttons can change when special modes are enabled. + If you enable rotation, the first button is used to rotate the image. Also, + in fast Julia mode, the first button is used to change the seed. + + +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. diff --git a/help/rest/copy.txt b/help/rest/copy.txt new file mode 100644 index 0000000..adc0904 --- /dev/null +++ b/help/rest/copy.txt @@ -0,0 +1,13 @@ +.. _copy: + +.. index:: + pair: 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 diff --git a/help/rest/cycling.txt b/help/rest/cycling.txt new file mode 100644 index 0000000..c0ed5fe --- /dev/null +++ b/help/rest/cycling.txt @@ -0,0 +1,41 @@ +.. index:: + pair: menu item; Color cycling + pair: command line option; cycling + pair: command; cycling + pair: menu item; Reversed color cycling + pair: command line option; rcycling + pair: command; rcycling + pair: menu item; Color cycling speed + pair: command; cyclingspeed + pair: command line option; cyclingspeed + +.. _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 :ref:`palette emulation filter <palettef>` 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 diff --git a/help/rest/dX-fullscreen.txt b/help/rest/dX-fullscreen.txt new file mode 100644 index 0000000..43b39ba --- /dev/null +++ b/help/rest/dX-fullscreen.txt @@ -0,0 +1,30 @@ +.. _dX-fullscreen: + +.. index:: + pair: driver; DirectX fullscreen + pair: platform; Windows + +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 :ref:`Win32 driver <win32>` documentation for some more Windows +releated information. + +DirectX driver was written by Jan Hubicka, Jan Olderdissen and Pavel Tzekov, +1999. diff --git a/help/rest/dX-window.txt b/help/rest/dX-window.txt new file mode 100644 index 0000000..2e7ba6e --- /dev/null +++ b/help/rest/dX-window.txt @@ -0,0 +1,30 @@ +.. _dX-window: + +.. index:: + pair: driver; DirectX windowed + pair: platform; Windows + +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 :ref:`win32 driver +<win32>`. If you have DirectX installed, this driver is used by default. It has +almost the same behaviour as the :ref:`win32 driver <win32>` 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 +:ref:`win32 driver <win32>` 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. diff --git a/help/rest/defpalette.txt b/help/rest/defpalette.txt new file mode 100644 index 0000000..4b08ae9 --- /dev/null +++ b/help/rest/defpalette.txt @@ -0,0 +1,20 @@ +.. _defpalette: + +.. index:: + pair: menu item; Default palette + pair: command line option; defaultpalette + pair: command; defaultpalette + +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 :ref:`palette emulation filter +<palettef>` first. + +**Available as**: menu item, command line option, command diff --git a/help/rest/devel.txt b/help/rest/devel.txt new file mode 100644 index 0000000..e51596f --- /dev/null +++ b/help/rest/devel.txt @@ -0,0 +1,20 @@ +.. _devel: + +.. index:: Development + +If you want to do some development, you are encouraged to send your work back +to the :ref:`authors <about>`; if it is well done, it will be added to the next +release. All changes should be submitted to the SourceForge patch tracker: +http://sourceforge.net/tracker/?group_id=5771&atid=305771 + +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. + + +.. toctree:: + + writehelp + xaosdev + addformula diff --git a/help/rest/display.txt b/help/rest/display.txt new file mode 100644 index 0000000..1d74885 --- /dev/null +++ b/help/rest/display.txt @@ -0,0 +1,15 @@ +.. _display: + +.. index:: + pair: menu item; Display fractal + pair: 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 diff --git a/help/rest/drivers.txt b/help/rest/drivers.txt new file mode 100644 index 0000000..aec5442 --- /dev/null +++ b/help/rest/drivers.txt @@ -0,0 +1,19 @@ +.. _drivers: + +.. index:: Platforms, 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. + +.. toctree:: + + cocoa + win32 + dX-window + dX-fullscreen + X11 + aa diff --git a/help/rest/dynamic.txt b/help/rest/dynamic.txt new file mode 100644 index 0000000..85b5e8a --- /dev/null +++ b/help/rest/dynamic.txt @@ -0,0 +1,36 @@ +.. _dynamic: +.. _nodynamic: +.. _dynamicanimation: +.. _dynamicnew: +.. _fastmode: + +.. index:: + pair: menu item; Dynamic resolution + pair: command line option; fastmode + pair: command; 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 diff --git a/help/rest/edge.txt b/help/rest/edge.txt new file mode 100644 index 0000000..eb185f3 --- /dev/null +++ b/help/rest/edge.txt @@ -0,0 +1,20 @@ +.. _edge: + +.. index:: + pair: command line option; edge + pair: menu item; Edge detection + pair: filter; Edge detection + +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 +:ref:`edge detection2 <edge2>` makes thinner lines, for the low resolution +modes. + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/edge2.txt b/help/rest/edge2.txt new file mode 100644 index 0000000..1a8253f --- /dev/null +++ b/help/rest/edge2.txt @@ -0,0 +1,20 @@ +.. _edge2: + +.. index:: + pair: command line option; edge2 + pair: menu item; Edge detection2 + pair: filter; Edge detection2 + +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 +:ref:`edge detection <edge>` makes thinner lines, for the high resolution +modes. + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/edit.txt b/help/rest/edit.txt new file mode 100644 index 0000000..7d54a16 --- /dev/null +++ b/help/rest/edit.txt @@ -0,0 +1,16 @@ +.. _edit: + +.. index:: + pair: menu; Edit + +Edit +==== + +A fairly ordinary Edit menu. + +.. toctree:: + + undo + redo + copy + paste diff --git a/help/rest/emboss.txt b/help/rest/emboss.txt new file mode 100644 index 0000000..393fbd6 --- /dev/null +++ b/help/rest/emboss.txt @@ -0,0 +1,17 @@ +.. _emboss: + +.. index:: + pair: command line option; emboss + pair: menu item; Emboss + pair: filter; 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 +:ref:`outcoloring mode <outcoloring>`. + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/fastjulia.txt b/help/rest/fastjulia.txt new file mode 100644 index 0000000..fd5b7f6 --- /dev/null +++ b/help/rest/fastjulia.txt @@ -0,0 +1,23 @@ +.. _fastjulia: + +.. index:: + pair: menu item; Fast Julia mode + pair: command line option; fastjulia + pair: 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 +:ref:`Julia mode <uimandelbrot>` to see the exact image. + +**Available as**: menu item, command line option, command diff --git a/help/rest/file.txt b/help/rest/file.txt new file mode 100644 index 0000000..c1e3cee --- /dev/null +++ b/help/rest/file.txt @@ -0,0 +1,18 @@ +.. _file: + +.. index:: + pair: menu; File + +File +==== + +.. toctree:: + + loadpos + savepos + record + play + saveimg + loadexample + savecfg + quit diff --git a/help/rest/filter.txt b/help/rest/filter.txt new file mode 100644 index 0000000..b2c09c6 --- /dev/null +++ b/help/rest/filter.txt @@ -0,0 +1,54 @@ +.. _filter: + +.. index:: + pair: command; filter + +Filter command +============== + +**Syntax**:(filter keyword bool) + +This command is used to enable or disable :ref:`filters <mfilter>`. The +**keyword** specifies the filter to change, and should be one of the following: + +'edge + + :ref:`Edge detection <edge>` + +'edge2 + + :ref:`Edge detection2 <edge2>` + +'starfield + + :ref:`Starfield <starfield>` + +'stereogram + + :ref:`Random dot stereogram <stereogram>` + +'interlace + + :ref:`Interlace filter <interlace>` + +'blur + + :ref:`Motion blur <blur>` + +'emboss + + :ref:`Emboss <emboss>` + +'palette + + :ref:`Palette emulator <palette>` + +'anti + + :ref:`Antialiasing <anti>` + +'truecolor + + :ref:`Truecolor <truecolor>` + +**Available as**: command diff --git a/help/rest/format.txt b/help/rest/format.txt new file mode 100644 index 0000000..1972704 --- /dev/null +++ b/help/rest/format.txt @@ -0,0 +1,136 @@ +.. _format: + +.. index:: + pair: file; format + +File Format +=========== + +.. highlight:: scheme + +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 :ref:`XaoS registry <menus>`. You may particularly want to +read about the :ref:`animation functions <animf>`. 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)
\ No newline at end of file diff --git a/help/rest/formula.txt b/help/rest/formula.txt new file mode 100644 index 0000000..964d0f9 --- /dev/null +++ b/help/rest/formula.txt @@ -0,0 +1,53 @@ +.. _formula: + +.. index:: + pair: command; formula + +Formula +======= + +**Syntax**:(formula keyword) + +Set the current fractal formula. keyword should be one of the following: + +'mandel + + Standard :ref:`Mandelbrot set <mandel>`. + +'mandel3 + + :ref:`Mandelbrot set, power 3 <mandel3>`. + +'mandel4 + + Mandelbrot set, power 4. + +'mandel5 + + Mandelbrot set, power 5. + +'mandel6 + + Mandelbrot set, power 6. + +'newton + + :ref:`Newton's approximation method <newton>`. + +'barnsley + + :ref:`First Barnsley's formula <barnsley>`. + +'octo + + :ref:`Fractint's octo <octal>`. + +'phoenix + + :ref:`Phoenix <phoenix>`. + +'magnet + + :ref:`Magnet <magnet>`. + +**Available as**: command diff --git a/help/rest/fractal.txt b/help/rest/fractal.txt new file mode 100644 index 0000000..2febdaa --- /dev/null +++ b/help/rest/fractal.txt @@ -0,0 +1,24 @@ +.. _fractal: + +.. index:: + pair: menu; 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. + +.. toctree:: + + formula + mformula + incoloring + outcoloring + plane + palettemenu + uimandelbrot + uiperturbation + uiview + initstate + tcolor diff --git a/help/rest/gpl.txt b/help/rest/gpl.txt new file mode 100644 index 0000000..ad2fb87 --- /dev/null +++ b/help/rest/gpl.txt @@ -0,0 +1,349 @@ +.. _gpl: + +.. index:: + pair: license; GPL + +GNU GENERAL PUBLIC LICENSE +========================== + +Version 2, June 1991 + +:: + + + Copyright © 1989, 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 Lesser 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. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION +``````````````````````````````````````````````````````````````` + +1. 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. + +2. 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. + +3. 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. + +4. 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, + + c. 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. + +5. 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. + +6. 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. + +7. 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. + +8. 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. + +9. 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. + +10. 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. + +11. 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. + +12. 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. + +13. 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. + +Appendix: 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) yyyy 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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) year 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 Lesser General Public License instead of this +License. diff --git a/help/rest/helpmenu.txt b/help/rest/helpmenu.txt new file mode 100644 index 0000000..b17fd11 --- /dev/null +++ b/help/rest/helpmenu.txt @@ -0,0 +1,9 @@ +.. _helpmenu: + +.. index:: + pair: menu; Help + +Help +==== + +This menu contains help and tutorials. diff --git a/help/rest/incoloring.txt b/help/rest/incoloring.txt new file mode 100644 index 0000000..80eff95 --- /dev/null +++ b/help/rest/incoloring.txt @@ -0,0 +1,87 @@ +.. _incoloring: +.. _mincoloring: +.. _in1: +.. _in2: +.. _in3: +.. _in4: +.. _in5: +.. _in6: +.. _in7: +.. _in8: +.. _in9: +.. _in10: +.. _in0: + +.. index:: + pair: command line option; incoloring + pair: command; incoloring + pair: menu; Incoloring mode + +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 :tutor:`tutorial on incoloring <incolor.xaf>` 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, +:ref:`truecolor <tcolor>` 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 + :ref:`tcolor <tcolor>` command. + +**Available as**: command line option, command diff --git a/help/rest/index.txt b/help/rest/index.txt new file mode 100644 index 0000000..3f43a52 --- /dev/null +++ b/help/rest/index.txt @@ -0,0 +1,42 @@ +.. _main: + +XaoS +==== + +Welcome to XaoS - a real-time fractal zoomer. + +| :ref:`About XaoS <about>` +| Learn who's behind XaoS and how you can help. +| +| :ref:`Getting started <start>` +| Start here to learn how to use XaoS's basic features. +| +| :ref:`Getting support <support>` +| How to report problems and get help from the XaoS community. +| +| :ref:`User formulas <sffe>` +| Learn how to render your own formulas in XaoS. +| +| :ref:`Encoding videos <video>` +| Learn how to create videos from your XaoS animations. +| +| :ref:`Platform-specific documentation <drivers>` +| XaoS runs on many platforms. Read instructions specific to yours. +| +| :ref:`XaoS's file format <format>` +| Learn how to tweak your saved fractals and animations. +| +| :ref:`Menus, commands and parameter index <menus>` +| An in-depth discussion of all of XaoS's commands. + +.. toctree:: + + about + controls + tutorial + support + sffe + video + format + drivers + menus
\ No newline at end of file diff --git a/help/rest/initstate.txt b/help/rest/initstate.txt new file mode 100644 index 0000000..2c49876 --- /dev/null +++ b/help/rest/initstate.txt @@ -0,0 +1,18 @@ +.. _initstate: + +.. index:: + pair: menu item; Reset to defaults + pair: command line option; initstate + pair: 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 diff --git a/help/rest/interlace.txt b/help/rest/interlace.txt new file mode 100644 index 0000000..641d146 --- /dev/null +++ b/help/rest/interlace.txt @@ -0,0 +1,17 @@ +.. _interlace: + +.. index:: + pair: command line option; interlace + pair: menu item; Interlace + pair: filter; 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. + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/interrupt.txt b/help/rest/interrupt.txt new file mode 100644 index 0000000..b46d885 --- /dev/null +++ b/help/rest/interrupt.txt @@ -0,0 +1,16 @@ +.. _interrupt: +.. _animinterrupt: + +.. index:: + pair: menu item; Interrupt + pair: command line option; interrupt + pair: command; interrupt + +Interrupt +========= + +**Syntax**:(interrupt) + +Interrupt current calculation. + +**Available as**: menu item, command line option, command diff --git a/help/rest/letterspersec.txt b/help/rest/letterspersec.txt new file mode 100644 index 0000000..4adb5b7 --- /dev/null +++ b/help/rest/letterspersec.txt @@ -0,0 +1,17 @@ +.. _letterspersec: +.. _animletterspersec: + +.. index:: + pair: command line option; letterspersec + pair: command; letterspersec + +Letters per second +================== + +**Syntax**:(letterspersec integer) + +Speed of subtitles for the :ref:`textsleep <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 diff --git a/help/rest/line.txt b/help/rest/line.txt new file mode 100644 index 0000000..2f3e587 --- /dev/null +++ b/help/rest/line.txt @@ -0,0 +1,16 @@ +.. _line: + +.. index:: + pair: command; 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
\ No newline at end of file diff --git a/help/rest/linekey.txt b/help/rest/linekey.txt new file mode 100644 index 0000000..3b61e5c --- /dev/null +++ b/help/rest/linekey.txt @@ -0,0 +1,13 @@ +.. _linekey: + +.. index:: + pair: command; linekey + +Set line key +============ + +**Syntax**:(linekey integer) + +Set current line key. + +**Available as**: command diff --git a/help/rest/linemenu.txt b/help/rest/linemenu.txt new file mode 100644 index 0000000..32c630a --- /dev/null +++ b/help/rest/linemenu.txt @@ -0,0 +1,49 @@ +.. _linemenu: +.. _line: + +.. index:: + pair: functions; Line drawing + pair: command; line + +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 ":tutor:`Introduction to fractals <intro.xaf>`" 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 :ref:`color <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. + +.. toctree:: + + line + morphline + morphlastline + linekey + clearline + clearlines diff --git a/help/rest/load.txt b/help/rest/load.txt new file mode 100644 index 0000000..205f981 --- /dev/null +++ b/help/rest/load.txt @@ -0,0 +1,15 @@ +.. _load: + +.. index:: + pair: command; 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 diff --git a/help/rest/loadexample.txt b/help/rest/loadexample.txt new file mode 100644 index 0000000..55c7dd0 --- /dev/null +++ b/help/rest/loadexample.txt @@ -0,0 +1,16 @@ +.. _loadexample: + +.. index:: + pair: menu item; Load random example + pair: command line option; loadexample + pair: 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 diff --git a/help/rest/loadpos.txt b/help/rest/loadpos.txt new file mode 100644 index 0000000..744cef1 --- /dev/null +++ b/help/rest/loadpos.txt @@ -0,0 +1,13 @@ +.. _loadpos: + +.. index:: + pair: menu item; Load + pair: command line option; loadpos + +Load XaoS position file +======================= + +Load a XaoS position file (\*.xpf). See the :ref:`format description <format>` +for more information. + +**Available as**: menu item, command line option diff --git a/help/rest/magnet.txt b/help/rest/magnet.txt new file mode 100644 index 0000000..6665de8 --- /dev/null +++ b/help/rest/magnet.txt @@ -0,0 +1,15 @@ +.. _magnet: + +.. index:: + pair: menu item; Magnet + pair: command line option; magnet + pair: formula; 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 :tutor:`tutorial chapter <phoenix.xaf>`. + +**Available as**: menu item, command line option diff --git a/help/rest/mandel.txt b/help/rest/mandel.txt new file mode 100644 index 0000000..f233d42 --- /dev/null +++ b/help/rest/mandel.txt @@ -0,0 +1,14 @@ +.. _mandel: + +.. index:: + pair: menu item; Mandelbrot + pair: command line option; mandel + pair: formula; Mandelbrot + +Mandelbrot +========== + +The Mandelbrot set is the most famous escape time fractal ever. It has the +simple formula z=z^2+c. See the :tutor:`tutorial chapter <mset.xaf>`. + +**Available as**: menu item, command line option diff --git a/help/rest/mandel3.txt b/help/rest/mandel3.txt new file mode 100644 index 0000000..37f40f0 --- /dev/null +++ b/help/rest/mandel3.txt @@ -0,0 +1,33 @@ +.. _mandel3: +.. _mandel4: +.. _mandel5: +.. _mandel6: +.. _mandel9: + +.. index:: + pair: menu item; Mandelbrot^3 + pair: formula; Mandelbrot^3 + pair: command line option; mandel3 + pair: menu item; Mandelbrot^4 + pair: formula; Mandelbrot^4 + pair: command line option; mandel4 + pair: menu item; Mandelbrot^5 + pair: formula; Mandelbrot^5 + pair: command line option; mandel5 + pair: menu item; Mandelbrot^6 + pair: formula; Mandelbrot^6 + pair: command line option; mandel6 + pair: menu item; Mandelbrot^9 + pair: formula; Mandelbrot^9 + pair: command line option; mandel9 + +Mandelbrot^3--Mandelbrot^6 +========================== + +This fractal is a simple modification of the standard :ref:`Mandelbrot set +<mandel>` 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 :tutor:`tutorial chapter <power.xaf>`. + +**Available as**: menu item, command line option diff --git a/help/rest/maxiter.txt b/help/rest/maxiter.txt new file mode 100644 index 0000000..2cb56fa --- /dev/null +++ b/help/rest/maxiter.txt @@ -0,0 +1,30 @@ +.. _maxiter: + +.. index:: + pair: menu item; Iterations + pair: command line option; maxiter + pair: 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 ":tutor:`Escape time fractals <escape.xaf>`" 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 diff --git a/help/rest/menus.txt b/help/rest/menus.txt new file mode 100644 index 0000000..2136529 --- /dev/null +++ b/help/rest/menus.txt @@ -0,0 +1,17 @@ +.. _menus: + +.. index:: Menus, Functions, Command Line Parameters + +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. + +.. toctree:: + + root + animroot + plc diff --git a/help/rest/message.txt b/help/rest/message.txt new file mode 100644 index 0000000..5f75275 --- /dev/null +++ b/help/rest/message.txt @@ -0,0 +1,17 @@ +.. _message: + +.. index:: + pair: command line option; message + pair: command; message + +Message +======= + +**Syntax**:(message string) + +This function is almost identical to the :ref:`text <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 diff --git a/help/rest/mfilter.txt b/help/rest/mfilter.txt new file mode 100644 index 0000000..0181a9e --- /dev/null +++ b/help/rest/mfilter.txt @@ -0,0 +1,27 @@ +.. _mfilter: + +.. index:: + pair: menu; Filters + +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 +:tutor:`tutorial chapter <filter.xaf>` about them. + +.. toctree:: + :maxdepth: 2 + + filter + edge + edge2 + starfield + stereogram + interlace + blur + emboss + palettef + anti + truecolor diff --git a/help/rest/mformula.txt b/help/rest/mformula.txt new file mode 100644 index 0000000..cd3159a --- /dev/null +++ b/help/rest/mformula.txt @@ -0,0 +1,20 @@ +.. _mformula: + +.. index:: + pair: menu; Formulae + +formulae +======== + +Each escape time fractal has its own formula. XaoS supports the following +formulae: + +.. toctree:: + + mandel + mandel3 + octal + newton + barnsley + phoenix + magnet diff --git a/help/rest/ministatus.txt b/help/rest/ministatus.txt new file mode 100644 index 0000000..478e819 --- /dev/null +++ b/help/rest/ministatus.txt @@ -0,0 +1,17 @@ +.. _ministatus: +.. _animministatus: + +.. index:: + pair: menu item; Ministatus + pair: command line option; ministatus + pair: command; ministatus + +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 diff --git a/help/rest/misc.txt b/help/rest/misc.txt new file mode 100644 index 0000000..e34db66 --- /dev/null +++ b/help/rest/misc.txt @@ -0,0 +1,22 @@ +.. _misc: + +.. index:: + pair: menu; Misc + +Misc +==== + +Miscellaneous functions. + +.. toctree:: + + command + renderanim + clearscreen + display + text + color + xtextpos + ytextpos + textposition + message diff --git a/help/rest/morphangle.txt b/help/rest/morphangle.txt new file mode 100644 index 0000000..fdbccd2 --- /dev/null +++ b/help/rest/morphangle.txt @@ -0,0 +1,24 @@ +.. _morphangle: + +.. index:: + pair: 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 :ref:`fast rotate mode <rotate>`. 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 diff --git a/help/rest/morphjulia.txt b/help/rest/morphjulia.txt new file mode 100644 index 0000000..7db837d --- /dev/null +++ b/help/rest/morphjulia.txt @@ -0,0 +1,19 @@ +.. _morphjulia: + +.. index:: + pair: command; morphjulia + +Morph Julia +=========== + +**Syntax**:(morphjulia complex) For the time selected by the next :ref:`usleep +<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 :ref:`fast Julia mode +<fastjulia>`. + +A simple animation morphing Julia seed in the X axis: + +(initstate) (fastjulia #t) (juliaseed -2 0) (morphjulia 2 0) (usleep 2000000) + +**Available as**: command diff --git a/help/rest/morphlastline.txt b/help/rest/morphlastline.txt new file mode 100644 index 0000000..d21f319 --- /dev/null +++ b/help/rest/morphlastline.txt @@ -0,0 +1,16 @@ +.. _morphlastline: + +.. index:: + pair: command; morphlastline + +Morph last line +--------------- + +**Syntax**:(morphlastline keyword complex complex) + +This function has the same functionality as :ref:`morphline <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 +:ref:`linekey <linekey>` back. + +**Available as**: command diff --git a/help/rest/morphline.txt b/help/rest/morphline.txt new file mode 100644 index 0000000..9673b76 --- /dev/null +++ b/help/rest/morphline.txt @@ -0,0 +1,16 @@ +.. _morphline: + +.. index:: + pair: 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 :ref:`timing command <time>`, and reach the final +position before the end of it. This function also increases the line key. + +**Available as**: command diff --git a/help/rest/morphview.txt b/help/rest/morphview.txt new file mode 100644 index 0000000..1493852 --- /dev/null +++ b/help/rest/morphview.txt @@ -0,0 +1,33 @@ +.. _morphview: + +.. index:: + pair: command; morphview + +Morph view +========== + +**Syntax**:(morphview float float float float) For the time selected by the +next :ref:`usleep <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 +:ref:`view <uiview>` 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 diff --git a/help/rest/moveview.txt b/help/rest/moveview.txt new file mode 100644 index 0000000..fe398a5 --- /dev/null +++ b/help/rest/moveview.txt @@ -0,0 +1,13 @@ +.. _moveview: + +.. index:: + pair: command; moveview + +Move view +========= + +**Syntax**:(moveview complex) + +Smoothly move the image center to another position. + +**Available as**: command diff --git a/help/rest/newton.txt b/help/rest/newton.txt new file mode 100644 index 0000000..90e7c7f --- /dev/null +++ b/help/rest/newton.txt @@ -0,0 +1,19 @@ +.. _newton: + +.. index:: + pair: menu item; Newton + pair: command line option; newton + pair: formula; 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 :tutor:`tutorial chapter <newton.xaf>`. + +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 diff --git a/help/rest/nogui.txt b/help/rest/nogui.txt new file mode 100644 index 0000000..68ec5f1 --- /dev/null +++ b/help/rest/nogui.txt @@ -0,0 +1,17 @@ +.. _nogui: + +.. index:: + pair: command line option; nogui + pair: 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**: command line option, command diff --git a/help/rest/octal.txt b/help/rest/octal.txt new file mode 100644 index 0000000..49aa3f2 --- /dev/null +++ b/help/rest/octal.txt @@ -0,0 +1,15 @@ +.. _octal: + +.. index:: + pair: menu item; Octal + pair: command line option; octal + pair: formula; Octal + +Octal +===== + +This is a less well-known fractal that Thomas discovered in Fractint. It has an +interesting shape when displayed in the alternative :ref:`planes <mplane>`. See +the :tutor:`tutorial chapter <octo.xaf>`. + +**Available as**: menu item, command line option diff --git a/help/rest/outcoloring.txt b/help/rest/outcoloring.txt new file mode 100644 index 0000000..ad26779 --- /dev/null +++ b/help/rest/outcoloring.txt @@ -0,0 +1,92 @@ +.. _outcoloring: +.. _moutcoloring: +.. _out1: +.. _out2: +.. _out3: +.. _out4: +.. _out5: +.. _out6: +.. _out7: +.. _out8: +.. _out9: +.. _out10: +.. _out0: + +.. index:: + pair: command line option; outcoloring + pair: command; outcoloring + pair: menu; Outcoloring mode + +Outside coloring mode +===================== + +**Syntax**:(outcoloring integer) + +Outcoloring modes are similar to :ref:`incoloring modes <incoloring>`, 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 :tutor:`tutorial on outcoloring <outcolor.xaf>` 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, :ref:`truecolor <tcolor>` 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 :ref:`outtcoloring <tcolor>`. + +**Available as**: command line option, command diff --git a/help/rest/palette.txt b/help/rest/palette.txt new file mode 100644 index 0000000..15f861d --- /dev/null +++ b/help/rest/palette.txt @@ -0,0 +1,39 @@ +.. _palette: + +.. index:: + pair: menu item; Custom palette + pair: command line option; palette + pair: 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 +:ref:`palette emulation filter <palettef>` first. + +**Available as**: menu item, command line option, command
\ No newline at end of file diff --git a/help/rest/palettef.txt b/help/rest/palettef.txt new file mode 100644 index 0000000..54e0b9e --- /dev/null +++ b/help/rest/palettef.txt @@ -0,0 +1,21 @@ +.. _palettef: + +.. index:: + pair: menu item; Palette emulator + pair: command line option; palette + pair: filter; Palette emulator + +Palette emulator +================ + +XaoS can work in either palette or :ref:`truecolor <truecolor>` mode. Both +modes have advantages and disadvantages. Palette mode allows effects such as +palette rotation, while truecolor mode allows smoother :ref:`incoloring +<incoloring>` and :ref:`outcoloring <outcoloring>` modes and the +:ref:`truecolor coloring <tcolor>` 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). + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/palettemenu.txt b/help/rest/palettemenu.txt new file mode 100644 index 0000000..d236a96 --- /dev/null +++ b/help/rest/palettemenu.txt @@ -0,0 +1,18 @@ +.. _palettemenu: + +.. index:: + pair: menu; Palette + +Palette +======= + +This menu contains functions to change the palette the fractal is displayed +with. + +.. toctree:: + + defpalette + randompalette + palette + cycling + shiftpalette diff --git a/help/rest/paste.txt b/help/rest/paste.txt new file mode 100644 index 0000000..e83c7c4 --- /dev/null +++ b/help/rest/paste.txt @@ -0,0 +1,13 @@ +.. _paste: + +.. index:: + pair: 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 diff --git a/help/rest/periodicity.txt b/help/rest/periodicity.txt new file mode 100644 index 0000000..8f700b2 --- /dev/null +++ b/help/rest/periodicity.txt @@ -0,0 +1,44 @@ +.. _periodicity: + +.. index:: + pair: menu item; Periodicity checking + pair: command line option; periodicity + pair: command; periodicity + +Periodicity checking +==================== + +**Syntax**:(periodicity bool) + +Periodicity checking is one way to speed up the calculation. Areas inside the +set always need :ref:`maxiter <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). + +Implementing 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 +:ref:`incoloring <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 ":tutor:`Escape time fractals <escape.xaf>`" 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 diff --git a/help/rest/phoenix.txt b/help/rest/phoenix.txt new file mode 100644 index 0000000..c409017 --- /dev/null +++ b/help/rest/phoenix.txt @@ -0,0 +1,13 @@ +.. _phoenix: + +.. index:: + pair: menu item; Phoenix + pair: command line option; phoenix + pair: formula; Phoenix + +Phoenix +======= + +This formula produces very nice Julia sets. See the :tutor:`tutorial chapter <phoenix.xaf>`. + +**Available as**: menu item, command line option diff --git a/help/rest/plane.txt b/help/rest/plane.txt new file mode 100644 index 0000000..5a28610 --- /dev/null +++ b/help/rest/plane.txt @@ -0,0 +1,83 @@ +.. _plane: +.. _mplane: +.. _plane0: +.. _plane1: +.. _plane2: +.. _plane3: +.. _plane4: +.. _plane5: +.. _plane6: +.. _plane7: +.. _plane8: +.. _plane9: +.. _plane10: + +.. index:: + pair: command line option; plane + pair: command; plane + +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 :tutor:`tutorial about planes <plane.xaf>` 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 diff --git a/help/rest/play.txt b/help/rest/play.txt new file mode 100644 index 0000000..e9fffb8 --- /dev/null +++ b/help/rest/play.txt @@ -0,0 +1,12 @@ +.. _play: + +.. index:: + pair: menu item; Replay + pair: command line option; play + +Replay animation +================ + +Replay a XaoS animation file (.xaf). + +**Available as**: menu item, command line option diff --git a/help/rest/plc.txt b/help/rest/plc.txt new file mode 100644 index 0000000..df9f44c --- /dev/null +++ b/help/rest/plc.txt @@ -0,0 +1,17 @@ +.. _plc: + +.. index:: + pair: functions; Replay only + +Replay only commands +==================== + +Some commands, such as timing primitives or animation functions, are available +only in animation files. + +.. toctree:: + + linemenu + animf + time + load diff --git a/help/rest/quit.txt b/help/rest/quit.txt new file mode 100644 index 0000000..b238c59 --- /dev/null +++ b/help/rest/quit.txt @@ -0,0 +1,17 @@ +.. _quit: +.. _quitmenu: +.. _noquit: + +.. index:: + pair: menu item; Quit + pair: command line option; quit + pair: command; quit + +Quit +==== + +**Syntax**:(quit) + +Quit XaoS. + +**Available as**: menu item, command line option, command diff --git a/help/rest/randompalette.txt b/help/rest/randompalette.txt new file mode 100644 index 0000000..fceb7c5 --- /dev/null +++ b/help/rest/randompalette.txt @@ -0,0 +1,20 @@ +.. _randompalette: + +.. index:: + pair: menu item; Random palette + pair: command line option; randompalette + pair: 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 :ref:`palette emulation filter +<palettef>` first. + +**Available as**: menu item, command line option, command diff --git a/help/rest/range.txt b/help/rest/range.txt new file mode 100644 index 0000000..6d10027 --- /dev/null +++ b/help/rest/range.txt @@ -0,0 +1,32 @@ +.. _range: +.. _mguess: +.. _guess0: +.. _guess1: +.. _guess2: +.. _guess3: +.. _guess4: +.. _guess5: +.. _guess6: +.. _guess7: +.. _guess8: +.. _guess9: +.. _guessall: + +.. index:: + pair: command line option; range + pair: command; range + pair: menu; Solid guessing + +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 diff --git a/help/rest/recalculate.txt b/help/rest/recalculate.txt new file mode 100644 index 0000000..88f8ba6 --- /dev/null +++ b/help/rest/recalculate.txt @@ -0,0 +1,17 @@ +.. _recalculate: + +.. index:: + pair: menu item; Recalculate + pair: command line option; recalculate + pair: 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 :ref:`solid guessing +<range>`. + +**Available as**: menu item, command line option, command diff --git a/help/rest/record.txt b/help/rest/record.txt new file mode 100644 index 0000000..4cdf5ab --- /dev/null +++ b/help/rest/record.txt @@ -0,0 +1,20 @@ +.. _record: + +.. index:: + pair: menu item; Record + pair: command line option; record + pair: 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 +:ref:`format description <format>` for more information. + +From the scripting language, (record #t) enables recording, and (record #f) +disables it. + +**Available as**: menu item, command line option, command diff --git a/help/rest/redo.txt b/help/rest/redo.txt new file mode 100644 index 0000000..c93d644 --- /dev/null +++ b/help/rest/redo.txt @@ -0,0 +1,11 @@ +.. _redo: + +.. index:: + pair: menu item; Redo + +Redo +==== + +Redo last undone operation. See :ref:`undo <undo>`. + +**Available as**: menu item diff --git a/help/rest/renderanim.txt b/help/rest/renderanim.txt new file mode 100644 index 0000000..e4573bf --- /dev/null +++ b/help/rest/renderanim.txt @@ -0,0 +1,12 @@ +.. _renderanim: + +.. index:: + pair: menu item; Render animation + +Render animation +================ + +Render an animation to image files. See :ref:`How to encode video files <video>` +for more information. + +**Available as**: menu item, diff --git a/help/rest/rest.pri b/help/rest/rest.pri new file mode 100644 index 0000000..268939c --- /dev/null +++ b/help/rest/rest.pri @@ -0,0 +1,134 @@ +OTHER_FILES += \
+ X11.txt \
+ aa.txt \
+ about.txt \
+ addformula.txt \
+ animateview.txt \
+ animf.txt \
+ animroot.txt \
+ anti.txt \
+ autopilot.txt \
+ background.txt \
+ bailout.txt \
+ barnsley.txt \
+ blur.txt \
+ calc.txt \
+ clearline.txt \
+ clearlines.txt \
+ clearscreen.txt \
+ cocoa.txt \
+ color.txt \
+ command.txt \
+ controls.txt \
+ copy.txt \
+ cycling.txt \
+ dX-fullscreen.txt \
+ dX-window.txt \
+ defpalette.txt \
+ devel.txt \
+ display.txt \
+ drivers.txt \
+ dynamic.txt \
+ edge.txt \
+ edge2.txt \
+ edit.txt \
+ emboss.txt \
+ fastjulia.txt \
+ file.txt \
+ filter.txt \
+ format.txt \
+ formula.txt \
+ fractal.txt \
+ gpl.txt \
+ helpmenu.txt \
+ incoloring.txt \
+ index.txt \
+ initstate.txt \
+ interlace.txt \
+ interrupt.txt \
+ letterspersec.txt \
+ line.txt \
+ linekey.txt \
+ linemenu.txt \
+ load.txt \
+ loadexample.txt \
+ loadpos.txt \
+ magnet.txt \
+ mandel.txt \
+ mandel3.txt \
+ maxiter.txt \
+ menus.txt \
+ message.txt \
+ mfilter.txt \
+ mformula.txt \
+ ministatus.txt
+ misc.txt \
+ morphangle.txt \
+ morphjulia.txt \
+ morphlastline.txt \
+ morphline.txt \
+ morphview.txt \
+ moveview.txt \
+ newton.txt \
+ nogui.txt \
+ octal.txt \
+ outcoloring.txt \
+ palette.txt \
+ palettef.txt \
+ palettemenu.txt \
+ paste.txt \
+ periodicity.txt \
+ phoenix.txt \
+ plane.txt \
+ play.txt \
+ plc.txt \
+ quit.txt \
+ randompalette.txt \
+ range.txt \
+ recalculate.txt \
+ record.txt \
+ redo.txt \
+ renderanim.txt \
+ root.txt \
+ rotate.txt \
+ savecfg.txt \
+ saveimg.txt \
+ savepos.txt \
+ sffe.txt \
+ shiftpalette.txt \
+ smoothmorph.txt \
+ speed.txt \
+ starfield.txt \
+ start.txt \
+ status.txt \
+ stereogram.txt \
+ stopreplay.txt \
+ support.txt \
+ tcolor.txt \
+ text.txt \
+ textposition.txt \
+ textsleep.txt \
+ time.txt \
+ truecolor.txt \
+ tutorial.txt \
+ ui.txt \
+ uimandelbrot.txt \
+ uiperturbation.txt \
+ uiview.txt \
+ undo.txt \
+ usleep.txt \
+ video.txt \
+ volunteer.txt \
+ wait.txt \
+ win32.txt \
+ writehelp.txt \
+ xaosdev.txt \
+ xtextcenter.txt \
+ xtexteight.txt \
+ xtextleft.txt \
+ xtextpos.txt \
+ ytextbottom.txt \
+ ytextmiddle.txt \
+ ytextpos.txt \
+ ytextup.txt \
+ zoom.txt
diff --git a/help/rest/root.txt b/help/rest/root.txt new file mode 100644 index 0000000..0513923 --- /dev/null +++ b/help/rest/root.txt @@ -0,0 +1,22 @@ +.. _root: + +.. index:: + pair: menu; 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 :ref:`Animation root menu <animroot>`. + +.. toctree:: + + file + edit + fractal + calc + mfilter + ui + misc + helpmenu diff --git a/help/rest/rotate.txt b/help/rest/rotate.txt new file mode 100644 index 0000000..f77c6b4 --- /dev/null +++ b/help/rest/rotate.txt @@ -0,0 +1,57 @@ +.. _rotate: +.. _norotate: +.. _controtate: +.. _mouserotate: +.. _rotationspeed: +.. _autorotate: +.. _fastrotate: + +.. index:: + pair: menu; Rotation + pair: command line option; fastrotate + pair: command; fastrotate + pair: menu item; Continuous rotation + pair: command line option; autorotate + pair: command; autorotate + pair: menu item; Rotation speed + pair: command line option; rotationspeed + pair: command; rotationspeed + + +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 :ref:`morphangle <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 diff --git a/help/rest/savecfg.txt b/help/rest/savecfg.txt new file mode 100644 index 0000000..1294623 --- /dev/null +++ b/help/rest/savecfg.txt @@ -0,0 +1,17 @@ +.. _savecfg: + +.. index:: + pair: menu item; Save configuration + pair: command line option; savecfg + pair: 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 diff --git a/help/rest/saveimg.txt b/help/rest/saveimg.txt new file mode 100644 index 0000000..ea4ea8b --- /dev/null +++ b/help/rest/saveimg.txt @@ -0,0 +1,21 @@ +.. _saveimg: + +.. index:: + pair: menu item; Save image + pair: command line option; saveimg + pair: command; 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 diff --git a/help/rest/savepos.txt b/help/rest/savepos.txt new file mode 100644 index 0000000..3c37e77 --- /dev/null +++ b/help/rest/savepos.txt @@ -0,0 +1,18 @@ +.. _savepos: + +.. index:: + pair: menu item; Save + pair: command line option; savepos + pair: command; 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 :ref:`format description <format>` for more +information. + +**Available as**: menu item, command line option, command diff --git a/help/rest/sffe.txt b/help/rest/sffe.txt new file mode 100644 index 0000000..674300d --- /dev/null +++ b/help/rest/sffe.txt @@ -0,0 +1,79 @@ +.. _sffe: +.. _usrform: +.. _usrformInit: + +.. index:: + pair: menu item; User formula + pair: menu item; User initialization + pair: command; usrform + pair: command line option; usrform + pair: command; usrformInit + pair: command line option; usrformInit + single: sffe + +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)**. + +Variables +--------- + +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) + +Constants +--------- + +Format for complex numbers is **{re;im}** eg. {3;2} is complex number 3+2i. + + +Functions +--------- + +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 diff --git a/help/rest/shiftpalette.txt b/help/rest/shiftpalette.txt new file mode 100644 index 0000000..08ebf64 --- /dev/null +++ b/help/rest/shiftpalette.txt @@ -0,0 +1,25 @@ +.. _shiftpalette: +.. _fshift: +.. _bshift: + +.. index:: + pair: menu item; Shift palette + pair: command line option; shiftpalette + pair: command; shiftpalette + +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 :ref:`palette emulation filter +<palettef>`. + +**Available as**: menu item, command line option, command diff --git a/help/rest/smoothmorph.txt b/help/rest/smoothmorph.txt new file mode 100644 index 0000000..73d68b5 --- /dev/null +++ b/help/rest/smoothmorph.txt @@ -0,0 +1,32 @@ +.. _smoothmorph: + +.. index:: + pair: command; morphview + +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 :ref:`morphview <morphview>` + +'angle + + control :ref:`morphangle <morphangle>` + +'julia + + control :ref:`morphjulia <morphjulia>` + +'line + + control :ref:`morphline <morphline>` diff --git a/help/rest/speed.txt b/help/rest/speed.txt new file mode 100644 index 0000000..8e723a2 --- /dev/null +++ b/help/rest/speed.txt @@ -0,0 +1,39 @@ +.. _speed: +.. _speedup: +.. _maxstep: + +.. index:: + pair: menu item; Zooming speed + pair: command line option; speed + pair: command; speed + pair: command; maxstep + pair: command; speedup + +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 diff --git a/help/rest/starfield.txt b/help/rest/starfield.txt new file mode 100644 index 0000000..4104c16 --- /dev/null +++ b/help/rest/starfield.txt @@ -0,0 +1,17 @@ +.. _starfield: + +.. index:: + menu item; Starfield + command line option; starfield + filter; 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 :) + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/start.txt b/help/rest/start.txt new file mode 100644 index 0000000..0f0c74e --- /dev/null +++ b/help/rest/start.txt @@ -0,0 +1,27 @@ +.. _start: + +Getting Started +=============== + +| :ref:`Basic controls <controls>` +| Learn the basic commands to control XaoS. +| +| :tutor:`An introduction to fractals <fractal.xaf>` +| 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. +| +| :tutor:`XaoS features overview <features.xaf>` +| Watch this tutorial to discover more of XaoS's features. + +.. note:: + + 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). + +| :ref:`XaoS Overview <tutorial>` +| A written introduction to all of XaoS's features. + +.. toctree:: + :hidden: + + controls + tutorial diff --git a/help/rest/status.txt b/help/rest/status.txt new file mode 100644 index 0000000..33cb262 --- /dev/null +++ b/help/rest/status.txt @@ -0,0 +1,18 @@ +.. _status: +.. _animstatus: + +.. index:: + pair: menu item; Status + pair: command line option; status + pair: command; status + +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 diff --git a/help/rest/stereogram.txt b/help/rest/stereogram.txt new file mode 100644 index 0000000..3f48bfa --- /dev/null +++ b/help/rest/stereogram.txt @@ -0,0 +1,109 @@ +.. _stereogram: + +.. index:: + pair: menu item; Random dot stereogram + pair: command line option; stereogram + pair: filter; Random dot 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. + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/stopreplay.txt b/help/rest/stopreplay.txt new file mode 100644 index 0000000..b24bd0e --- /dev/null +++ b/help/rest/stopreplay.txt @@ -0,0 +1,11 @@ +.. _stopreplay: + +.. index:: + pair: menu item; Stop replay + +Stop replay +=========== + +Terminate animation replay. + +**Available as**: menu item diff --git a/help/rest/support.txt b/help/rest/support.txt new file mode 100644 index 0000000..73af87f --- /dev/null +++ b/help/rest/support.txt @@ -0,0 +1,70 @@ +.. _support: + +.. index:: Support, Home Page, Discussion Groups, Issue Tracker, Bugs + +Getting Support +=============== + +XaoS is a community-supported free software project. + +Home Page +--------- + +Visit the `XaoS home page`__ for the latest news and +information about XaoS and to download the latest versions. + +__ http://xaos.sourceforge.net/ + + + +Users' Discussion Group +----------------------- + +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. + +__ http://groups.google.com/group/xaos-users + +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 +encourageyou 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 +---------------------------- + +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. + +__ http://groups.google.com/group/xaos-devel + + +Issue Tracker +------------- + +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). + +__ http://code.google.com/p/gnuxaos/issues/list + +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. + diff --git a/help/rest/tcolor.txt b/help/rest/tcolor.txt new file mode 100644 index 0000000..09e5ede --- /dev/null +++ b/help/rest/tcolor.txt @@ -0,0 +1,108 @@ +.. _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: + +.. index:: + pair: menu; True-color outcoloring mode + pair: command line option; intcoloring + pair: command; intcoloring + pair: menu; True-color incoloring mode + pair: command line option; outtcoloring + pair: command; outtcoloring + +Truecolor coloring mode +======================= + +**Syntax**:(intcoloring integer) + +**Syntax**:(outtcoloring integer) + +Truecolor coloring modes are similar to :ref:`incolor <incoloring>` and +:ref:`outcolor <outcoloring>` 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 :ref:`palette +emulator filter <palettef>` first to see anything, amd the quality won't be so +good, as far fewer colors are available per parameter. + +The :tutor:`tutorial on truecolor coloring modes <truecol.xaf>` 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 diff --git a/help/rest/text.txt b/help/rest/text.txt new file mode 100644 index 0000000..edabde4 --- /dev/null +++ b/help/rest/text.txt @@ -0,0 +1,28 @@ +.. _text: + +.. index:: + pair: menu item; Display text + pair: command line option; text + pair: 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 +:ref:`clearscreen` or :ref:`display` functions. You might also want to use the +:ref:`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 :ref:`textsleep` function. + +Example:: + + (clearscreen) + (textposition 'center 'middle) + (text "Welcome into my animation") + (textsleep) + (display) + +**Available as**: menu item, command line option, command
\ No newline at end of file diff --git a/help/rest/textposition.txt b/help/rest/textposition.txt new file mode 100644 index 0000000..4863150 --- /dev/null +++ b/help/rest/textposition.txt @@ -0,0 +1,19 @@ +.. _textposition: + +.. index:: + pair: menu; Horizontal text position + pair: menu; Vertical text position + pair: command line option; textposition + pair: command; textposition + +Text position +============= + +**Syntax**:(textposition keyword keyword) + +Select :ref:`text <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 diff --git a/help/rest/textsleep.txt b/help/rest/textsleep.txt new file mode 100644 index 0000000..6143313 --- /dev/null +++ b/help/rest/textsleep.txt @@ -0,0 +1,18 @@ +.. _textsleep: + +.. index:: + pair: command; textsleep + +Wait for text +============= + +**Syntax**:(textsleep) + +This function's behavior is very similar to :ref:`usleep <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 +:ref:`letterspersec <letterspersec>`. This value can be changed during replay +with the arrow keys. + +**Available as**: command diff --git a/help/rest/time.txt b/help/rest/time.txt new file mode 100644 index 0000000..b46695b --- /dev/null +++ b/help/rest/time.txt @@ -0,0 +1,18 @@ +.. _time: + +.. index:: + pair: functions; Timing + +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. + +.. toctree:: + + usleep + textsleep + wait diff --git a/help/rest/truecolor.txt b/help/rest/truecolor.txt new file mode 100644 index 0000000..e9c6c93 --- /dev/null +++ b/help/rest/truecolor.txt @@ -0,0 +1,21 @@ +.. _truecolor: + +.. index:: + pair: menu item; Truecolor emulator + pair: command line option; truecolor + pair: filter; Truecolor emulator + +Truecolor emulator +================== + +XaoS can work in either :ref:`palette <palettef>` or truecolor mode. Both modes +have advantages and disadvantages. Palette mode allows effects such as palette +rotation, while truecolor mode allows smoother :ref:`incoloring <incoloring>` +and :ref:`outcoloring <outcoloring>` modes and the :ref:`truecolor coloring +<tcolor>` 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). + +:ref:`More information about filters <filter>` + +**Available as**: menu item, command line option diff --git a/help/rest/tutorial.txt b/help/rest/tutorial.txt new file mode 100644 index 0000000..2757a78 --- /dev/null +++ b/help/rest/tutorial.txt @@ -0,0 +1,254 @@ +.. _tutorial: + +.. index:: Tutorial, Features, Overview + +Feature Overview +================ + +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 :tutor:`Incoloring modes <incolor.xaf>` 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 :tutor:`Out-coloring modes <outcolor.xaf>` 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 :tutor:`Julia set <julia.xaf>` 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 :ref:`filters <filter>`. +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 +:ref:`palette emulator filter <palettef>` 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. diff --git a/help/rest/ui.txt b/help/rest/ui.txt new file mode 100644 index 0000000..690c882 --- /dev/null +++ b/help/rest/ui.txt @@ -0,0 +1,22 @@ +.. _ui: +.. _uia: + +.. index:: + pair: menu; UI + +UI +== + +This menu contains functions to control the user interface layer of XaoS: +zooming speed, the autopilot, realtime status information, and so on. + +.. toctree:: + + speed + letterspersec + autopilot + recalculate + interrupt + nogui + status + ministatus diff --git a/help/rest/uimandelbrot.txt b/help/rest/uimandelbrot.txt new file mode 100644 index 0000000..3edf916 --- /dev/null +++ b/help/rest/uimandelbrot.txt @@ -0,0 +1,48 @@ +.. _uimandelbrot: +.. _julia: +.. _juliaseed: + +.. index:: + pair: menu item; Mandelbrot mode + pair: command line option; julia + pair: command; julia + pair: command line option; juliaseed + pair: command; 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 :tutor:`Julia set <julia.xaf>`. + +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 :ref:`Fast Julia mode <fastjulia>`. + +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 diff --git a/help/rest/uiperturbation.txt b/help/rest/uiperturbation.txt new file mode 100644 index 0000000..4195af9 --- /dev/null +++ b/help/rest/uiperturbation.txt @@ -0,0 +1,37 @@ +.. _uiperturbation: +.. _perturbation: + +.. index:: + pair: menu item; Perturbation + pair: command line option; perturbation + pair: command; 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 +:ref:`Mandelbrot set <mandel>`) and only then in :ref:`Mandelbrot mode +<uimandelbrot>`. + +**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 diff --git a/help/rest/uiview.txt b/help/rest/uiview.txt new file mode 100644 index 0000000..7db5c18 --- /dev/null +++ b/help/rest/uiview.txt @@ -0,0 +1,56 @@ +.. _uiview: +.. _view: +.. _angle: + +.. index:: + pair: menu item; View + pair: command line option; view + pair: command; view + pair: command line option; angle + pair: command; 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 :ref:`fast rotation mode <rotate>`, 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 diff --git a/help/rest/undo.txt b/help/rest/undo.txt new file mode 100644 index 0000000..e93948a --- /dev/null +++ b/help/rest/undo.txt @@ -0,0 +1,13 @@ +.. _undo: + +.. index:: + pair: menu item; 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 diff --git a/help/rest/usleep.txt b/help/rest/usleep.txt new file mode 100644 index 0000000..dfe4b54 --- /dev/null +++ b/help/rest/usleep.txt @@ -0,0 +1,16 @@ +.. _usleep: + +.. index: + pair: command; 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 diff --git a/help/rest/video.txt b/help/rest/video.txt new file mode 100644 index 0000000..bc4adf3 --- /dev/null +++ b/help/rest/video.txt @@ -0,0 +1,99 @@ +.. _video: + +.. index:: + pair: Encoding; Videos + +Encoding Videos +=============== + +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 + +* `ffmpeg home page`_ +* `ffmpeg instructions`_ + +.. _`ffmpeg home page`: + http://ffmpeg.mplayerhq.hu/ + +.. _`ffmpeg Instructions`: + http://ffmpeg.mplayerhq.hu/faq.html#SEC12 + +mencoder (part of mplayer) + +* `mplayer homepage`_ +* `mencoder instructions`_ + +.. _`mplayer homepage`: + http://www.mplayerhq.hu/ + +.. _`mencoder 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. However, this software costs approximately +US $30. Although QuickTime may be easier to use, the two free +encoders above are just as capable once you learn how to use them. + +.. _`Quicktime Pro`: + http://www.apple.com/quicktime/pro/ diff --git a/help/rest/volunteer.txt b/help/rest/volunteer.txt new file mode 100644 index 0000000..1ef88d9 --- /dev/null +++ b/help/rest/volunteer.txt @@ -0,0 +1,36 @@ +.. _volunteer: + +.. index:: + pair: Volunteer; Opportunities + +Volunteer Opportunities +======================= + +XaoS is free software. One of the most significant rights its :ref:`license +<gpl>` grants to you is the right to **freely get, study and improve** its +source code. + +In return, we need your help to make it the best fractal program it can be. +You don't have to be a programmer to contribute. The following tasks open to +volunteers: + +* Helping other users on the :ref:`forums <forums>` +* Testing new versions and :ref:`reporting bugs <bugs>` +* Creating additional tutorials and examples +* Improving the :ref:`documentation <writehelp>` +* Translating XaoS into your language +* Compiling binaries for your favorite operating system +* Reviewing and documenting the source code +* Implementing new features and fixing bugs + +All development activities are coordinated through `Google Code`__. If you want to +contribute, we recommend that you sign up for an account so that you can +use its facilities to coordinate your activites with the rest of the team. + +__ http://gnuxaos.googlecode.com/ + +Before you start, please join the `xaos-devel`__ discussion group and let us know +what you want to work on. We would be happy to help you get started! + +__ http://groups.google.com/group/xaos-devel + diff --git a/help/rest/wait.txt b/help/rest/wait.txt new file mode 100644 index 0000000..f111358 --- /dev/null +++ b/help/rest/wait.txt @@ -0,0 +1,20 @@ +.. _wait: + +.. index: + pair: 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 +:ref:`motion blur <blur>`. + +This function deadlocks if used with :ref:`animation functions <animf>`; don't +do that. + +**Available as**: command diff --git a/help/rest/win32.txt b/help/rest/win32.txt new file mode 100644 index 0000000..cc94f5b --- /dev/null +++ b/help/rest/win32.txt @@ -0,0 +1,42 @@ +.. _win32: + +.. index:: + pair: driver; Win32 + pair: platform; Windows + +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 :ref:`DirectX <dX-window>` API. + +Win32 driver was written by Jan Hubicka, Jan Olderdissen and Pavel Tzekov, +1999. diff --git a/help/rest/writehelp.txt b/help/rest/writehelp.txt new file mode 100644 index 0000000..9ea7ac6 --- /dev/null +++ b/help/rest/writehelp.txt @@ -0,0 +1,63 @@ +.. _documentation: + +.. index:: Documentation; Help; Sphinx; reStructuredText + +XaoS Documentation +================== + +XaoS documentation is generated from reStructuredText__ using the Sphinx__ +document processor. This toolchain allows the documentation to be written +using natural, unobtrusive markup and automatically converted to a number of +formats including HTML, PDF, Microsoft HTML Help, and Apple Help. + +__ http://docutils.sourceforge.net/rst.html +__ http://sphinx.pocoo.org/ + +When viewing the HTML version of the documentaiton, you can click the "Show +Source" link in the left sidebar to view the original reST source. The full +source of the documentation is also available in the `subversion repository`__. + +__ http://xaos.svn.sf.net/viewvc/xaos/trunk/help/rest/ + +If you want to contribute to the documentation, we encourage you to familarize +yourself with the `reStructuredText Primer`__. Although reStructuredText looks +very much like plain text, it follows certain conventions to enhance formatting. + +__ http://docutils.sourceforge.net/docs/user/rst/quickstart.html + +If you are only making a small change, feel free to submit it as plain text, +and the maintainers will be happy to convert it to reST for you. + +All changes to the documentation should be submitted via the `issue tracker`__. + +__ http://code.google.com/p/gnuxaos/issues/list + + +.. highlight:: rest + +Context-Sensitive Help +---------------------- + +XaoS provides context-sensitive help from many areas of the user interface. +If you are writing documentation about some command in the user interface, +you must provide a target in order to make context sensitive help work. +Place an internal hyperlink target in front of the section describing the +command using the name of the command in the XaoS function registry, like so:: + + .. _command-name: + + About My Hypothetical Command + ============================= + + This command allows you to... + + +Tutorials +--------- + +XaoS's documentation introduces an interpreted text role to reference +tutorials. To reference a tutorial from the documentation, write +``:tutor:`title <filename.xaf>```. This will refer to the tutorial +*filename.xaf* using the text *title*. Depending on the format of the +output, this may generate a link that will launch the referenced tutorial +in XaoS, or it may just format the title in a different font. diff --git a/help/rest/xaosspecific.py b/help/rest/xaosspecific.py new file mode 100644 index 0000000..134777f --- /dev/null +++ b/help/rest/xaosspecific.py @@ -0,0 +1,4 @@ +from docutils import nodes + +def setup(app): + app.add_generic_role('tutor', nodes.emphasis) diff --git a/help/rest/xtextcenter.txt b/help/rest/xtextcenter.txt new file mode 100644 index 0000000..c0f8652 --- /dev/null +++ b/help/rest/xtextcenter.txt @@ -0,0 +1,11 @@ +.. _xtextcenter: + +.. index:: + pair: menu item; Center + +Center +====== + +Draw :ref:`text <text>` in the center of the screen. + +**Available as**: menu item diff --git a/help/rest/xtexteight.txt b/help/rest/xtexteight.txt new file mode 100644 index 0000000..951c872 --- /dev/null +++ b/help/rest/xtexteight.txt @@ -0,0 +1,11 @@ +.. _xtextright: + +.. index:: + pair: menu item; Right + +Right +===== + +Draw :ref:`text <text>` at the right side of the screen. + +**Available as**: menu item diff --git a/help/rest/xtextleft.txt b/help/rest/xtextleft.txt new file mode 100644 index 0000000..dd34715 --- /dev/null +++ b/help/rest/xtextleft.txt @@ -0,0 +1,11 @@ +.. _xtextleft: + +.. index:: + pair: menu item; Left + +Left +==== + +Draw :ref:`text <text>` at the left side of the screen. + +**Available as**: menu item diff --git a/help/rest/xtextpos.txt b/help/rest/xtextpos.txt new file mode 100644 index 0000000..c48fadc --- /dev/null +++ b/help/rest/xtextpos.txt @@ -0,0 +1,16 @@ +.. _xtextpos: + +.. index:: + pair: menu; Horizontal text position + +Horizontal text position +======================== + +Select the horizontal position used to display :ref:`text <text>`. It can be +placed at the left, in the center or at the right. + +.. toctree:: + + xtextleft + xtextcenter + xtexteight diff --git a/help/rest/ytextbottom.txt b/help/rest/ytextbottom.txt new file mode 100644 index 0000000..37cf58d --- /dev/null +++ b/help/rest/ytextbottom.txt @@ -0,0 +1,11 @@ +.. _ytextbottom: + +.. index:: + pair: menu item; Bottom + +Bottom +====== + +Draw :ref:`text <text>` at the bottom of the screen. + +**Available as**: menu item diff --git a/help/rest/ytextmiddle.txt b/help/rest/ytextmiddle.txt new file mode 100644 index 0000000..680b4ef --- /dev/null +++ b/help/rest/ytextmiddle.txt @@ -0,0 +1,11 @@ +.. _ytextmiddle: + +.. index:: + pair: menu item; Middle + +Middle +====== + +Draw :ref:`text <text>` in the middle of the screen. + +**Available as**: menu item diff --git a/help/rest/ytextpos.txt b/help/rest/ytextpos.txt new file mode 100644 index 0000000..6e1616a --- /dev/null +++ b/help/rest/ytextpos.txt @@ -0,0 +1,16 @@ +.. _ytextpos: + +.. index:: + pair: menu; Vertical text position + +Vertical text position +====================== + +Select the vertical position used to display :ref:`text <text>`. It can be +placed at the top, in the middle or at the bottom of the screen. + +.. toctree:: + + ytextup + ytextmiddle + ytextbottom diff --git a/help/rest/ytextup.txt b/help/rest/ytextup.txt new file mode 100644 index 0000000..ade6b74 --- /dev/null +++ b/help/rest/ytextup.txt @@ -0,0 +1,11 @@ +.. _ytextup: + +.. index:: + menu item; Up + +Up +== + +Draw :ref:`text <text>` at the top of the screen. + +**Available as**: menu item diff --git a/help/rest/zoom.txt b/help/rest/zoom.txt new file mode 100644 index 0000000..a151a06 --- /dev/null +++ b/help/rest/zoom.txt @@ -0,0 +1,37 @@ +.. _zoom: +.. _unzoom: +.. _stop: + +.. index:: + pair: functions; Zooming + pair: command; zoomcenter + pair: command; zoom + pair: command; unzoom + pair: command; stop + +Zooming functions +================= + +The functions for zooming/unzooming were created mainly for recording +animations. In manually created animation files, it is easier to use +:ref:`morphview <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 :ref:`speed <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 diff --git a/help/restconv b/help/restconv new file mode 100755 index 0000000..fe5a55f --- /dev/null +++ b/help/restconv @@ -0,0 +1,68 @@ +#!/bin/sh +processline() +{ + echo "- $1 -" + echo "==============================================================================================" + name="$1" + anchors="" + echo "$1.txt $*" >> anchors + while [ "$1" != "" ] ; do + echo "s!\[help:$1\]!$name.html!g" >> htmllinks.sed + echo "s!\[help:$1\]!help:anchor=$name bookID=XaoS Help!g" >> applehelplinks.sed + shift + done + # I changed "0" to "$" because my sed + # doesn't want to understand "0". + # -- Zoltan + echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<HTML> +<HEAD> + <TITLE>XaoS online help</TITLE> +</HEAD> +<BODY>' > $name.html + cat $mypath/xaos.hlp | sed '1,/%'"$name"'/d;/^%/,$ d' | sed \ +'1,2s_<head>\([^<]*\)</head>_<H1>\1</H1>_g +s_<head>_<center><H2>_g +s_</head>_</H2></center>_g +s_<emph>_<strong>_g +s_<submenu>__g +s_<menuhead>__g +s_</menuhead>__g +s_<mainmenu>__g +s_<menuitems>__g +s_</menuitems>__g +s_<main>__g +s_</main>__g +s_<math>__g +s_</math>__g +s_<notex>__g +s_</notex>__g +s_<node.*>__g +s_</emph>_</strong>_g +s_<tt>_<code>_g +s_</tt>_</code>_g +s_<tutor \([^>]*\)>_<A HREF="[tutor:\1]">_g +s_</tutor>_</A>_g +s_<a \([^>]*\)>_<A HREF="\1">_g +s/'\'\''/"/g +s/``/"/g' >> $name.html + if [ $2 ]; then + echo $* >> aliases.conf + fi + echo "</BODY></HTML>" >> $name.html + cat -n $name.html + tidy -utf8 -asxml -qm $name.html + $mypath/xhtml2rest.py $name.html > $name.txt + rm $name.html +} +process() +{ + while read line ; do + eval "processline $line" + done +} +mypath=`dirname $0` +rm htmllinks.sed +rm applehelplinks.sed +rm anchors +grep "^%" $mypath/xaos.hlp | sed '/%%/d;s/%//g' | process diff --git a/help/rtfconv b/help/rtfconv new file mode 100755 index 0000000..0e23bc0 --- /dev/null +++ b/help/rtfconv @@ -0,0 +1,2 @@ +#!/bin/sh +cat xaos.hlp | sh hlp2rtf | sh multfix > xaoswin.rtf diff --git a/help/rtfconv.bat b/help/rtfconv.bat new file mode 100644 index 0000000..5fb8003 --- /dev/null +++ b/help/rtfconv.bat @@ -0,0 +1,2 @@ +bash -c "cat xaos.hlp | sh hlp2rtf | sh multfix >xaoswin.rtf"
+
\ No newline at end of file diff --git a/help/tutorial.scpt b/help/tutorial.scpt Binary files differnew file mode 100644 index 0000000..ef0283a --- /dev/null +++ b/help/tutorial.scpt diff --git a/help/winhelpconv b/help/winhelpconv new file mode 100755 index 0000000..6248c7d --- /dev/null +++ b/help/winhelpconv @@ -0,0 +1,71 @@ +#!/bin/sh +processline() +{ + echo "- $1 -" + name="$1" + anchors="<object type=\"application/x-oleobject\" classid=\"clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e\"><param name=\"ALink Name\" value=\"$1\"></object>" + title="" + stylesheet="xaoshelp.css" + shift + while [ "$1" != "" ] ; do + if [ "$1" != "$name" ] ; then + anchors="$anchors <object type=\"application/x-oleobject\" classid=\"clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e\"><param name=\"ALink Name\" value=\"\$name\"></object>" + fi + shift + done + # I changed "0" to "$" because my sed + # doesn't want to understand "0". + # -- Zoltan + cat xaos.hlp | sed '/%'"$name"'/H' | sed '1,/%'"$name"'/d;/^%/,$ d' | sed \ +'1,3s_<head>\([^<]*\)</head>_\ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\ +<HTML>\ +<HEAD>\ + <TITLE>\1</TITLE>\ + '"$title"'\ + <LINK HREF="'"$stylesheet"'" REL="stylesheet" TYPE="text/css">\ +</HEAD>\ +<BODY>\ +'"$anchors"'\ +<H1>\1</H1>\ +_g +s_<head>_<H2>_g +s_</head>_</H2>_g +s_<center>__g +s_</center>__g +s_<emph>_<STRONG>_g +s_<submenu>__g +s_<menuhead>__g +s_</menuhead>__g +s_<mainmenu>__g +s_<main>__g +s_<math>__g +s_<menuitems>__g +s_<notex>__g +s_</notex>__g +s_<node.*>__g +s_</emph>_</STRONG>_g +s_<tt>_<CODE>_g +s_</tt>_</CODE>_g +s_<tutor \([^>]*\)>_<strong>_g +s_</tutor>_</strong>_g +s_<a \([^>]*\)>_<A HREF="\1.html">_g +s/'\'\''/"/g +s/``/"/g' > $name.html + echo "</BODY></HTML>" >> $name.html + tidy -qm $name.html + case $name in + main) mv $name.html xaoshelp/index.html;; + *) mv $name.html xaoshelp;; + esac +} +process() +{ + while read line ; do + eval "processline $line" + done +} +rm -rf xaoshelp +mkdir -p xaoshelp +cp xaoshelp.css xaoshelp +grep "^%" xaos.hlp | sed '/%%/d;s/%//g' | process diff --git a/help/xaos.hlp b/help/xaos.hlp new file mode 100644 index 0000000..9953af3 --- /dev/null +++ b/help/xaos.hlp @@ -0,0 +1,3996 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%main +<head>XaoS</head> +<center> +Welcome to XaoS - a real-time fractal zoomer. +</center> + +<dl> +<dt><a about>About XaoS</a> +<dd>Learn who's behind XaoS and how you can help. + +<dt><a start>Getting started</a> +<dd>Start here to learn how to use XaoS's basic features. + +<dt><a support>Getting support</a> +<dd>How to report problems and get help from the XaoS community. + +<dt><a sffe>User formulas</a> +<dd>Learn how to render your own formulas in XaoS. + +<dt><a video>Encoding videos</a> +<dd>Learn how to create videos from your XaoS animations. + +<dt><a drivers>Platform-specific documentation</a> +<dd>XaoS runs on many platforms. Read instructions specific to yours. + +<dt><a format>XaoS's file format</a> +<dd>Learn how to tweak your saved fractals and animations. + +<dt><a menus>Menus, commands and parameter index</a> +<dd>An in-depth discussion of all of XaoS's commands. +</dl> + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%about +<head>About XaoS</head> +<notex> +XaoS is free software. You are welcome to redistribute it under the terms of +the <a gpl>GNU General Public License</a>. This also means that you may get +<emph>sources</emph> and help improve XaoS through an open +<a devel>development process</a>. +</notex> +<head>Credits</head> +(alphabetically) +<dl> +<dt>Lucio Henrique de Araujo (lucio.matema@gmail.com) +<dd>Brazilian/Portuguese translation +<dt>Eric Courteau (ecourteau@cplus.fr) +<dd>francais.cat (translation of tutorials) +<dt>Jean-Pierre Demailly (Jean-Pierre.Demailly@ujf-grenoble.fr) +<dd>Updates for French translation +<dt>Radek Doulik (rodo@atrey.karlin.mff.cuni.cz) +<dd>TK interface, windowid patches +<dt>Martin Dozsa (madsoft@centrum.cz) +<dd>cs.po (Czech translation of menus) +<dt>Arpad Fekete (Fekete.Arpad.2@stud.u-szeged.hu) +<dd>some new fractals, and the 'More formulae' menu +<dt>Zelia Maria Horta Garcia (zeliagarcia@seed.pr.gov.br) +<dd>Brazilian/Portuguese translation +<dt>Tim Goodwin (tgoodwin@cygnus.co.uk) +<dd>english.cat corrections +<dt>Ben Hines +<dd>autoconf suggestions, Mac OS X port +<dt>Jan Hubicka (jh@ucw.cz) +<dd>Zooming routines, ugly interface, palettes, drivers, autopilot, filters, documentation, tutorials etc. +<dt>Jens Kilian (jjk@acm.org) +<dd>BeOS driver, deutsch.cat +<dt>Thomas A. K. Kjaer (takjaer@imv.aau.dk) +<dd>OS/2 ports (320x200 graphics and AA-lib) +<dt>Zoltan Kovacs (kovzol@math.u-szeged.hu) +<dd>Internationalization, Hungarian translations, finalizing version 3.1, bug fixes, web design, current maintainer +<dt>Zsigmond Kovacs (kovzsi@gmail.com) +<dd>Fractal examples +<dt>J.B. Langston III (jb-langston@austin.rr.com) +<dd>Native Mac OS X port (from version 3.2.2); web redesign; co-maintainer +<dt>Andreas Madritsch (amadritsch@datacomm.ch) +<dd>New fractal types, bailout, many fixes +<dt>Mateusz Malczak (xaos@malczak.info) +<dd>User formula evaluation library +<dt>Giorgio Marazzi (gmarazzi@vtr.net) +<dd>Improvements and fixes for espanhol.cat +<dt>Thomas Marsh (thomas.marsh2@gmail.com) +<dd>First zoomer, formulae, planes, X11 driver, inversions, many ideas +<dt>Dominic Mazzoni (dmazzoni@cs.cmu.edu) +<dd>Macintosh port (version 2.0) +<dt>David Meleedy +<dd>Grammatical and spelling fixed version of <tt>xaos.6</tt> +<dt>Paul Nasca (zynaddsubfx@yahoo.com) +<dd>Ministatus improvement +<dt>Nix (nix@esperi.demon.co.uk) +<dd>Grammatical and spelling fixed version of <tt>xaos.hlp</tt> and other files +<dt>Terje Pedersen (terjepe@login.eunet.no) +<dd>Amiga port +<dt>Cesar Perez (oroz@users.sourceforge.net) +<dd>Spanish translations +<dt>Fabrice Premel (premelfa@etu.utc.fr) +<dd>Periodicity checking +<dt>Jan Olderdissen (jan@olderdissen.com) +<dd>Win32 port +<dt>Ilinca Sitaru (ilinca.sitaru@gmail.com) +<dd>Romanian translation +<dt>Daniel Skarda +<dd>Fractal examples +<dt>Andrew Stone (Stone Design - www.stone.com) +<dd>Videator Support, Cocoa improvements, performance mode, bug fixes +<dt>Marton Torok (marton.torok@gmail.com) +<dd>Small fixes for pipes +<dt>Pavel Tzekov (paveltz@csoft.bg) +<dd>Win32 support +<dt>Charles Vidal +<dd>Tcl/Tk interface +<dt>Tapio K. Vocaldo (taps@rmx.com) +<dd>Macintosh port +<dt>Tormod Volden +<dd>Fixes for X11 driver to improve compatability with Xorg, XScreenSaver, Beryl and Compiz +<dt>Philippe Wautelet (p.wautelet@fractalzone.be) +<dd>Bug fixes for version 3.1.1, French translation, gcc 4.0 fixes +<dt>Sergio Zanchetta +<dd>Italian translation +</dl> +<head>Included Software</head> +XaoS uses the following libraries. These libraries may be included +with some binary distributions of XaoS. +<p> +<emph>gettext 0.17</emph><br> +Website: <tt>http://www.gnu.org/software/gettext/</tt><br> +Copyright (C) 1995-1997, 2000-2007 Free Software Foundation, Inc.<br> +License GPLv3+: GNU GPL version 3 or later (http://gnu.org/licenses/gpl.html)<br> +This is free software: you are free to change and redistribute it.<br> +There is NO WARRANTY, to the extent permitted by law. +<p> +<emph>GNU Scientific Library 1.11</emph><br> +Website: <tt>http://www.gnu.org/software/gsl/</tt><br> +Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 The GSL Team.<br> +License GPLv3+: GNU GPL version 3 or later (http://gnu.org/licenses/gpl.html)<br> +This is free software: you are free to change and redistribute it.<br> +There is NO WARRANTY, to the extent permitted by law. +<p> +<emph>libpng 1.2.25</emph><br> +Website: <tt>http://www.libpng.org/pub/png/libpng.html</tt><br> +Copyright (c) 1998-2008 Glenn Randers-Pehrson<br> +Copyright (c) 1996-1997 Andreas Dilger<br> +Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%start +<head>Getting Started</head> + +<a controls>Basic controls</a><br> +Learn the basic commands to control XaoS. + +<p> +<tutor fractal.xaf>An introduction to fractals</tutor><br> +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. + +<p> +<tutor features.xaf>XaoS features overview</tutor><br> +Watch this tutorial to discover more of XaoS's features. + +<p> +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). + +<p> +<a tutorial>XaoS Overview</a><br> +A written introduction to all of XaoS's features. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%support +<head>Support</head> +XaoS is a community-supported free software project. + +<head>Home Page</head> +Site: <tt>http://xaos.sourceforge.net</tt><p> + +Check the Xaos home page for the latest news and information about +XaoS and to download the latest versions. + +<head>Users' Discussion Group</head> +Site: <tt>http://groups.google.com/group/xaos-users</tt><p> + +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.<p> + +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.<p> + +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. + + +<head>Developers' Discussion Group</head> + +Site: <tt>http://groups.google.com/group/xaos-devel</tt><p> + +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. + + +<head>Issue Tracker</head> + +Site: <tt>http://code.google.com/p/gnuxaos/issues/list</tt><p> + +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).<p> + +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.<p> + +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.<p> + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%devel +<head>Development</head> +XaoS is free software. One of the most significant rights its <a gpl>license</a> +grants to you is the right to <emph>freely get, study and improve</emph> its +source code, which is available from the XaoS homepage. +<p> +XaoS has an open development model. All development is coordinated via Google Code +at <tt>http://gnuxaos.googlecode.com/</tt>. Development versions are +available via Subversion at <tt>https://sourceforge.net/scm/?type=svn&group_id=5771</tt>, +so if you are interested in the future of XaoS, give the latest source a try! We also +have a several <a support>discussion groups</a>, which you can join if you want to +discuss XaoS with others or participate in the development process. +<p> +If you want to do some development, you are encouraged to send your work back +to the <a about>authors</a>; if it is well done, it will be added to the +next release. All changes should be submitted to the Google Code issue tracker. +<p> +XaoS is quite easily extensible. You might want to +read a bit about its internals in the file <emph>doc/xaosdev.info</emph>. +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. +<p> +<head>Volunteer Opportunities</head> +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: + +<p>Improving the documentation via the Wiki (and improving the DokuWiki converter). +<p>Compiling binaries for your favorite operating system. +<p>Reviewing the source code, adding comments, and checking lines which generate warnings during compilation. +<p>Creating additional tutorials and examples. +<p>Translating XaoS into your language. +<p>Implementing feature requests. +<p>Fixing outstanding bugs. +<p>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 +<head>Using user formulas</head> +<p> +XaoS supports entering your own custom formulas. +Select <tt>User formula</tt> from the <tt>Fractal</tt> menu to define a +custom fractal formula. Select <tt>User initialization</tt> to change +the sequence starting point <emph>z0</emph>. By default <emph>z0</emph> +is set to 0. User formulas should be interpreted as functions in the form<br> +<emph>Z(n+1) = formula (Z(n), Z(n-1), C)</emph>. +<p> +In user formulas, as shown above, three variables are available:<br> +<dl> +<dt>z +<dd>current sequance point Z(n) +<dt>c +<dd>current plane 'point' +<dt>p +<dd>previous sequence point Z(n-1) +</dl> +<p> +Format for complex numbers is <emph>{re;im}</emph><br> +eg. {3;2} is complex number 3+2i. +<p> +Available functions are listed below: +<dl> +<p> +<dt>basic operations +<dd>+, -, *, / +<p> +<dt>basic trigonometry +<dd>sin, cos, tan, cot<br> +asin, acos, atan, acot<br> +sinh, cosh, tanh, coth +<p> +<dt>Exponential and logarithmic functions +<dd>exp<br> +log - natural logarithm<br> +log2, log10<br> +logN (base, z) - logarithm of base N (where N is integer)<br> +logCN (base, z) - logarithm of base CN (where CN is complex) +<p> +<dt>power functions +<dd>powi - power with integer exponent (fastest)<br> +powd - power with real exponent<br> +powdc - power with complex exponent<br> +pow - same as powd<br> +sqr - square +<p> +<dt>square functions +<dd>sqrt - square root of a complex number<br> +rtni (z, n, i) - i-th root of n-th orgder +<p> +<dt>other functions +<dd>rand (max) - random real number in range [0, max)<br> +inv - inverse<br> +abs - absolute value<br> +re - real part<br> +im - imaginary part +</dl> +<p> + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%video + +<head>How to encode video files from XaoS</head> +<p> +To create a video, make and <tt>xaf</tt> file first (the easiest way to do this is +to use the <emph>record</emph> function in the file menu). Then you need to render +the animation. XaoS can output sequences of ordinary <tt>PNG</tt> images, that +can later be used by a video encoder. +<p> +<head>Generating image sequences for video</head> +<p> +To generate an image sequence, choose <emph>Render Animation</emph> from the <emph>Misc</emph> +menu. You can also use the following command on the command line: +<p><tt> +xaos -render [filename] -size 352x240 -antialiasing + -renderframerate 24 -basename [basename] +</tt><p> +<emph>File to render</emph> (<tt>[filename]</tt>) is the name of the <tt>xaf</tt> file, +<emph>Basename</emph> (<tt>[basename]</tt>) 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 <tt>.png</tt> extension to this name automatically. +<p> +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. +<p> +The framerate can also be altered. Make sure you choose a framerate that is supported by +the video codec you wish to use. +<p> +<emph>Antialiasing</emph> (<tt>-antialiasing</tt>) 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 <emph>JPEG images</emph>) +<p> +On the other hand, the other XaoS rendering option <emph>Always Recalculate</emph> (<tt>-alwaysrecalc</tt>) (which disables +XaoS's zooming optimizations) is <emph>not recommended</emph>. 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. +<head>Rendered files</head> +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). +<p> +All images are named <tt>[basename]framenum.png</tt>. For example <tt>intro0001.png</tt> 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 <tt>mv</tt> or symbolic linking. +<p> +A list of all filenames is saved into the file <tt>[basename].par</tt>, 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. +<head>Encoding videos</head> +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: +<dl> +<dt>ffmpeg +<dd>Available from: <tt>http://ffmpeg.mplayerhq.hu/</tt><br> +Instructions: <tt>http://ffmpeg.mplayerhq.hu/faq.html#SEC12</tt> +<dt>mencoder +<dd>Part of mplayer, available from: http://www.mplayerhq.hu/<br> +Instructions: <tt>http://www.mplayerhq.hu/DOCS/HTML/en/menc-feat-enc-images.html</tt> +</dl> +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. + +<p> +Note: we used to recommend <a berkeley>Berkeley parallel MPEG encoder</a> to +encode the generated png files into MPEG videos. We have kept +the instructions mainly for historic purposes. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%berkeley +<head>Berkeley parallel MPEG encoder</head> + +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. +<p> +It is available at Berkeley's FTP site <tt>mm-ftp.CS.Berkeley.EDU</tt> and called +<tt>mpeg_encode1.5b</tt> +<p> +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 <tt>doc/mpeg.param</tt>. +<p> +I've also made some patches that makes possible to use the pattern and motion +files generated from XaoS. The patch is in <tt>doc/mpeg_encode.patch</tt>. So if +you want to use these features (they are <emph>EXPERIMENTAL</emph>) you might apply this +patch and recompile the encoder. +<p> +Once you filled the <tt>mpeg.param</tt> file (see comments inside), you should render +sequence using <tt>mpeg_encode [filename]</tt> and with luck you are done. + +<head>Pattern file</head> + +Some other files are generated as well. A <emph>pattern file</emph> is generated, +which contains a <emph>recommended order of P, B and I frames</emph>. +<p> +MPEG sequence consist of these three frames. The <emph>I frames</emph> are just images +saved in a format similar to JPEG files. +<p> +The <emph>P frames</emph> 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. +<p> +The <emph>B frames</emph> 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 <emph>not used as previous frames</emph>, +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. +<p> +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 <emph>recalculate all P and B frames +since latest I frame</emph>. 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 <tt>-iframedist</tt> option. It should be a multiple of 3. +<p> +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 <tt>IBBPBBPBBPBBP...</tt> is used. +<p> +If your encoder supports this, you should supply this pattern for encoding to +squeeze out some bytes. + +<head>Motion vector files</head> + +XaoS also generates a motion vector recommendation for the encoder. This is +useful for encoding of B and P frames. +<p> +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. +<p> +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). +<p> +XaoS knows how the fractals move, so it can calculate this vectors quite +easily. XaoS saves this information into <tt>*.p</tt> and <tt>*.b</tt> files. (<tt>*.p</tt> are for P +frames, <tt>*.b</tt> are for B frames). If your encoder supports this, you should +provide this vector to increase quality. They are <tt>not exact</tt> (XaoS can make +mistakes); the encoder should try to find its own vectors, then try XaoS's ones, +and pick whichever is better. +<p> +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). +<p> +To enable saving of motion vector files, add the option +<tt>-rendervectors</tt>. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%controls +<head>Basic controls</head> +By default the mouse buttons work in the following way: +<p> +<dl> +<dt>left<dd>zoom in +<dt>right<dd>zoom out +<dt>middle<dd>move fractal in a drag-and-drop fashion +</dl> +<p> +<emph>Note:</emph> Since most Macs only have one button mice, these controls +are emulated on Mac OS X using modifier keys. See the help section on +<a cocoa>Mac OS X</a> for details. +<p> +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. +<p> +If you don't have a middle button, press both buttons to enable +emulation. +<p> +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. +<p> +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 <emph>Left</emph> and <emph>Right</emph>. +<p> +An <emph>Up</emph> and <emph>Down</emph> keys should be used to change zooming +speed. Note that higher speed costs more and image will be blocky. +<p> +This behavior can also change. With palette cycling enabled, <emph>Left</emph> +and <emph>Right</emph> keys change cycling speed; in continuous +rotation they change rotation speed. +<p> +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 +<head>How to write XaoS help files</head> +XaoS help is stored in the file <tt>help/xaos.hlp</tt>. It is divided into parts, +each part being started by a <emph>keyword</emph>. In the help file keywords are +written as <tt>%keyword</tt> +<p> +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. +<p> +<notex> +The help file is written in a special format called <a xshl>xshl</a>. +</notex> + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%xshl +<head>xshl</head> +<emph>Xshl</emph> stands for <emph>XaoS simple hypertext language</emph>. 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 <tt>src/util/xshl.c</tt> to parse it. +<p> +The following tags are supported: +<p> +<dl> +<dt>head +<dd>make headings (should be at the beginning of the page, at least) +<dt>emph +<dd>emphasize +<dt>tt +<dd>Use non proportional font +<dt>br +<dd>Break line +<dt>p +<dd>Next paragraph +<dt>dl +<dd>Definition list +<dt>dt +<dd>Definition tag (should be used only inside a definition list) +<dt>dd +<dd>Definition description (should be used only inside a definition list) +<dt>center +<dd>align to center +<dt>right +<dd>align to right +<dt>red +<dd>change color to red (should not be used in help files) +<dt>black +<dd>change color to black (should not be used in help files) +<dt>white +<dd>change color to white (should not be used in help files) +<dt>a name +<dd>link to other help page +<dt>tutor name +<dd>activate tutorial +<dt>notex +<dd>Ignore this in texinfo manuals +</dl> + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%format +<head>XaoS's file format</head> +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. +<p> +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. +<p> +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: +<p> +<tt>(command_name </tt><emph>[param1] [param2]</emph><tt>)</tt> +<p> +where parameters are optional and separated by whitespace (an arbitrary number +of spaces, tabs and newlines). The parameters can have the following types: +<p> +<dl> +<dt>integer +<dd>number w/o decimal point (<tt>123</tt>) +<dt>float +<dd>floating point number in decimal notation with optional exponent (<tt>1.23E2</tt>) +<dt>keyword +<dd>text started by quote <tt>'</tt>. It is used to pass various string constants +like formula name (<tt>'mandel</tt>) Quote is required for scheme compatibility +<dt>string +<dd>Text inside double quotes. The only parameter that should contain whitespace +<dt>boolean +<dd><tt>#t</tt> for true or <tt>#f</tt> for false +</dl> +<p> +There is a complete description of all XaoS functions (with some examples) and an +index of functions in the <a menus>XaoS registry</a>. You may particularly want +to read about the <a animf>animation functions</a>. Also, the following functions +are significant: + +<dl> +<dt>load +<dd> +This function loads and interprets a file. It works similarly to <tt>#include</tt> +in C. +<dt>initstate +<dd> +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. +<dt>usleep +<dd> +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. +<dt>wait +<dd> +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. +</dl> +<p> +Example: +<p><tt> +;configure everything for the first frame<br> +(inistate)<br> +(palette 1 1163254293 0) ;custom palette<br> +(cycling #t) ;enable cycling<br> +(cyclingspeed 7)<br> +(maxiter 276) ;higher number of iterations<br> +(range 3) ;default range for solid guessing<br> +(usleep 1000000) ;second frame starts here<br> +(moveview -1.8101154154614007889 -8.2687205907162041209E-05)<br> + ;just move the image<br> +(usleep 1000000) ;third frame<br> +(morphview -1.8101154154614007889 -8.2687205907162041209E-05<br> + 6.277210971069452361E-10 6.2772109785334669875E-10)<br> + ;10 seconds of zooming into selected<br> + rectangle<br> +(usleep 100000000)<br> +</tt><p> +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: +<p><tt> +(initstate)<br> +(defaultpalette 0)<br> +(formula 'mandel)<br> +(view -1.64128273713 -5.50393226816E-05 9.69332308848E-08<br> +9.69332308834E-08)<br> +</tt><p> +Just change the <tt>view</tt> command to <tt>morphview</tt>, and add <tt>usleep</tt>: + +<p><tt> +(initstate)<br> +(defaultpalette 0)<br> +(formula 'mandel)<br> +(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08<br> +9.69332308834E-08)<br> +(usleep 10000000)<br> +</tt><p> +The following code produces Julia morphing in the real axis: +<p><tt> +(initstate)<br> +(fastjulia #t)<br> +(juliaseed -2 0)<br> +(morphjulia 2 0)<br> +(usleep 2000000)<br> +</tt><p> + +And following is the ``rotozooming'' animation: + +<p><tt> +(initstate)<br> +(fastrotate #t)<br> +(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08<br> +9.69332308834E-08)<br> +(morphangle 300)<br> +(usleep 10000000)<br> +(wait)<br> +(fastrotate #f)<br> +</tt><p> + +<head>XaoS gallery</head> + +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 <a support>mailing list</a> or upload them to our website. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%drivers + +<head>Platform-specific documentation</head> +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. +<notex> +<center> +<p> +<a X11>X11 driver</a> +<p> +<a cocoa>Mac OS X driver</a> +<p> +<a win32>Win32 driver</a> +<p> +<a dX-window>DirectX windowed driver</a> +<p> +<a dX-fullscreen>DirectX fullscreen driver</a> +<p> +<a aa>AA-lib driver</a> +<p> +<a dos>MS-DOS driver</a> +<p> +<a ggi>GGI driver</a> +<p> +<a plan9>plan9 driver</a> +<p> +<a SVGAlib>SVGAlib driver</a> +<p> +<a DGA>DGA driver</a> +<p> +<a BeOS>BeOS drivers (BeOS, DirectWindow, WindowScreen) </a> +</center> +</notex> + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%cocoa + +<head>Mac OS X port</head> +XaoS has full support for Mac OS X including native menus, dialogs, help, +Finder integration, drag and drop, and basic AppleScript support. +<p> +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. + +<head>Zooming</head> +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: + +<dl> +<dt>Zoom in +<dd>Hold down the main mouse button. +<dt>Zoom out +<dd>1. Hold down the Ctrl key while pressing the main mouse button.<br> + 2. Use the right mouse button if you have one.<br> + 3. On laptops with gestures enabled, place two fingers on your trackpad and press the main mouse button. +<dt>Pan +<dd>1. Hold down the Shift key while dragging with the main mouse button.<br> + 2. Drag with the center button if you have one.<br> + 3. Use the scroll wheel or ball if you have one to pan up/down and left/right.<br> + 4. On laptops with gestures enabled, swipe two fingers across the trackpad to pan horizontally or vertically. +</dl> + +<head>Keyboard Shortcuts</head> +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. + +<p>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. + +<p>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. + +<head>Full Screen Mode</head> +The Mac OS X port supports a full screen mode. To enter it, select <emph>Mac OS X Full Screen Driver</emph> +from the <emph>UI -> Driver</emph> 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 <emph>Mac OS X Windowed Driver</emph> +from the <emph>UI -> Driver</emph> submenu. + +<head>Videator Support</head> +XaoS for Mac OS X can send a live video stream to Stone Design's Videator (<tt>http://stone.com/Videator/</tt>), +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). +<p>To turn on output to Videator, select <emph>Videator Output</emph> from the <emph>UI</emph> menu. +See <tt>http://stone.com/Videator/VJ.html</tt> for more details on how using Videator with XaoS. + +<head>Known Issues</head> +<dl> +<dt>Catseye fractal does not render properly. +<dd>Workaround: Set the bailout to just over 4 (e.g., 4.000000001). After changing this setting, the fractal renders as expected. +</dl> +<p> +The Mac OS X driver was written by J.B. Langston, 2006-2008. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%aa + +<head>AA-lib driver</head> + +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 <tt>http://aa-project.sf.net</tt>) +<p> +It is a fully featured XaoS driver for text mode displays. It supports 256 colors +and the mouse where possible. +<p> +It also has some extended features available from the UI menu: +<p> +<dl> +<dt>Attributes +<dd>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. +<dt>Font +<dd>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. +<dt>Inversion +<dd>Some devices use inverse video: use this to get correct results on such devices. +<dt>Dithering mode +<dd>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. +<dt>Palette options +<dd>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 <emph>palette menu</emph>. +<dt>Save text screen +<dd>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 <emph>file +menu</emph>. +</dl> +<p> +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 <tt>xaos -help</tt> or the AA-lib documentation for details. +<p> +The AA driver was written by Jan Hubicka, 1997. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%dos + +<head>DOS driver</head> +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. +<p> +The following problems may occur: +<p> +<dl> +<dt>Some DPMI servers may cause problems +<dd>Some DPMI servers like the one from Novell/Dr/Open DOS are buggy. Use clean DOS + instead and XaoS will automatically start <tt>cwsdpmi</tt>. + Under Open Dr DOS use <tt>dpmi off</tt> at command line to disable it. +<dt>Higher resolutions don't work + <dd>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.) +<dt>XaoS needs a coprocessor + <dd>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. +<dt>XaoS needs mouse driver to be usable +<dt>XaoS works slowly in higher resolution + <dd>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 <tt>http://www.talula.demon.co.uk</tt> for the FreeBE + project or Scitech Display Doctor package. + (See the note about VESA at the end of this section.) +</dl> +<head>VESA</head> +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. +<p> +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 +<tt>ftp.simtel.net</tt>, where there are many VESA emulation packages such as +<tt>s3vbe</tt> or the new FreeBe project at +<tt>http://www.talula.demon.co.uk</tt> +<p> +DOS driver was written by Jan Hubicka, 1997. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%ggi + +<head>GGI driver</head> + +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. +<p> +Everything else might work well, but there are no guarantees. It is alpha quality +software. +<p> +GGI driver was written by Jan Hubicka, 1998. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%plan9 + +<head>Plan9 driver</head> + +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) +<p> +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. +<p> +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 <tt>-pixelwidth</tt> and <tt>-pixelheight</tt> +instead of <tt>-screenwidth</tt> and <tt>-screenheight</tt>. +<p> +By default XaoS changes the colormap. This will collide with other colorful +programs like Mortha. You can disable this behavior using +<tt>-nopalette</tt> switch, but this will slow down XaoS. +<p> +Plan9 driver was written by Jan Hubicka, 1997. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%SVGAlib + +<head>SVGAlib driver</head> + +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: +<p> +<dl> +<dt>XaoS doesn't initialize graphics mode +<dd>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 (<tt>chmod +s</tt>) at XaoS executable. + note that I take care to disable all security holes caused by this + bit so I believe it is safe. +<dt>Mouse doesn't work +<dt>Screen is blank at higher resolutions +<dd>Both this problems are probably caused by misconfiguration of +SVGAlib. Please configure it in <tt>etc/vga/libvga.cong</tt> or +<tt>/usr/local/lib/libvga.conf</tt> +GPM can also cause problems. Try to kill it before starting XaoS. +<dt>When I switch console I can't switch back +<dd>This is another typical SVGAlib bug. Try to hold <tt>F</tt> key longer than <tt>alt</tt>. + 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. +</dl> +<p> +SVGAlib driver was written by Jan Hubicka, 1997. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%win32 + +<head>Win32 driver</head> + +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. +<p> +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. +<p> +Use <tt>-size WIDTHxHEIGHT</tt> command line option to change the default +window size. +<p> +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. +<p> +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 <tt>doc/cmdopts.txt</tt>. +<p> +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. +<p> +Note that XaoS also supports the <a dX-window>DirectX</a> API. +<p> +Win32 driver was written by Jan Hubicka, Jan Olderdissen and Pavel Tzekov, 1999. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%dX-window + +<head>DirectX windowed driver</head> + +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. +<p> +The DirectX driver is an alternative to the windowed <a win32>win32 driver</a>. +If you have DirectX installed, this driver is used by default. It has +almost the same behaviour as the <a win32>win32 driver</a> so please read its +documentation for more details. The only difference should be the display +speed. +<p> +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. +<p> +If you are experiencing problems with this driver, you might want to +use the <a win32>win32 driver</a> by default; to do this, use the <tt>-driver win32</tt> +command line option. +<p> +DirectX driver was written by Jan Hubicka, Jan Olderdissen +and Pavel Tzekov, 1999. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%dX-fullscreen + +<head>DirectX fullscreen driver</head> +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. +<p> +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 <tt>=</tt> key +(or by using the UI/Resize menu). If the selected mode is not supported, +the driver will restore the previous setting. +<p> +Use the <tt>-mode WIDTHxHEIGHTxDEPTH</tt> (like <tt>-mode 640x480x16</tt>) +command line option to change graphics mode. +<p> +If you want to start XaoS in DirectX, use the <tt>-driver dX-fullscreen</tt> +option. +<p> +See the <a win32>Win32 driver</a> documentation for some more Windows +releated information. +<p> +DirectX driver was written by Jan Hubicka, Jan Olderdissen +and Pavel Tzekov, 1999. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%BeOS DirectWindow WindowScreen + +<head>BeOS support</head> + +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. +<p> +The first version of the BeOS driver was written by Jens Kilian and later +extended by Jan Hubicka. +<p> +<head>Installation</head> +<p> +You can start the installation script to do everything for you. If you want +something special, read this section. +<p> +In order for XaoS to work you need to keep the executable together with +its data files (<tt>help</tt>, <tt>examples</tt>, <tt>catalogs</tt> and the <tt>tutorials</tt> directory) +<p> +When first started, XaoS registers two new mime types called +<tt>image/x-xaos-position</tt> for XaoS Position Files and +<tt>video/x-xaos-animation</tt> for XaoS Animation Files, +registers icons for them and sets itself as default application. +<p> +<head>Available display drivers</head> +<p> +XaoS supports following drivers: +<p> +<dl> +<dt>BeOS +<dd>Standard windowed driver using application server +<dt>DirectWindow +<dd>Driver done using Game Kit's direct window class +<dt>WindowScreen +<dd>Fullscreen driver. +</dl> +<p> +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. +<p> +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. +<p> +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 <tt>-driver WindowScreen</tt> command line option. +<p> +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. +<p> +<head>XaoS as translator</head> +<p> +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. +<p> +Note that <emph>translation can take a while</emph>. So be patient and +wait for the result. +<p> +If the translator doesn't work, ensure that you have a link to the XaoS executable +in <tt>/boot/beos/system/add-ons/Translators/</tt>. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%X11 + +<head>X11 driver</head> +This was the first driver done for XaoS. It supports many visuals, shared +colormaps and MitSHM extension. +<p> +Bugs/limitations: +<p> +<dl> +<dt>XaoS makes some X servers too busy +<dd>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 <tt>-sync</tt> +to avoid this problem. Note that <tt>-sync</tt> does <tt>not</tt> make all +communication with X asynchronous; it just adds one additional XSync call. +So the slowdown is not as large as you might expect. +<dt>Does not work on all visuals +<dd>This driver supports only 8bpp pseudocolor/grayscales, 15,16,24 and 32bpp truecolor, 1bpp and 8bpp staticolor visuals. +<dt>Palette rotating does not work for 8bpp pseudocolor w/o private palette +</dl> +<p> +X11 driver was written by Jan Hubicka and Thomas Marsh, 1997. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%DGA + +<head>DGA driver</head> +This is the driver for DGA (Direct Graphics Architecture) extension used by +XFree86 X servers. It is pretty new so it could be buggy. +<p> +Bugs/limitations: +<p> +<dl> +<dt>In 8bpp mode, XaoS has problems with the palette with certain window managers +<dd>I don't know why this happens. Just let me know what's wrong, or use another +window manager. +<dt>Banked modes are not supported. +<dd>I don't have any card to test this with, so it doesn't work in the current version. +</dl> +<p> +DGA driver was written by Jan Hubicka, 1999. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%tutorial + +<head>XaoS tutorial</head> + +This is a brief introduction to the basic XaoS features. + +<head>How to zoom</head> + 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 <emph>left</emph> 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 <emph>middle + button</emph> (or <emph>left+right</emph> buttons) you may also + <emph>move the image</emph> using ``drag & drop'' if you missed an interesting + place. <emph>Unzooming</emph> is also possible by using the <emph>right button</emph>, + but it is much slower because optimizations are not so effective as for zooming. +<p> + In case you think that the default <emph>speed</emph> is boring (it is quite slow, to + make XaoS smooth on a slow computer) you may change it by pressing <emph>arrow + up/down</emph>. But faster zooming is more expensive, so if the speed is too high + you will see little but funny colorful blinking rectangles. + +<head>Autopilot</head> + + To make XaoS yet more impressive we made a special autopilot that + automatically drives into interesting boundaries of the set. So you can + press <tt>A</tt>, 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. +<p> + 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. +<p> +<head>Various fractal formulae</head> + + XaoS also supports formulae other than the Mandelbrot set. You may change + <emph>formula</emph> using the <emph>number keys</emph> + or <emph>SHIFT+letters</emph>. + + +<p> + On keys <tt>1</tt> to <tt>5</tt> are <emph>Mandelbrot sets of various power</emph>. The ``normal'' + Mandelbrot set is on key <tt>1</tt>. +<p> + On key <tt>6</tt> is a fractal called <emph>Newton</emph>. It is Newton's famous formula for finding roots. +<p> + On key <tt>7</tt> is the <emph>fourth ordered Newton</emph> fractal. +<p> + On key <tt>8</tt> is a fractal called <emph>Barnsley</emph>. +<p> + On key <tt>9</tt> is <emph>Barnsley's second</emph> fractal. +<p> + On key <tt>0</tt> is <emph>Barnsley's third</emph> fractal. +<p> + With keys <tt>SHIFT-A</tt> you can display a fractal called <emph>octo</emph>. It is a fractal that Thomas + discovered in fractint. +<p> + With keys <tt>SHIFT-B</tt> you can display a fractal called <emph>Phoenix</emph>. It is a very nice and quite famous fractal. +<p> + With keys <tt>SHIFT-C</tt> you can display a fractal called <emph>Magnet</emph>. This fractal has quite a complex formula so it is + a bit slow. +<p> + With keys <tt>SHIFT-D</tt> you can display the <emph>Magnet2</emph> fractal. +<p> + The rest of the built-in fractals are accessible through an other menu, but + you can still use the hotkeys. +<p> + On <tt>SHIFT-E</tt> is a fractal called <emph>Triceratops</emph> found by Arpad. +<p> + On <tt>SHIFT-F</tt> is a fractal called <emph>Catseye</emph> found by Arpad. + This is more interesting if you change the bailout value. +<p> + On <tt>SHIFT-G</tt> is a fractal called <emph>Mandelbar</emph>. It was in + Gnofract4d, and they found it at: + http://mathworld.wolfram.com/MandelbarSet.html +<p> + On <tt>SHIFT-H</tt> is the <emph>Lambda</emph> fractal. +<p> + On <tt>SHIFT-I</tt> and <tt>SHIFT-J</tt> are the <emph>Manowar</emph> + and <emph>Spider</emph> 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 +<p> + The next 3 fractals are famous classic fractals. +<p> + On <tt>SHIFT-K</tt> is the <emph>Sierpinski</emph> Gasket. + You can change its shape by selecting another Julia seed. + (This is for technical reasons.) +<p> + On <tt>SHIFT-L</tt> is the <emph>Sierpinski Carpet.</emph> + It's shape can also be changed by selecting another Julia seed. +<p> + On <tt>SHIFT-M</tt> is the <emph>Koch Snowflake.</emph> +<p> + + +<head>Out-coloring modes</head> + + 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 <emph>Fractal menu</emph> or by pressing key <tt>C</tt> + To see more about coloring modes, try the tutorial on <tutor incolor.xaf>Incoloring modes</tutor> from the XaoS features overview. +<p> + Those cryptic names for coloring modes are mathematical formulae, where <emph>iter</emph> means number + of iterations, <emph>real</emph> means real coordinate of last orbit, and <emph>imag</emph> means imaginary + coordinate of last orbit. +<p> +<head>In-coloring mode</head> + + 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 <emph>fractal + menu</emph> or by pressing <tt>F</tt>. + <p> + You might also want to see the tutorial on + <tutor outcolor.xaf>Out-coloring modes</tutor> from the XaoS features overview. + +<head>Planes</head> + + 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 + <emph>Fractal menu</emph>, or by pressing <tt>I</tt>. +<p> + Like the coloring modes, planes have cryptic names. You guessed it, they're + mathematical formulae. Here <tt>mu</tt> means coordinates in the normal + complex plane. If you have coordinates in <tt>1/mu</tt> 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. + <p> +<dl> + <dt>mu + <dd>normal mode. + + <dt>1/mu + <dd>Inversion: infinity goes to 0 and 0 goes to infinity. + + <dt>1/(mu+0.25) + <dd>Similar to inversion, but moves the center outside of the + Mandelbrot set so that it looks parabolic. + + <dt>lambda + <dd>Lambda plane. + + <dt>1/lambda + <dd>Inversion of lambda plane. + + <dt>1/lambda-1 + <dd>Inversion with moved center. + + <dt>1/(mu-1.40115) + <dd>A very interesting mode for the Mandelbrot set. It makes small things + big, so you can browse the set's details easily. +</dl> +<p> + +<head>Mandelbrot/Julia switching</head> + + 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 + <tutor julia.xaf>Julia set</tutor> from the Introduction to fractals. +<p> + In the Mandelbrot mode, you can get a corresponding Julia by moving the mouse + to an interesting point and pressing <tt>M</tt>. To get back press <tt>M</tt> + again. Some fractals (Barnsley and phoenix) are already in their Julia + versions, because the Mandelbrot ones are boring. But by pressing <tt>M</tt> + in such fractal you should get the Mandelbrot version, and by choosing another + point as the base point and pressing <tt>M</tt> 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. +<p> + +<head>Fast Julia preview mode</head> + + Fast Julia mode is a quick way to find a point to use as a base for the Julia + set.. Just press <tt>J</tt> 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. + +<head>Palette</head> + + If you think that the default XaoS colors are ugly or you are just + bored by them you can change it by pressing <tt>P</tt>. XaoS will + automatically generate random palettes. Many of them look ugly, so + press <tt>P</tt> again to get another one until you find one you like. +<p> +<head>Filters</head> + + Many interesting effects are done by post-calculation <a filter>filters</a>. + 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 <tt>filter menu</tt> or press <tt>E</tt>. +<p> +<head>Palette cycling</head> + + This is a very old trick that makes the Mandelbrot set a little flashier. You + may enable or disable it using <tt>Y</tt>. In the truecolor modes you need + to enable the <a palettef>palette emulator filter</a> first. This is done + via the <tt>E</tt> key, or from the filter menu. +<p> +<head>Changing number of iterations</head> + + 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: + <p> + Press and hold <tt>arrow right</tt> and wait until iterations are high enough. + This may slow down calculation much. To reduce number of iterations + press <tt>arrow left</tt>. + +<head>Changing resolution</head> + + 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 <tt>.gif</tt> images, you may change the resolution. This + can be done by pressing <tt>=</tt> in the full screen drivers, or simply + by resizing the XaoS window. + +<head>Changing driver</head> + + 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. + <p> + 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.. + +<head>Other features</head> +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 <emph>animated tutorials</emph> from the <emph>help menu</emph>, +to have an idea what XaoS can do. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%menus +<main><head>Menus, functions and command line parameters</head></main> +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. +<menuitems><center> +<p><submenu><a root>Root menu</a> +<p><submenu><a animroot>Animation root menu</a> +<p><submenu><a plc>Replay only commands</a> +%end +<p><submenu><a linemenu>Line drawing functions</a> +<p><submenu><a animf>Animation functions</a> +<p><submenu><a time>Timing functions</a> +<p><submenu><a file>File</a> +<p><submenu><a edit>Edit</a> +<p><submenu><a fractal>Fractal</a> +<p><submenu><a calc>Calculation</a> +<p><submenu><a mfilter>Filters</a> +<p><submenu><a ui>UI</a> +<p><submenu><a misc>Misc</a> +<p><submenu><a helpmenu>Help</a> +<p><submenu><a xtextpos>Horizontal text position</a> +<p><submenu><a ytextpos>Vertical text position</a> +<p><submenu><a mformula>Formulae</a> +<p><submenu><a palettemenu>Palette</a> +</center></menuitems> +<node root, , animroot, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%root + +<notex> +<menuhead><head>Root menu</head></menuhead> +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 +<a animroot>Animation root menu</a>. +<menuitems><center> +<p><submenu><a file>File</a> +<p><submenu><a fractal>Fractal</a> +<p><submenu><a calc>Calculation</a> +<p><submenu><a mfilter>Filters</a> +<p><submenu><a ui>UI</a> +<p><submenu><a misc>Misc</a> +<p><submenu><a helpmenu>Help</a> +</center></menuitems> +</notex> +<node animroot, root, plc, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%animroot + +<menuhead><head>Animation root menu</head></menuhead> +This menu is displayed at the top of the screen when animation replay is active. +<menuitems><center> +<p><submenu><a file>File</a> +<p><a stopreplay>Stop replay</a> +<p><submenu><a helpmenu>Help</a> +<p><submenu><a ui>UI</a> +</center></menuitems> +<node stopreplay, , , animroot> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%stopreplay +<head>Stop replay</head> +Terminate animation replay. +<p> +<emph>Available as</emph>: menu item + + + +<node plc, animroot, linemenu, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%plc +<menuhead><head>Replay only commands</head></menuhead> +Some commands, such as timing primitives or animation functions, are available +only in animation files. +<menuitems><center> +<p><submenu><a linemenu>Line drawing functions</a> +<p><submenu><a animf>Animation functions</a> +<p><submenu><a time>Timing functions</a> +<p><a load>Include file</a> +</center></menuitems> +<node load, , , plc> + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%load +<head>Include file</head> +<p><emph>Syntax</emph>:(load file) +<p> +This function lets you include another file in your script. It works similarly +to <tt>#include</tt> in C or <tt>load</tt> in Scheme. +The file is searched for in the same directory as the current source file. +<p> +<emph>Available as</emph>: command + +<node linemenu, plc, animf, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%linemenu + +<menuhead><head>Line drawing functions</head></menuhead> +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 ``<tutor intro.xaf>Introduction to fractals</tutor>'' +for examples of this feature. +<p> +Lines can be drawn in <emph>screen</emph> coordinates, where 0,0 +is the top left corner and 1,1 is bottom right, <emph>scaled</emph> +coordinates, which are similar, but scaled to keep 0,0--1,1 rectangular, +or <emph>Fractal</emph> coordinates, to draw a line at an exact position +on the screen. +<p> +The color of the line should be specified by the <a color><tt>color</tt></a> 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 <tt>linekey</tt>. +Commands for changing lines operate on the line with the current key. +(Lines drawn in sequence have consecutive numbers.) +<p> +For example: +<p><tt> +(color 'red)<br> +(line 'scaled 0.3 0.5 0.7 0.5)<br> +(line 'scaled 0.3 0.5 0.7 0.5)<br> +(line 'scaled 0.3 0.5 0.3 0.5)<br> +(line 'scaled 0.7 0.5 0.7 0.5)<br> +(linekey 0)<br> +(morphline 'scaled 0.3 0.3 0.7 0.3)<br> +(morphline 'scaled 0.3 0.7 0.7 0.7)<br> +(morphline 'scaled 0.3 0.3 0.3 0.7)<br> +(morphline 'scaled 0.7 0.3 0.7 0.7)<br> +(usleep 1000000)<br> +</tt><p> +Creates line morphing to rectangle. +<notex> +<menuitems><center> +<p><a line>Draw line</a> +<p><a morphline>Morph line</a> +<p><a morphlastline>Morph last line</a> +<p><a linekey>Set line key</a> +<p><a clearline>Clear line</a> +<p><a clearlines>Clear all lines</a> +</center></menuitems> +</notex> +<notex> +<node line, , morphline, linemenu> +</notex> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%line + + +<notex> +<head>Draw line</head> +</notex> +<p><emph>Syntax</emph>:(line keyword complex complex) +<p> +Draw line between two points. +<tt>keyword</tt> specifies type of coordinates and should be one of the +following: <tt>`fractal</tt>, <tt>`screen</tt> or <tt>`scaled</tt>. +This function also increases the line key. +<p> +<emph>Available as</emph>: command + +<notex> +<node morphline, line, morphlastline, linemenu> +</notex> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%morphline + + +<notex> +<head>Morph line</head> +</notex> +<p><emph>Syntax</emph>:(morphline keyword complex complex) +<p> +Morph current line to given coordinates. +<tt>keyword</tt> specifies type of coordinates and should be one of the +following: <tt>`fractal</tt>, <tt>`screen</tt> or <tt>`scaled</tt>. +The line will start moving at the next <a time>timing command</a>, and reach the +final position before the end of it. +This function also increases the line key. +<p> +<emph>Available as</emph>: command + +<notex> +<node morphlastline, morphline, linekey, linemenu> +</notex> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%morphlastline + + +<notex> +<head>Morph last line</head> +</notex> +<p><emph>Syntax</emph>:(morphlastline keyword complex complex) +<p> +This function has the same functionality as <a morphline>morphline</a>, 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 <a linekey>linekey</a> back. +<p> +<emph>Available as</emph>: command + +<notex> +<node linekey, morphlastline, clearline, linemenu> +</notex> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%linekey +<notex> +<head>Set line key</head> +</notex> +<p><emph>Syntax</emph>:(linekey integer) +<p> +Set current line key. +<p> +<emph>Available as</emph>: command + +<notex> +<node clearline, linekey, clearlines, linemenu> +</notex> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%clearline +<notex> +<head>Clear line</head> +</notex> +<p><emph>Syntax</emph>:(clearline) +<p> +Clear current line. This function also increases the line key. +<p> +<emph>Available as</emph>: command + +<notex> +<node clearlines, clearline, , linemenu> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%clearlines +<head>Clear all lines</head> +</notex> +<p><emph>Syntax</emph>:(clearlines) +<p> +Clear all displayed lines. Lines can also be cleared using the +<tt>clearscreen</tt> or <tt>display</tt> commands available from the <a misc>Misc menu</a>. +<p> +<emph>Available as</emph>: command + +<node animf, linemenu, time, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%animf + +<menuhead><head>Animation functions</head></menuhead> +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 +<a time>timing function</a>. +For example: +<p><tt> +(view 0 0 1 1)<br> +(morphview 0 0 2 2)<br> +(usleep 5000000) +</tt><p> +Will do a 5 second long unzooming animation. +<menuitems><center> +<p><a animateview>Animate view</a> +<p><a smoothmorph>Smooth morphing</a> +<p><a morphview>Morph view</a> +<p><a morphjulia>Morph julia</a> +<p><a moveview>Move view</a> +<p><a morphangle>Morph angle</a> +<p><a zoom>Zooming functions</a> +</center></menuitems> +<node animateview, , smoothmorph, animf> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%animateview +<head>Animate view</head> +<p><emph>Syntax</emph>:(animateview float float float float) +<p> +This function is almost identical to function <a uiview><tt>view</tt></a>. +It expects that the view will be changed only slightly, so recalculation is done +with <tt>ANIMATE</tt> priority. This means that dynamic resolution is used by +default. +<p> +Viewport is selected by the center and two radiuses (real and imaginary). See +<a uiview><tt>view</tt></a> for more information. +<p> +<emph>Available as</emph>: command + +<node smoothmorph, animateview, morphview, animf> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%smoothmorph +<head>Smooth Morphing</head> +<p><emph>Syntax</emph>:(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. +<p> +The keystring is used to select what morphing you want to control. It is one of +the following: +<dl> +<dt>'view +<dd>control <a morphview>morphview</a> +<dt>'angle +<dd>control <a morphangle>morphangle</a> +<dt>'julia +<dd>control <a morphjulia>morphjulia</a> +<dt>'line +<dd>control <a morphline>morphline</a> +</dl> +<node morphview, smoothmorph, morphjulia, animf> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%morphview +<head>Morph view</head> +<p><emph>Syntax</emph>:(morphview float float float float) +For the time selected by the next <a usleep><tt>usleep</tt></a> or other timing function, the viewpoint is smoothly morphed from +the current one to that selected by <tt>morphview</tt>. +<p> +Viewport is selected by the center and two radiuses (real and imaginary). See +<a uiview><tt>view</tt></a> for more information. +<p> +This function can easily be used for creating zooming/unzooming animations using position files. +This is an example position file generated by XaoS: +<p><tt> +(initstate)<br> +(defaultpalette 0)<br> +(formula 'mandel)<br> +(view -1.64128273713 -5.50393226816E-05 9.69332308848E-08 + 9.69332308834E-08)<br> +</tt><p> +By replacing the <tt>view</tt> command with <tt>morphview</tt> and +adding <tt>usleep</tt> you can create a zooming animation: +<p><tt> +(initstate)<br> +(defaultpalette 0)<br> +(formula 'mandel)<br> +(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08 + 9.69332308834E-08)<br> +(usleep 10000000) +</tt><p> + + +<emph>Available as</emph>: command + +<node morphjulia, morphview, moveview, animf> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%morphjulia +<head>Morph Julia</head> +<p><emph>Syntax</emph>:(morphjulia complex) +For the time selected by the next <a usleep><tt>usleep</tt></a> or other timing function, the Julia seed +is smoothly interpolated from the current one to that selected by <tt>morphjulia</tt>. By default this will +cause recalculation of the whole screen. +To avoid this, use <a fastjulia>fast Julia mode</a>. +<p> +A simple animation morphing Julia seed in the X axis: +<p><tt> +(initstate)<br> +(fastjulia #t)<br> +(juliaseed -2 0)<br> +(morphjulia 2 0)<br> +(usleep 2000000)<br> +</tt><p> +<p> +<emph>Available as</emph>: command + +<node moveview, morphjulia, morphangle, animf> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%moveview +<head>Move view</head> +<p><emph>Syntax</emph>:(moveview complex) +Smoothly move the image center to another position. +<p> +<emph>Available as</emph>: command + +<node morphangle, moveview, zoom, animf> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%morphangle +<head>Morph angle</head> +<p><emph>Syntax</emph>:(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 +<a rotate>fast rotate mode</a>. Don't forget to disable it later, since +it slows down other animations. +<p>A simple ``rotozooming'' animation: +<p><tt> +(initstate)<br> +(fastrotate #t)<br> +(morphview -1.64128273713 -5.50393226816E-05 9.69332308848E-08<br> +9.69332308834E-08)<br> +(morphangle 300)<br> +(usleep 10000000)<br> +(wait)<br> +(fastrotate #f)<br> +</tt><p> +<emph>Available as</emph>: command + +<node zoom, morphangle, , animf> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%zoom zoom unzoom stop +<head>Zooming functions</head> +<p> +The functions for zooming/unzooming were created mainly for recording +animations. In manually created animation files, it is easier to use +<a morphview><tt>morphview</tt></a>. +<p> +<p><emph>Syntax</emph>:(zoomcenter complex) +This function sets the center to zoom in on. The center is given as a position +in fractal coordinates. +<p> +<emph>Available as</emph>: command +<p><emph>Syntax</emph>:(zoom) +Start zooming to the area specified by <tt>zoomcenter</tt>. +<p> +The speed of zooming should be controlled by the function <a speed><tt>speed</tt></a> +or in a more exact way by <tt>maxstep</tt> and <tt>speedup</tt>. +<p> +<p><emph>Syntax</emph>:(unzoom) +<p> +Start unzooming from the area specified by <tt>zoomcenter</tt>. +<p> +<emph>Available as</emph>: command +<p><emph>Syntax</emph>:(stop) +Stop zooming or unzooming. +<p> +<emph>Available as</emph>: command + +<node time, animf, file, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%time + +<menuhead><head>Timing functions</head></menuhead> +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. +<menuitems><center> +<p><a usleep>Usleep</a> +<p><a textsleep>Wait for text</a> +<p><a wait>Wait for complete image</a> +</center></menuitems> +<node usleep, , textsleep, time> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%usleep +<head>Usleep</head> +<p><emph>Syntax</emph>:(usleep integer) +<p> +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. +<p> +<emph>Available as</emph>: command + +<node textsleep, usleep, wait, time> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%textsleep +<head>Wait for text</head> +<p><emph>Syntax</emph>:(textsleep) +<p>This function's behavior is very similar to <a usleep><tt>usleep</tt></a>, +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 +<a letterspersec><tt>letterspersec</tt></a>. This value can be changed during +replay with the arrow keys. +<p> +<emph>Available as</emph>: command + +<node wait, textsleep, , time> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%wait +<head>Wait for complete image</head> +<p><emph>Syntax</emph>:(wait) +<p> +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 +<a blur>motion blur</a>. +<p> +This function deadlocks if used with <a animf>animation functions</a>; don't +do that. +<p> +<emph>Available as</emph>: command + +<node file, time, edit, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%file + +<menuhead><head>File</head></menuhead> +<menuitems><center> +<p><a loadpos>Load</a> +<p><a savepos>Save</a> +<p><a record>Record</a> +<p><a play>Replay</a> +<p><a saveimg>Save image</a> +<p><a loadexample>Load random example</a> +<p><a savecfg>Save configuration</a> +<p><submenu><a quit>Quit</a> +</center></menuitems> +<node loadpos, , savepos, file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%loadpos +<head>Load XaoS position file</head> +<p> +Load a XaoS position file (<tt>*.xpf</tt>). +See the <a format>format description</a> for more information. +<p> +<emph>Available as</emph>: menu item, command line option + +<node savepos, loadpos, record, file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%savepos +<head>Save XaoS position file</head> +<p><emph>Syntax</emph>:(savepos file) +<p> +Save current state to a XaoS position file (<tt>*.xpf</tt>). This file is +human-readable, and can easily be improved by hand after saving, or used as +a base for animations. +See the <a format>format description</a> for more information. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node record, savepos, play, file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%record +<head>Record animation</head> +<p><emph>Syntax</emph>:(record bool [ file ]) +<p>e +Toggle recording to a XaoS animation file (<tt>*.xaf</tt>). This file is +human-readable, and can easily be improved by hand after recording. +See the <a format>format description</a> for more information. +<p> +From the scripting language, <tt>(record #t)</tt> enables recording, and +<tt>(record #f)</tt> disables it. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node play, record, saveimg, file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%play +<head>Replay animation</head> +<p> +Replay a XaoS animation file (<tt>.xaf</tt>). +<p> +<emph>Available as</emph>: menu item, command line option + +<node saveimg, play, loadexample, file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%saveimg +<head>Save image</head> +<p><emph>Syntax</emph>:(saveimg file) +<p> +Save current state to an image file. This file is in <tt>.png</tt> (portable +network graphics) format, which can be read by many applications varying from +graphics programs all the way to Web browsers. +<p> +This function needs an external library called <tt>libpng</tt>. If the library +wasn't available during compilation, this function is unavailable too. +Please see <tt>INSTALL</tt> for more information about obtaining libpng +and recompiling XaoS. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node loadexample, saveimg, savecfg, file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%loadexample +<head>Load random example</head> +<p><emph>Syntax</emph>:(loadexample) +<p> +Choose random <tt>.xpf</tt> file from the <tt>examples</tt> directory and +load it. +You might use it as the starting point for next exploration. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node savecfg, loadexample, quit, file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%savecfg +<head>Save configuration</head> +<p><emph>Syntax</emph>:(savecfg) +<p> +Save current configuration to <tt>~/.xaosrc</tt> (under Unix) or <tt>xaos.cfg</tt> +(under DOS and Windows). XaoS automatically reloads the configuration from this +file when it starts. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node quit, savecfg, ,file> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%quit quitmenu noquit +<head>Quit</head> +<p><emph>Syntax</emph>:(quit) +<p> +Quit XaoS. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node edit, file, fractal, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%edit +<menuhead><head>Edit</head></menuhead> +A fairly ordinary Edit menu. +<menuitems><center> +<p><a undo>Undo</a> +<p><a redo>Redo</a> +<p><a copy>Copy</a> +<p><a paste>Paste</a> +</center></menuitems> +<node undo, , redo, edit> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%undo +<head>Undo</head> +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. +<p> +<emph>Available as</emph>: menu item +<node redo, undo, copy, edit> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%redo +<head>Redo</head> +Redo last undone operation. See <a undo>undo</a>. +<p> +<emph>Available as</emph>: menu item +<node copy, redo, paste, edit> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%copy +<head>Copy</head> +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). +<p> +<emph>Available as</emph>: menu item +<node paste, copy, , edit> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%paste +<head>Paste</head> +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). +<p> +<emph>Available as</emph>: menu item + +<node fractal, edit, calc, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%fractal +<menuhead><head>Fractal</head></menuhead> +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. + +<menuitems><center> +<p><a formula>Formula</a> +<p><submenu><a mformula>formulae</a> +<p><a incoloring>Incoloring mode</a> +<p><a outcoloring>Outcoloring mode</a> +<p><a plane>Plane</a> +<p><submenu><a palettemenu>Palette</a> +<p><a uimandelbrot>Mandelbrot mode</a> +<p><a uiperturbation>Perturbation</a> +<p><a uiview>View</a> +<p><a initstate>Reset to defaults</a> +<p><a tcolor>True-color coloring modes</a> +</center></menuitems> +<node formula, , uimandelbrot, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%formula +<head>Formula</head> +<p><emph>Syntax</emph>:(formula keyword) +<p> +Set the current fractal formula. <tt>keyword</tt> should be one of the +following: +<dl> +<dt>'mandel +<dd>Standard <a mandel>Mandelbrot set</a>. +<dt>'mandel3 +<dd><a mandel3>Mandelbrot set, power 3</a>. +<dt>'mandel4 +<dd>Mandelbrot set, power 4. +<dt>'mandel5 +<dd>Mandelbrot set, power 5. +<dt>'mandel6 +<dd>Mandelbrot set, power 6. +<dt>'newton +<dd><a newton>Newton's approximation method</a>. +<dt>'barnsley +<dd><a barnsley>First Barnsley's formula</a>. +<dt>'octo +<dd><a octal>Fractint's octo</a>. +<dt>'phoenix +<dd><a phoenix>Phoenix</a>. +<dt>'magnet +<dd><a magnet>Magnet</a>. +</dl> +<p> +<emph>Available as</emph>: command + +<node uimandelbrot, formula, uiperturbation, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%uimandelbrot julia juliaseed +<head>Mandelbrot/Julia mode</head> +<p> +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 <tutor julia.xaf>Julia set</tutor>. +<p> +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. +<p> +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 <tt>M</tt> key instead of +using the menu, the current mouse position is used. +<p> +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 <a fastjulia>Fast Julia mode</a>. +<p> +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. +<p> +<emph>Available as</emph>: menu item +<p><emph>Syntax</emph>:(julia bool) +<p> +This function is used to enable/disable julia mode in animation files. +<p> +<emph>Available as</emph>: command line option, command +<p><emph>Syntax</emph>:(juliaseed complex) +<p> +Select the current julia seed. +<p> +<emph>Available as</emph>: command line option, command + +<node uiperturbation, uimandelbrot, uiview, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%uiperturbation perturbation +<head>Perturbation</head> +<p> +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. +<p> +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. +<p> +It can be used to specify a complex number representing a point on the screen. +If you hit the <tt>B</tt> key instead of using the menu, the current mouse +position is used. This too is a toggle, so <tt>B</tt> again will disable +perturbation by setting it to zero. +<p> +This function only has an effect for certain formulae (like the +<a mandel>Mandelbrot set</a>) and only then in <a uimandelbrot>Mandelbrot mode</a>. +<p> +<emph>Available as</emph>: menu item +<p><emph>Syntax</emph>:(perturbation complex) +<p> +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. +<p> +<emph>Available as</emph>: command line option, command + +<node bailout, maxiter, fastjulia, calc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%bailout bailout +<head>Bailout</head> +<p> +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. +<p> +For the <a mandel>Mandelbrot set</a> +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. +<p> +Other fractal types may use other bailout values. The default +is 4 for each types. +<p> +<emph>Available as</emph>: menu item, command line option, command +<p><emph>Syntax</emph>:(bailout float) +<p> + +<node uiview, uiperturbation, initstate, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%uiview view angle +<head>View</head> +<p> +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. +<p> +In the dialog you will be asked for the <emph>center</emph>, <emph>radius</emph> +and <emph>angle</emph> of the image. +<p> +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. +<p> +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 <math>x1</math>, <math>y1</math>, <math>x2</math>, <math>y2</math>. +To set the same viewpoint in XaoS, set the real portion of the center to +<math>(x1+x2)/2</math>, the imaginary part of center to <math>(y1+y2)/2</math>, and +the radius to the greater of <math>x2-x1</math> and <math>y2-y1</math>. +<p> +Other programs use a zoom factor instead of a radius. For these, you can set the +radius to <math>2/zoom</math>. +<p> +<emph>Available as</emph>: menu item +<p><emph>Syntax</emph>:(view float float float float) +<p> +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 +<tt>angle</tt>), 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. +<p> +<emph>Available as</emph>: command line option, command +<p><emph>Syntax</emph>:(angle float) +<p> +Set the rotation angle in degrees. By default this causes recalculation of the +screen. You can enable the <a rotate>fast rotation mode</a>, which lets you +rotate the screen without recalculation; but it slows down other things, so +don't forget to disable it later. +<p> +<emph>Available as</emph>: command line option, command + +<node initstate, uiview, plane, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%initstate +<head>Reset to defaults</head> +<p><emph>Syntax</emph>:(initstate) +<p> +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. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node plane, initstate, incoloring, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%plane mplane plane0 plane1 plane2 plane3 plane4 plane5 plane6 plane7 plane8 plane9 plane10 +<head>Plane</head> +<p><emph>Syntax</emph>:(plane integer) +<p> +All fractals displayed by XaoS are functions with a complex parameter. +They can be be displayed in the normal complex plane where the <tt>x</tt> +coordinate is the real part of the number and the <tt>y</tt> is imaginary; +but they can also be displayed differently: +<dl> +<dt><math>mu</math> +<dd>Normal complex plane (default) +<dt><math>1/mu</math> + <dd>Inversion--infinity is at 0 and + 0 is at infinity. +<dt><math>1/(mu+0.25)</math> + <dd>Similar to inversion, but moves + the center outside the Mandelbrot set, + so it looks parabolic. +<dt><math>lambda plane</math>, <math>1/lambda</math>, <math>1/lambda-1</math> +<dd>Lambda plane and its inversion, and with a different center. +<dt><math>1/(mu-1.40115)</math> + <dd>A very interesting mode for the + Mandelbrot set, this makes small + things large, for easier browsing + of the set's details. +</dl> +The <tutor plane.xaf>tutorial about planes</tutor> has some examples. +<p> + +<p> +In the scripting language, the planes are numbered as follows: +<p> +<dl> +<dt>0 +<dd><math>mu</math> +<dt>1 +<dd><math>1/mu</math> +<dt>2 +<dd><math>1/(mu+0.25)</math> +<dt>3 +<dd><math>lambda</math> +<dt>4 +<dd><math>1/lambda</math> +<dt>5 +<dd><math>1/(lambda-1)</math> +<dt>6 +<dd><math>1/(mu-1.40115)</math> +</dl> +<p> +<emph>Available as</emph>: command line option, command + +<node incoloring, plane, outcoloring, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%incoloring mincoloring in1 in2 in3 in4 in5 in6 in7 in8 in9 in10 in0 +<head>Inside coloring mode</head> +<p><emph>Syntax</emph>:(incoloring integer) +<p> +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. +<p> +The <tutor incolor.xaf>tutorial on incoloring</tutor> has more information and +examples. +<p> +XaoS has many different ways to show that value. The cryptic names of the modes +are mathematical formulae, where <emph>real</emph> means the real part of the +latest orbit, and <emph>imag</emph> means the imaginary part. <emph>zmag</emph> +uses the magnitude of the value. The <emph>Decomposition-like</emph> method uses +the angle of the orbit. Also, <a tcolor>truecolor</a> 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: +<p> +<dl> +<dt>0 +<dd><math>0</math> (default) +<dt>1 +<dd><math>zmag</math> +<dt>2 +<dd>Decomposition-like +<dt>3 +<dd><math>real/imag</math> +<dt>4 +<dd><math>abs(abs(c)-abs(r))</math> +<dt>5 +<dd><math>cos(mag)</math> +<dt>6 +<dd><math>mag*cos(real^2)</math> +<dt>7 +<dd><math>sin(real^2-imag^2)</math> +<dt>8 +<dd><math>atan(real*imag*creal*cimag)</math> +<dt>9 +<dd>squares +<dt>10 +<dd>Truecolor. To set exact parameters for truecolor coloring use the +<a tcolor><tt>tcolor</tt></a> command. +</dl> +<p> +<emph>Available as</emph>: command line option, command + +<node outcoloring, incoloring, tcolor, fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%outcoloring moutcoloring out1 out2 out3 out4 out5 out6 out7 out8 out9 out10 out0 +<head>Outside coloring mode</head> +<p><emph>Syntax</emph>:(outcoloring integer) +<p> +Outcoloring modes are similar to <a incoloring>incoloring modes</a>, 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. +<p> +The <tutor outcolor.xaf>tutorial on outcoloring</tutor> has more information and +examples. +<p> +The cryptic names of the modes are mathematical formulae, where <emph>iter</emph> +means the number of iterations required for the value to become recognisably divergent, +<emph>real</emph> means the real part of the latest orbit, and <emph>imag</emph> +means the imaginary part. <emph>binary decomposition</emph> uses a different color +when the imaginary part of the orbit is lower than zero, and <emph>smooth</emph> +attempts to remove stripes and discontinuities. Also, <a tcolor>truecolor</a> 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). +<p> +In the scripting language, the outcoloring mode is specified by one of the following +integers: +<p> +<dl> +<dt>0 +<dd><math>iter</math> (default) +<dt>1 +<dd><math>iter+real</math> +<dt>2 +<dd><math>iter+imag</math> +<dt>3 +<dd><math>iter+real/imag</math> +<dt>4 +<dd><math>iter+real+imag+real/imag</math> +<dt>5 +<dd>binary decomposition +<dt>6 +<dd>biomorphs +<dt>7 +<dd>potential +<dt>8 +<dd>color decomposition +<dt>9 +<dd>smooth +<dt>10 +<dd>True-color outcoloring mode. To set exact parameters for truecolor coloring use <a tcolor><tt>outtcoloring</tt></a>. +</dl> +<p> +<emph>Available as</emph>: command line option, command + +<node tcolor, outcoloring, , fractal> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%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 +<head>Truecolor coloring mode</head> +<p><emph>Syntax</emph>:(intcoloring integer) +<p><emph>Syntax</emph>:(outtcoloring integer) +<p> +Truecolor coloring modes are similar to <a incoloring>incolor</a> and +<a outcoloring>outcolor</a> 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 +<a palettef>palette emulator filter</a> first to see anything, amd the quality +won't be so good, as far fewer colors are available per parameter. +<p> +The <tutor truecol.xaf>tutorial on truecolor coloring modes</tutor> has more +information and examples. +<p> +The cryptic names of the modes are always three mathematical formulae (one for +each color component), where <emph>real</emph> means the real part of the latest +orbit, and <emph>imag</emph> means the imaginary part. +<p> +To enable inside/outside truecolor coloring mode in the scripting language, +set <tt>incoloring</tt>/<tt>outcoloring</tt> value to 10 (truecolor coloring +mode) before (or after) calling <tt>intcoloring</tt> or <tt>outtcoloring</tt>. +<p> +In the scripting language, the coloring mode is specified by one of the following +integers: +<p> +<dl> +<dt>0 +<dd>black +<dt>1 +<dd><math>re*im</math> <math>sin(re^2)</math> angle +<dt>2 +<dd><math>sin(re)</math> <math>sin(im)</math> <math>sin(square)</math> +<dt>3 +<dd>hsv +<dt>4 +<dd>hsv2 +<dt>5 +<dd><math>cos(re^c)</math> <math>cos(im^2)</math> <math>cos(square)</math> +<dt>6 +<dd><math>abs(re^2)</math> <math>abs(im^2)</math> <math>abs(square)</math> +<dt>7 +<dd><math>re*im</math> <math>re*re</math> <math>im*im</math> +<dt>8 +<dd><math>abs(im*cim)</math> <math>abs(re*cre)</math> <math>abs(re*cim)</math> +<dt>9 +<dd><math>abs(re*im-csqr)</math> <math>abs(re^2-csqr)</math> <math>abs(im^2-csqr)</math> +</dl> +<p> +<emph>Available as</emph>: command line option, command + +<node calc, fractal, mfilter, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%calc + +<menuhead><head>Calculation</head></menuhead> +This menu contains functions that control calculation parameters such as +the maximum iteration count and periodicity checking. +<menuitems><center> +<p><a range>Solid guessing</a> +<p><submenu><a dynamic>Dynamic resolution</a> +<p><a periodicity>Periodicity checking</a> +<p><a maxiter>Iterations</a> +<p><a bailout>Bailout</a> +<p><a fastjulia>Fast Julia mode</a> +<p><a dynamic>Dynamic resolution</a> +<p><a rotate>Rotation</a> +</center></menuitems> +<node range, , periodicity, calc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%range mguess guess0 guess1 guess2 guess3 guess4 guess5 guess6 guess7 guess8 guess9 guessall +<head>Solid guessing range</head> +<p><emph>Syntax</emph>:(range integer) +<p> +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. +<p> +<emph>Available as</emph>: command line option, command + +<node periodicity, range, maxiter, calc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%periodicity +<head>Periodicity checking</head> +<p><emph>Syntax</emph>:(periodicity bool) +<p> +Periodicity checking is one way to speed up the calculation. Areas inside the +set always need <a maxiter><tt>maxiter</tt></a> 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). +<p> +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. +<p> +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 <a incoloring>incoloring</a> 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.) +<p> +The tutorial chapter ``<tutor escape.xaf>Escape time fractals</tutor>'' has +more information on fractal calculation in XaoS, and there is a lengthy +section in the hacker's manual (<tt>xaosdev.texinfo</tt>) devoted to the +subject. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node maxiter, periodicity, bailout, calc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%maxiter +<head>Iterations</head> +<p><emph>Syntax</emph>:(maxiter integer) +<p> +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. +<p> +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. +<p> +The tutorial chapter ``<tutor escape.xaf>Escape time fractals</tutor>'' has +more information on fractal calculation in XaoS, and there is a lengthy +section in the hacker's manual (<tt>xaosdev.texinfo</tt>) devoted to the +subject. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node fastjulia, bailout, dynamic, calc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%fastjulia +<head>Fast Julia mode</head> +<p><emph>Syntax</emph>:(fastjulia bool) +<p> +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. +<p> +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 <a uimandelbrot>Julia mode</a> to see the exact image. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node dynamic, fastjulia, rotate, calc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%dynamic nodynamic dynamicanimation dynamicnew fastmode + +<menuhead><head>Dynamic resolution</head></menuhead> +<p><emph>Syntax</emph>:(fastmode keyword) +<p> +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. +<p> +In the scripting languge, the keyword should be one of the following: +<dl> +<dt><tt>'never</tt> +<dd>Disable dynamic resolution +<dt><tt>'animate</tt> +<dd>Use only for animations (default) +<dt><tt>'new</tt> +<dd>Use also for new images +</dl> +<node rotate, dynamic, , calc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%rotate norotate controtate mouserotate rotationspeed autorotate fastrotate + +<menuhead><head>Image rotation</head></menuhead> + +XaoS has support for rotation of the image to any angle. By default, changing +the angle requires recalculation of the whole screen, but when +<emph>fast rotation mode</emph> 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. +<p> +The user interface provides two rotation modes--<emph>rotate by +mouse</emph> which allows the angle to be changed by dragging with the first +mouse button depressed, and <emph>continuous rotation mode</emph>, where the image +is rotated clockwise continuously, and the arrow keys can be used to change +the rotiation speed. +<p><emph>Syntax</emph>:(fastrotate bool) +<p> +This function is used to enable and disable fast rotation mode. +<emph>Available as</emph>: command line option, command +<head>Automatic rotation</head> +<p><emph>Syntax</emph>:(autorotate bool) +<p> +Use this function to enable continuous rotation. In the scripting language you +can also use <a morphangle><tt>morphangle</tt></a> to get an outwardly similar +but more controllable effect. +<p><emph>Syntax</emph>:(rotationspeed float) +<p> +Specify the speed of continuous rotation, in degrees per second. +Negative values are allowed and rotate anticlockwise. +<p> +<emph>Available as</emph>: menu item, command line option, command + + + +<node mfilter, calc, ui, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%mfilter + +<menuhead><head>Filters</head></menuhead> +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 <tutor filter.xaf>tutorial chapter</tutor> about them. +<p> +<menuitems><center> +<p><a filter>Filter command</a> +<p><a edge>Edge detection</a> +<p><a edge2>Edge detection2</a> +<p><a starfield>Starfield</a> +<p><a stereogram>Random dot stereogram</a> +<p><a interlace>Interlace filter</a> +<p><a blur>Motion blur</a> +<p><a emboss>Emboss</a> +<p><a palettef>Palette emulator</a> +<p><a anti>Antialiasing</a> +<p><a truecolor>Truecolor emulator</a> +</center></menuitems> +<node filter, , edge, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%filter +<head>Filter command</head> +<p><emph>Syntax</emph>:(filter keyword bool) +<p> +This command is used to enable or disable <a mfilter>filters</a>. +The <emph>keyword</emph> specifies the filter to change, and should be one of +the following: +<p> +<dl> +<dt><tt>'edge</tt> +<dd><a edge>Edge detection</a> +<dt><tt>'edge2</tt> +<dd><a edge2>Edge detection2</a> +<dt><tt>'starfield</tt> +<dd><a starfield>Starfield</a> +<dt><tt>'stereogram</tt> +<dd><a stereogram>Random dot stereogram</a> +<dt><tt>'interlace</tt> +<dd><a interlace>Interlace filter</a> +<dt><tt>'blur</tt> +<dd><a blur>Motion blur</a> +<dt><tt>'emboss</tt> +<dd><a emboss>Emboss</a> +<dt><tt>'palette</tt> +<dd><a palette>Palette emulator</a> +<dt><tt>'anti</tt> +<dd><a anti>Antialiasing</a> +<dt><tt>'truecolor</tt> +<dd><a truecolor>Truecolor</a> +</dl> +<p> +<emph>Available as</emph>: command +<node edge, filter, edge2, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%edge +<head>Edge detection</head> +<p> +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 +<a edge2>edge detection2</a> makes thinner lines, for the low resolution modes. +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node edge2, edge, starfield, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%edge2 +<head>Edge detection2</head> +<p> +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 +<a edge>edge detection</a> makes thinner lines, for the high resolution modes. +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node starfield, edge2, stereogram, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%starfield +<head>Starfield</head> +<p> +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 :) +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node stereogram, starfield, interlace, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%stereogram +<head>Random dot stereogram</head> +<p> + 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). +<p> + 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. +<p> + To make this work right, XaoS needs to know the <emph>exact size of your + monitor</emph>. Because most platforms have no way to determine this, you need to + use <emph>command line options</emph> 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). +<p> + 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. +<p> + 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. +<p> + The following command line options are provided to specify sizes: +<p> +<dl> +<dt><tt>-screenwidth</tt>, <tt>-screenheight</tt> + <dd>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. + + <dt><tt>-pixelwidth</tt>, <tt>-pixelheight</tt> + <dd>Lets you specify the exact size of a single pixel, if XaoS cannot + determine this for itself from your screen size. +</dl> +<p> + 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. +<p> + If the window is <emph>smaller than 8cm in any direction</emph>, you will probably be + unable to see anything; make the window bigger. + + The correct way to see XaoS stereograms is: +<dl> + <dt>1 + <dd>Start XaoS with options specifying the exact size of your screen or one pixel on it + <dt>2 + <dd>Sit 60cm away from monitor + <dt>3 + <dd>If you use a windowed environment, resize XaoS's window to make it wider than, say, 15 cm. + <dt>4 + <dd>Enable the filter (by pressing <tt>E</tt>) + <dt>5 + <dd>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. + <dt>6 + <dd>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...) + <dt>7 + <dd>Enjoy animation :) +</dl> +<p> + 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. +<notex> +<p> +<a filter>More information about filters</a> +</notex> + +<p> +<emph>Available as</emph>: menu item, command line option + +<node interlace, stereogram, blur, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%interlace +<head>Interlace filter</head> +<p> +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. +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node blur, interlace, emboss, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%blur +<head>Motion blur</head> +<p> +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 +<a palettef>palette filter</a> first. +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node emboss, blur, palettef, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%emboss +<head>Emboss</head> +<p> +This is a standard emboss filter, as seen in programs such as the GIMP or +Photoshop. It produces especially nice results with the smooth +<a outcoloring>outcoloring mode</a>. +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node palettef, emboss, anti, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%palettef +<head>Palette emulator</head> +<p> +XaoS can work in either palette or <a truecolor>truecolor</a> mode. Both modes +have advantages and disadvantages. Palette mode allows effects such as palette +rotation, while truecolor mode allows smoother <a incoloring>incoloring</a> +and <a outcoloring>outcoloring</a> modes and the +<a tcolor>truecolor coloring</a> 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). +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node anti, palettef, truecolor, mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%anti +<head>Antialiasing</head> +<p> +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. +<p> +This filter slows XaoS down a <emph>lot</emph> 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). +<notex> +<p> +<a filter>More information about filters</a> +</notex> +<p> +<emph>Available as</emph>: menu item, command line option + +<node truecolor, anti, , mfilter> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%truecolor +<head>Truecolor emulator</head> +<p> +XaoS can work in either <a palettef>palette</a> or truecolor mode. Both modes +have advantages and disadvantages. Palette mode allows effects such as palette +rotation, while truecolor mode allows smoother <a incoloring>incoloring</a> +and <a outcoloring>outcoloring</a> modes and the +<a tcolor>truecolor coloring</a> 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). +<p> +<a filter>More information about filters</a> +<p> +<emph>Available as</emph>: menu item, command line option + +<node ui, mfilter, misc, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%ui uia + +<menuhead><head>UI</head></menuhead> + +This menu contains functions to control the user interface layer of XaoS: +zooming speed, the autopilot, realtime status information, and so on. + +<menuitems><center> +<p><a speed>Zooming speed</a> +<p><a letterspersec>Letters per second</a> +<p><a autopilot>Autopilot</a> +<p><a recalculate>Recalculate</a> +<p><a interrupt>Interrupt</a> +<p><a nogui>Disable XaoS's builtin GUI</a> +<p><a status>Status</a> +<p><a ministatus>Ministatus</a> +</center></menuitems> +<node speed, , letterspersec, ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%speed speedup maxstep +<head>Zooming speed</head> +<p><emph>Syntax</emph>:(speed float) +<p> +Change zooming speed, where 1 is the default, 2 means twice as fast, and so on. +<p> +<emph>Available as</emph>: menu item, command line option, command +<p> +In the scripting language you can use the following functions for better +control: +<p><emph>Syntax</emph>:(maxstep float) +<p> +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. +<p> +<emph>Available as</emph>: command +<p><emph>Syntax</emph>:(speedup float) +When zooming/unzooming, every twentieth of a second the <tt>speedup</tt> +value is added to the current step until <tt>maxstep</tt> 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. +<p> +<emph>Available as</emph>: command + +<node letterspersec, speed, autopilot, ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%letterspersec animletterspersec +<head>Letters per second</head> +<p><emph>Syntax</emph>:(letterspersec integer) +<p> +Speed of subtitles for the <a textsleep><tt>textsleep</tt></a> function. +The user can set this value to suit; it can also be changed with the left and +right arrow keys during animation replay. +<p> +<emph>Available as</emph>: command line option, command + +<node autopilot, letterspersec, recalculate, ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%autopilot +<head>Autopilot</head> +<p><emph>Syntax</emph>:(autopilot bool) +<p> + To make XaoS yet more impressive, we made a special autopilot mode that + automatically drives into interesting boundaries of the set; you should + press <tt>A</tt>, 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. +<p> + 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. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node recalculate, autopilot, interrupt, ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%recalculate +<head>Recalculate</head> +<p><emph>Syntax</emph>:(recalculate) +<p> +Recalculate current fractal. This should be used when the fractal on the +screen is strange because of error propagation caused by +<a range>solid guessing</a>. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node interrupt, recalculate, nogui, ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%interrupt animinterrupt +<head>Interrupt</head> +<p><emph>Syntax</emph>:(interrupt) +<p> +Interrupt current calculation. +<p> +<emph>Available as</emph>: menu item, command line option, command + + +<node nogui, interrupt, status, ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%nogui +<head>Disable XaoS's builtin GUI</head> +<p><emph>Syntax</emph>:(nogui bool) +<p> +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 (<tt>xaosdev.texinfo</tt>) +for more details. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node status, nogui, ministatus, ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%status animstatus +<head>Status</head> +<p><emph>Syntax</emph>:(status bool) +<p> +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...) +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node ministatus, status, , ui> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%ministatus animministatus +<head>Ministatus</head> +<p><emph>Syntax</emph>:(ministatus bool) +<p> +Enable/disable status line. This contains basic information such as how +much you are zoomed and the framerate. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node misc, ui, helpmenu, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%misc + +<menuhead><head>Misc</head></menuhead> +Miscellaneous functions. +<menuitems><center> +<p><a command>Command</a> +<p><a renderanim>Render animation</a> +<p><a clearscreen>Clear screen</a> +<p><a display>Display fractal</a> +<p><a text>Display text</a> +<p><a color>Color</a> +<p><submenu><a xtextpos>Horizontal text position</a> +<p><submenu><a ytextpos>Vertical text position</a> +<p><a textposition>Text position</a> +<p><a message>Message</a> +</center></menuitems> +<node command, , renderanim, misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%command +<head>Command</head> +<p> +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 <a format>XaoS animation file</a> instead; +they are written in the same language. +<p> +<emph>Available as</emph>: menu item + +<node renderanim, command, clearscreen, misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%renderanim +<head>Render animation</head> +<p> +Render an animation to image files. See <a video>How to encode video files</a> +for more information. +<p> +<emph>Available as</emph>: menu item, +<node clearscreen, renderanim, display, misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%clearscreen +<head>Clear screen</head> +<p><emph>Syntax</emph>:(clearscreen) +<p> +Clear the screen. To display the fractal again, use <a display><tt>display</tt></a>. +This function is mainly useful in tutorials and similar animations. +<p> +<emph>Available as</emph>: menu item, command + +<node display, clearscreen, text, misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%display +<head>Display fractal</head> +<p><emph>Syntax</emph>:(display) +<p> +Display fractal. This functions reverses the effect of the <tt>clearscreen</tt>, +line drawing and text output functions. +<p> +<emph>Available as</emph>: menu item, command + +<node text, display, color, misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%text +<head>Display text</head> +<p><emph>Syntax</emph>:(text string) +<p> +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 +<a clearscreen><tt>clearscreen</tt></a> or <a display><tt>display</tt></a> +functions. You might also want to use the <a textposition><tt>textposition</tt></a> +function to select the part of the screen to display the text on. +<p> +To wait for the user to read the text, you can use the <a textsleep><tt>textsleep</tt></a> +function. +<p> +Example: +<p><tt> +(clearscreen)<br> +(textposition 'center 'middle)<br> +(text "Welcome into my animation")<br> +(textsleep)<br> +(display)<br> +</tt><p> +<emph>Available as</emph>: menu item, command line option, command + +<node color, text, textposition, misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%color +<head>Color</head> +<p><emph>Syntax</emph>:(color keyword) +<p> +Change text and line color. <emph>keyword</emph> should be one of <tt>'white</tt>, +<tt>'black</tt> and <tt>'red</tt>. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node textposition, color, message, misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%textposition +<head>Text position</head> +<p><emph>Syntax</emph>:(textposition keyword keyword) +<p> +Select <a text>text</a> position. The first keyword specifies the horizontal +position, the second the vertical position. The horizontal position should be +one of <tt>'left</tt>, <tt>'center</tt>, and <tt>'right</tt>. +The vertical should be one of <tt>'top</tt>, <tt>'middle</tt>, and <tt>'bottom</tt>. +<p> +<emph>Available as</emph>: command line option, command + +<node message, textposition, , misc> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%message +<head>Message</head> +<p><emph>Syntax</emph>:(message string) +<p> +This function is almost identical to the <a text><tt>text</tt></a> function, +except that it uses message catalogs in the <tt>catalog</tt> directory to +translate messages into other languages. It should be used only in the multi-lingual +XaoS tutorials. +<p> +<emph>Available as</emph>: command line option, command + +<node helpmenu, misc, xtextpos, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%helpmenu + +<menuhead><head>Help</head></menuhead> +This menu contains help and tutorials. +<notex> +<menuitems><center> +<p><a help>Help</a> +</center></menuitems> +<node help, , , helpmenu> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%help +<head>Help</head> +<p><emph>Syntax</emph>:(help) +<p> +Display the main help page. +<p> +<emph>Available as</emph>: menu item, command line option, command +</notex> + +<node xtextpos, helpmenu, ytextpos, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%xtextpos + +<menuhead><head>Horizontal text position</head></menuhead> +Select the horizontal position used to display <a text>text</a>. +It can be placed at the left, in the center or at the right. +<notex> +<menuitems><center> +<p><a xtextleft>Left</a> +<p><a xtextcenter>Center</a> +<p><a xtexteight>Right</a> +</center></menuitems> +<node xtextleft, , xtextcenter, xtextpos> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%xtextleft +<head>Left</head> +<p> +Draw <a text>text</a> at the left side of the screen. +<p> +<emph>Available as</emph>: menu item + +<node xtextcenter, xtextleft, xtexteight, xtextpos> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%xtextcenter +<head>Center</head> +<p> +Draw <a text>text</a> in the center of the screen. +<p> +<emph>Available as</emph>: menu item + +<node xtexteight, xtextcenter, , xtextpos> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%xtexteight +<head>Right</head> +<p> +Draw <a text>text</a> at the right side of the screen. +<p> +<emph>Available as</emph>: menu item +</notex> + +<node ytextpos, xtextpos, mformula, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%ytextpos + +<menuhead><head>Vertical text position</head></menuhead> +Select the vertical position used to display <a text>text</a>. It can be +placed at the top, in the middle or at the bottom of the screen. +<notex> +<menuitems><center> +<p><a ytextup>Up</a> +<p><a ytextmiddle>Middle</a> +<p><a ytextbottom>Bottom</a> +</center></menuitems> +<node ytextup, , ytextmiddle, ytextpos> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%ytextup +<head>Up</head> +<p> +Draw <a text>text</a> at the top of the screen. +<p> +<emph>Available as</emph>: menu item + +<node ytextmiddle, ytextup, ytextbottom, ytextpos> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%ytextmiddle +<head>Middle</head> +<p> +Draw <a text>text</a> in the middle of the screen. +<p> +<emph>Available as</emph>: menu item + +<node ytextbottom, ytextmiddle, , ytextpos> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%ytextbottom +<head>Bottom</head> +<p> +Draw <a text>text</a> at the bottom of the screen. +<p> +<emph>Available as</emph>: menu item +</notex> + +<node mformula, ytextpos, palettemenu, menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%mformula + +<menuhead><head>formulae</head></menuhead> +<p> +Each escape time fractal has its own formula. XaoS supports the following +formulae: +<p> +<menuitems><center> +<p><a mandel>Mandelbrot</a> +<p><a mandel3>Mandelbrot^3</a> +<notex> +<p><a mandel4>Mandelbrot^4</a> +<p><a mandel5>Mandelbrot^5</a> +<p><a mandel6>Mandelbrot^6</a> +</notex> +<p><a octal>Octal</a> +<p><a newton>Newton</a> +<p><a barnsley>Barnsley1</a> +<p><a phoenix>Phoenix</a> +<p><a magnet>Magnet</a> +</center></menuitems> +<node mandel, , mandel3, mformula> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%mandel +<head>Mandelbrot</head> +<p> +The Mandelbrot set is the most famous escape time fractal ever. It has the +simple formula <math>z=z^2+c</math>. See the <tutor mset.xaf>tutorial chapter</tutor>. +<p> +<emph>Available as</emph>: menu item, command line option + +<node mandel3, mandel, octal, mformula> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%mandel3 mandel4 mandel5 mandel6 +<head>Mandelbrot^3--Mandelbrot^6</head> +<p> +This fractal is a simple modification of the standard +<a mandel>Mandelbrot set</a> formula, using <math>z=z^3+c</math> instead of +<math>z=z^2+c</math>. +<p> +Other derivations of the Mandelbrot set (Mandelbrot^4 and so on) use even +higher powers. See the <tutor power.xaf>tutorial chapter</tutor>. +<p> +<emph>Available as</emph>: menu item, command line option +<node octal, mandel3, newton, mformula> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%octal +<head>Octal</head> +<p> +This is a less well-known fractal that Thomas discovered in Fractint. +It has an interesting shape when displayed in the alternative +<a mplane>planes</a>. See the <tutor octo.xaf>tutorial chapter</tutor>. +<p> +<emph>Available as</emph>: menu item, command line option + +<node newton, octal, barnsley, mformula> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%newton +<head>Newton</head> +<p> +This is Newton's approximation method for finding the roots of a polynomial. It +uses the polynomial <math>x^3=1</math> and counts the number of iterations needed +to reach the approximate value of the root. See the <tutor newton.xaf>tutorial chapter</tutor>. +<p> +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''). +<p> +<emph>Available as</emph>: menu item, command line option + +<node barnsley, newton, phoenix, mformula> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%barnsley +<head>Barnsley1</head> +<p> +This is a formula by Michael Barnsley. It produces very nice crystalline Julia +sets. See the <tutor barnsley.xaf>tutorial chapter</tutor>. +<p> +<emph>Available as</emph>: menu item, command line option + +<node phoenix, barnsley, magnet, mformula> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%phoenix +<head>Phoenix</head> +<p> +This formula produces very nice Julia sets. +See the <tutor phoenix.xaf>tutorial chapter</tutor>. +<p> +<emph>Available as</emph>: menu item, command line option + +<node magnet, phoenix, , mformula> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%magnet +<head>Magnet</head> +<p> +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 <tutor phoenix.xaf>tutorial chapter</tutor>. +<p> +<emph>Available as</emph>: menu item, command line option + +<node palettemenu, mformula, , menus> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%palettemenu + +<menuhead><head>Palette</head></menuhead> +This menu contains functions to change the palette the fractal is displayed with. +<menuitems><center> +<p><a defpalette>Default palette</a> +<p><a randompalette>Random palette</a> +<p><a palette>Custom palette</a> +<p><a cycling>Color cycling</a> +<p><a shiftpalette>Shift palette</a> +</center></menuitems> +<node defpalette, , randompalette, palettemenu> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%defpalette +<head>Default palette</head> +<p><emph>Syntax</emph>:(defaultpalette number) +<p> +Create a default palette. In the scripting language, <tt>number</tt> specifies +how much the palette is shifted by. +<p> +Note that changing the palette in truecolor modes forces recalculation of +the whole screen. To avoid this, you can enable the +<a palettef>palette emulation filter</a> first. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node randompalette, defpalette, palette, palettemenu> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%randompalette +<head>Random palette</head> +<p><emph>Syntax</emph>:(randompalette) +<p> +Create a random palette. XaoS will automatically pick one of its +palette-generation algorithms and create one. +<p> +Note that changing the palette in truecolor modes forces recalculation of +the whole screen. To avoid this, you can enable the +<a palettef>palette emulation filter</a> first. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node palette, randompalette, cycling, palettemenu> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%palette +<head>Custom palette</head> +<p><emph>Syntax</emph>:(palette integer integer integer) +<p> +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: +<dl> +<dt>0 +<dd>Default palette +<dt>1 +<dd>Black to color gradient +<dt>2 +<dd>Black to color to white gradient +<dt>3 +<dd>Cubistic-like algorithm. +</dl> +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. +<p> +Note that changing the palette in the truecolor modes forces recalculation of +the whole screen. To avoid this, you can enable the +<a palettef>palette emulation filter</a> first. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node cycling, palette, shiftpalette, palettemenu> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%cycling rcycling cyclingspeed +<head>Color cycling</head> +<p><emph>Syntax</emph>:(cycling bool) +<p> +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 <a palettef>palette emulation filter</a> to make it possible. +<p> +<emph>Available as</emph>: menu item, command line option, command +<p> +In the user interface, colors can also be cycled in the opposite direction +with the ``<emph>Reversed color cycling</emph>'' function. +<p> +To control the cycling speed, you coan use arrow keys or the +``<emph>Color cycling speed</emph>'' function. +<p> +<emph>Available as</emph>: menu item +<p><emph>Syntax</emph>:(cyclingspeed integer) +<p> +The parameter specifies the number of skips per second. It can be negative to +cycle in the opposite direction. +<p> +<emph>Available as</emph>: menu item, command line option, command + +<node shiftpalette, cycling, , palettemenu> +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%shiftpalette fshift bshift +<head>Shift palette</head> +<p><emph>Syntax</emph>:(shiftpalette integer) +<p> +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 +<emph>Shift one forward</emph> and <emph>Shift one backward</emph> functions +for fine-tuning. Note that shifted and rotated palettes could look different on +different displays (because they may have different palette sizes). +<p> +Shifting the palette on truecolor displays causes a recalculation of the screen. +To avoid this, you could use <a palettef>palette emulation filter</a>. +<p> +<emph>Available as</emph>: menu item, command line option, command + + +%endmenus +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%gpl + +<head>GNU GENERAL PUBLIC LICENSE</head> +<center>Version 2, June 1991<p> + + Copyright (C) 1989, 1991 Free Software Foundation, Inc.<br> + 675 Mass Ave, Cambridge, MA 02139, USA<br> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. +</center> +<head>Preamble</head> + + 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. +<p> + 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. +<p> + 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. +<p> + 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. +<p> + 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. +<p> + 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. +<p> + 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. +<p> + The precise terms and conditions for copying, distribution and +modification follow. + +<head>GNU GENERAL PUBLIC LICENSE<p>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</head> + + 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". +<p> +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. +<p> + 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. +<p> +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. +<p> + 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: +<dl> +<dt> +<dd> +<p> +a) + You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. +<p> +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. +<p> +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.) +</dl> +<p> +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. +<p> +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. +<p> +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. +<p> + 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: +<dl> +<dt> +<dd> +<p> +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, +<p> +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, +<p> +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.) +<p> +</dl> +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. +<p> +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. +<p> + 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. + +<p> + 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. + +<p> + 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. + +<p> + 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. +<p> + +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. +<p> + +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. +<p> + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. +<p> + 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. +<p> + 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. +<p> +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. +<p> + 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. + +<head>NO WARRANTY</head> + + 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. +<p> + 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. +<p> +<center>END OF TERMS AND CONDITIONS</center> +<head>How to Apply These Terms to Your New Programs</head> +<p> + 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. +<p> + 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. +<p> +<emph> +<tt> + (one line to give the program's name and a brief idea of what it + does.)<br> + Copyright (C) 19yy (name of author) +<p> + 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. +<p> + 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. +<p> + 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. +</tt> +</emph> +<p> +Also add information on how to contact you by electronic and paper mail. +<p> +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: +<p> +<emph> +<tt> + 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. +</tt> +</emph> +<p> +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. +<p> +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: +<p> +<emph> +<tt> + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. +<p> + (signature of Ty Coon), 1 April 1989 + Ty Coon, President of Vice +</tt> +</emph> +<p> +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 diff --git a/help/xaoshelp.css b/help/xaoshelp.css new file mode 100644 index 0000000..b7f8857 --- /dev/null +++ b/help/xaoshelp.css @@ -0,0 +1,18 @@ +body { + font-size: 9pt; + font-family: "Lucida Grande", "Segoe UI", Arial, sans-serif; +} + +a { + color: #778fbd; + font-weight: bold; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +dt { + font-weight: bold; +} diff --git a/help/xaoshelp.hhp b/help/xaoshelp.hhp new file mode 100755 index 0000000..e2f6ec9 --- /dev/null +++ b/help/xaoshelp.hhp @@ -0,0 +1,159 @@ +[OPTIONS]
+Auto Index=Yes
+Auto TOC=1
+Compatibility=1.1 or later
+Compiled file=xaoshelp.chm
+Default Window=main
+Default topic=xaoshelp\index.html
+Display compile progress=No
+Language=0x409 English (United States)
+Title=XaoS Help
+
+[WINDOWS]
+main="XaoS Help","toc.hhc",,"xaoshelp\index.html","xaoshelp\index.html",,,,,0x2120,,0x304e,,,,,,,,0
+
+
+[FILES]
+xaoshelp\aa.html
+xaoshelp\about.html
+xaoshelp\animateview.html
+xaoshelp\animf.html
+xaoshelp\animroot.html
+xaoshelp\anti.html
+xaoshelp\autopilot.html
+xaoshelp\bailout.html
+xaoshelp\barnsley.html
+xaoshelp\BeOS.html
+xaoshelp\berkeley.html
+xaoshelp\blur.html
+xaoshelp\calc.html
+xaoshelp\clearline.html
+xaoshelp\clearlines.html
+xaoshelp\clearscreen.html
+xaoshelp\cocoa.html
+xaoshelp\color.html
+xaoshelp\command.html
+xaoshelp\controls.html
+xaoshelp\copy.html
+xaoshelp\cycling.html
+xaoshelp\defpalette.html
+xaoshelp\devel.html
+xaoshelp\DGA.html
+xaoshelp\display.html
+xaoshelp\dos.html
+xaoshelp\drivers.html
+xaoshelp\dX-fullscreen.html
+xaoshelp\dX-window.html
+xaoshelp\dynamic.html
+xaoshelp\edge.html
+xaoshelp\edge2.html
+xaoshelp\edit.html
+xaoshelp\emboss.html
+xaoshelp\end.html
+xaoshelp\endmenus.html
+xaoshelp\fastjulia.html
+xaoshelp\file.html
+xaoshelp\filter.html
+xaoshelp\format.html
+xaoshelp\formula.html
+xaoshelp\fractal.html
+xaoshelp\ggi.html
+xaoshelp\gpl.html
+xaoshelp\help.html
+xaoshelp\helpmenu.html
+xaoshelp\incoloring.html
+xaoshelp\index.html
+xaoshelp\initstate.html
+xaoshelp\interlace.html
+xaoshelp\interrupt.html
+xaoshelp\letterspersec.html
+xaoshelp\line.html
+xaoshelp\linekey.html
+xaoshelp\linemenu.html
+xaoshelp\load.html
+xaoshelp\loadexample.html
+xaoshelp\loadpos.html
+xaoshelp\magnet.html
+xaoshelp\mandel.html
+xaoshelp\mandel3.html
+xaoshelp\maxiter.html
+xaoshelp\menus.html
+xaoshelp\message.html
+xaoshelp\mfilter.html
+xaoshelp\mformula.html
+xaoshelp\ministatus.html
+xaoshelp\misc.html
+xaoshelp\morphangle.html
+xaoshelp\morphjulia.html
+xaoshelp\morphlastline.html
+xaoshelp\morphline.html
+xaoshelp\morphview.html
+xaoshelp\moveview.html
+xaoshelp\newton.html
+xaoshelp\nogui.html
+xaoshelp\octal.html
+xaoshelp\outcoloring.html
+xaoshelp\palette.html
+xaoshelp\palettef.html
+xaoshelp\palettemenu.html
+xaoshelp\paste.html
+xaoshelp\periodicity.html
+xaoshelp\phoenix.html
+xaoshelp\plan9.html
+xaoshelp\plane.html
+xaoshelp\play.html
+xaoshelp\plc.html
+xaoshelp\quit.html
+xaoshelp\randompalette.html
+xaoshelp\range.html
+xaoshelp\recalculate.html
+xaoshelp\record.html
+xaoshelp\redo.html
+xaoshelp\renderanim.html
+xaoshelp\root.html
+xaoshelp\rotate.html
+xaoshelp\savecfg.html
+xaoshelp\saveimg.html
+xaoshelp\savepos.html
+xaoshelp\sffe.html
+xaoshelp\shiftpalette.html
+xaoshelp\smoothmorph.html
+xaoshelp\speed.html
+xaoshelp\starfield.html
+xaoshelp\start.html
+xaoshelp\status.html
+xaoshelp\stereogram.html
+xaoshelp\stopreplay.html
+xaoshelp\support.html
+xaoshelp\SVGAlib.html
+xaoshelp\tcolor.html
+xaoshelp\text.html
+xaoshelp\textposition.html
+xaoshelp\textsleep.html
+xaoshelp\time.html
+xaoshelp\truecolor.html
+xaoshelp\tutorial.html
+xaoshelp\ui.html
+xaoshelp\uimandelbrot.html
+xaoshelp\uiperturbation.html
+xaoshelp\uiview.html
+xaoshelp\undo.html
+xaoshelp\usleep.html
+xaoshelp\video.html
+xaoshelp\wait.html
+xaoshelp\win32.html
+xaoshelp\writehelp.html
+xaoshelp\X11.html
+xaoshelp\xshl.html
+xaoshelp\xtextcenter.html
+xaoshelp\xtexteight.html
+xaoshelp\xtextleft.html
+xaoshelp\xtextpos.html
+xaoshelp\ytextbottom.html
+xaoshelp\ytextmiddle.html
+xaoshelp\ytextpos.html
+xaoshelp\ytextup.html
+xaoshelp\zoom.html
+
+[INFOTYPES]
+
diff --git a/help/xaoswin.Hpj b/help/xaoswin.Hpj new file mode 100644 index 0000000..b08fa79 --- /dev/null +++ b/help/xaoswin.Hpj @@ -0,0 +1,23 @@ +; This file is maintained by HCW. Do not modify this file directly.
+
+; This help project requires hc 3.1
+[OPTIONS]
+;HCW=0
+;HLP=winxaos.HLP
+COMPRESS=12 Hall Zeck
+ERRORLOG=xaoswin.ERR
+LCID=0x409 0x0 0x0 ; anglicky (Spojené státy)
+REPORT=Yes
+TITLE=XaoS Help
+BUILD=RELEASE
+HLP=xaoswin.hlp
+
+[FILES]
+xaoswin.RTF
+
+[BUILDTAGS]
+DEBUG
+RELEASE
+
+[CONFIG]
+BrowseButtons()
diff --git a/help/xhtml2rest.py b/help/xhtml2rest.py new file mode 100755 index 0000000..d05f10d --- /dev/null +++ b/help/xhtml2rest.py @@ -0,0 +1,537 @@ +#!/usr/bin/python +""" +NAME +==== + +xhtml2rest - Convert xhtml to reStructuredText + +SYNOPSIS +======== + +xhtml2rest *xhtmlfile* > *restfile* + +DESCRIPTION +=========== + +``xhtml2rest``, which, far from being a decent and complete program, is +only something to begin with, hopefully processes the given UTF-8 +xhtml file and produces reStructuredText "source code" in the standard +output. If your input is html and/or not in UTF-8, you can convert it +to UTF-8 xhtml using ``iconv`` and ``tidy``: + + iconv -f *source_encoding* -t utf-8 *source_html* > *html_utf8* + + tidy -utf8 -asxml -o *xhtmlfile* *html_utf8* + + xhtml2rest *xhtmlfile* > *restfile* + +Interestingly, since reStructuredText is not simple markup, but has +very strict rules with the intention that the source is perfectly +readable, it turns out that converting html to reStructuredText is +actually *rendering*. ``xhtml2rest`` is a small rendering engine. Since +I had no time to study how existing rendering engines work, I had to +reinvent the wheel. So although the code is clean (I actually wrote it +twice), I doubt that the core logic is adequate for future extensions. +But it's better than nothing. There is some documentation in the code, +but feel free to email me if you need more explanations. + +LIMITATIONS +=========== + +I created ``xhtml2rest`` for a very specific job. It does that job +correctly, but for your web page it might not work. It should not be +very hard, however, either to improve the code, or to determine what +it is in your web page that confuses ``xhtml2rest`` and remove it. + +Other than that, there are the following limitations: + +* No indented tables + +* No multi-col or -row spans in tables + +* No support for \<br> + +* Not tested in nested tables (check http://www.w3m.org/story.html) + +* \<th> support is quick and dirty + +* If the same anchor text is met twice, the anchor is ignored + +* No indented \<pre> elements (but I'm not sure the HTML standard + allows them) + +* Images are ignored + +* The word HARDWIRED in the code indicates a hardwired hack which is + specific to the job I wanted ``xhtml2rest`` to do. + +META +==== + +``xhtml2rest`` was created by Antonios Christofides, +anthony@itia.ntua.gr, May-June 2005. + +Revision: $Revision: 3753 $ + +The code and this text is hereby placed in the public domain. +""" + +import xml.dom.minidom +import re +import sys +import textwrap +import math +import UserList +import warnings +import codecs + +############################################################################### +# Global variables. I know. I'm terribly sorry. Please get rid of them. + +# 'unindent' is used by list items. A li list item is always indented, but its +# first line is "unindented" and contains the number or bullet. However, it was +# difficult for the li node to tell its #text contents (which may be deeply +# nested) to use that. So it just places the number or bullet, which must be 4 +# characters, like " 1. ", in "unindent". The first text to be rendered uses +# the unindent and then sets it to empty again. + +unindent = '' +hyperlinks = {} # text-target pairs found in "a href" elements +############################################################################### + +class Ditem: + """A document item; usually a node, but can be a block of text + resulting from processing adjacent inline items. If it is a node, + it is usually the BlockDitem subclass; if it is text, it is + normally a plain Ditem.""" + def __init__(self, text): + self.text = text # Contained text (empty for BlockDitem) + self.type = '' # tag for block node, empty for inline + self.indentlevel = 0 # 0 - unindented; 1 - indented; etc. + def __repr__(self): + return self.__class__.__name__+'("""'+self.text+'""")' + def propagate_indents(self): + "Propagates indent level recursively to children" + pass + def maxwidth(self): + "Width it will occupy if allowed to render on infinite width" + self.remove_white_space() + return len(self.text) + 4*self.indentlevel + def minwidth(self): + "Width it will occupy if wrapped as much as possible" + wordlens = [len(x) for x in self.text.split()] + if wordlens: return max(wordlens) + 4*self.indentlevel + else: return 0 + def format(self, width): + """Returns contents formatted so as not to exceed specified + width, if possible""" + global unindent + if(self.type=='pre'): raise Exception, "What are we doing here?" + self.remove_white_space() + # Quick hack to fix a problem. Do we begin with '* '? + while len(self.text)>=2 and self.text[1]==' ' and self.text[0] in '*-': + # It may be mistaken for a bullet list. Strip it. + self.text = self.text[2:] + if width < self.minwidth(): width = self.minwidth() + # The textwrap module has the nasty habit of breaking at hyphens. So + # we'll do a nasty hack: find a character that does not exist in the + # text, replace all hyphens with that character, ok, you get the point. + hyphensurrogate = '' + for c in '!@#$%^&*~': + if self.text.find(c)<0: + hyphensurrogate = c + break + if not hyphensurrogate: raise Exception, "Houston we have a problem" + text = self.text.replace('-', hyphensurrogate) + wrapper = textwrap.TextWrapper( + initial_indent=((4*self.indentlevel)-len(unindent))*' '+unindent, + subsequent_indent=4*self.indentlevel*' ', + width=width, break_long_words = False) + unindent = '' + text = wrapper.fill(text) + text = text.replace(hyphensurrogate, '-') + return text + def empty(self): + "Returns true if contains nothing" + return not self.text + def remove_white_space(self): + "Removes extra white space" + self.text = re.sub('\s+', ' ', self.text).strip() + def canmerge(self): + "Tells whether it's possible to merge this Ditem with adjacent ones" + return True + def merge(self, aditem): + """If possible, merges aditem, which should be an adjacent Ditem that + comes after this one.""" + if not self.canmerge() or not aditem.canmerge(): return False + if len(self.text)>0 and self.text[-1] == '_' and len(aditem.text)>0 \ + and aditem.text[0] not in """ \n\t:.,!=/|;"'?<>[]{}()""": + # Leave space after link if not followed by punctuation + self.text = self.text + ' ' + aditem.text + else: + self.text = self.text + aditem.text + return True + +class BlockDitem(Ditem): + "A Ditem which contains other Ditems" + def __init__(self, type): + Ditem.__init__(self, '') + self.type = type + self.children = [] # Contained Ditems + def __repr__(self): + return self.__class__.__name__+'("'+self.type+'"); children = '+repr(self.children) + def maxwidth(self): + childmaxwidths = [x.maxwidth() for x in self.children] + return childmaxwidths and max(childmaxwidths) or 0 + def minwidth(self): + childminwidths = [x.minwidth() for x in self.children] + return childminwidths and max(childminwidths) or 0 + def propagate_indents(self): + for x in self.children: + x.indentlevel = self.indentlevel + x.propagate_indents() + def format(self, width): + if width < self.minwidth(): width = self.minwidth() + results = [x.format(width) for x in self.children] + results = [x for x in results if x] + return "\n\n".join(results) + def empty(self): + return not (self.children) + def canmerge(self): + return False + +class PreDitem(Ditem): + "A Ditem representing a literal block" + def maxwidth(self): + return max([len(x) for x in self.text.split('\n')]) + def minwidth(self): + return self.maxwidth() # Literal block; width's given + def remove_white_space(self): + pass + def format(self, width): + result = '::\n\n' + for x in self.text.split('\n'): + result = result + ' ' + x + '\n' + result = result + '..\n\n' + return result + def canmerge(self): + return False + +class HeadingDitem(BlockDitem): + "A Ditem representing an h1, h2, ..., h9" + def __init__(self, type): + BlockDitem.__init__(self, type) + def minwidth(self): + return self.maxwidth() # Headings don't wrap + def format(self, width): + assert(len(self.children)==1) + text = self.children[0].format(32767) + level = eval(self.type[1]) + underliner = "=-`'.~*+^"[level-1] + return text + '\n' + len(text)*underliner + +class BlockQuoteDitem(BlockDitem): + "A Ditem representing a blockquote" + def __init__(self, type): + BlockDitem.__init__(self, type) + def propagate_indents(self): + self.indentlevel = self.indentlevel + 1 + BlockDitem.propagate_indents(self) + +class ListDitem(BlockDitem): + "A Ditem representing an ol, ul, or dl" + def __init__(self, type): + BlockDitem.__init__(self, type) + def format(self, width): + # First pass the list type and order to the children + order = 1 + for x in self.children: + if isinstance(x, ListItemDitem): + x.listtype = self.type + x.order = order + order = order+1 + # And then process normally + return BlockDitem.format(self, width) + +class ListItemDitem(BlockDitem): + "A Ditem representing a li, dt, or dd" + def __init__(self, type): + BlockDitem.__init__(self, type) + self.listtype = None + self.order = 0 + def minwidth(self): + if self.type == 'dt': return self.maxwidth() # Don't wrap dt + else: return BlockDitem.minwidth(self) + def propagate_indents(self): + if self.type in ('li', 'ol', 'dd'): + self.indentlevel = self.indentlevel + 1 + BlockDitem.propagate_indents(self) + def format(self, width): + global unindent + if self.type == 'li' and self.listtype == 'ol': + unindent = ('%d. ' % (self.order)).ljust(4) + elif self.type == 'li' and self.listtype == 'ul': + unindent = '* ' + return BlockDitem.format(self, width) + +class RenderedColumn: + "Width information about a column being rendered" + def __init__(self, minwidth, maxwidth): + self.minwidth = minwidth + self.maxwidth = maxwidth + self.curwidth = maxwidth + self.fixedwidth = 0 + def logwidth(self): + if self.maxwidth==0: return 0 + else: return math.log(self.maxwidth) + def update(self, minwidth, maxwidth): + "Replaces minwidth/maxwidth if greater" + self.minwidth = minwidth>self.minwidth and minwidth or self.minwidth + self.maxwidth = maxwidth>self.maxwidth and maxwidth or self.maxwidth + self.curwidth = self.maxwidth + +class RenderedColumns(UserList.UserList): + "A list of RenderedColumn" + def __init__(self, alist): + self.data = alist + def totalWidth(self): + "Returns total table width" + return reduce(lambda x,y: x+y, [z.curwidth for z in self.data]) \ + + len(self.data) + 1 + def sumLogWidth(self): + "Returns sum of logwidth for nonfixed columns" + return reduce(lambda x,y: x+y, + [x.logwidth()*(1-x.fixedwidth) for x in self.data]) + def distributeWidthDifference(self, width): + "Step 4 of w3m table rendering algorithm" + # Note: The use of math.ceil below is because I'd rather have a + # suboptimal width (a few characters less than requested width) rather + # than go find what to do with rounding. + w = self.totalWidth() - width + assert(w>0) + repeat_distribution = 1 + while repeat_distribution: + repeat_distribution = 0 + for x in self.data: + if x.fixedwidth: continue + if x.curwidth - math.ceil(w*x.logwidth()/self.sumLogWidth()) < \ + x.minwidth: + x.curwidth = x.minwidth + x.fixedwidth = 1 + w = self.totalWidth() - width + repeat_distribution=1 + break + # Now that the we finished finding which columns need to be fixed to + # their minimum width, perform the distribution once again, without + # checking, and actually change remaining column widths + for x in self.data: + if x.fixedwidth: continue + x.curwidth = x.curwidth - math.ceil(w*x.logwidth()/self.sumLogWidth()) + +def tablehrule(colwidths, rule='-'): + "Returns a horizontal table separator for given column widths" + result = '+' + for x in colwidths: + result = result + rule * x + '+' + return result + +class TableDitem(BlockDitem): + def __init__(self, type): + BlockDitem.__init__(self, type) + def format(self, width): + # Uses table rendering algorithm of w3m + # (http://www.w3m.org/story.html), but ignoring width attribute + # Step 1 + columns = RenderedColumns([RenderedColumn(x.minwidth(), + max(x.maxwidth(), 1) # A column can't be smaller than 1 character + ) for x in self.children[0].children]) + for x in self.children: + for i in range(len(columns)): + if (len(x.children)<=i): continue # Skip empty columns + columns[i].update(x.children[i].minwidth(), x.children[i].maxwidth()) + # Step 2 (width attribute) ignored + # Step 3 (already done - list was created with maxwidth) + # Step 4 + if columns.totalWidth() > width: columns.distributeWidthDifference(width) + # OK, column widths are now calculated + colwidths = [int(x.curwidth) for x in columns] + result = tablehrule(colwidths) + '\n' + usedheadbodysep = False + for tr in self.children: + result = result + tr.format(colwidths) + rule = '-' + if not usedheadbodysep and tr.children[0].type == 'th' \ + and tr!=self.children[-1]: + rule = '=' + usedheadbodysep = True + result = result + tablehrule(colwidths, rule) + '\n' + return result + +class TrDitem(BlockDitem): + def __init__(self, type): + BlockDitem.__init__(self, type) + def maxwidth(self): + return reduce(lambda x,y: x+y, + [x.maxwidth() for x in self.children]) + len(self.children) + 1 + def minwidth(self): + return reduce(lambda x,y: x+y, + [x.minwidth() for x in self.children]) + len(self.children) + 1 + def format(self, colwidths): + columns = [] # List of lists of lines + maxlinecount = 0 # Num of lines in vertically largest column + for i in range(len(colwidths)): + if len(self.children)<=i: lines = [ '' ] + else: lines = self.children[i].format(colwidths[i]).split('\n') + lines = [x + ' ' * (colwidths[i]-len(x)) for x in lines] # Pad to col len + maxlinecount = max(maxlinecount, len(lines)) + columns.append(lines) + # Pad vertically + for i in range(len(columns)): + for j in range(maxlinecount-len(columns[i])): + columns[i].append(' ' * colwidths[i]) + result = '' + # Add vertical separators + for i in range(maxlinecount): + result = result + '|' + for j in range(len(columns)): + result = result + columns[j][i] + '|' + result = result + '\n' + return result + +def handleNodeList(nodelist): + "Processes given nodes; merges them if possible; returns ditem list" + ditems = [] + curditem = Ditem('') + for node in nodelist: + aditem = handleNode(node) + if curditem.merge(aditem): continue + ditems.append(curditem) + curditem = aditem + if not curditem.empty(): ditems.append(curditem) + return ditems + +def handleNode(node): + if node.nodeType == node.TEXT_NODE: + return handleText(node) + elif node.nodeName=='a': + return handleAnchor(node) + elif re.match('h\d', node.nodeName): + return handleHeading(node) + elif node.nodeName=='div' and node.getAttribute('class')=='cit': # HARDWIRED + return handleBlockQuote(node) + elif node.nodeName in ('body', 'div', 'p', 'td', 'th'): + return handleGenericBlock(node) + elif node.nodeName in ('em', 'i'): + return handleEmphasis(node) + elif node.nodeName in ('strong', 'b'): + return handleStrong(node) + elif node.nodeName in ('ol', 'ul', 'dl'): + return handleList(node) + elif node.nodeName in ('li', 'dd', 'dt'): + return handleListItem(node) + elif node.nodeName in ('table'): + return handleTable(node) + elif node.nodeName in ('tr'): + return handleTr(node) + elif node.nodeName in ('pre'): + return handlePre(node) + elif node.hasChildNodes(): + contents = handleNodeList(node.childNodes) + if len(contents) == 1: return contents[0] + if len(contents) == 0: return Ditem('') + result = BlockDitem(node.nodeName) + result.children = contents + return result + return Ditem('') + +def processChildren(node): + if node.hasChildNodes(): + return handleNodeList(node.childNodes) + else: + return () + +def mergeChildren(node): + contents = processChildren(node) + if len(contents)>1: raise Exception('Unexpected block elements') + if contents: return contents[0] + else: return Ditem('') + +def handleText(node): + return Ditem(node.data) + +def handleAnchor(node): + result = mergeChildren(node) + result.type = node.nodeName + result.text = result.text.strip() + if result.text == '': return result + target = node.getAttribute('href').strip() + result.text = re.sub('\s+', ' ', result.text) + result.text = ':ref:`'+result.text+' <'+target+'>`' + return result + +def handleHeading(node): + contents = mergeChildren(node) + if contents.empty(): return contents + result = HeadingDitem(node.nodeName) + result.children.append(contents) + return result + +def handleEmphasis(node): + result = mergeChildren(node) + result.type = node.nodeName + if result.text: + result.text = '*' + result.text + '*' + return result + +def handleStrong(node): + result = mergeChildren(node) + result.type = node.nodeName + if result.text: + result.text = '**' + result.text + '**' + return result + +def handleGenericBlock(node): + result = BlockDitem(node.nodeName) + result.children = processChildren(node) + return result + +def handleBlockQuote(node): + result = BlockQuoteDitem(node.nodeName) + result.children = processChildren(node) + return result + +def handleList(node): + result = ListDitem(node.nodeName) + result.children = processChildren(node) + return result + +def handleListItem(node): + result = ListItemDitem(node.nodeName) + result.children = processChildren(node) + return result + +def handleTable(node): + result = TableDitem(node.nodeName) + # Ignore table contents that are not tr + result.children = [x + for x in processChildren(node) if x.type=='tr'] + return result + +def handleTr(node): + result = TrDitem(node.nodeName) + # Ignore tr contents that are not th or td + result.children = [x + for x in processChildren(node) if x.type in ('th', 'td')] + return result + +def handlePre(node): + return PreDitem(mergeChildren(node).text) + +dom1 = xml.dom.minidom.parse(sys.argv[1]) +ditem = handleNode(dom1.getElementsByTagName("body")[0]) +ditem.propagate_indents() +(utf8_encode, utf8_decode, utf8_reader, utf8_writer) = codecs.lookup('utf-8') +outf = utf8_writer(sys.stdout) +outf.write(ditem.format(79) + '\n') +for h in hyperlinks.keys(): + outf.write('\n.. _`' + h + '`:\n ' + hyperlinks[h] + '\n') |
