From 1829404c7a968b28f6468c4ed30ac792a612b417 Mon Sep 17 00:00:00 2001 From: jessekornblum Date: Sun, 10 Jan 2010 15:10:40 +0000 Subject: [PATCH] Updating documentation git-svn-id: https://svn.code.sf.net/p/ssdeep/code/trunk@87 d1b3761f-3242-0410-b1a5-fe525d664610 --- NEWS | 3 +- doc/Makefile | 29 +++++++-- doc/changes.txt | 8 +++ doc/manpage.html | 162 +++++++++++++++++++++++++++++++++++++++++++++++ doc/manpage.txt | 123 ----------------------------------- doc/ssdeep.html | 150 ++++++++++++++++++++++++++++--------------- 6 files changed, 295 insertions(+), 180 deletions(-) create mode 100644 doc/manpage.html delete mode 100644 doc/manpage.txt diff --git a/NEWS b/NEWS index 73e5f68..33a4502 100644 --- a/NEWS +++ b/NEWS @@ -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 diff --git a/doc/Makefile b/doc/Makefile index c41fbbf..27bd550 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -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 jessekornblum@ssh.sf.net:/home/groups/s/ss/ssdeep/htdocs/ - -all: - scp changes.txt manpage.txt *.css *.html jessekornblum@ssh.sf.net:/home/groups/s/ss/ssdeep/htdocs/ + rsync -avP -e ssh $(ALL_FILES) $(USERNAME)@$(DESTDIR) +all: manpages changes publish diff --git a/doc/changes.txt b/doc/changes.txt index 4ce5ffc..33a4502 100644 --- a/doc/changes.txt +++ b/doc/changes.txt @@ -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 diff --git a/doc/manpage.html b/doc/manpage.html new file mode 100644 index 0000000..855ed37 --- /dev/null +++ b/doc/manpage.html @@ -0,0 +1,162 @@ + + + + + +ssdeep man page + + +Table of Contents

+

+ +

Name

+ssdeep - Computes context triggered piecewise hashes

+ +

Synopsis

+ssdeep +[-m <file>] [-vprdsblcxa] [-t val] [FILES]
+ssdeep [-V|h]

+ +

Description

+

+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.

+ +

+ +
-m <file>
+
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. +

+

+ +
-v
+
Verbose mode. The name of each file is printed to standard error as it +is being hashed.

+

+

+ +
-p
+
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 -m flag, but not the -d flag.

+

+ +
-r
+
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 -r *.txt 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 find(1) + command.

+

+ +
-d
+
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 -d mode. This flag may also be used in +conjunction with the -m mode, but with the -p mode.

+

+ +
-s
+
Silent mode. All error +messages are suppressed.

+

+ +
-b
+
Enables bare mode. Strips any leading directory +information from displayed filenames. This flag may not be used in conjunction +with the -l flag.

+

+ +
-l
+
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 flag.

+

+ +
-c
+
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. +

+

+ +
-x
+
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.

+

+ +
-a
+
Displays all matches in any of the matching mode, regardless of +score. Yes, this displays all 'matches', even if the match score is zero.

+ +

+ +
-t <val>
+
In any of the matching modes, only displays matches whose match score +is above the given value.

+

+ +
-h
+
Show a help screen and exit.

+

+ +
-V
+
Show the version +number and exit.

+

+

+
+ +

Return Value

+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.

+ +

Author

+ssdeep was written by Jesse Kornblum, ManTech International +Corporation
+

+jesse DoT kornblum =-=at mantech dot com

+

+ +

Copyright

+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.

+ +

See +Also

+This program is based on SpamSum by Dr. Andrews Tridgell.
+http://www.samba.org/ftp/unpacked/junkcode/spamsum/ +

+ +

+Table of Contents

+

+ diff --git a/doc/manpage.txt b/doc/manpage.txt deleted file mode 100644 index 4628a9d..0000000 --- a/doc/manpage.txt +++ /dev/null @@ -1,123 +0,0 @@ -SSDEEP(1) ManTech International SSDEEP(1) - - - -NAME - ssdeep - Computes context triggered piecewise hashes - - -SYNOPSIS - ssdeep [-m ] [-vprdsblcx] [-t val] [FILES] - ssdeep [-V|h] - - -DESCRIPTION - 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. - - - -m - 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 con- - tain Unicode characters, they can hold hashes with Unicode file- - names. - - - -v Verbose mode. The name of each file is printed to standard error - as it is being hashed. - - - - -p 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 -m flag, but not - the -d flag. - - - -r 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 pro- - gram with -r *.txt 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 find(1) command. - - - -d Enables directory mode. In this mode, all of the FILES are exam- - ined 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 -d mode. This flag may also be - used in conjunction with the -m mode, but with the -p mode. - - - -s Silent mode. All error messages are suppressed. - - - -b Enables bare mode. Strips any leading directory information from - displayed filenames. This flag may not be used in conjunction - with the -l flag. - - - -l 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 flag. - - - -c 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. - - - -x 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. - - - -t - In any of the matching modes, only displays matches whose match - score is above the given value. - - - -h Show a help screen and exit. - - - -V Show the version number and exit. - - - -RETURN VALUE - 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. - - -AUTHOR - ssdeep was written by Jesse Kornblum, ManTech International Corporation - jesse DoT kornblum =-=at mantech dot com - - - -COPYRIGHT - This program is Copyright (C) 2006-2008 ManTech International Corpora- - tion and is licensed under the terms of the General Public License. See - the file COPYING for details. - - -SEE ALSO - This program is based on SpamSum by Dr. Andrews Tridgell. - http://www.samba.org/ftp/unpacked/junkcode/spamsum/ - - - -ManTech International Version 2.2 - 22 Jul 2009 SSDEEP(1) diff --git a/doc/ssdeep.html b/doc/ssdeep.html index 52bb702..62fec66 100644 --- a/doc/ssdeep.html +++ b/doc/ssdeep.html @@ -1,17 +1,18 @@ + - -Fuzzy Hashing and ssdeep - + Fuzzy Hashing and ssdeep + -

-ssdeep - Latest version 2.2 +ssdeep - Latest version 2.3

@@ -39,7 +40,7 @@

Quick Links

  • Download ssdeep
    • -
  • The ssdeep man page
    • +
  • The ssdeep man page
  • Changelog
  • Quickstart Guide
    • + + + +