Difference between revisions of "TSK Library User's Guide"

From SleuthKitWiki
Jump to: navigation, search
m (Library Users Guide moved to Library User's Guide: Making it grammatically correct.)
(Added links to newer schema versions)
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This guide (which is a work in progress) is for developers that want to use the library part of The Sleuth Kit (TSK) in a program.  TSK has both a static library and a collection of command line tools that use the library.  All of the functionality of the command line tools can be obtained from the library (and it is much more efficient to directly call the library instead of calling the individual tools and parsing the output.  
+
This guide (which is a work in progress) is for developers that want to use the library part of The Sleuth Kit ([[TSK]]) in a program.  TSK has both a static C/C++ library and a collection of command line tools that use the library.  All of the functionality of the command line tools can be obtained from the library (and it is much more efficient to directly call the library instead of calling the individual tools and parsing the output.
 +
 
 +
Refer to the [[TSK Bindings]] page for details on how the TSK library can be accessed from other languages besides C/C++.  
  
 
= "Official" Documents =
 
= "Official" Documents =
 
The term official is used very loosely here, but these are the documents that are shipped with TSK or have been published on the [http://www.sleuthkit.org/sleuthkit/ sleuthkit.org] website.  Note: Please do not remove links from this section because they could be the only links to the pages on the website.  
 
The term official is used very loosely here, but these are the documents that are shipped with TSK or have been published on the [http://www.sleuthkit.org/sleuthkit/ sleuthkit.org] website.  Note: Please do not remove links from this section because they could be the only links to the pages on the website.  
* [http://www.sleuthkit.org/sleuthkit/docs/api-docs/index.html User's Guide]: The API spec has a section in it that is a User's Guide that outlines how to use the library and how to get your build system setup.
+
* [http://www.sleuthkit.org/sleuthkit/docs/api-docs/4.3/ User's Guide]: The API spec has a '''User's Guide''' section that outlines how to use the library and how to get your build system setup.
* [http://www.sleuthkit.org/sleuthkit/docs/api-docs/index.html API Specification]: The API spec is automatically created from the source code and describes the public API functions and the arguments.  
+
* [http://www.sleuthkit.org/sleuthkit/docs/api-docs/ API Specification]: The API spec is automatically created from the source code and describes the public API functions and the arguments.
 +
* [http://svn.sleuthkit.org/repos/sleuthkit/trunk/samples/ Samples]: The source code comes with some sample skeleton code that uses the library to open a disk image and parse through the volumes and files. 
 
* [http://www.sleuthkit.org/support.php Support]: If you have questions, find bugs, or want to contribute patches then refer to the TSK support page for details on where to send questions or submit bugs and patches.
 
* [http://www.sleuthkit.org/support.php Support]: If you have questions, find bugs, or want to contribute patches then refer to the TSK support page for details on where to send questions or submit bugs and patches.
  
 
+
* [[TSK Framework]]: For details on the new framework.
 +
* Database Schema references:
 +
** [[SQLite Database v2 Schema]]
 +
** [[SQLite Database v3 Schema]]
 +
** [[SQLite Database v6 Schema]]
  
 
= "External" Documents =
 
= "External" Documents =
 
These are documents that others have written on using the TSK library
 
These are documents that others have written on using the TSK library
 
* (to be created...)
 
* (to be created...)

Revision as of 08:03, 25 April 2017

This guide (which is a work in progress) is for developers that want to use the library part of The Sleuth Kit (TSK) in a program. TSK has both a static C/C++ library and a collection of command line tools that use the library. All of the functionality of the command line tools can be obtained from the library (and it is much more efficient to directly call the library instead of calling the individual tools and parsing the output.

Refer to the TSK Bindings page for details on how the TSK library can be accessed from other languages besides C/C++.

"Official" Documents

The term official is used very loosely here, but these are the documents that are shipped with TSK or have been published on the sleuthkit.org website. Note: Please do not remove links from this section because they could be the only links to the pages on the website.

  • User's Guide: The API spec has a User's Guide section that outlines how to use the library and how to get your build system setup.
  • API Specification: The API spec is automatically created from the source code and describes the public API functions and the arguments.
  • Samples: The source code comes with some sample skeleton code that uses the library to open a disk image and parse through the volumes and files.
  • Support: If you have questions, find bugs, or want to contribute patches then refer to the TSK support page for details on where to send questions or submit bugs and patches.

"External" Documents

These are documents that others have written on using the TSK library

  • (to be created...)