doc/newlispdoc-man.txt

   1 newlispdoc(1)               Commandline Parameters               newlispdoc(1)
   2
   3
   4
   5 NAME
   6        newlispdoc - generate documentation from newLISP source comments
   7
   8 SYNOPSIS
   9        newlispdoc [-s] lisp-file1 [lisp-file2 ...]
  10
  11        newlispdoc [-url] urls-file
  12
  13 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
  23 OPTIONS
  24        -s     this option causes newlispdoc to also generate  a  syntax  high-
  25               lighted  HTML  file  of  the source. A link to this file will be
  26               present in the HTML documentation of this  file.  The  generated
  27               file will have the added extension .src.html.
  28
  29        lisp-file
  30               is  a  commented  newLISP source file from which a documentation
  31               file will be generated.
  32
  33        -url   this option is used to retrieve newLISP source files  for  docu-
  34               mentation from remote locations.
  35
  36        urls-file
  37               is  a  file containing urls of newLISP source files, one url per
  38               line.
  39
  40 EXAMPLES
  41        Generate all documentation form files in the current directory.
  42               newlispdoc afile.lsp bfile.lsp
  43
  44
  45        Generate documentation and syntax highlighted HTML  versions  from  all
  46        lisp files in the current directory
  47               newlispdoc -s *.lsp
  48
  49        Retrieve source files for documentation  from  remote  locations.  Each
  50        file is specified on one line in urls.txt with its http:// address.
  51               newlispdoc -s -url urls.txt
  52
  53 EXIT STATUS
  54        newlispdoc returns a zero exit status for normal exit or writes a usage
  55        message if not enough paramneters are supplied.
  56
  57 AUTHOR
  58        Lutz Mueller <lutz@nuevatec.com>
  59
  60 SEE ALSO
  61        newlisp(1) - newlisp man page
  62
  63        http://www.newlisp.org/ -  the newLISP home page
  64
  65
  66
  67
  68 version 1.4                      January 2008                    newlispdoc(1)
  69