cloc (1)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man1/cloc.1".)

NAME

cloc - Count, and compute differences of, lines of source code and comments.

SYNOPSIS

  cloc [options] <FILE|DIR> ...

DESCRIPTION

Count, or compute differences of, physical lines of source code in the given files (may be archives such as compressed tarballs or zip files) and/or recursively below the given directories. It is written entirely in Perl, using only modules from the standard distribution.

OPTIONS

Input Options

To count standard input, use the special filename -.

--extract-with=CMD

This option is only needed if cloc is unable to figure out how to extract the contents of the input file(s) by itself. Use

CMD

to extract binary archive files (e.g.: .tar.gz, .zip, .Z). Use the literal '>FILE<' as a stand-in for the actual file(s) to be extracted. For example, to count lines of code in the input files gcc-4.2.tar.gz perl-5.8.8.tar.gz on Unix use:

    --extract-with='gzip -dc >FILE< | tar xf -

or, if you have

GNU

tar:

    --extract-with='tar zxf >FILE<'

and on Windows, use, for example:

    --extract-with="\"c:\Program Files\WinZip\WinZip32.exe\" -e -o >FILE<

--list-file=FILE

Take the list of file and/or directory names to process from

FILE

which has one file/directory name per line. See also --exclude-list-file

--unicode

Check binary files to see if they contain Unicode expanded

ASCII

text. This causes performance to drop noticably.

Processing Options

--autoconf

Count .in files (as processed by

GNU

autoconf) of recognized languages.

--by-file

Report results for every source file encountered.

--by-file-by-lang

Report results for every source file encountered in addition to reporting by language.

--diff

SET1 SET2

Compute differences in code and comments between source file(s) of

SET1

and

SET2.

The inputs may be pairs of files, directories, or archives. Use --diff-alignment to generate a list showing which file pairs where compared. See also --ignore-case, --ignore-whitespace.

--diff-timeout N

Ignore files which take more than N seconds to process. Default is 10 seconds. (Large files with many repeated lines can cause Algorithm::Diff::sdiff() to take hours.)

--follow-links

[Unix only] Follow symbolic links to directories (sym links to files are always followed).

--force-lang=LANG[,EXT]

Process all files that have a

EXT

extension with the counter for language

LANG.

For example, to count all .f files with the Fortran 90 counter (which expects files to end with .f90) instead of the default Fortran 77 counter, use:

        --force-lang="Fortran 90",f

If

EXT

is omitted, every file will be counted with the

LANG

counter. This option can be specified multiple times (but that is only useful when

EXT

is given each time). See also --script-lang, --lang-no-ext.

--force-lang-def=FILE

Load language processing filters from

FILE,

then use these filters instead of the built-in filters. Note: languages which map to the same file extension (for example: MATLAB/Objective C/MUMPS; Pascal/PHP; Lisp/OpenCL) will be ignored as these require additional processing that is not expressed in language definition files. Use --read-lang-def to define new language filters without replacing built-in filters (see also --write-lang-def).

--ignore-whitespace

Ignore horizontal white space when comparing files with --diff. See also --ignore-case.

--ignore-case

Ignore changes in case; consider upper- and lowercase letters equivalent when comparing files with --diff. See also --ignore-whitespace.

--lang-no-ext=LANG

Count files without extensions using the

LANG

counter. This option overrides internal logic for files without extensions (where such files are checked against known scripting languages by examining the first line for "#!"). See also --force-lang, --script-lang.

--max-file-size=MB

Skip files larger than "MB" megabytes when traversing directories. By default, "MB"=100. cloc's memory requirement is roughly twenty times larger than the largest file so running with files larger than 100

MB

on a computer with less than 2

GB

of memory will cause problems. Note: this check does not apply to files explicitly passed as command line arguments.

--read-binary-files

Process binary files in addition to text files. This is usually a bad idea and should only be attempted with text files that have embedded binary data.

--read-lang-def=FILE

Load new language processing filters from

FILE

and merge them with those already known to cloc. If

FILE

defines a language cloc already knows about, cloc's definition will take precedence. Use --force-lang-def to over-ride cloc's definitions. (see also --write-lang-def).

--script-lang=LANG,S

Process all files that invoke "S" as a "#!" scripting language with the counter for language

LANG.

For example, files that begin with "#!/usr/local/bin/perl5.8.8" will be counted with the Perl counter by using

        --script-lang=Perl,perl5.8.8

The language name is case insensitive but the name of the script language executable, "S", must have the right case. This option can be specified multiple times. See also --force-lang.

--sdir=DIR

Use

DIR

as the scratch directory instead of letting File::Temp chose the location. Files written to this location are not removed at the end of the run (as they are with File::Temp).

--skip-uniqueness

Skip the file uniqueness check. This will give a performance boost at the expense of counting files with identical contents multiple times (if such duplicates exist).

--stdin-name=FILE

Count lines streamed via

STDIN

as if they came from a file named

FILE.

--strip-comments=EXT

For each file processed, write to the current directory a version of the file which has blank lines and comments removed. The name of each stripped file is the original file name with ".EXT" appended to it. It is written to the current directory unless --original-dir is on.

--original-dir

Write the stripped files the same directory as the original files. Only effective in combination with --strip-comments.

--sum-reports

Input arguments are report files previously created with the --report-file option. Makes a cumulative set of results containing the sum of data from the individual report files.

--unix

Over-ride the operating system detection logic and run in

UNIX

mode. See also --windows, --show-os.

--windows

Over-ride the operating system detection logic and run in Microsoft Windows mode. See also --unix, --show-os.

Filter Options

--exclude-dir=<dir[,<dir> ...]>

Exclude the given comma separated directories from being scanned. For example:

        --exclude-dir=.cache,test

will skip all files that match "/.cache/" or "/test/" as part of their path. Directories named ".bzr", ".cvs", ".hg", ".git", ".hg", and ".svn" are always excluded.

--exclude-ext=EXT1[,EXT2 ...]

Do not count files having the given file name extensions.

--exclude-lang=<L1[,<L2> ...]>

Exclude the given comma separated languages from being counted.

--exclude-list-file=FILE

Ignore files whose names appear in

FILE. FILE

should have one entry per line. Relative path names will be resolved starting from the directory where cloc is invoked. See also --list-file.

--match-d=REGEX

Only count files in directories matching the Perl regex. For example

     --match-d='/(src|include)/'

only counts files in directory paths containing "/src/" or "/include/".

--not-match-d=REGEX

Count all files except in directories matching the Perl regex.

--match-f=REGEX

Only count files whose basenames match the Perl regex. For example this only counts files at start with Widget or widget:

     --match-f='^[Ww]idget'

--not-match-f=REGEX

Count all files except those whose basenames match the Perl regex.

--skip-archive=REGEX

Ignore files that end with the given Perl regular expression. For example, if given
  --skip-archive='(zip|tar(\.(gz|Z|bz2|xz|7z))?)' the code will skip files that end with .zip, .tar, .tar.gz, .tar.Z, .tar.bz2, .tar.xz, and .tar.7z.

--skip-win-hidden

On Windows, ignore hidden files.

Debug Options

--categorized=FILE

Save names of categorized files to

FILE.

--counted=FILE

Save names of processed source files to

FILE.

--diff-alignment=FILE

Write to

FILE

a list of files and file pairs showing which files were added, removed, and/or compared during a run with --diff. This switch forces the --diff mode on.

--help

Print this usage information and exit.

--found=FILE

Save names of every file found to

FILE.

--ignored=FILE

Save names of ignored files and the reason they were ignored to

FILE.

--print-filter-stages

Print to

STDOUT

processed source code before and after each filter is applied.

--show-ext[=EXT]

Print information about all known (or just the given) file extensions and exit.

--show-lang[=LANG]

Print information about all known (or just the given) languages and exit.

--show-os

Print the value of the operating system mode and exit. See also --unix, --windows.

-v[=<number]>

Turn on verbose with optional numeric value.

--version

Print the version of this program and exit.

--write-lang-def=FILE

Writes to

FILE

the language processing filters then exits. Useful as a first step to creating custom language definitions. See also --force-lang-def, --read-lang-def.

Output Options

--3

Print third-generation language output. (This option can cause report summation to fail if some reports were produced with this option while others were produced without it.)

--progress-rate=N

Show progress update after every N files are processed (default N=100). Set N to 0 to suppress progress output; useful when redirecting output to

STDOUT

.

--quiet

Suppress all information messages except for the final report.

--report-file=FILE

Write the results to

FILE

instead of standard output.

--out=FILE

Synonym for --report-file=FILE.

--csv

Write the results as comma separated values.

--csv-delimiter=C

Use the character C as the delimiter for comma separated files instead of ,. This switch forces --csv to be on.

--sql=FILE

Write results as

SQL CREATE

and

INSERT

statements which can be read by a database program such as SQLite. If

FILE

is -, output is sent to

STDOUT

.

--sql-project=NAME

Use <name> as the project identifier for the current run. Only valid with the --sql option.

--sql-append

Append

SQL

insert statements to the file specified by --sql and do not generate table creation option.

--sum-one

For plain text reports, show the

SUM:

output line even if only one input file is processed.

--xml

Write the results in

XML.

--xsl[=FILE]

Reference

FILE

as an

XSL

stylesheet within the

XML

output. If

FILE

is not given, writes a default stylesheet, cloc.xsl. This switch forces --xml to be on.

--yaml

Write the results in

YAML.

EXAMPLES

Count the lines of code in the Perl 5.10.0 compressed tar file on a UNIX-like operating system:

  cloc perl-5.10.0.tar.gz

Count the changes in files, code, and comments between Python releases 2.6.6 and 2.7:

  cloc --diff Python-2.6.6.tar.bz  Python-2.7.tar.bz2

To see how cloc aligns files for comparison between two code bases, use the --diff-alignment=FILE option. Here the alignment information is written to "align.txt":

  cloc --diff-aligment=align.txt gcc-4.4.0.tar.bz2  gcc-4.5.0.tar.bz2

Print the recognized languages

  cloc --show-lang

Remove comments from "foo.c" and save the result in "foo.c.nc"

  cloc --strip-comments=nc foo.c

Additional examples can be found at <cloc.sourceforge.net>.

ENVIRONMENT

None.

FILES

None.

SEE ALSO

sloccount(1)

AUTHORS

The cloc program was written by Al Danial <al.danial@gmail.com> and is Copyright (C) 2006-2013 Northrop Grumman Corporation.

The manual page was originally written by Jari Aalto <jari.aalto@cante.net>.

Both the code and documentation is released under the

version 2 or (at your option) any later version. For more information about license, visit <www.gnu.org/copyleft/gpl.html>.