GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CHIBI-DOC (1)

NAME

chibi-doc - generate docs from Scheme scribble syntax

CONTENTS

Synopsis
Description
Options
Authors
See Also

SYNOPSIS

chibi-doc [-hst] [ file ]

chibi-doc dotted-name.of.module [ identifier ]

DESCRIPTION

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 ;;>

The scribble syntax is described in the manual.

OPTIONS

-h Outputs in HTML format (the default).
-s Outputs in SXML format.
-t Outputs in text format (the default for describing a single variable).

AUTHORS

Alex Shinn (alexshinn @ gmail . com)

SEE ALSO

The chibi-scheme home-page: http://code.google.com/p/chibi-scheme/

Search for    or go to Top of page |  Section 1 |  Main Index


CHIBI-DOC (1)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.