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

Last change on this file since 4333 was 4333, checked in by Sam Hocevar, 10 years ago

Large source code cleanup, getting rid of spaces, tabs, and svn keywords.

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