DirIndex

Package: WA2L/WinTools 1.2.08
Section: General Commands (1)
Updated: 29 March 2022
Index Return to Main Contents

 

NAME

DirIndex - create directory and file HTML page based on directories and files

 

SYNOPSIS

WA2LWinTools/bin/DirIndex [ -h | -V | -i | -u ]

DirIndex [ -n ] {directory|directory/configname.cfg}...

 

AVAILABILITY

WA2L/WinTools

 

DESCRIPTION

create a HTML directory and file index page for file(s).

The directory index page file name is _DIRINDEX.html by default.

The DirIndex command should be installed to the 'Send To' context menu in 'Microsoft™ Windows Explorer' for most convenient usage. To do so, select the related option in config(1m).

 

OPTIONS

-h
usage message.

-V
print program version.

-i
install the DirIndex command as menu point to the 'Send To' context menu in 'Windows Explorer'.

-u
uninstall the DirIndex shortcut from the 'Send To' context menu in 'Windows Explorer'.

-n
non interactive execution (= no user dialog). This option can be used if the DirIndex command is scheduled.

directory...
directory for which to create a directory index HTML page for.

configname.cfg...
configuration file located in the directory where the directory index will be created. This configuration file allows to set additional properties for the generated index.

 

ENVIRONMENT

-

 

EXIT STATUS

0
no error.

4
usage message displayed.

5
program version printed.

 

FILES

directory/dirindex.cfg
optional configuration file located in the directory where the directory index will be created. This configuration file allows to set additional properties for the generated index.

If the configuration file with the name dirindex.cfg exists in a directory it is automatically read, also when only the directory is specified.

directory/configname.cfg
configuration file located in the directory where the directory index will be created. This configuration file allows to set additional properties for the generated index.

A configuration file with a name other then dirindex.cfg must be specified explicitly to be read by the DirIndex command.

 

EXAMPLES

-

 

SEE ALSO

wintoolsintro(1), dirindex.cfg(4), config(1m)

 

NOTES

-

 

BUGS

-

 

AUTHOR

DirIndex was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2022 Christian Walther

This is free software; see WA2LWinTools/man/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
OPTIONS
ENVIRONMENT
EXIT STATUS
FILES
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 16:31:59 GMT, September 14, 2024