[Forensics-changes] [yara] 94/135: Document the command-line -x option in the man page and add example to documentation

[Hilko Bengen]

This is an automated email from the git hooks/post-receive script.

bengen pushed a commit to annotated tag v3.1.0
in repository yara.

commit 542c955b20358a6e26092dd22ec57fa224ea413f
Author: Victor M. Alvarez <plusvic at gmail.com>
Date:   Wed Aug 13 13:42:16 2014 +0200

    Document the command-line -x option in the man page and add example to documentation
---
 docs/commandline.rst |  4 +++-
 yara.man             | 16 ++++++++++++++++
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/docs/commandline.rst b/docs/commandline.rst
index bf44c39..e2c2b11 100644
--- a/docs/commandline.rst
+++ b/docs/commandline.rst
@@ -106,6 +106,8 @@ Here you have some examples:
 
     yara -d mybool=true -d myint=5 -d mystring="my string" /foo/bar/rules bazfile
 
+* Apply rules on */foo/bar/rules* to *bazfile* while passing the content of
+  *cuckoo_json_report* to the cuckoo module::
 
-
+    yara -x cuckoo=cuckoo_json_report /foo/bar/rules bazfile
 
diff --git a/yara.man b/yara.man
index 30e27a6..7c0a9f4 100644
--- a/yara.man
+++ b/yara.man
@@ -58,6 +58,10 @@ has elapsed.
 .BI \-d " identifier"=value
 Define an external variable. This option can be used multiple times.
 .TP
+.BI \-x " module"=file
+Pass file's content as extra data to module. This option can be used multiple
+times.
+.TP
 .B \-r
 Scan files in directories recursively.
 .TP
@@ -110,6 +114,18 @@ Defines three external variables
 and
 .I mystring.
 .RE
+.PP
+$ yara -x cuckoo=cuckoo_json_report /foo/bar/rules bazfile
+.RS
+.PP
+Apply rules on
+.I /foo/bar/rules
+to
+.I bazfile
+while passing the content of
+.I cuckoo_json_report
+to the cuckoo module.
+.RE
 
 .SH AUTHOR
 Victor M. Alvarez <plusvic at gmail.com>;<vmalvarez at virustotal.com>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/forensics/yara.git