added and rearranged. Tests, website, etc.
[trivial-backtrace.git] / website / source / index.md
blob553b0de12fb2b27cb8499b64f37bdff5acc8f47b
1 {include resources/header.md}
3 <div class="contents">
4 <div class="system-links">
6   * [Mailing Lists][3]
7   * [Getting it][4]
8   * [Documentation][5]
9   * [News][6]
10   * [Test results][tr]
11   * [Changelog][7]
13    [3]: #mailing-lists
14    [4]: #downloads
15    [5]: documentation/ "documentation link"
16    [6]: #news
17    [7]: changelog.html
18    [tr]: test-report.html
19    
20 </div>
21 <div class="system-description">
23 ### What it is
25 On of the many things that didn't quite get into the Common
26 Lisp standard was how to get a Lisp to output its call stack
27 when something has gone wrong. As such, each Lisp has
28 developed its own notion of what to display, how to display
29 it, and what sort of arguments can be used to customize it.
30 `trivial-backtrace` is a simple solution to generating a
31 backtrace portably. As of {today}, it supports Allegro Common
32 Lisp, LispWorkds, ECL, MCL, SCL, SBCL and CMUCL. Its
33 interface consists of three functions and one variable:
35     * print-backtrace
36         * print-backtrace-to-stream
37         * print-condition
38         * \*date-time-format\*
40 You can probably already guess what they do, but they are
41 described in more detail below.
43 {anchor mailing-lists}
45 ### Mailing Lists
47   * [trivial-backtrace-devel][devel-list]: A list for
48     announcements, questions, patches, bug reports, and so
49     on; It's for anything and everything
51 ### API
53 {set-property docs-package trivial-backtrace}
54 {docs print-backtrace}
55 {docs print-backtrace-to-stream}
56 {docs print-condition}
57 {docs *date-time-format*}
59 {anchor downloads}
61 ### Where is it
63 A [darcs][] repository is available. The commands to get it are
64 listed below:
66     darcs get http://common-lisp.net/project/trivial-backtrace/
68 trivial-backtrace is also [ASDF installable][]. Its CLiki
69 home is right [where][cliki-home] you'd expect.
71 There's also a handy [gzipped tar file][tarball].
74 {anchor news}
76 ### What is happening
78 <dl>
79 <dt>1 June 2008</dt>
80 <dd>Release version 1.0
81     </dd>
82     </dl>
83 </div>
84 </div>
86 {include resources/footer.md}