Heaven Files

dirindex, a utility to create an html file out of a directory tree.


... [1] installation :

 just run :

	$ make 

 to compile it and :

	$ make install

 to install it.


... [2] usage :

 dirindex <options>
  options:
	-d <directory>		directory to make the html file from
	-o <file>		output html file name
	-f <file>		format file
	-r 			recursively follow directories and link their elements to the output file
        -u                      dont unlink the format file after execution
                                (by default, dirindex deletes this file, adding this flag will make
                                it keep the file and read from it  until -H or -F flags are given)

                                if the format directory, specified on the command line, or 'mkformat' if
                                not, already exists, it will not be unlinked. passing an -H or -F option
                                to mki when this file exists will cause mki to rewrite this file and not
                                unlink it.

	
	-H <tags> 		header tags to use
	-F <tags> 		format tags to use
 
 
 the syntax of the format file is :


  mkiHeader: <header tags>
  mkiFooter: <footer tags>
  mkiEnd:

  "mkiHeader:" is used to define where the html header starts for the index file. "mkiFooter:" is used to
 discern the footer tags for the file, and "mkiEnd:" denotes the end of the file so's not to overrun the
 end of the format file. if any of the tags are missing no errors will be reported, and an empty html 
 file will be created.


... [3] information :

dirindex was written on a linux 2.4.4 machine

  supported platforms : 

	Linux
	NetBSD