Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.code.sf.net/p/ssdeep/code/trunk@87 d1b3761f-3242-0410-b1a5-fe525d664610
  • Loading branch information
jessekornblum committed Jan 10, 2010
1 parent a28105d commit 1829404
Show file tree
Hide file tree
Showing 6 changed files with 295 additions and 180 deletions.
3 changes: 2 additions & 1 deletion NEWS
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
** Version 2.3 - RBF DATE 2009
** Version 2.3 - 10 Jan 2010

* New Features

- Added -a mode to display all 'matches', regardless of score.



** Version 2.2 - 22 Jul 2009

* New Features
Expand Down
29 changes: 23 additions & 6 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -1,11 +1,28 @@
clean:
# This Makefile is separate from the autotools files in the
# top level directory. It is used only to clean up and
# publish files for the public web site.
#
# $Id$
#

ALL_FILES = manpage.txt ssdeep.html usage.html changes.txt style.css

USERNAME = jessekornblum,ssdeep
DESTDIR = web.sourceforge.net:htdocs/

RMAN = /sw/bin/rman

preflight:
rm -f *~
grep RBF *.html *.txt

manpages:
$(RMAN) -f HTML -S -l "ssdeep man page" ../ssdeep.1 > manpage.html

changes:
cp ../NEWS changes.txt
man ../ssdeep.1 | col -bx > manpage.txt

publish:
scp ssdeep.html [email protected]:/home/groups/s/ss/ssdeep/htdocs/

all:
scp changes.txt manpage.txt *.css *.html [email protected]:/home/groups/s/ss/ssdeep/htdocs/
rsync -avP -e ssh $(ALL_FILES) $(USERNAME)@$(DESTDIR)

all: manpages changes publish
8 changes: 8 additions & 0 deletions doc/changes.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
** Version 2.3 - 10 Jan 2010

* New Features

- Added -a mode to display all 'matches', regardless of score.



** Version 2.2 - 22 Jul 2009

* New Features
Expand Down
162 changes: 162 additions & 0 deletions doc/manpage.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
<!-- manual page source format generated by PolyglotMan v3.1, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->

<html>
<head>
<title>ssdeep man page</title>
</head>
<body bgcolor='white'>
<a href='#toc'>Table of Contents</a><p>
<p>

<h2><a name='sect0' href='#toc0'>Name</a></h2>
ssdeep - Computes context triggered piecewise hashes <p>

<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
<b>ssdeep
[-m &lt;file&gt;] [-vprdsblcxa] [-t val] [FILES]</b> <br>
<b>ssdeep [-V|h] </b> <p>

<h2><a name='sect2' href='#toc2'>Description</a></h2>
<p>
Computes a checksum based on context triggered
piecewise hashes for each input file. If requested, the program matches
those checksums against a file of known checksums and reports any possible
matches. It can also examine one or more of signatures and find any matches
in those signatures. Output is written to standard out and errors to standard
error. Input from standard input is not supported. <p>

<dl>

<dt><b>-m &lt;file&gt;</b> </dt>
<dd>Load the file
of known hashes to be used for matching. This file must be a previous output
of the program and have the correct header. Displays only those files that
match a known file and what file they matched against. Although filenames
may not contain Unicode characters, they can hold hashes with Unicode filenames.
<p>
</dd>

<dt><b>-v</b> </dt>
<dd>Verbose mode. The name of each file is printed to standard error as it
is being hashed. <p>
<p>
</dd>

<dt><b>-p</b> </dt>
<dd>Pretty matching mode. Computes signatures for all input
files and then display all matches between files. That is, if file A matches
file B, displays "A matches B" and "B matches A" but not "A matches A".
Each file's information is grouped and separated by newlines. This flag
may be used with the <b>-m</b> flag, but not the <b>-d</b> flag. <p>
</dd>

<dt><b>-r</b> </dt>
<dd>Enables recursive mode.
All subdirectories are traversed. Please note that recursive mode cannot
be used to examine all files of a given file extension. For example, invoking
the program with <b>-r *.txt</b> will examine all files in directories that end
in .txt. If you want to process all files in a directory tree with the .txt
suffix, try using the <b><a href='find.1'>find(1)</b></a>
command. <p>
</dd>

<dt><b>-d</b> </dt>
<dd>Enables directory mode. In this
mode, all of the FILES are examined and a signature is computed for each.
If the signature for any files matches any of the previously computed signatures,
a match is displayed just like the <b>-d</b> mode. This flag may also be used in
conjunction with the <b>-m</b> mode, but with the <b>-p</b> mode. <p>
</dd>

<dt><b>-s</b> </dt>
<dd>Silent mode. All error
messages are suppressed. <p>
</dd>

<dt><b>-b</b> </dt>
<dd>Enables bare mode. Strips any leading directory
information from displayed filenames. This flag may not be used in conjunction
with the <b>-l</b> flag. <p>
</dd>

<dt><b>-l</b> </dt>
<dd>Enables relative file paths. Instead of printing the
absolute path for each file, displays the relative file path as indicated
on the command line. This flag may not be used in conjunction with the
<b>-b</b> flag. <p>
</dd>

<dt><b>-c</b> </dt>
<dd>Enables comma separated output mode. In any of the matching modes
-d, -p, or -m, displays the results as input file, known file, matching score.
<p>
</dd>

<dt><b>-x</b> </dt>
<dd>Enables signature file matching. The input FILES are assumed to contain
ssdeep formatted signatures. All of the signatures in these FILES are loaded
into memory and compared against each other. All matches are displayed,
except for matches that have the same filename and come from the same input
file. <p>
</dd>

<dt><b>-a</b> </dt>
<dd>Displays all matches in any of the matching mode, regardless of
score. Yes, this displays all 'matches', even if the match score is zero. <p>

</dd>

<dt><b>-t &lt;val&gt;</b> </dt>
<dd>In any of the matching modes, only displays matches whose match score
is above the given value. <p>
</dd>

<dt><b>-h</b> </dt>
<dd>Show a help screen and exit. <p>
</dd>

<dt><b>-V</b> </dt>
<dd>Show the version
number and exit. <p>
<p>
</dd>
</dl>

<h2><a name='sect3' href='#toc3'>Return Value</a></h2>
Returns 0 on success, 1 if there is a problem.
Read errors, permission denied, and encountering directories while not
in recursive mode are still considered successes. Problems are things like
being unable to load the matching file, specifying both bare and relative
paths, etc. <p>

<h2><a name='sect4' href='#toc4'>Author</a></h2>
ssdeep was written by Jesse Kornblum, ManTech International
Corporation <br>
<p>
jesse DoT kornblum =-=at mantech dot com <p>
<p>

<h2><a name='sect5' href='#toc5'>Copyright</a></h2>
This program is Copyright
(C) 2006-2008 ManTech International Corporation and is licensed under the
terms of the General Public License. See the file COPYING for details. <p>

<h2><a name='sect6' href='#toc6'>See
Also</a></h2>
This program is based on SpamSum by Dr. Andrews Tridgell. <br>
<a href='http://www.samba.org/ftp/unpacked/junkcode/spamsum/'>http://www.samba.org/ftp/unpacked/junkcode/spamsum/</a>
<p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Description</a></li>
<li><a name='toc3' href='#sect3'>Return Value</a></li>
<li><a name='toc4' href='#sect4'>Author</a></li>
<li><a name='toc5' href='#sect5'>Copyright</a></li>
<li><a name='toc6' href='#sect6'>See Also</a></li>
</ul>
</body></html>
123 changes: 0 additions & 123 deletions doc/manpage.txt

This file was deleted.

Loading

0 comments on commit 1829404

Please sign in to comment.