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       The following parameters are passed to clang from compiler’s command
21       line:
22
23       ·   -D...
24
25       ·   -I...
26
27       ·   -include ...
28
29       ·   -iquote ...
30
31       ·   -isystem ...
32
33       The following file extensions are recognized as C/C++ source files:
34
35       ·   c
36
37       ·   C
38
39       ·   cc
40
41       ·   cpp
42
43       ·   cxx
44
45       The following path substrings are black-listed from being scanned by
46       clang:
47
48       ·   conftest.c
49
50       ·   _configtest.c
51
52       ·   /CMakeTmp/
53
54       ·   ../test.c
55
56       If csclng is installed on system, the following command activates the
57       wrapper:
58
59           export PATH="`csclng --print-path-to-wrap`:$PATH"
60

OPTIONS

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

EXIT STATUS

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

ENVIRONMENT VARIABLES

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

BUGS

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

AUTHOR

90       Written by Kamil Dudka.
91

COPYING

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