Ignore:
Timestamp:
Apr 21, 2006, 6:27:43 PM (14 years ago)
Author:
Sam Hocevar
Message:
  • Added AUTHORS, THANKS, NEWS and TODO to the Doxygen documentation. Moved the main documentation page from caca.h to a separate file.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/caca/caca.h

    r819 r823  
    1919 *  This header contains the public types and functions that applications
    2020 *  using \e libcaca may use.
    21  */
    22 
    23 /** \mainpage libcaca developer documentation
    24  *
    25  *  \section intro Introduction
    26  *
    27  *  \e libcaca is a graphics library that outputs text instead of pixels,
    28  *  so that it can work on older video cards or text terminals. It is not
    29  *  unlike the famous AAlib library. \e libcaca can use almost any virtual
    30  *  terminal to work, thus it should work on all Unix systems (including
    31  *  Mac OS X) using either the slang library or the ncurses library, on DOS
    32  *  using the conio library, and on Windows systems using either slang or
    33  *  ncurses (through Cygwin emulation) or conio. There is also a native X11
    34  *  driver, and an OpenGL driver (through freeglut) that does not require a
    35  *  text terminal. For machines without a screen, the raw driver can be used
    36  *  to send the output to another machine, using for instance cacaserver.
    37  *
    38  *  \e libcaca is free software, released under the Do What The Fuck You
    39  *  Want To Public License. This ensures that no one, not even the \e libcaca
    40  *  developers, will ever have anything to say about what you do with the
    41  *  software. It used to be licensed under the GNU Lesser General Public
    42  *  License, but that was not free enough.
    43  *
    44  *  \section api The libcaca API
    45  *
    46  *  \e libcaca relies on a low-level, device independent library, called
    47  *  \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
    48  *  Unicode compositing canvas.
    49  *
    50  *  The complete \e libcucul and \e libcaca programming interface is
    51  *  available from the cucul.h and caca.h headers.
    52  *
    53  *  \section env Environment variables
    54  *
    55  *  Some environment variables can be used to change the behaviour of
    56  *  \e libcaca without having to modify the program which uses them. These
    57  *  variables are:
    58  *
    59  *  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
    60  *      - \c conio uses the DOS conio.h interface.
    61  *      - \c ncurses uses the ncurses library.
    62  *      - \c slang uses the S-Lang library.
    63  *      - \c x11 uses the native X11 driver.
    64  *      - \c gl uses freeglut and opengl libraries.
    65  *      - \c raw outputs to the standard output instead of rendering the
    66  *        canvas. This is can be used together with cacaserver.
    67  *
    68  *  \li \b CACA_GEOMETRY: set the video display size. The format of this
    69  *      variable must be XxY, with X and Y being integer values. This option
    70  *      currently works with the network, X11 and GL drivers.
    71  *
    72  *  \li \b CACA_FONT: set the rendered font. The format of this variable is
    73  *      implementation dependent, but since it currently only works with the
    74  *      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
    7521 */
    7622
Note: See TracChangeset for help on using the changeset viewer.