1CSCLNG(1)                                                            CSCLNG(1)
2
3
4

NAME

6       csclng - a compiler wrapper that runs the Clang analyzer in background
7

SYNOPSIS

9       csclng [--help | --print-path-to-wrap]
10

DESCRIPTION

12       csclng is a compiler wrapper that runs clang in background. Create a
13       symbolic link to csclng named as your compiler (gcc, g++, ...) and put
14       it to your $PATH.
15
16       The following parameters are given to clang by default:
17
18       ·   --analyze
19
20       ·   -Xanalyzer -analyzer-output=text
21
22       The following parameters are passed to clang from compiler’s command
23       line:
24
25       ·   -D...
26
27       ·   -I...
28
29       ·   -include ...
30
31       ·   -iquote ...
32
33       ·   -isystem ...
34
35       The following file extensions are recognized as C/C++ source files:
36
37       ·   c
38
39       ·   C
40
41       ·   cc
42
43       ·   cpp
44
45       ·   cxx
46
47       The following path substrings are black-listed from being scanned by
48       clang:
49
50       ·   conftest.c
51
52       ·   _configtest.c
53
54       ·   /CMakeTmp/
55
56       ·   ../test.c
57
58       If csclng is installed on system, the following command activates the
59       wrapper:
60
61           export PATH="`csclng --print-path-to-wrap`:$PATH"
62

OPTIONS

64       --help
65           Prints basic usage information.
66
67       --print-path-to-wrap
68           Prints path to the directory with symlinks to the csclng
69           executable.
70

EXIT STATUS

72       csclng propagates the exit status returned by the compiler (in case
73       csclng succeeds to run the compiler). The exit status returned by clang
74       does not affect the resulting exit status.
75

ENVIRONMENT VARIABLES

77       DEBUG_CSCLNG
78           If set to a non-empty string, csclng outputs the list of parameters
79           given to clang to the standard output.
80
81       CSCLNG_ADD_OPTS
82           csclng expects a colon-separated list of Clang options that should
83           be appended to command line prior to invoking Clang. The options
84           are appended even if they already appear in the command line and
85           they are always appended at the end of the command line.
86

BUGS

88       Please report bugs and feature requests at
89       https://github.com/kdudka/cscppc .
90

AUTHOR

92       Written by Kamil Dudka.
93

COPYING

95       Copyright (C) 2013-2014 Red Hat, Inc. Free use of this software is
96       granted under the terms of the GNU General Public License (GPL). See
97       the COPYING file for details.
98
99
100
101                                  02/05/2020                         CSCLNG(1)