commit d9f34c05cccf8ad62f2545c301467881af51ba8e parent a412aa5601d7c7164fbb47476486ad36fb547912 Author: Kyle Milz <kyle@0x30.net> Date: Fri, 5 Aug 2016 00:40:39 -0600 man: make synopsis better Diffstat:
| M | man/citrun-wrap.1 | | | 24 | ++++++++++-------------- |
1 file changed, 10 insertions(+), 14 deletions(-)
diff --git a/man/citrun-wrap.1 b/man/citrun-wrap.1 @@ -21,32 +21,28 @@ .Nd instrument a build command .Sh SYNOPSIS .Nm -.Ar make | -.Ar jam | -.Ar gcc | -.Ar cmake | -.Ar ... +.Ar build_cmd .Sh DESCRIPTION -Add instrumentation to any C/C++ source files compiled during a build command. -.Pp +Add instrumentation to any source files compiled by +.Ar build_cmd . The build command must search .Ev PATH when finding compiler executables, which must be one of the following: .Pp .Bl -bullet -compact .It -clang / clang++ +clang or clang++ .It -egcc / eg++ +egcc or eg++ .It -gcc / g++ +gcc or g++ .It -cc / c++ +cc or c++ .El .Pp -Because instrumentation is silent any activity is logged to the -.Pa citrun.log -file. Instrumentations summaries can be generated by the +All instrumentation activity is logged to +.Pa citrun.log . +Instrumentation summaries can be generated by the .Xr citrun-check 1 script. .Pp