.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "LICENSECHECK 1p"
.TH LICENSECHECK 1p "2021-02-06" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
licensecheck \- simple license checker for source files
.SH "VERSION"
.IX Header "VERSION"
Version v3.1.1
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBlicensecheck\fR \fB\-\-help\fR|\fB\-\-version\fR
.PP
\&\fBlicensecheck\fR [\fBoptions\fR...] \fIpath\fR [\fIpath\fR...]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBlicensecheck\fR attempts to determine the license that applies to each file
passed to it, by searching the start of the file for text belonging to
various licenses.
.PP
If any of the arguments passed are directories, \fBlicensecheck\fR will add
the files contained within to the list of files to process.
.SH "DEBUGGING"
.IX Header "DEBUGGING"
If either of environment variables \s-1INFO, DEBUG\s0 or \s-1TRACE\s0 is set to true,
varying details about discoveries are emitted to \s-1STDERR.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Other similar tools exist.
.PP
Here is a list of known tools also command-line based and general-purpose:
.IP "copyright-update <https://github.com/jaalto/project--copyright-update>" 16
.IX Item "copyright-update <https://github.com/jaalto/project--copyright-update>"
Written in Perl.
.IP "debmake <http://anonscm.debian.org/git/collab-maint/debmake.git>" 16
.IX Item "debmake <http://anonscm.debian.org/git/collab-maint/debmake.git>"
Written in Python.
.Sp
Specific to Debian packages.
.IP "decopy <https://anonscm.debian.org/git/collab-maint/decopy.git>" 16
.IX Item "decopy <https://anonscm.debian.org/git/collab-maint/decopy.git>"
Written in Python.
.Sp
)item Licensee <http://ben.balter.com/licensee/>
.Sp
Written in Ruby.
.IP "LicenseFinder <https://github.com/pivotal/LicenseFinder>" 16
.IX Item "LicenseFinder <https://github.com/pivotal/LicenseFinder>"
Written in Ruby.
.IP "ninka <http://ninka.turingmachine.org/>" 16
.IX Item "ninka <http://ninka.turingmachine.org/>"
Written in \*(C+.
.Sp
Used in FOSSology <http://fossology.org/>
(along with Monk and Nomos apparently unavailable as standalone command-line tools).
.IP "ripper <https://github.com/odeke-em/ripper>" 16
.IX Item "ripper <https://github.com/odeke-em/ripper>"
Written in Go.
.IP "scancode-toolkit <https://github.com/nexB/scancode-toolkit>" 16
.IX Item "scancode-toolkit <https://github.com/nexB/scancode-toolkit>"
Written in Python.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonas Smedegaard \f(CW\*(C`<dr@jones.dk>\*(C'\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This program is based on the script \*(L"licensecheck\*(R" from the \s-1KDE SDK,\s0
originally introduced by Stefan Westerfeld \f(CW\*(C`<stefan@space.twc.de>\*(C'\fR.
.PP
.Vb 1
\&  Copyright © 2007, 2008 Adam D. Barratt
\&
\&  Copyright © 2012 Francesco Poli
\&
\&  Copyright © 2016\-2020 Jonas Smedegaard
\&
\&  Copyright © 2017\-2020 Purism SPC
.Ve
.PP
This program is free software:
you can redistribute it and/or modify it
under the terms of the \s-1GNU\s0 Affero General Public License
as published by the Free Software Foundation,
either version 3, or (at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0;
without even the implied warranty
of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0
See the \s-1GNU\s0 Affero General Public License for more details.
.PP
You should have received a copy
of the \s-1GNU\s0 Affero General Public License along with this program.
If not, see <https://www.gnu.org/licenses/>.