source: libcaca/trunk/doc/libcaca.dox @ 1357

Last change on this file since 1357 was 1357, checked in by Sam Hocevar, 14 years ago
  • Documentation updates. Moved the canvas and font format definitions to the Doxygen documentation.
  • Property svn:keywords set to Id
File size: 2.0 KB
RevLine 
[823]1/* $Id: libcaca.dox 1357 2006-11-12 10:42:14Z sam $ */
2
[845]3/** \mainpage libcaca Documentation
[823]4
5 \section intro Introduction
6
7 \e libcaca is a graphics library that outputs text instead of pixels,
8 so that it can work on older video cards or text terminals. It is not
9 unlike the famous AAlib library. \e libcaca can use almost any virtual
10 terminal to work, thus it should work on all Unix systems (including
11 Mac OS X) using either the slang library or the ncurses library, on DOS
12 using the conio library, and on Windows systems using either slang or
13 ncurses (through Cygwin emulation) or conio. There is also a native X11
14 driver, and an OpenGL driver (through freeglut) that does not require a
15 text terminal. For machines without a screen, the raw driver can be used
16 to send the output to another machine, using for instance cacaserver.
17
18 \e libcaca is free software, released under the Do What The Fuck You
19 Want To Public License. This ensures that no one, not even the \e libcaca
20 developers, will ever have anything to say about what you do with the
21 software. It used to be licensed under the GNU Lesser General Public
22 License, but that was not free enough.
23
[824]24 \section devel Developer's documentation
[823]25
26 \e libcaca relies on a low-level, device independent library, called
27 \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
28 Unicode compositing canvas.
29
30 The complete \e libcucul and \e libcaca programming interface is
[1214]31 available from the following headers:
[823]32
[1214]33 - cucul.h
34 - caca.h
35
[824]36 Some other topics are covered by specific sections:
[823]37
[824]38 - \subpage tutorial
39 - \subpage migrating
[823]40
[836]41 There is also information specially targeted at \e libcaca developers:
42
[1357]43 - \subpage font
44 - \subpage canvas
[836]45 - \subpage style
46
[824]47 \section user User's documentation
[823]48
[824]49 - \subpage env
[823]50
[824]51 \section misc Misc
[823]52
53 - \subpage news
54 - \subpage authors
55 - \subpage thanks
56 - \subpage todo
57
[824]58 \section license License
59
60 Permission is granted to copy, distribute and/or modify this document
61 under the terms of the Do What The Fuck You Want To Public License, version
62 2 as published by Sam Hocevar. For details see http://sam.zoy.org/wtfpl/ .
63
[823]64*/
Note: See TracBrowser for help on using the repository browser.