newlispdoc(1)

1newlispdoc(1)               Commandline Parameters               newlispdoc(1)
2
3
4

NAME

6       newlispdoc - generate documentation from newLISP source comments
7

SYNOPSIS

9       newlispdoc [-s] [-d] lisp-file1 [lisp-file2 ...]
10
11       newlispdoc [-s] [-d] [-url] urls-file
12

DESCRIPTION

14       newlispdoc is a commandline utility written in newLISP to generate HTML
15       documentation from comments written in newLISP  source  files.  Consult
16       /usr/share/doc/newlisp/newLISPdoc.html  for  a  detailed description on
17       how to write comments usable for  newlispdoc.  The  newlispdoc  command
18       should  be  executed from inside the directory where the newLISP source
19       files can be found. The generated documetation files  will  have  .html
20       added  to the name of the source file. An index.html page is generated,
21       which is listing for each file links to all the  documented  functions.
22       If  the  current directory contains the file newlispdoc.css, it will be
23       used for formatting HTML output. For a sample  see  util/newlispdoc.css
24       in the source distribution.
25

OPTIONS

27       -s     this  option  causes  newlispdoc to also generate a syntax high‐
28              lighted HTML file of the source. A link to  this  file  will  be
29              present  in  the  HTML documentation of this file. The generated
30              file will have the added extension .src.html.
31
32       -d     also generate a link to the raw unformatted sourcefile.
33
34       lisp-file
35              is a commented newLISP source file from  which  a  documentation
36              file will be generated.
37
38       -url   this  option  is used to retrieve newLISP source files for docu‐
39              mentation from remote locations.
40
41       urls-file
42              is a file containing urls of newLISP source files, one  url  per
43              line.
44

EXAMPLES

46       Generate all documentation form files in the current directory.
47              newlispdoc afile.lsp bfile.lsp
48
49       Generate  documentation  and  syntax highlighted HTML versions from all
50       lisp files in the current directory and also supply a download link.
51              newlispdoc -s -d *.lsp
52
53       Retrieve source files for documentation  from  remote  locations.  Each
54       file is specified on one line in urls.txt with its http:// address.
55              newlispdoc -s -url urls.txt
56

EXIT STATUS

58       newlispdoc returns a zero exit status for normal exit or writes a usage
59       message if not enough paramneters are supplied.
60

AUTHOR

62       Lutz Mueller <lutz@nuevatec.com>
63