NAME
      parse-index - search and browse the FreeBSD ports INDEX*

SYNOPSIS
      parse-index -usage

      parse-index -show

      parse-index [ -port ] pattern

      parse-index [ -any | -comment | -port | -origin | -class
                    | -find=<too many options to list>
                  ]
                  pattern

DESCRIPTION
    Parse-index eases searching & browsing of *FreeBSD Ports INDEX**
    (without make(1) and without the restriction of being in /usr/ports)
    with help of Perl regular expressions.

    To search for a port (name), just specify a pattern; there is no
    pressing need to specify -port or -find=port option.

    The given arguments/patterns separated by spaces/tabs are turned into an
    OR'd regex. To avoid this behaviour, protect the spaces. In other words,
    take care to avoid shell interpretation.

OPTIONS
    -usage
      Show this message; overrides any other option.

    -dir=*ports tree location*
      Specify ports tree directory.

      If unspecified, *PORTSDIR* environment variable is checked. If this is
      also unspecified, /usr/ports is used as the default.

      This option overrides *PORTSDIR* which overrides default /usr/ports.

    -index=*name of index file*
      Specify name of the index file. Mind you that this is a file name not
      a file path (at least for now).

    -show
    -any
    -name
    -origin
    -comment
    -class
    -find=*show*|*any*|*name*|*origin*|*comment*|*class*|*category*
    -find=*maintainer*|*build-dep*|*run-dep*|*uri*
      Specify what to do, or where search in for given (command line)
      argument(s).

      show
        show the whole index.

      (Below are proper search options which define, for given arguments,
      the field (singular) to search for all the ports. Their purpose are
      explicitly listed for completeness sake even if that is blatantly
      obvious.)

      any
        search anywhere in a port's record.

      name
        search in port name.

        this option is assumed when any other options are missing and at
        least an argument (to search for) is given.

      origin
        search in origin (*bsd.port.mk* lists it as "port path").

      comment
        search in (one line) comment.

      maintainer
        search from maintainer (e-mail address).

      class | category
        search for the categories in which a particular port, well, has been
        categorized.

      build-dep
        search build dependencies.

      run-dep
        search run time dependencies.

      uri
        search for unique resource identifier, URI (web or FTP address for
        example).

ENVIRONMENT
    *PORTSDIR*
      Environment variable pointing to the location of ports tree.

FILES
    /usr/ports
      Default location of ports tree.

    /usr/ports/INDEX
      Default index file for FreeBSD [34].x.

    /usr/ports/Mk/bsd.port.mk
      just read it to see what it does.

DEPENDENCIES
    This program requires List::Util module, a standard module in Perl
    5.8.7.

BUGS
    Dependency search does not work right now.

SEE ALSO
    *FreeBSD::Ports* - More flexible Module similar to this program

    *pkg_info*(1), *ports*(7) *pkg_version*(1), *portupgrade*(1),
    *pkg_tree*(7)

    FreeBSD ports collection: http://www.freebsd.org/ports/

Author, Distribution and such
    Parv, parv(at)pair(dot)com

    Version: 1.04

    ModifieD: Feb 28 2006

    Free to use as you please w/ proper credit given. Use at your own risk.
    All responsibility for potential damage, loss, etc. is disclaimed.