source: libcaca/trunk/doc/user.dox @ 1020

Last change on this file since 1020 was 824, checked in by Sam Hocevar, 14 years ago
  • Documentation improvements. Wrote a small migration guide and added the skeleton of a tutorial for Jylam.
  • Property svn:keywords set to Id
File size: 1.0 KB
Line 
1/* $Id: user.dox 824 2006-04-21 18:03:22Z sam $ */
2
3/** \page env Environment variables
4
5 Some environment variables can be used to change the behaviour of
6 \e libcaca without having to modify the program which uses them. These
7 variables are:
8
9 \li \b CACA_DRIVER: set the backend video driver. In order of preference:
10     - \c conio uses the DOS conio.h interface.
11     - \c ncurses uses the ncurses library.
12     - \c slang uses the S-Lang library.
13     - \c x11 uses the native X11 driver.
14     - \c gl uses freeglut and opengl libraries.
15     - \c raw outputs to the standard output instead of rendering the
16       canvas. This is can be used together with cacaserver.
17
18 \li \b CACA_GEOMETRY: set the video display size. The format of this
19     variable must be \c XxY, with \c X and \c Y being integer values. This
20     option currently works with the X11 and GL drivers.
21
22 \li \b CACA_FONT: set the rendered font. The format of this variable is
23     implementation dependent, but since it currently only works with the
24     X11 driver, an X11 font name such as \c fixed or \c 5x7 is expected.
25
26*/
Note: See TracBrowser for help on using the repository browser.