.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "REUSE-LINT" "1" "Dec 04, 2024" "5.0.2" "reuse"
.SH NAME
reuse-lint \- Verify whether a project is compliant with the REUSE Specification
.SH SYNOPSIS
.sp
\fBreuse lint\fP [\fIoptions\fP]
.SH DESCRIPTION
.sp
\fBreuse\-lint\fP verifies whether a project is compliant with the REUSE
Specification located at \X'tty: link https://reuse.software/spec'\fI\%https://reuse.software/spec\fP\X'tty: link'\&.
.SH CRITERIA
.sp
These are the criteria that the linter checks against.
.SS Bad licenses
.sp
Licenses that are found in \fBLICENSES/\fP that are not found in the SPDX License
List or do not start with \fBLicenseRef\-\fP are bad licenses.
.SS Deprecated licenses
.sp
Licenses whose SPDX License Identifier has been deprecated by SPDX.
.SS Licenses without file extension
.sp
These are licenses whose file names are a valid SPDX License Identifier, but
which do not have a file extension.
.SS Missing licenses
.sp
A license which is referred to in a comment header, but which is not found in
the \fBLICENSES/\fP directory.
.SS Unused licenses
.sp
A license found in the \fBLICENSES/\fP directory, but which is not referred to in
any comment header.
.SS Read errors
.sp
Not technically a criterion, but files that cannot be read by the operating
system are read errors, and need to be fixed.
.SS Files without copyright and license information
.sp
Every file needs to have copyright and licensing information associated with it.
The REUSE Specification details several ways of doing it. By and large, these
are the methods:
.INDENT 0.0
.IP \(bu 2
Placing tags in the header of the file.
.IP \(bu 2
Placing tags in a \fB\&.license\fP file adjacent to the file.
.IP \(bu 2
Putting the information in a \fBREUSE.toml\fP file, which must be in an ancestor
directory relative to the file.
.IP \(bu 2
Putting the information in the \fB\&.reuse/dep5\fP file. (Deprecated)
.UNINDENT
.sp
If a file is found that does not have copyright and/or license information
associated with it, then the project is not compliant.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Do not print anything to STDOUT.
.UNINDENT
.INDENT 0.0
.TP
.B \-j, \-\-json
Output the results of the lint as JSON.
.UNINDENT
.INDENT 0.0
.TP
.B \-p, \-\-plain
Output the results of the lint as descriptive text. The text is valid
Markdown. This option is the default.
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-lines
Output one line per error, prefixed by the file path.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help
Display help and exit.
.UNINDENT
.SH AUTHOR
Free Software Foundation Europe
.SH COPYRIGHT
2017, Free Software Foundation Europe. CC-BY-SA-4.0
.\" Generated by docutils manpage writer.
.