Updated the guide with info about the oscap_wrapper helper script.

odidev · Jun 14, 2019 · 633dc5a · 633dc5a
1 parent e4f4599
commit 633dc5a
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/docs/developer/developer.adoc b/docs/developer/developer.adoc
@@ -160,11 +160,12 @@ $ make install
 
 == Running oscap
 It is important to use your compiled `libopenscap.so` library with your `oscap` tool.
-The easiest way how to achieve that without need to install `libopenscap.so` to the system path, is to use a shell script called *run* in the OpenSCAP build directory.
+The easiest way how to achieve that without need to install `libopenscap.so` to the system path, is to use a shell script called *oscap_wrapper* or *run* in the OpenSCAP build directory.
 
 -------------------------------------------------
 $ cd build/
-$ bash ./run utils/oscap xccdf eval ... whatever
+$ ./oscap_wrapper xccdf eval ... whatever
+$ ./run valgrind utils/oscap xccdf eval ... whatever
 -------------------------------------------------
 
 The *run* script is generated at configure time by CMake and it sets the following environment variables:
@@ -176,6 +177,9 @@ The *run* script is generated at configure time by CMake and it sets the followi
 to generate html documents from xml)
 * *OSCAP_CPE_PATH* - path to the OpenSCAP CPE dictionary.
 
+The *oscap_wrapper* script is a convenience shortcut for `run utils/oscap` call.
+
+
 == Debugging
 Developers and users who intend to help find and fix possible bugs in OpenSCAP
 or possible bugs in their security policies have these possibilities: