Skip to content

Commit 4c13afb

Browse files
committed
Add crangler man page
This was built using help2man and then manually expanded.
1 parent a914ead commit 4c13afb

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

doc/man/crangler.1

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.TH CRANGLER "1" "June 2022" "crangler-5.59.0" "User Commands"
2+
.SH NAME
3+
crangler \- C source transformation
4+
.SH SYNOPSIS
5+
.B crangler [\-?] [\-h] [\-\-help]
6+
7+
.BI crangler \ file.json
8+
9+
.SH DESCRIPTION
10+
.B crangler
11+
is a command-line utility that makes changes to a preprocessed C file
12+
that are prescribed in a JSON configuration file.
13+
14+
The supported transformations are:
15+
.IP
16+
Add a contract (pre/post/assigns) to a named C function.
17+
.IP
18+
Add a loop invariant to a loop identified by the name of the function its in and
19+
a loop number.
20+
.IP
21+
Remove the
22+
.B static
23+
storage classifier from a function or a variable.
24+
.PP
25+
The resulting source file is written to standard output or to a file specified
26+
in the JSON configuration.
27+
.SH EXAMPLE
28+
The following JSON configuration file makes
29+
.B crangler
30+
preprocess
31+
.IR remove_static1.c ,
32+
removing the
33+
.B static
34+
storage classifier from all functions matching the regular expression
35+
.BR foobar[12] .
36+
The result is written to standard output.
37+
.EX
38+
{
39+
"sources": [
40+
"remove_static1.c"
41+
],
42+
"functions": [
43+
{
44+
"foobar[12]": [
45+
"remove static"
46+
]
47+
}
48+
],
49+
"output": "stdout"
50+
}
51+
.EE
52+
.SH ENVIRONMENT
53+
All tools honor the TMPDIR environment variable when generating temporary
54+
files and directories.
55+
.SH COPYRIGHT
56+
2021, Daniel Kroening

0 commit comments

Comments
 (0)