1LICENSECHECK(1) LICENSECHECK(1)
2
6 licensecheck - simple license checker for source files
7
9 licensecheck --help|--version
10 licensecheck [--no-conf] [--verbose] [--copyright] [-l|--lines=N]
12 [-i|--ignore=regex] [-c|--check=regex] [-m|--machine] [-r|--recursive]
13 list of files and directories to check
14
16 licensecheck attempts to determine the license that applies to each
17 file passed to it, by searching the start of the file for text
18 belonging to various licenses.
19 If any of the arguments passed are directories, licensecheck will add
21 the files contained within to the list of files to process.
22
24 --verbose, --no-verbose
25 Specify whether to output the text being processed from each file
26 before the corresponding license information.
27 Default is to be quiet.
29 -l=N, --lines=N
31 Specify the number of lines of each file's header which should be
32 parsed for license information. (Default is 60).
33 -i=regex, --ignore=regex
35 When processing the list of files and directories, the regular
36 expression specified by this option will be used to indicate those
37 which should not be considered (e.g. backup files, VCS metadata).
38 -r, --recursive
40 Specify that the contents of directories should be added
41 recursively.
42 -c=regex, --check=regex
44 Specify a pattern against which filenames will be matched in order
45 to decide which files to check the license of.
46 The default includes common source files.
48 --copyright
50 Also display copyright text found within the file
51 -m, --machine
53 Display the information in a machine readable way, i.e. in the form
54 <file><tab><license>[<tab><copyright>] so that it can be easily
55 sorted and/or filtered, e.g. with the awk and sort commands. Note
56 that using the --verbose option will kill the readability.
57 --no-conf, --noconf
59 Do not read any configuration files. This can only be used as the
60 first option given on the command-line.
61
63 The two configuration files /etc/rpmdevtools/devscripts.conf and
64 ~/.devscripts are sourced by a shell in that order to set configuration
65 variables. Command line options can be used to override configuration
66 file settings. Environment variable settings are ignored for this
67 purpose. The currently recognised variables are:
68 LICENSECHECK_VERBOSE
70 If this is set to yes, then it is the same as the --verbose command
71 line parameter being used. The default is no.
72 LICENSECHECK_PARSELINES
74 If this is set to a positive number then the specified number of
75 lines at the start of each file will be read whilst attempting to
76 determine the license(s) in use. This is equivalent to the --lines
77 command line option.
78
80 This code is copyright by Adam D. Barratt <adam@adam-barratt.org.uk>,
81 all rights reserved; based on a script of the same name from the KDE
82 SDK, which is copyright by <dfaure@kde.org>. This program comes with
83 ABSOLUTELY NO WARRANTY. You are free to redistribute this code under
84 the terms of the GNU General Public License, version 2 or later.
85
87 Adam D. Barratt <adam@adam-barratt.org.uk>
88Debian Utilities 2014-06-09 LICENSECHECK(1)