mirror of
https://github.com/ashinn/chibi-scheme.git
synced 2025-05-19 13:49:17 +02:00
8b5eb68238
They can be close()d explicitly with close-file-descriptor, and will close() on gc, but only explicitly closing the last port on them will close the fileno. Notably needed for network sockets where we open separate input and output ports on the same socket.
55 lines
1.1 KiB
Groff
55 lines
1.1 KiB
Groff
.TH "chibi-doc" "1" "" ""
|
|
.UC 4
|
|
.SH NAME
|
|
.PP
|
|
chibi-doc \- generate docs from Scheme scribble syntax
|
|
|
|
.SH SYNOPSIS
|
|
.B chibi-doc
|
|
[-hst]
|
|
[
|
|
.I file
|
|
]
|
|
.BR
|
|
|
|
.B chibi-doc
|
|
.I dotted-name.of.module
|
|
[
|
|
.I identifier
|
|
]
|
|
.BR
|
|
.SP 0.4
|
|
|
|
.SH DESCRIPTION
|
|
.I chibi-doc
|
|
is a tool to generate documentation from the Scheme scribble syntax
|
|
from Racket. It works like a Unix filter, translating from the
|
|
current input or a file to standard output. You can also specify a
|
|
module name, with components separated with dots, and it will search
|
|
for the module and generate documentation from it automatically from
|
|
literate comments in the module or any of its source files. These
|
|
comments are any line beginning with the characters
|
|
.I ;;>
|
|
|
|
The scribble syntax is described in the manual.
|
|
|
|
.SH OPTIONS
|
|
.TP 5
|
|
.BI -h
|
|
Outputs in HTML format (the default).
|
|
.TP
|
|
.BI -s
|
|
Outputs in SXML format.
|
|
.TP
|
|
.BI -t
|
|
Outputs in text format (the default for describing a single variable).
|
|
|
|
.SH AUTHORS
|
|
.PP
|
|
Alex Shinn (alexshinn @ gmail . com)
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
The chibi-scheme home-page:
|
|
.BR
|
|
http://code.google.com/p/chibi-scheme/
|