citrun

watch C/C++ source code execute
Log | Files | Refs | LICENSE

citrun_inst.1 (1872B)

      1 .\"
      2 .\" Copyright (c) 2016 Kyle Milz <kyle@0x30.net>
      3 .\"
      4 .\" Permission to use, copy, modify, and distribute this software for any
      5 .\" purpose with or without fee is hereby granted, provided that the above
      6 .\" copyright notice and this permission notice appear in all copies.
      7 .\"
      8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
      9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     15 .\"
     16 .Dd $Mdocdate: August 13 2016 $
     17 .Dt CITRUN_INST 1
     18 .Os
     19 .Sh NAME
     20 .Nm citrun_inst
     21 .Nd rewrite source code
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Ar compile_cmd
     25 .Sh DESCRIPTION
     26 .Pp
     27 Warning:
     28 .Nm
     29 is not usually called directly. Use
     30 .Xr citrun_wrap 1
     31 instead.
     32 .Pp
     33 The
     34 .Nm
     35 utility performs source code rewriting. It visits statements in source files
     36 adding extra code to some of them.
     37 .Pp
     38 When a link command is detected extra arguments are added to the command line.
     39 .Pp
     40 .Nm
     41 should accept any
     42 .Ar compile_cmd
     43 that the compilers listed in
     44 .Xr citrun_wrap 1
     45 would accept.
     46 .Sh CALLING DIRECTLY
     47 When
     48 .Nm
     49 is called directly it only performs its source code rewriting
     50 step. That means it does not perform its usual call to compile the (possibly)
     51 rewritten source file.
     52 .Pp
     53 Calling directly is useful for debugging rewrite failures and rewritten source
     54 compile
     55 failures.
     56 .Pp
     57 In this mode, successfully rewritten source files have
     58 .Qq .citrun
     59 appended to their file name and diagnostic information is printed to both
     60 standard output and
     61 .Pa citrun.log .
     62 .Sh EXIT STATUS
     63 .Ex -std
     64 .Sh SEE ALSO
     65 .Xr citrun_wrap 1