portindex.cfg.sample

# This file contains -*- perl -*- code
#
# @(#) $Id$
#
# Sample configuration file for portindex, cache-init, cache-update
#

## Copy this file to any of /usr/local/etc/portindex.cfg,
## ${HOME}/.portindexrc or ./.portindexrc (ie. the CWD where any of
## the portindex processes are run), and edit the configuration
## settings to taste, which will set the appropriate entries in the
## global %Config hash.  Nothing in this file is obligatory, nor is
## any configuration file required to be present: there are built-in
## defaults for everything.

## Available configuration and command line options are listed,
## indicating which programs they affect.  The default values are
## shown, commented out.  All options can be overriden from the
## command line.

## all (-c, --cache-dir): Directory where BDB btree files containing
## the cache and master-slave relationships are stored.

# $Config{CacheDir} = '/var/db/portindex';

## all (-C, --cache-file): BDB btree file within the CacheDir
## containing the cached 'make describe' output.

# $Config{CacheFilename} = 'portindex-cache.db';

## portindex (-W --crunch-white --nocrunch-white): Boolean. If true,
## emulate 'make index' more closely by converting multiple whitespace
## into single spaces in the port comment field.  This has a purely
## cosmetic effect on the output INDEX and doesn't affect the cache
## contents.

# $Config{CrunchWhitespace} = 0;

## cache-update, cache-init (-m --endemic-makefile): List of Makefiles
## from within $Config{PortsDir} whose inclusion or modification is
## assumed to have no effect on the resulting INDEX file, hence those
## file names will not be stored in the cache. (Note: non-absolute
## paths are taken as relative to $Config{PortsDir})

# $Config{EndemicMakefiles} = [ qw(
#              /usr/ports/Mk/bsd.commands.mk
#              /usr/ports/Mk/bsd.licenses.db.mk
#              /usr/ports/Mk/bsd.licenses.mk
#              /usr/ports/Mk/bsd.options.desc.mk
#              /usr/ports/Mk/bsd.options.mk
#              /usr/ports/Mk/bsd.pbi.mk
#              /usr/ports/Mk/bsd.pkgng.mk
#              /usr/ports/Mk/bsd.sites.mk
#              /usr/share/mk/bsd.compat.mk
#              /usr/share/mk/bsd.cpu.mk
#              /usr/share/mk/bsd.own.mk
#              /usr/share/mk/bsd.port.mk
#              /usr/share/mk/bsd.port.options.mk
#              /usr/share/mk/bsd.port.post.mk
#              /usr/share/mk/bsd.port.pre.mk
#              /usr/share/mk/sys.mk
#     ) ];

## cache-update (--input-format, --format): What format to treat the
## input data as.  Choices are:
##    plain           -- a list of port directory origins, one per line
##    cvsup-output    -- Output from running cvsup(1) with at least -L1
##    cvsup-checkouts -- The cvsup(1) checkouts or list file
##    options         -- Scan the contents of PORTS_DBDIR to find port
##                       OPTIONS settings changed more recently than the
##                       data in the ports cache.
##    other           -- check timestamps for various makefiles outside
##                       PORTSDIR or PORT_DBDIR
##    cache           -- compare timestamps of makefiles and pkg-descr files
##                       against values recorded in cache (default) 

## Additionally you can append ',options' and/or ',other' to any of
## the first three to make cache-update scan for changes to port
## OPTIONS or changes to other makefiles as well as using the primary
## input mechanism.

## If the cvsup-checkouts format is chosen, the input file will
## usually be /var/db/sup/ports-all/checkouts.cvs:.

# $Config{Format} = 'cache';

## cache-update (-i, --input): Filename to read input from, '-' for
## STDIN

# $Config{Input} = '-';

## portindex (-o, --output): Filename to write the INDEX data out to,
## '-' for STDOUT

# $Config{Output} = '-';

## cache-update (-d, --port-dbdir): Where OPTIONS settings are
## stored, same as the PORT_DBDIR environment variable.

# $Config{PortDBDir} = $ENV{PORT_DBDIR} || '/var/db/ports';

## portdepends (-s, --style {short|graph|default}): When set to
## 'graph', output digraph code that can be fed into GraphViz to
## generate a diagram of dependencies between ports.  When set to
## 'short' instead of an exhaustive listing of the dependency tree,
## only visit each node at most one time.  Any other setting results
## in the default exhaustive long listing.

# $Config{OutputStyle} = 'default';

## cache-init, cache-update, find-updated (-p, --ports-dir): Base
## directory of the ports tree, same as the PORTSDIR environment
## variable.

# $Config{PortsDir} = $ENV{PORTSDIR} || '/usr/ports';

## make-readmes (-d, --output-directory): top of the directory tree to
## create, containing the generated README.html files.  Default: ./ports
## (in current working directory).

# $Config{ReadmeDir} = "./ports";

## make-readmes (-t --template-directory): Where to read the template
## README.html files from.

# $Config{ReadmeTemplateDir} = "$ENV{PORTSDIR}/Templates" || '/usr/ports/Templats';

## cache-init, cache-update (-s, --scrub-environment,
## --noscrub-environment): Boolean -- delete everything from the
## environment except for USER, HOME, PATH, SHELL, TERM, TERMCAP if
## true.  Default no or if value set to false.

# $Config{ScrubEnvironment} = 0;

## portindex (-L, --shlibs, --noshlibs): Boolean -- when enabled,
## instead of generating an INDEX file, generate an alternative format
## 'SHLIBS' file showing the cumulative dependencies of each port on
## other ports that provide shared libraries.  In principle, given
## this data it is easy to work out what ports need a PORTREVISION
## bump when a shared library ABI is updated.

# $Config{ShLibs} = 0;

## portindex (-S, --strict, --nostrict): Boolean -- currently 'strict'
## mode enforces the check that ports are referenced from their
## immediately superior category -- ie. that they are 'connected to
## the ports.'  It may be extended in future.

# $Config{Strict} = 1;

## all (-T, --timestamp-file): Filename within CacheDir used to mark
## the last time any updates to the cache were made.

# $Config{TimestampFile} = 'portindex-timestamp';

## cache-update, cache-init (-M, --ubiquitous-makefile): List of
## Makefiles included by all or the vast majority of ports.
## cache-update will emit a warning if any Makefile on this list has
## been modified since the last time the cache was updated, saying
## that it might be preferable to re-initialise the cache from scratch
## using cache-init(1) rather than trying to do an incremental update.

## Default: the list as shown below (Note: non-absolute paths are
## taken as relative to $Config{PortsDir})

# $Config{UbiquitousMakefiles} = [ qw(
#              /etc/make.conf
#              /usr/ports/Mk/bsd.commands.mk
#              /usr/ports/Mk/bsd.licenses.mk
#              /usr/ports/Mk/bsd.options.desc.mk
#              /usr/ports/Mk/bsd.options.mk
#              /usr/ports/Mk/bsd.pbi.mk
#              /usr/ports/Mk/bsd.perl.mk
#              /usr/ports/Mk/bsd.pkgng.mk
#              /usr/ports/Mk/bsd.port.mk
#              /usr/ports/Mk/bsd.sites.mk
#              /usr/share/mk/bsd.compat.mk
#              /usr/share/mk/bsd.cpu.mk
#              /usr/share/mk/bsd.own.mk
#              /usr/share/mk/bsd.port.mk
#              /usr/share/mk/sys.mk
#     ) ];

## all (-v, -q, --verbose, --noverbose, --quiet): Boolean -- turn on
## verbose output if true, turn off if false or undef

# $Config{Verbose} = 1;

## all (-w, --warnings, --nowarnings): Boolean -- turn on various
## warning messages about a number of non-fatal problems if true, turn
## off if false or undef

# $Config{Warnings} = 0;

##
## That's All Folks!
##