aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d8a6663
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+NAME
+ braces - count number of braces in code
+
+SYNOPSIS
+ braces [-s] [file] ...
+
+DESCRIPTION
+ braces counts the number of braces in code for each specified
+ file. braces will treat each file as a C source code or
+ C header file. If file is -, or if a file is not specified,
+ the standard input is read.
+
+ If more than one file is specified, each successfully
+ processed file will have its line count output in the format
+
+ "%s:%*s%zu\n", <file>, <some positive integer>, "", <#braces in code>
+
+ The total for all processed files is printed on the last line
+ with the format
+
+ "%zu\n", <total #braces in code>
+
+ If exactly one or no files are specified, this will be the
+ only line output.
+
+OPTIONS
+ -s
+ Only output the last line. (The total over all files.)
+
+SEE ALSO
+ semicolons(1)