[Forensics-changes] [yara] 157/160: Document new command-line options
Hilko Bengen
bengen at moszumanska.debian.org
Sat Jul 1 10:29:28 UTC 2017
This is an automated email from the git hooks/post-receive script.
bengen pushed a commit to annotated tag v3.4.0
in repository yara.
commit a96846f2bfea28ce2d5df47dc288e4e00847ed40
Author: Victor M. Alvarez <plusvic at gmail.com>
Date: Thu Jun 18 14:06:54 2015 +0200
Document new command-line options
---
docs/commandline.rst | 62 +++++++++++++++++++++++++++++-----------------------
yara.man | 5 ++++-
2 files changed, 39 insertions(+), 28 deletions(-)
diff --git a/docs/commandline.rst b/docs/commandline.rst
index e2c2b11..6b54a1c 100644
--- a/docs/commandline.rst
+++ b/docs/commandline.rst
@@ -26,65 +26,73 @@ Available options are:
.. program:: yara
-.. option:: -t <tag>
+.. option:: -t <tag> --tag=<tag>
- Print rules tagged as <tag> and ignore the rest.
+ Print rules tagged as <tag> and ignore the rest.
-.. option:: -i <identifier>
+.. option:: -i <identifier> --identifier=<identifier>
- Print rules named <identifier> and ignore the rest.
+ Print rules named <identifier> and ignore the rest.
.. option:: -n
- Print not satisfied rules only (negate).
+ Print not satisfied rules only (negate).
-.. option:: -g
+.. option:: -D --print-module-data
- Print tags.
+ Print module data.
-.. option:: -m
+.. option:: -g --print-tags
- Print metadata.
+ Print tags.
-.. option:: -s
+.. option:: -m --print-meta
- Print matching strings.
+ Print metadata.
-.. option:: -p <number>
+.. option:: -s --print-strings
- Use the specified <number> of threads to scan a directory.
+ Print matching strings.
-.. option:: -l <number>
+.. option:: -p <number> --threads=<number>
- Abort scanning after matching a number of rules.
+ Use the specified <number> of threads to scan a directory.
-.. option:: -a <seconds>
+.. option:: -l <number> --max-rules=<number>
- Abort scanning after a number of seconds has elapsed.
+ Abort scanning after matching a number of rules.
+
+.. option:: -a <seconds> --timeout=<seconds>
+
+ Abort scanning after a number of seconds has elapsed.
.. option:: -d <identifier>=<value>
- Define external variable.
+ Define external variable.
.. option:: -x <module>=<file>
- Pass file's content as extra data to module.
+ Pass file's content as extra data to module.
+
+.. option:: -r --recursive
+
+ Recursively search for directories.
-.. option:: -r
+.. option:: -f --fast-scan
- Recursively search for directories.
+ Fast matching mode.
-.. option:: -f
+.. option:: -w --no-warnings
- Fast matching mode.
+ Disable warnings.
-.. option:: -w
+.. option:: -v --version
- Disable warnings.
+ Show version information.
-.. option:: -v
+.. option:: -h --help
- Show version information.
+ Show help.
Here you have some examples:
diff --git a/yara.man b/yara.man
index aaf3ca6..dd0560a 100644
--- a/yara.man
+++ b/yara.man
@@ -31,6 +31,9 @@ and ignore the rest. This option can be used multiple times.
.B \-n " --negate"
Print rules that doesn't apply (negate)
.TP
+.B \-D " --print-module-data"
+Print module data.
+.TP
.B \-g " --print-tags"
Print the tags associated to the rule.
.TP
@@ -72,7 +75,7 @@ Speeds up scanning by searching only for the first occurrence of each pattern.
Disable warnings.
.TP
.B \-v " --version"
-Show version information.
+Show version information.
.SH EXAMPLES
$ yara /foo/bar/rules1 /foo/bar/rules2 .
.RS
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/forensics/yara.git
More information about the forensics-changes
mailing list