"Fossies" - the Fresh Open Source Software Archive

Member "code2html-0.9.1/README" (12 Jan 2002, 1436 Bytes) of package /linux/www/old/code2html-0.9.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 *** README for code2html(1) ***
    2 *** $Revision: 1.2 $
    3 *** $Date: 2002/01/12 21:17:02 $
    4 
    5 [For details on installing code2html see the INSTALL file]
    6 
    7 This is the README for code2html, a tool wich allows you to convert
    8 your source code files to syntax highlighted HTML. In the future other 
    9 output-formats may be added, the hooks to support this are already
   10 there.
   11 
   12 
   13 For options and details please query the man-page which is distributed 
   14 together with code2thml. In short, there are 3 ways to use code2html:
   15 
   16 o Convert a simple source-code file to HTML. For example to convert
   17   the code2html perl script itself to an HTML file, use
   18 
   19 	code2html code2html out.html
   20 
   21   The first part ('code2html') calls the program itself, the second
   22   block is the source file, where code2html should take the
   23   source-code to syntax highlight from, and the third and last part is 
   24   the desitination file.
   25 
   26   The source and destination files are optional, if not given STDIN
   27   and STDOUT will be used.
   28 
   29 o Use code2html in patch mode. Code2html allows you to have inline
   30   source code in an HTML file. It can then take this file and replace
   31   the source code in the HTML file with its syntax highlighted
   32   counterpart. 
   33 
   34   For details see the man-page.
   35 
   36 o At last code2html can also be used as a CGI script.
   37 
   38   See the man-page and the example at
   39 
   40   http://www.palfrader.org/code2html/
   41 
   42   for details.
   43 
   44 
   45 Have fun.
   46 Peter Palfrader <code2html@palfrader.org>