NAME

SYNOPSIS

DESCRIPTION

The entire collection is scanned if no port origins are given.

The following options are available:

-l logdir

Save the log result into logdir instead of outputting to stdout. The log files will be dated and will include the current SVN revision or Git commit hash of portsdir. portscan creates portscan-latest.log and portscan-previous.log symlinks to point to the latest or previous results.

-p portsdir

The port directory to scan. If not specified defaults to /usr/ports or the value of PORTSDIR in the environment.

-q regexp

Filter returned values based on the given regular expressions.

--categories

Check categories for unhooked, wrong, or misordered entries.

--clones

Check for variables that are set twice.

--comments

Check comments for problems. Currently checks for commented PORTREVISION or PORTEPOCH lines.

--option-default-descriptions[=editdist]

Report redundant option descriptions. It checks them against the default descriptions in Mk/bsd.options.desc.mk. editdist is the edit distance between the default and port option description. It defaults to 3.

--options

Include port options and option groups in the result. Use -q to filter the options.

--progress[=interval]

Print regular progress reports. They are printed to stderr every interval seconds. interval defaults to 1 second. This option is enabled by default when stderr is a valid terminal type device. Use an interval of 0 to disable this. portscan will print progress reports when it receives SIGINFO or SIGUSR2.

--strict

For unknown variables do not check if they are referenced elsewhere in the Makefile and always report them. Without this option referenced but otherwise unknown variables will be ignored.

--unknown-targets

Scan for unknown or unrecognized targets.

--unknown-variables

Scan for unknown or unrecognized variables.

--variable-values[=regex]

Output variable values. If unconstrained this will output the value of every variable one by one. Use -q to filter the values and regex to select only a subset of all variables.

portscan will default to --categories, --clones, --comments, --option-default-descriptions, --unknown-targets, and --unknown-variables if no check was specified.

OUTPUT

#

Problematic comment

C

Unsorted category Makefile

Ce

Nonexistent port referenced by category Makefile

Cu

Unhooked port missing in category Makefile

E

Parser or IO errors encountered during the scan

OD

Redundant port option description that matches the default one

OG

Port option group

O

Port option

V

Unknown variable

Vc

Variable that is set twice or more

Vv

Variable value

T

Unknown target

origin is the origin of the variable or target.

name is the variable or target name. name might contain whitespace as part of its value. name never starts with whitespace. Any tools that consumes portscan output should keep this in mind.

ENVIRONMENT

PORTSDIR

The ports directory to operate on if -p is not specified.

EXIT STATUS

0

The collection was scanned successfully. An exit status of 0 does not mean there were no issues in the scanned ports.

1

An error occurred.

2

There were no changes when compared to previous results. Only possible when -l was passed to portscan.

EXAMPLES

portscan -l .
diff -u portscan-previous.log portscan-latest.log

Scan category Makefiles for mistakes:

portscan --categories

SEE ALSO

AUTHORS