Disk ARchive  2.4.12
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Public Member Functions | List of all members
libdar::archive_options_merge Class Reference

class holding optional parameters used to proceed to the merge operation More...

#include <archive_options.hpp>

Public Member Functions

 archive_options_merge (const archive_options_merge &ref)
 
const archive_options_mergeoperator= (const archive_options_merge &ref)
 
void clear ()
 
void set_auxilliary_ref (archive *ref)
 
void set_selection (const mask &selection)
 defines the filenames to only save (except directory) as those that match the given mask
 
void set_subtree (const mask &subtree)
 defines the directory and files to consider (this mask will be applied to the absolute path of files being proceeded)
 
void set_allow_over (bool allow_over)
 defines whether overwritting is allowed or not
 
void set_warn_over (bool warn_over)
 defines whether a warning shall be issued before overwriting
 
void set_overwriting_rules (const crit_action &overwrite)
 policy to solve merging conflict
 
void set_info_details (bool info_details)
 defines whether the user needs detailed output of the operation
 
void set_pause (const infinint &pause)
 set a pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each slice, set to 2 makes libdar pause each 2 slices and so on.
 
void set_empty_dir (bool empty_dir)
 defines whether we need to store ignored directories as empty
 
void set_compression (compression compr_algo)
 set the compression algorithm to be used
 
void set_compression_level (U_I compression_level)
 set the compression level (from 1 to 9)
 
void set_slicing (const infinint &file_size, const infinint &first_file_size=0)
 define the archive slicing More...
 
void set_ea_mask (const mask &ea_mask)
 defines which Extended Attributes to save
 
void set_execute (const std::string &execute)
 set the command to execute after each slice creation
 
void set_crypto_algo (crypto_algo crypto)
 set the cypher to use
 
void set_crypto_pass (const secu_string &pass)
 
void set_crypto_size (U_32 crypto_size)
 set the size of the encryption by block to use
 
void set_compr_mask (const mask &compr_mask)
 defines files to compress
 
void set_min_compr_size (const infinint &min_compr_size)
 defines file size under which to never compress
 
void set_empty (bool empty)
 defines whether we do a dry-run execution
 
void set_display_skipped (bool display_skipped)
 whether to display files that have been excluded by filters
 
void set_keep_compressed (bool keep_compressed)
 make dar ignore the 'algo' argument and do not uncompress / compress files that are selected for merging
 
void set_slice_permission (const std::string &slice_permission)
 if not an empty string set the slice permission according to the octal value given.
 
void set_slice_user_ownership (const std::string &slice_user_ownership)
 if not an empty string set the user ownership of slices accordingly
 
void set_slice_group_ownership (const std::string &slice_group_ownership)
 if not an empty string set the group ownership of slices accordingly
 
void set_decremental_mode (bool mode)
 if set to true use a merging mode suitable to build a decremental backup from two full backups (see Notes)
 
void set_sequential_marks (bool sequential)
 whether to activate escape sequence aka tape marks to allow sequential reading of the archive
 
void set_sparse_file_min_size (const infinint &size)
 whether to try to detect sparse files
 
void set_user_comment (const std::string &comment)
 specify a user comment in the archive (always in clear text!)
 
void set_hash_algo (hash_algo hash)
 specify whether to produce a hash file of the slice and which hash algo to use
 
void set_slice_min_digits (infinint val)
 defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this
 
archiveget_auxilliary_ref () const
 
const maskget_selection () const
 
const maskget_subtree () const
 
bool get_allow_over () const
 
bool get_warn_over () const
 
const crit_actionget_overwriting_rules () const
 
bool get_info_details () const
 
const infinintget_pause () const
 
bool get_empty_dir () const
 
compression get_compression () const
 
U_I get_compression_level () const
 
const infinintget_slice_size () const
 
const infinintget_first_slice_size () const
 
const maskget_ea_mask () const
 
const std::string & get_execute () const
 
crypto_algo get_crypto_algo () const
 
const secu_stringget_crypto_pass () const
 
U_32 get_crypto_size () const
 
const maskget_compr_mask () const
 
const infinintget_min_compr_size () const
 
bool get_empty () const
 
bool get_display_skipped () const
 
bool get_keep_compressed () const
 
const std::string & get_slice_permission () const
 
const std::string & get_slice_user_ownership () const
 
const std::string & get_slice_group_ownership () const
 
bool get_decremental_mode () const
 
bool get_sequential_marks () const
 
infinint get_sparse_file_min_size () const
 
const std::string & get_user_comment () const
 
hash_algo get_hash_algo () const
 
infinint get_slice_min_digits () const
 

Detailed Description

class holding optional parameters used to proceed to the merge operation

Definition at line 655 of file archive_options.hpp.

Member Function Documentation

void libdar::archive_options_merge::set_crypto_pass ( const secu_string pass)
inline

set the pass the password / passphrase to use. Giving an empty string makes the password asked interactively through the dialog argument if encryption has been set.

Definition at line 726 of file archive_options.hpp.

void libdar::archive_options_merge::set_slicing ( const infinint file_size,
const infinint first_file_size = 0 
)
inline

define the archive slicing

Parameters
[in]file_sizeset the slice size in byte (0 for a single slice whatever its size is)
[in]first_file_sizeset the first file size
Note
if not specified or set to zero, first_file_size is considered equal to file_size

Definition at line 706 of file archive_options.hpp.


The documentation for this class was generated from the following file: