File: ocamlwc.1

package info (click to toggle)
ocamlwc 0.3-21
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 172 kB
  • sloc: makefile: 83; ml: 55; sh: 3
file content (45 lines) | stat: -rw-r--r-- 1,321 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
.TH OCAMLWC 1 "January 2, 2007"
.SH NAME
ocamlwc \- count the lines of code and comments in OCaml sources
.SH SYNOPSIS
.B ocamlwc
.RI [ options ]
.RI [ files ]
.br
.SH DESCRIPTION
.B ocamlwc
is a program to count the number of lines of code and documentation in OCaml
sources.  It assumes its input to be lexically well-formed.  If no
.I files
are given, then
.B ocamlwc
reads from stdin.
.PP
The first column of the output lists the number of source lines of code, the
second column the number of lines of documentation, and the third the
respective filename.  If
.B ocamlwc
acts on more than one file, then it prints a total in the last line.
.SH OPTIONS
.TP
.B \-p
Print percentage of documentation (in an additional column after the filename).
.TP
.B \-c
Print only the code size, i.e., omit the documentation column.
.TP
.B \-e
(everything) Do not skip headers.  A header is the first comment in a file.
.TP
.B \-a
(all) Do not skip generated files.  foo.ml is a generated file if one of
foo.mll, foo.mly, or foo.ml4 is amongst the given files.  foo.mli is a generated
file if foo.mly is amongst the given files.
.TP
.B \-h
Print short usage information.
.SH AUTHOR
ocamlwc was written by Jean-Christophe Filliatre
<Jean-Christophe.Filliatre@lri.fr>.
.br
This manual page was written by Georg Neis <gn@oglaroon.de>.