Changeset 824 for libcaca/trunk/doc


Ignore:
Timestamp:
Apr 21, 2006, 8:03:22 PM (14 years ago)
Author:
Sam Hocevar
Message:
  • Documentation improvements. Wrote a small migration guide and added the skeleton of a tutorial for Jylam.
Location:
libcaca/trunk/doc
Files:
2 added
2 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/doc/Makefile.am

    r823 r824  
    11# $Id$
    22
    3 EXTRA_DIST = doxygen.cfg.in footer.html header.html libcaca.dox $(man_MANS)
     3EXTRA_DIST = doxygen.cfg.in footer.html header.html $(man_MANS) \
     4             libcaca.dox user.dox migrating.dox tutorial.dox
    45
    56man_MANS = caca-config.1 cacafire.1 cacaview.1
  • libcaca/trunk/doc/libcaca.dox

    r823 r824  
    2222 License, but that was not free enough.
    2323
    24  \section api The libcaca API
     24 \section devel Developer's documentation
    2525
    2626 \e libcaca relies on a low-level, device independent library, called
     
    3131 available from the cucul.h and caca.h headers.
    3232
    33  \section env Environment variables
     33 Some other topics are covered by specific sections:
    3434
    35  Some environment variables can be used to change the behaviour of
    36  \e libcaca without having to modify the program which uses them. These
    37  variables are:
     35 - \subpage tutorial
     36 - \subpage migrating
    3837
    39  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
    40      - \c conio uses the DOS conio.h interface.
    41      - \c ncurses uses the ncurses library.
    42      - \c slang uses the S-Lang library.
    43      - \c x11 uses the native X11 driver.
    44      - \c gl uses freeglut and opengl libraries.
    45      - \c raw outputs to the standard output instead of rendering the
    46        canvas. This is can be used together with cacaserver.
     38 \section user User's documentation
    4739
    48  \li \b CACA_GEOMETRY: set the video display size. The format of this
    49      variable must be XxY, with X and Y being integer values. This option
    50      currently works with the network, X11 and GL drivers.
     40 - \subpage env
    5141
    52  \li \b CACA_FONT: set the rendered font. The format of this variable is
    53      implementation dependent, but since it currently only works with the
    54      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
    55 
    56  \section Misc
     42 \section misc Misc
    5743
    5844 - \subpage news
     
    6147 - \subpage todo
    6248
     49 \section license License
     50
     51 Permission is granted to copy, distribute and/or modify this document
     52 under the terms of the Do What The Fuck You Want To Public License, version
     53 2 as published by Sam Hocevar. For details see http://sam.zoy.org/wtfpl/ .
     54
    6355*/
Note: See TracChangeset for help on using the changeset viewer.