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

Last change on this file since 3512 was 2824, checked in by Sam Hocevar, 11 years ago

Continuing the libcucul-libcaca merge.

  • Property svn:keywords set to Id
File size: 2.0 KB
Line 
1/* $Id: libcaca.dox 2824 2008-09-27 14:29:11Z sam $ */
2
3/** \mainpage libcaca Documentation
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 S-Lang library or the ncurses library, on DOS
12 using the conio library, and on Windows systems using the native Win32
13 console, the conio library, or using S-Lang or ncurses (through Cygwin
14 emulation). There is also a native X11 driver, and an OpenGL driver
15 (through freeglut) that does not require a text terminal. For machines
16 without a screen, the raw driver can be used to send the output to another
17 machine, using for instance cacaserver.
18
19 \e libcaca is free software, released under the Do What The Fuck You
20 Want To Public License. This ensures that no one, not even the \e libcaca
21 developers, will ever have anything to say about what you do with the
22 software. It used to be licensed under the GNU Lesser General Public
23 License, but that was not free enough.
24
25 \section devel Developer's documentation
26
27 The complete \e libcaca programming interface is
28 available from the following header:
29
30 - caca.h
31
32 There is language-specific documentation for the various bindings:
33
34 - \subpage libcaca-ruby
35
36 Some other topics are covered by specific sections:
37
38 - \subpage libcaca-tutorial
39 - \subpage libcaca-migrating
40
41 There is also information specially targeted at \e libcaca developers:
42
43 - \subpage libcaca-font
44 - \subpage libcaca-canvas
45 - \subpage libcaca-style
46
47 \section user User's documentation
48
49 - \subpage libcaca-env
50
51 \section misc Misc
52
53 - \subpage libcaca-news
54 - \subpage libcaca-authors
55 - \subpage libcaca-thanks
56
57 \section license License
58
59 Permission is granted to copy, distribute and/or modify this document
60 under the terms of the Do What The Fuck You Want To Public License, version
61 2 as published by Sam Hocevar. For details see http://sam.zoy.org/wtfpl/ .
62
63*/
Note: See TracBrowser for help on using the repository browser.