1LICENSECHECK(1)                                                LICENSECHECK(1)
2
3
4

NAME

6       licensecheck - simple license checker for source files
7

SYNOPSIS

9       licensecheck --help|--version
10
11       licensecheck [--no-conf] [--verbose] [--copyright] [-l|--lines=N]
12       [-i|--ignore=regex] [-c|--check=regex] [-r|--recursive] list of files
13       and directories to check
14

DESCRIPTION

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
20       If any of the arguments passed are directories, licensecheck will add
21       the files contained within to the list of files to process.
22

OPTIONS

24       --verbose --no-verbose
25           Specify whether to output the text being processed from each file
26           before the corresponding license information.
27
28           Default is to be quiet.
29
30       -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
34       -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
39       -r --recursive
40           Specify that the contents of directories should be added
41           recursively.
42
43       -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
47           The default includes common source files.
48
49       --copyright
50           Also display copyright text found within the file
51
52       --no-conf --noconf Do not read any configuration files. This can only
53       be used as the first option given on the command-line.
54

CONFIGURATION VARIABLES

56       The two configuration files /etc/rpmdevtools/devscripts.conf and
57       ~/.devscripts are sourced by a shell in that order to set configuration
58       variables.  Command line options can be used to override configuration
59       file settings.  Environment variable settings are ignored for this
60       purpose.  The currently recognised variables are:
61
62       LICENSECHECK_VERBOSE
63           If this is set to yes, then it is the same as the --verbose command
64           line parameter being used. The default is no.
65
66       LICENSECHECK_PARSELINES
67           If this is set to a positive number then the specified number of
68           lines at the start of each file will be read whilst attempting to
69           determine the license(s) in use.  This is equivalent to the --lines
70           command line option.
71

LICENSE

73       This code is copyright by Adam D. Barratt <adam@adam-barratt.org.uk>,
74       all rights reserved; based on a script of the same name from the KDE
75       SDK, which is copyright by <dfaure@kde.org>.  This program comes with
76       ABSOLUTELY NO WARRANTY.  You are free to redistribute this code under
77       the terms of the GNU General Public License, version 2 or later.
78

AUTHOR

80       Adam D. Barratt <adam@adam-barratt.org.uk>
81
82
83
84Debian Utilities                  2012-09-26                   LICENSECHECK(1)
Impressum