| 1 | /* $Id: libcaca.dox 2243 2008-02-26 21:43:10Z 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 | \e libcaca relies on a low-level, device independent library, called |
|---|
| 28 | \e libcucul. \e libcucul can be used alone as a simple ASCII and/or |
|---|
| 29 | Unicode compositing canvas. |
|---|
| 30 | |
|---|
| 31 | The complete \e libcucul and \e libcaca programming interface is |
|---|
| 32 | available from the following headers: |
|---|
| 33 | |
|---|
| 34 | - cucul.h |
|---|
| 35 | - caca.h |
|---|
| 36 | |
|---|
| 37 | There is language-specific documentation for the various bindings: |
|---|
| 38 | |
|---|
| 39 | - \subpage libcaca-ruby |
|---|
| 40 | |
|---|
| 41 | Some other topics are covered by specific sections: |
|---|
| 42 | |
|---|
| 43 | - \subpage libcaca-tutorial |
|---|
| 44 | - \subpage libcaca-migrating |
|---|
| 45 | |
|---|
| 46 | There is also information specially targeted at \e libcaca developers: |
|---|
| 47 | |
|---|
| 48 | - \subpage libcaca-font |
|---|
| 49 | - \subpage libcaca-canvas |
|---|
| 50 | - \subpage libcaca-style |
|---|
| 51 | |
|---|
| 52 | \section user User's documentation |
|---|
| 53 | |
|---|
| 54 | - \subpage libcaca-env |
|---|
| 55 | |
|---|
| 56 | \section misc Misc |
|---|
| 57 | |
|---|
| 58 | - \subpage libcaca-news |
|---|
| 59 | - \subpage libcaca-authors |
|---|
| 60 | - \subpage libcaca-thanks |
|---|
| 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 | */ |
|---|
