dirindex.cfg

Package: WA2L/WinTools 1.2.08
Section: Configuration Files (4)
Updated: 31 March 2022
Index Return to Main Contents

 

NAME

dirindex.cfg - configuration file for DirIndex

 

SYNOPSIS

directory/dirindex.cfg

directory/configname.cfg

 

AVAILABILITY

WA2L/WinTools

 

DESCRIPTION

This is the optional configuration file for the DirIndex command.

 

FILEFORMAT

Rows starting with # are considered as comments.

The file format is OPTION=VALUE

Between the OPTION , the = and the VALUE are no spaces.

You can comment out any OPTION or completely remove the related setting line to use the default settings.

 

OPTIONS

TITLE
Title of the directory index.

Example: TITLE=Science Documents

Default: TITLE=File Index

SUBTITLE
Subtitle of the bibliography.

Example: SUBTITLE=Mathematics

Default: SUBTITLE=

ABSTRACT
Abstract text at in the bibliography header.

Example: ABSTRACT=This are the collected mathematical documents.

Default: ABSTRACT=

STYLE
Style selection.

Example: STYLE=GREEN

Default: STYLE=

OUTFILE
Style selection.

Example: OUTFILE=_MATHEMATICS_FILES.html

Default: OUTFILE=_DIRINDEX.html

FILES
List of meta files whose files should be included into the index.

The FILES settings is as in the lsw (1) command.

Example: FILES=*.pdf matrices\*.pdf basics\*.pdf

Default: FILES=*

EXCLUDES
files or directories to be excluded. The setting must be a valid regular expression as understood by egrep(1).

Note: The first whitespace in the example below is a tabulator.

Example: EXCLUDES=(( |\\)(tmp|temp|\.meta)(\\|$))|(\.meta$)

Default: EXCLUDES=(( |\\)(_old|_alt|\.sav|.*\.files|\.meta)(\\|$))|(\.meta$)

 

EXAMPLES

-

 

SEE ALSO

wintoolsintro(1), dirindex(1)

 

NOTES

-

 

BUGS

-

 

AUTHOR

dirindex.cfg 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
FILEFORMAT
OPTIONS
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

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