Claudenw commented on PR #246:
URL: https://github.com/apache/creadur-rat/pull/246#issuecomment-2094238845
This change also updated the Help routines and the CLI usage of commons-cli.
New help screen now looks like:
```
usage: java -jar apache-rat/target/apache-rat-CURRENT-VERSION.jar [options]
[DIR|TARBALL]
====== Available Options ======
-a (deprecated) Add the default license
header to any file with an unknown license. Use '-A'
or ---addLicense instead.
-A,--addLicense Add the default license header to any
file with an unknown license that is not in the
exclusion list. By default new files
will be created with the license header, to force the
modification of existing files use the
--force option.
--archive <ProcessingType> Specifies how ARCHIVE processing will
be handled. (default is NOTIFICATION)
-c,--copyright <arg> The copyright message to use in the
license headers, usually in the form of "Copyright 2008
Foo"
-d,--dir <DirOrArchive> (deprecated, use '--') Used to
indicate source when using --exclude.
--dry-run If set do not update the files but
generate the reports.
-e,--exclude <Expression> Excludes files matching wildcard
<expression>. May be followed by multiple argumentsNote
that '--' or a following option is
required when using this parameter.
-E,--exclude-file <FileOrURI> Excludes files matching regular
expression in the input file.
-f,--force Forces any changes in files to be
written directly to the source files (i.e. new files are
not created).
-h,--help Print help for the RAT command line
interface and exit.
--licenses <FileOrURI> File names or URLs for license
definitions
--list-families <LicenseFilter> List the defined license families
(default is NONE). Valid options are: ALL, APPROVED, NONE
--list-licenses <LicenseFilter> List the defined licenses (default is
NONE). Valid options are: ALL, APPROVED, NONE
--log-level <LogLevel> sets the log level.
--no-default-licenses Ignore default configuration. By
default all approved default licenses are used
-o,--out <arg> Define the output file where to write
a report to (default is System.out).
-s,--stylesheet <arg> XSLT stylesheet to use when creating
the report. Not compatible with -x. Either an
external xsl file may be specified or
one of the internal named sheets: plain-rat (default),
missing-headers, or unapproved-licenses
--scan-hidden-directories Scan hidden directories
-x,--xml Output the report in raw XML format.
Not compatible with -s
====== Argument Types ======
<DirOrArchive>
A director or archive file to scan
<Expression>
A wildcard file matching pattern. example: *-test-*.txt
<FileOrURI>
A file name or URI
<LicenseFilter>
A defined filter for the licenses to include. Valid values: ALL,
APPROVED, NONE.
<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 archive as present
PRESENCE: List any licenses found
ABSENCE: List licenses found and any unknown licences
<StyleSheet>
Either an external xsl file may be one of the internal named sheets:
missing-headers, plain-rat, unapproved-licenses.
====== Notes ======
1. Rat highlights possible issues.
2. Rat reports require interpretation.
3. Rat often requires some tuning before it runs well against a project.
4. Rat relies on heuristics: it may miss issues
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
