News. - What is DAR? - The bindings. - API Documentation. - Related works. - Project site. - What is the logo? - Public key.
Main Page   Modules   Data Structures   File List   Data Fields   Globals  

dar_sup_storage Struct Reference
[Archive operations]

A collection of options regarding archive storage options. More...

#include <libdarc.h>


Data Fields

dar_compression_algorithm compress_algo
 Compression algorithm that will be used to create an archive or was used to create a previous archive.

U_I compress_level
 Compression level used, from 0 - 9.

dar_mask * compress_mask
 Selection mask applied when choosing which files to compress.

dar_infinint * compress_min_size
 Minimum size of files to be compressed.

dar_encryption_algorithm crypto_algo
 Encryption algorithm that will be used to create an archive or was used to create a previous archive.

U_32 crypto_size
 Size of encryption blocks.

char * crypto_pass
 Passphrase used the generate encryption key.

dar_infinint * file_size
 The size of each file slice.

dar_infinint * first_file_size
 The size of the first file slice.

char * slice_execute
 A command to execute between each slice.

dar_infinint * hourshift
 An integer number of hours of which the difference between times in the archive and in the file system will be ignored.

Detailed Description

A collection of options regarding archive storage options.

These are optional parameters. While passing this structure is required, each field has default options that should be reasonable for typical operations.

Definition at line 659 of file libdarc.h.

Field Documentation

dar_compression_algorithm dar_sup_storage::compress_algo
 

Compression algorithm that will be used to create an archive or was used to create a previous archive.

This field has a default value of none.

Field usage: 

Operation          Used

Create              X
Open                
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 682 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), and dar_sup_storage_defaults().

U_I dar_sup_storage::compress_level
 

Compression level used, from 0 - 9.

The field has a default value of 9.

Field usage: 

Operation          Used

Create              X
Open                
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 703 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), and dar_sup_storage_defaults().

dar_mask* dar_sup_storage::compress_mask
 

Selection mask applied when choosing which files to compress.

This field has a default value of boolean true mask.

Field usage: 

Operation          Used

Create              X
Open                
Close               
Test                
List                
Extract             
Diff                
Isolate             
Get children of

Definition at line 724 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_sup_storage_defaults(), and dar_sup_storage_destroy().

dar_infinint* dar_sup_storage::compress_min_size
 

Minimum size of files to be compressed.

This field has a default value of 0.

Field usage: 

Operation          Used

Create              X
Open                
Close               
Test                
List                
Extract             
Diff                
Isolate             
Get children of

Definition at line 745 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_sup_storage_defaults(), and dar_sup_storage_destroy().

dar_encryption_algorithm dar_sup_storage::crypto_algo
 

Encryption algorithm that will be used to create an archive or was used to create a previous archive.

This field has a default value of none.

Field usage: 

Operation          Used

Create              X
Open                X
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 770 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), dar_op_archive_open(), and dar_sup_storage_defaults().

char* dar_sup_storage::crypto_pass
 

Passphrase used the generate encryption key.

If NULL, passphrase will be queried by callback.

This field has a default value of NULL.

Field usage: 

Operation          Used

Create              X
Open                X
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 814 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), dar_op_archive_open(), dar_sup_storage_defaults(), and dar_sup_storage_destroy().

U_32 dar_sup_storage::crypto_size
 

Size of encryption blocks.

This field has a default value of 10240. The maximum block size is around 4 GiB.

Field usage: 

Operation          Used

Create              X
Open                X
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 792 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), dar_op_archive_open(), and dar_sup_storage_defaults().

dar_infinint* dar_sup_storage::file_size
 

The size of each file slice.

This field has a default value of 0, which indicates no slices.

Field usage: 

Operation          Used

Create              X
Open                
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 840 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), dar_sup_storage_defaults(), and dar_sup_storage_destroy().

dar_infinint* dar_sup_storage::first_file_size
 

The size of the first file slice.

Must not be zero if file_size is non-zero.

This field has a default value of 0, set to match file_size.

Field usage: 

Operation          Used

Create              X
Open                
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 863 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), dar_sup_storage_defaults(), and dar_sup_storage_destroy().

dar_infinint* dar_sup_storage::hourshift
 

An integer number of hours of which the difference between times in the archive and in the file system will be ignored.

This can be used when dealing with filesystems that unexpectedly change times. Remote samba mounts is one example.

This field has a default value of 0.

Field usage: 

Operation          Used

Create              X
Open                
Close               
Test                
List                
Extract             X
Diff                
Isolate             
Get children of

Definition at line 922 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_extract(), dar_sup_storage_defaults(), and dar_sup_storage_destroy().

char* dar_sup_storage::slice_execute
 

A command to execute between each slice.

The following macros will be expanded in the string:

  • n : The previous (create mode) or next (read mode) slice number.
  • b : The archive basename.
  • p : The path to the archive files.
  • e : The archive extension (usually "dar").
  • %% : '%' character escape.
This field has a default value of "", indicating no command will be executed.

Field usage: 

Operation          Used

Create              X
Open                X
Close               
Test                
List                
Extract             
Diff                
Isolate             X
Get children of

Definition at line 897 of file libdarc.h.

Referenced by dar_op_archive_create(), dar_op_archive_isolate(), dar_op_archive_open(), dar_sup_storage_defaults(), and dar_sup_storage_destroy().

The documentation for this struct was generated from the following file:
API Copyright © 2005, Wesley Leggette - See Sourceforge project page for contact details.
Documents generated on Mon Mar 21 13:26:20 2005 by doxygen 1.2.18