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

Last change on this file since 2137 was 2003, checked in by Sam Hocevar, 12 years ago
  • Property svn:keywords set to Id
File size: 2.2 KB
Line 
1/* $Id: libcaca.dox 2003 2007-11-17 02:15:01Z 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 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
24 \section devel Developer's documentation
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
31 available from the following headers:
32
33 - cucul.h
34 - caca.h
35
36 There is language-specific documentation for the various bindings:
37
38 - \subpage libcaca-ruby
39
40 Some other topics are covered by specific sections:
41
42 - \subpage libcaca-tutorial
43 - \subpage libcaca-migrating
44
45 There is also information specially targeted at \e libcaca developers:
46
47 - \subpage libcaca-font
48 - \subpage libcaca-canvas
49 - \subpage libcaca-style
50
51 \section user User's documentation
52
53 - \subpage libcaca-env
54
55 \section misc Misc
56
57 - \subpage libcaca-news
58 - \subpage libcaca-authors
59 - \subpage libcaca-thanks
60 - \subpage libcaca-todo
61
62 \section license License
63
64 Permission is granted to copy, distribute and/or modify this document
65 under the terms of the Do What The Fuck You Want To Public License, version
66 2 as published by Sam Hocevar. For details see http://sam.zoy.org/wtfpl/ .
67
68*/
Note: See TracBrowser for help on using the repository browser.