dir2html

(c) 2004 by Peer Schaefer (peer@wolldingwacht.de). dir2html is free software (see license below).


dir2html: a Perl script that generates an (optionally) commented HTML indexfile for a directory and (optionally) for all its subdirectories (and all its subsubdirs etc.).

dir2html generates an (optionally) commented HTML indexfile for a directory and (optionally) for all its subdirectories (and all its subsubdirs etc.)

And here are the downloads (written for perl v5.6.1):

Bug-reports, suggestions, corrections of my bad english (or just congratulations) are welcome! Send to Peer Schaefer, peer@wolldingwacht.de.


Usage: dir2html [OPTIONS] [--] [DIRECTORY]

DIRECTORY should specify the directory (path from the current directory) for which the indexfile has to be generated. If DIRECTORY is omitted, the indexfile is created for the current directory.

OPTIONS:

-o FILE, --output FILE The default name for the created indexfile is `index.html'. With this option you can
change it to FILE. If you specify `-' as FILE, then all output will be written to the standard output STDOUT. Multiple files
will be seperated by form feeds (\f = 0x0c = ASCII #12).
-r, --recursively An indexfile is not only generated for the specified DIRECTORY but also for all its subdirectories (and subsubdirs etc.). Each
indexfile is placed in the respective directory.
-c FILE, --commentfile FILE Creates a commented indexfile. All comments are generated using the specified FILE. The FILE should be a plain textfile (ASCII)
and each line should be in the following format:

FILENAME:COMMENTARY

If the created indexfile contains a reference to the file (or directory) FILENAME, then the COMMENTARY is written beneath the
filename.

-b NAME, --base NAME In the indexfile use NAME as the name of the DIRECTORY. The default is `/'. If you create indexfiles for subdirectories (using the -r option) the paths of these are based on NAME. That makes NAME your virtual `root'.
-p CHAR, --pathseparator CHAR Uses the character CHAR to separate the names of files and directories in the path which is displayed in the title of the indexfile. Default is the Unix style slash `/'. Windows users may find it convenient to replace it with a backslash `\' (to avoid confusing your shell you may use the keyword `backslash' instead of `\').
-v, --version Display the program version
-l, --license Display the license
-h, --help Display this help screen
-h2, --advanced-help Display another help screen with advanced options.

There are some advanced options for controlling the standard behaviour of the program. For these options please refer to the advanced help-screen, available through the -h2 option.

Send bug reports or suggestions to: peer@wolldingwacht.de

Notice:
A DIRECTORY name beginning with an `-' can be placed after a `--' to make clear that it is not an OPTION.


INI-File:
The program looks for a file named `dir2html.ini' in the current directory. If the file (called INI-file) is present, the program reads the file and scans it. Inside the INI-file you can configure the program similar to configuring it with options like -o or -r (use -h option for details). The INI-file should be a plain ASCII-textfile. The INI-file should have a section titled `[Defaults]' that contains commands in the format

KEY = VALUE

The following KEYS are available:

KEY EFFECT AS OPTION POSSIBLE VALUES
OutputFile -o see description of the -o option
Recursively -r YES or NO
CommentFile -c see description of the -c option
Base -b see description of the -b option
Exclamation -x see description of the -x option
PathSeparator -p see description of the -p option
Timestamp -s see description of the -s option
Title -t see description of the -t option
Filetype -f see description of the -f option
FileCounter -cf YES or NO
DirCounter -cd YES or NO
Tree -e YES or NO
Dirfiles -d see description of the -d option

To create an example INI-file (containing the default values) use the option -ci or --create-inifile.


License:
dir2html generates an (optionally) commented HTML indexfile for a directory and (optionally) for all its subdirectories (and all its subsubdirs etc.).

Written & copyright (c) 2004 by Peer Schaefer.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the

Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307
USA

It's also available from the web at http://www.gnu.org.


Return to my home page (in german)


Peer Schaefer's Website / This page: The dir2html indexfile creating utility / URL: http://www.wolldingwacht.de/progs/dir2html.html / Last update: 2004 April 7