1chibi-doc(1)                General Commands Manual               chibi-doc(1)
2
3
4

NAME

6       chibi-doc - generate docs from Scheme scribble syntax
7
8

SYNOPSIS

10       chibi-doc [-hst] [ file ]
11
12       chibi-doc dotted-name.of.module [ identifier ]
13
14

DESCRIPTION

16       chibi-doc  is a tool to generate documentation from the Scheme scribble
17       syntax from Racket.  It works like a Unix filter, translating from  the
18       current  input  or  a  file to standard output.  You can also specify a
19       module name, with components separated with dots, and  it  will  search
20       for  the  module  and generate documentation from it automatically from
21       literate comments in the module or any of its source files.  These com‐
22       ments are any line beginning with the characters ;;>
23
24       The scribble syntax is described in the manual.
25
26

OPTIONS

28       -h   Outputs in HTML format (the default).
29
30       -s   Outputs in SXML format.
31
32       -t   Outputs  in text format (the default for describing a single vari‐
33            able).
34
35

AUTHORS

37       Alex Shinn (alexshinn @ gmail . com)
38
39

SEE ALSO

41       The chibi-scheme home-page:  http://code.google.com/p/chibi-scheme/
42
43
44
454th Berkeley Distribution                                         chibi-doc(1)