doc/newlispdoc.1

   1 .TH newlispdoc 1 "January 2008" "version 1.4" "Commandline Parameters"
   2 .SH NAME
   3 .B newlispdoc
   4 \- generate documentation from newLISP source comments
   5 .SH SYNOPSIS
   6 .B newlispdoc
   7 [\-s] lisp\-file1 [lisp\-file2 ...]
   8
   9 .B newlispdoc
  10 [\s] [\-url] urls-file
  11 .SH DESCRIPTION
  12 newlispdoc is a commandline utility written in newLISP to generate HTML documentation from comments written in newLISP source files. Consult /usr/share/doc/newlisp/newLISPdoc.html for a detailed description on how to write comments usable for newlispdoc. The newlispdoc command should be executed from inside the directory where the newLISP source files can be found. The generated documetation files will have .html added to the name of the source file. An index.html page is generated, which is listing for each file links to all the documented functions.
  13 .SH OPTIONS
  14 .TP
  15 \-s
  16 this option causes newlispdoc to also generate a syntax highlighted HTML file of the source. A link to this file will be present in the HTML documentation of this file. The generated file will have the added extension .src.html.
  17 .TP
  18 lisp\-file
  19 is a commented newLISP source file from which a documentation file will be generated.
  20 .TP
  21 \-url
  22 this option is used to retrieve newLISP source files for documentation from remote locations.
  23 .TP
  24 urls-file
  25 is a file containing urls of newLISP source files, one url per line.
  26 .SH EXAMPLES
  27 .TP
  28 Generate all documentation form files in the current directory.
  29 .B newlispdoc
  30 afile.lsp bfile.lsp
  31 .PP
  32 .TP
  33 Generate documentation and syntax highlighted HTML versions from all lisp files in the current directory
  34 .B newlispdoc
  35 \-s *.lsp
  36 .TP
  37 Retrieve source files for documentation from remote locations. Each file is specified on one line in urls.txt with its http:// address.
  38 .B newlispdoc
  39 \-s \-url urls.txt
  40 .SH EXIT STATUS
  41 newlispdoc returns a zero exit status for normal exit or writes a usage message if not enough paramneters are supplied.
  42 .SH AUTHOR
  43 Lutz Mueller <lutz@nuevatec.com>
  44 .SH SEE ALSO
  45 newlisp(1) \- newlisp man page
  46
  47 http://www.newlisp.org/ \-  the newLISP home page
  48