.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 1" .TH LICENSECHECK 1 "2016-07-25" "Debian Utilities" " " .\" 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 "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBlicensecheck\fR \fB\-\-help\fR|\fB\-\-version\fR .PP \&\fBlicensecheck\fR [\fB\-\-no\-conf\fR] [\fB\-\-verbose\fR] [\fB\-\-copyright\fR] [\fB\-l\fR|\fB\-\-lines=\fR\fIN\fR] [\fB\-i\fR|\fB\-\-ignore=\fR\fIregex\fR] [\fB\-c\fR|\fB\-\-check=\fR\fIregex\fR] [\fB\-m\fR|\fB\-\-machine\fR] [\fB\-r\fR|\fB\-\-recursive\fR] \&\fIlist of files and directories to check\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 "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-verbose\fR, \fB\-\-no\-verbose\fR" 4 .IX Item "--verbose, --no-verbose" Specify whether to output the text being processed from each file before the corresponding license information. .Sp Default is to be quiet. .IP "\fB\-l=\fR\fIN\fR, \fB\-\-lines=\fR\fIN\fR" 4 .IX Item "-l=N, --lines=N" Specify the number of lines of each file's header which should be parsed for license information. (Default is 60). .IP "\fB\-i=\fR\fIregex\fR, \fB\-\-ignore=\fR\fIregex\fR" 4 .IX Item "-i=regex, --ignore=regex" When processing the list of files and directories, the regular expression specified by this option will be used to indicate those which should not be considered (e.g. backup files, \s-1VCS\s0 metadata). .IP "\fB\-r\fR, \fB\-\-recursive\fR" 4 .IX Item "-r, --recursive" Specify that the contents of directories should be added recursively. .IP "\fB\-c=\fR\fIregex\fR, \fB\-\-check=\fR\fIregex\fR" 4 .IX Item "-c=regex, --check=regex" Specify a pattern against which filenames will be matched in order to decide which files to check the license of. .Sp The default includes common source files. .IP "\fB\-\-copyright\fR" 4 .IX Item "--copyright" Also display copyright text found within the file .IP "\fB\-m\fR, \fB\-\-machine\fR" 4 .IX Item "-m, --machine" Display the information in a machine readable way, i.e. in the form [] so that it can be easily sorted and/or filtered, e.g. with the \fBawk\fR and \fBsort\fR commands. Note that using the \fB\-\-verbose\fR option will kill the readability. .IP "\fB\-\-no\-conf\fR, \fB\-\-noconf\fR" 4 .IX Item "--no-conf, --noconf" Do not read any configuration files. This can only be used as the first option given on the command line. .SH "CONFIGURATION VARIABLES" .IX Header "CONFIGURATION VARIABLES" The two configuration files \fI/etc/devscripts.conf\fR and \&\fI~/.devscripts\fR are sourced by a shell in that order to set configuration variables. Command line options can be used to override configuration file settings. Environment variable settings are ignored for this purpose. The currently recognised variables are: .IP "\fB\s-1LICENSECHECK_VERBOSE\s0\fR" 4 .IX Item "LICENSECHECK_VERBOSE" If this is set to \fIyes\fR, then it is the same as the \fB\-\-verbose\fR command line parameter being used. The default is \fIno\fR. .IP "\fB\s-1LICENSECHECK_PARSELINES\s0\fR" 4 .IX Item "LICENSECHECK_PARSELINES" If this is set to a positive number then the specified number of lines at the start of each file will be read whilst attempting to determine the license(s) in use. This is equivalent to the \fB\-\-lines\fR command line option. .SH "LICENSE" .IX Header "LICENSE" This code is copyright by Adam D. Barratt <\fIadam@adam\-barratt.org.uk\fR>, all rights reserved; based on a script of the same name from the \s-1KDE SDK,\s0 which is copyright by <\fIdfaure@kde.org\fR>. This program comes with \s-1ABSOLUTELY NO WARRANTY.\s0 You are free to redistribute this code under the terms of the \s-1GNU\s0 General Public License, version 2 or later. .SH "AUTHOR" .IX Header "AUTHOR" Adam D. Barratt