Skip to content

Commit

Permalink
Updated man and framework docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bcarrier committed May 23, 2012
1 parent 147d762 commit c4dc335
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 6 deletions.
1 change: 1 addition & 0 deletions framework/docs/Doxyfile
Expand Up @@ -565,6 +565,7 @@ WARN_LOGFILE =
# with spaces.

INPUT = framework/docs/main.dox \
framework/docs/basics.dox \
framework/docs/module_dev.dox \
framework/docs/module_blackboard.dox \
framework/docs/pipeline.dox \
Expand Down
2 changes: 1 addition & 1 deletion framework/docs/basics.dox
@@ -1,4 +1,4 @@
/*! \basics_page Basic Framework Concepts
/*! \page basics_page Basic Framework Concepts

<h3>Basic Concepts</h3>
<ul>
Expand Down
19 changes: 19 additions & 0 deletions framework/docs/build-man.pl
@@ -0,0 +1,19 @@
#!/usr/bin/perl -w

# uses pandoc (http://johnmacfarlane.net/pandoc/) to
# generate man and html pages for the tools in the
# framework.
#
# Stores the results in the man folder
use strict;

die "pandoc not found" unless (-x "/usr/local/bin/pandoc");

opendir (DIR, ".") or die "Error opening docs folder";
while (my $f = readdir(DIR)) {
next unless ($f =~ /^(.*?)\.1\.md$/);
my $f1 = $1;
system("pandoc -s -w man ${f} -o ../man/${f1}\.1");
system("pandoc -s --toc ${f} -o ../man/${f1}\.html");
}
closedir (DIR);
2 changes: 1 addition & 1 deletion framework/docs/module_dev.dox
Expand Up @@ -85,7 +85,7 @@ Although not a service, you might also want to check out TskUtilities, which has

\subsection mod_stuff_file Accessing File Content and Metadata

A file analysis module will be passed a TskFile object for the file to analyze. TskFile objects can represent all types of files, including allocated and deleted files, carved files, and derived files (i.e. a file stored inside of a ZIP file). From this object, you can read content using the TskFile.read() method. You can also access specific types of file metadata using specific methods, such as TskFile.size(), TskFile.crtime(), and TskFile.gePath(). Refer to the TskFile documentation for a list of all methods.
A file analysis module will be passed a TskFile object for the file to analyze. TskFile objects can represent all types of files, including allocated and deleted files, carved files, and derived files (i.e. a file stored inside of a ZIP file). From this object, you can read content using the TskFile.read() method. You can also access specific types of file metadata using specific methods, such as TskFile.getSize(), TskFile.getCrtime(), and TskFile.getPath(). Refer to the TskFile documentation for a list of all methods.


\subsection mod_stuff_files Accessing Other Files
Expand Down
8 changes: 4 additions & 4 deletions framework/docs/tsk_validatePipeline.1.md
@@ -1,18 +1,18 @@
% tsk_validatePipeline(1) user manual
% tsk_validatepipeline(1) user manual
% Brian Carrier
% May 2012

# NAME

tsk_validatePipeline - Process a TSK framework pipeline configuration file to ensure that it is valid and all modules can be found.
tsk_validatepipeline - Process a TSK framework pipeline configuration file to ensure that it is valid and all modules can be found.

# SYNOPSIS

tsk_validatePipeline framework_config_file pipeline_config_file
tsk_validatepipeline framework_config_file pipeline_config_file

# DESCRIPTION

tsk_validatePipeline is a command line tool for the Sleuth Kit (TSK) Framework that enables you to validate if a pipeline configuration file has valid syntax and that all modules can be loaded. This tool is useful if you are using the framework in an automated or distributed environment where the pipeline is run without user interaction and you want to verify that the configuration file is correct before adding it to the system.
tsk_validatepipeline is a command line tool for the Sleuth Kit (TSK) Framework that enables you to validate if a pipeline configuration file has valid syntax and that all modules can be loaded. This tool is useful if you are using the framework in an automated or distributed environment where the pipeline is run without user interaction and you want to verify that the configuration file is correct before adding it to the system.

Refer to the [online docs](http://www.sleuthkit.org/sleuthkit/docs/framework-docs/) for more details on the framework and the pipelines.

Expand Down

0 comments on commit c4dc335

Please sign in to comment.