.\" Man page generated from reStructuredText.
.
.TH TLSH_UNITTEST 1 "" "" "Debian"
.SH NAME
tlsh_unittest \- compute TLSH digest values and distance
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
tlsh_unittest [\-c <file|digest>]         \-f <file>     [\-T <threshold_value>] [\-xlen] [\-details]
.sp
tlsh_unittest  \-c <file|digest>          \-d <digest>   [\-T <threshold_value>] [\-xlen] [\-details]
.sp
tlsh_unittest [\-c <file|digest> | \-xref] \-r <dir>      [\-T <threshold_value>] [\-xlen] [\-details]
.sp
tlsh_unittest [\-c <file|digest> | \-xref] \-l <listfile> [\-T <threshold_value>] [\-xlen] [\-details]
.sp
tlsh_unittest \-version
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
tlsh_unittest can be used to compute TLSH digest values or the distance between
digest values in the following ways:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
To compute the TLSH digest value of a single file (\fI\-f file\fP), or a
directory of files (\fI\-r dir\fP). This output can be used to create the
listfile required by the \fI\-l\fP option described below.
.IP 2. 3
To compute the distance between a comparison file or TLSH digest
(\fI\-c <file|digest>\fP) and the specified file (\fI\-f file\fP), TLSH digest (\fI\-d digest\fP),
directory of files (\fI\-r dir\fP), or list (\fI\-l listfile\fP).
.IP 3. 3
To compute the distance between each element in a set of files (\fI\-r dir\fP) or
files/digests in a list (\fI\-l listfile\fP) with every other element in that
set, using the \fI\-xref\fP flag
.UNINDENT
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-c \ <file|digest>
Specifies a filename or digest whose TLSH value will be
compared to a specified TLSH digest (\fI\-d\fP) OR the TLSH value
of a sepcified file (\fI\-f\fP) OR the TLSH values of files in a
specified directory (\fI\-r\fP) OR the TLSH values in a specified
listfile (\fI\-l\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-xref
Results in the calculation of distance between each
element in the set. Used only when a set of files (\fI\-r dir\fP) or TLSH values
(\fI\-l listfile\fP) is specified.
.UNINDENT
.INDENT 0.0
.TP
.BI \-f \ file
Specifies a file whose TLSH values are to be computed, or
used for comparison (\fI\-c <file|digest>\fP)
.TP
.BI \-d \ digest
Specifies a TLSH digest value that is to be compared to the specified
comparison file or digest (\fI\-c <file|digset>\fP)
.TP
.BI \-r \ dir
Specifies a recursive directory search for files whose TLSH values are to
be computed, or used for comparison (\fI\-c <file|digset>\fP or \fI\-xref\fP)
.TP
.BI \-l \ listfile
Used for comparison purposes only (\fI\-c <file|digset>\fP or \fI\-xref\fP). Each line in
listfile can contain either:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
a TLSH digest value (comparison output will display TLSH digests)
.IP \(bu 2
a tab separated TLSH digest value and its corresponding filename
(comparison output will display filenames)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The tab separated listfile can be generated by running
\fItlsh_unittest\fP with either the \fI\-f\fP or \fI\-r\fP flag
.UNINDENT
.INDENT 0.0
.TP
.B \-xlen
Determines if the lengths of the compared files is to be included in
determining the distance.
.TP
.B \-details
Results in extra detailed output.
.UNINDENT
.INDENT 0.0
.TP
.BI \-T \ threshold_value
Used only during comparisons (\fI\-c <file|digset>\fP or \fI\-xref\fP). Specifies the
maximun distance that a comparison must generate before it is reported
(defaults to 9999).
.UNINDENT
.SH EXAMPLE
.sp
Calculate the distance between two files:
.INDENT 0.0
.INDENT 3.5
tlsh_unittest \-c <file 1> \-f <file 2>
.UNINDENT
.UNINDENT
.sp
Calculate the distance between two TLSH digest values:
.INDENT 0.0
.INDENT 3.5
tlsh_unittest \-c <TLSH digest 1> \-d <TLSH digest 2>
.UNINDENT
.UNINDENT
.sp
Calculate the TLSH digest values for every file in a directory. This creates
input for the \-l option:
.INDENT 0.0
.INDENT 3.5
tlsh_unittest \-r <dir>
.UNINDENT
.UNINDENT
.sp
Get the distance between a reference TLSH digest value, and a list of TLSH
digest values in a file:
.INDENT 0.0
.INDENT 3.5
tlsh_unittest \-c <TLSH digest> \-l <file>
.UNINDENT
.UNINDENT
.sp
Compare the TLSH value for every file in a directory, to every other file in
that directory:
.INDENT 0.0
.INDENT 3.5
tlsh_unittest \-xref \-r <dir>
.UNINDENT
.UNINDENT
.SH NOTES
.sp
This man page has been adapted from \fItlsh_unittest\fP usage output for the Debian
project.
.SH AUTHOR
Jérémy Bobbio <lunar@debian.org>
.SH COPYRIGHT
Apache-2.0
.\" Generated by docutils manpage writer.
.