XMayday is an "HTML Browser", that is, an application capable of reading, displaying, and managing documents created with HTML language (Hypertext Markup Language). HTML is a document description language; with it the user may set items in bold or italics, arrange a list of elements, position text, and so forth. HTML is unique because it creates links between documents: clicking on a word in Document A refers XMayday to a particular Document B.
XMayday was specially designed for viewing HTML documents. Because application documentations are generally structured around an index or a table of contents, XMayday isolates this page so it always remains quickly accessible. XMayday's Main Interface contains two sections:

• The Index or Table of Contents is always accessible from the first section. This page remains the same while the hypertext links it is made of determine the contents of the second section.
   
• The second section displays the HTML pages for the requested documentation. The pages in this section change according to the hypertext links they contain, or according to the hypertext links from the first section.
   

Xmayday may also be used like any other HTML browser by not using the Table of Contents presented in the first interface section.

Please note that Xmayday can only read local files. Unlike Internet browsers which utilize the HTTP protocol, it cannot access distant files. This unique feature allows XMayday to take full advantage of system resources, making it a particularly good tool for HTML documentation display.

To create your own documents:

Xmayday is freeware; it may only be used and distributed according to the usage license. XMayday is capable of producing documents according to the HTML 2.0 norm, and is capable of displaying other features such as tables. Images used in documentation may be in GIF, JPEG, PNG, BMP, or TGA formats, although it is always recommended to use GIF or JPEG format because the others are not recognized by all browsers.

To utilize Xmayday to its fullest, create a page (Table of Contents or Index) containing links to all parts of the documentation. Generally called "index.html", this page must be loaded in the first section of the Main Interface.

An API performs an external inquiry into XMayday operations, in order to remain properly interfaced with your other applications. API is also used for documentation in all other Axene products.

The Launch

usage: XMayday [-help] [-version] [-fg <color>] [-bg <color>] [-display <displayname>] [-geometry <geom>] [-keepFreeColor <number>] [-index <file>] [file]

detail:
-help, --help, -h
displays a summary of valid parameters on the command line.

-version, -v
displays XMayday's version number.

-fg color
defines the foreground color.

-bg color
defines the background color.

-display host:dpy
specifies which X server to use.

-geometry geom
sets the size of the application window.

-keepFreeColor number
sets the number of colors to be left free for use by other X applications. This value is 10 by default for a 256 color palette. This option may only be used when your X server works in Pseudo-Color.

-index file, -id file
Opens XMayday with a file as the index page.