Argument Types
Rat defines several argument types for the pom options. Available types are listed below
<CounterPattern> A pattern comprising one of the following prefixes followed by a colon and a count (e.g. UNAPPROVED:5). Prefixes are APPROVED: A count of approved licenses. Default range [0, unlimited] ARCHIVES: A count of archive files. Default range [0, unlimited] BINARIES: A count of binary files. Default range [0, unlimited] DOCUMENT_TYPES: A count of distinct document types. Default range [1, unlimited] IGNORED: A count of ignored files. Default range [0, unlimited] LICENSE_CATEGORIES: A count of distinct license categories. Default range [1, unlimited] LICENSE_NAMES: A count of distinct license names. Default range [1, unlimited] NOTICES: A count of notice files. Default range [0, unlimited] STANDARDS: A count of standard files. Default range [1, unlimited] UNAPPROVED: A count of unapproved licenses. Default range [0, 0] UNKNOWN: A count of unknown file types. Default range [0, unlimited]. <DirOrArchive> A directory or archive file to scan. <Expression> A file matching pattern usually of the form used in Ant build files and '.gitignore' files (see https://ant.apache.org/manual/dirtasks.html#patterns for examples). Regular expression patterns may be specified by surrounding the pattern with '%regex[' and ']'. For example '%regex[[A-Z].*]' would match files and directories that start with uppercase latin letters. <FamilyID> The ID for a license family. <File> A file name. <Integer> An integer value. <LicenseFilter> A defined filter for the licenses to include. Valid values: ALL, APPROVED, NONE. <LicenseID> The ID for a license. <LogLevel> The log level to use. Valid values DEBUG, INFO, WARN, ERROR, OFF. <ProcessingType> Specifies how to process file types. Valid values are: NOTIFICATION: List file as present PRESENCE: List any licenses found ABSENCE: List licenses found and any unknown licences <StandardCollection> Defines standard expression patterns (see above). Valid values are: ALL: All of the Standard Excludes combined. ARCH: The files and directories created by an ARCH source code control based tool. BAZAAR: The files and directories created by a Bazaar source code control based tool. BITKEEPER: The files and directories created by a Bitkeeper source code control based tool. CVS: The files and directories created by a CVS source code control based tool. DARCS: The files and directories created by a DARCS source code control based tool. ECLIPSE: The files and directories created by an Eclipse IDE based tool. GIT: The files and directories created by GIT source code control to support GIT, also processes files listed in '.gitignore'. HIDDEN_DIR: The hidden directories. Directories with names that start with '.' HIDDEN_FILE: The hidden files. Directories with names that start with '.' IDEA: The files and directories created by an IDEA IDE based tool. MAC: The .DS_Store files on Mac computers. MAVEN: The files and directories created by Maven build system based project. MERCURIAL: The files and directories created by a Mercurial source code control based tool. MISC: The set of miscellaneous files generally left by editors and the like. MKS: The files and directories created by an MKS source code control based tool. RCS: The files and directories created by a RCS source code control based tool. SCCS: The files and directories created by a SCCS source code control based tool. SERENA_DIMENSIONS_10: The files and directories created by a Serena Dimensions V10 change control system based tool. STANDARD_PATTERNS: A standard collection of generally accepted patterns to ignore. STANDARD_SCMS: A standard collection of SCMs SUBVERSION: The files and directories created by a Subversion source code control based tool. SURROUND_SCM: The files and directories created by a Surround SCM source code control based tool. VSS: The files and directories created by a Visual Source Safe source code control based tool. <StyleSheet> Either an external xsl file or one of the internal named sheets. Internal sheets are: plain-rat: The default style. missing-headers: Produces a report of files that are missing headers. unapproved-licenses: Produces a report of the files with unapproved licenses. xml: Produces output in pretty-printed XML.