Skip to content
Snippets Groups Projects
Commit c05a93a7 authored by Brian Carrier's avatar Brian Carrier
Browse files

updated links to sample folder

parent 86a1e824
No related branches found
No related tags found
No related merge requests found
/*! \page basepage Base Functions
This section describes some base API functions and concepts that are general to all of the other layers, such as error and Unicode handling. In addition to this documentation, there are sample programs in the <tt>samples</tt> directory in TSK that show these functions being used while processing a disk image.
This section describes some base API functions and concepts that are general to all of the other layers, such as error and Unicode handling. In addition to this documentation, there are sample programs in the <a href="https://github.com/sleuthkit/sleuthkit/tree/develop/samples">samples</a> directory in TSK that show these functions being used while processing a disk image.
\section basic_encodings Encodings
......
/*! \page basicpage Library Basics
This page describes some of the basic concepts of the TSK library. It is assumed that you have built and installed the TSK library based on either the instructions in the <tt>INSTALL.txt</tt> file or via a package. Refer to the files in the <tt>samples</tt> directory for examples on the topics in this and later sections.
This page describes some of the basic concepts of the TSK library. It is assumed that you have built and installed the TSK library based on either the instructions in the <tt>INSTALL.txt</tt> file or via a package. Refer to the files in the <a href="https://github.com/sleuthkit/sleuthkit/tree/develop/samples">samples</a> directory for examples on the topics in this and later sections.
\section basic_layers Layers
......
/*! \page fspage File Systems
This section describes the general file system analysis concepts and corresponding APIs in TSK. In addition to this documentation, there are sample programs in the <tt>samples</tt> directory in TSK that show these functions being used while processing a disk image.
This section describes the general file system analysis concepts and corresponding APIs in TSK. In addition to this documentation, there are sample programs in the <a href="https://github.com/sleuthkit/sleuthkit/tree/develop/samples">samples</a> directory in TSK that show these functions being used while processing a disk image.
\section fs_gen General Concepts
\subsection fs_layers File System Layers
......
/*! \page imgpage Disk Images
This section describes the general disk image analysis concepts and corresponding APIs in TSK. In addition to this documentation, there are sample programs in the <tt>samples</tt> directory in TSK that show these functions being used while processing a disk image.
This section describes the general disk image analysis concepts and corresponding APIs in TSK. In addition to this documentation, there are sample programs in the <a href="https://github.com/sleuthkit/sleuthkit/tree/develop/samples">samples</a> directory in TSK that show these functions being used while processing a disk image.
\section img_open Opening the Disk Image
......
......@@ -3,7 +3,7 @@
\author Brian Carrier
<h3>Overview</h3>
This document was designed to help integrate the <a href="http://www.sleuthkit.org/sleuthkit/">Sleuth Kit</a> (TSK) library into an application that needs to analyze data from a disk image. Note that this document does not contain information about using the command line tools in TSK. The command line tools use the functionality of this library, but this document is for programmers who want to use the library.
This document was designed to help integrate the <a href="http://www.sleuthkit.org/sleuthkit/">Sleuth Kit</a> (TSK) C/C++ library into an application that needs to analyze data from a disk image. Note that this document does not contain information about using the command line tools in TSK. The command line tools use the functionality of this library, but this document is for programmers who want to use the C/C++ library. If you want to integrate into Java, then refer to the <a href="http://sleuthkit.org/sleuthkit/docs/jni-docs/latest/">Java Bindings</a> document.
There are two main sections to this document. One is the User's Guide that describes the organization of TSK, the APIs, and how to use them together. The other is a list of the API functions and a description of their arguments and return values.
......@@ -28,5 +28,9 @@ The API Reference lists the public C and C++ API functions with their arguments
- \ref hashdblib and \ref hashdblib_cpp
- \ref autolib
<h3>Support</h3>
If you have questions, refer to the addresses and sites on the <a href="http://sleuthkit.org/support.php">support</a> page.
*/
/*! \page vspage Volume Systems
This section describes the general volume system analysis concepts and corresponding APIs in TSK. In addition to this documentation, there are sample programs in the <tt>samples</tt> directory in TSK that show these functions being used while processing a disk image.
This section describes the general volume system analysis concepts and corresponding APIs in TSK. In addition to this documentation, there are sample programs in the <a href="https://github.com/sleuthkit/sleuthkit/tree/develop/samples">samples</a> directory in TSK that show these functions being used while processing a disk image.
\section vs_open Opening the Volume System
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment