 |
Disk ARchive
2.6.8
Full featured and portable backup and archiving tool
|
Go to the documentation of this file.
26 #ifndef COMMAND_LINE_HPP
27 #define COMMAND_LINE_HPP
29 #include "../my_config.h"
41 enum operation { noop, extract, create, diff, test, listing, isolate, merging, version_or_help, repairing };
45 enum dirty_behavior { dirtyb_ignore, dirtyb_warn, dirtyb_ok };
59 { ent_proto.clear(); ent_login.clear(); ent_pass.
clear();
60 ent_host.clear(); ent_port.clear(); network_retry = 3;
61 auth_from_file =
false; };
177 ref_filename =
nullptr;
179 compress_mask =
nullptr;
181 aux_filename =
nullptr;
183 backup_hook_mask =
nullptr;
189 if(fs_root !=
nullptr)
191 if(sauv_root !=
nullptr)
193 if(ref_root !=
nullptr)
195 if(selection !=
nullptr)
197 if(subtree !=
nullptr)
199 if(ref_filename !=
nullptr)
201 if(ea_mask !=
nullptr)
203 if(compress_mask !=
nullptr)
204 delete compress_mask;
205 if(aux_root !=
nullptr)
207 if(aux_filename !=
nullptr)
209 if(overwrite !=
nullptr)
211 if(backup_hook_mask !=
nullptr)
212 delete backup_hook_mask;
218 extern bool get_args(shared_ptr<user_interaction> & dialog,
220 const deque<string> & dar_dcf_path,
221 const deque<string> & dar_duc_path,
228 const struct option *get_long_opt();
231 const char *get_short_opt();
bool cache_directory_tagging
whether to ignore directory contents where a the cache directory tagging files is found
bool display_treated_only_dir
whether to show treated files's current working directory
hash_algo
hashing algorithm available
bool warn_remove_no_match
whether to warn file about to be removed during a restoration, when they to no match the expected typ...
bool ignore_unknown_inode
whether to ignore unknown inode types
string backup_hook_execute
which command to execute as backup hook
archive_options_listing_shell::listformat list_mode
type of listing to follow
string slice_user
user to set when creating a slice
string slice_group
group to set when creating a slice
path * aux_root
where is the auxiliary archive of reference [used for merging but also when creating an archive,...
bool empty
whether to do a dry-run execution
string ea_name_for_exclusion
EA name to use for file exclusion, or empty string for the default EA name.
compression
the different compression algorithm available
bool display_masks
whether to display masks value
fsa_scope scope
FSA scope to consider for the operation.
string execute_ref
if not an empty string, the command to execute between slices of the archive of reference
infinint repeat_byte
archive total maximum amount of byte to waste re-saving changing files
bool get_args(shared_ptr< user_interaction > &dialog, const char *home, const deque< string > &dar_dcf_path, const deque< string > &dar_duc_path, S_I argc, char *const argv[], line_param ¶m)
main routine to extract parameters from command-line and included files
string ignored_as_symlink
column separated list of absolute paths of links to follow rather to record as such
bool filter_unsaved
whether to not list files that are not saved in the archive
infinint aux_num_digits
minimum number of decimal for the slice number of the auxiliary archive of reference
string input_pipe
if not an empty string, name of the pipe through which to read data from dar_slave
string aux_execute
command to be run between the slice of the auxiliary archive of reference
bool lax
whether to activate the last chance recovery mode (use with caution!)
bool security_check
whether to signal possible root-kit presence
U_32 aux_crypto_size
block size by which to cypher/uncypher data to/from the auxiliary archive of reference
bool quiet
whether to display final summary for the operation
infinint sparse_file_min_size
minimum size of a zeroed byte sequence to be considered as a hole and stored this way in the archive
string ent_login
entrepot login
bool sizes_in_bytes
whether to display sizes in bytes of to the larges unit (Mo, Go, To,...)
bool sequential_read
whether to follow escape sequential marks to achieve a sequential reading of the archive
string ent_proto
entrepot protocol
the arbitrary large positive integer class
infinint hourshift
consider equal two dates that have an integer hour of difference equal or less than hourshift
vector< string > signatories
list of email's key to use to sign the archive
mask * compress_mask
which file to compress
path * fs_root
filesystem root
the generic class, parent of all masks
infinint iteration_count
iteration count used when creating/isolating/merging an encrypted archive (key derivation)
bool nodump
whether to ignore files having the "nodump" flag set when performing a backup
secu_string ent_pass
entrepot password
infinint ref_num_digits
minimum number of decimal for the slice number of the archive of reference
bool auth_from_file
whether ~/.netrc and ~/.ssh files should be considered for credentials
mask * subtree
filter files for the operation based on path+filename
bool beep
whether to ring the terminal upon user interaction request
infinint repeat_count
number of time to try saving a file if it changes at the time it is read for backup
bool use_sequential_marks
whether to add escape sequential marks in the archive
secu_string aux_pass
crypto to use for the auxiliary archive
bool warn_over
whether to warn before overwriting files or slices
secu_string pass_ref
if not an empty string, use the provided encryption scheme to read the archive of reference
hash_algo hash
whether to produce a hash file, and which algoritm to use for that hash
all parameters retreived from command-line
bool no_compare_symlink_date
whether to report difference in dates of symlinks while diffing an archive with filesystem
operation op
which operation to perform
bool flat
whether to ignore directory structure when restoring data
secu_string pass
if not an empty string, encrypt the archive with the given algo:pass string
bool header_only
whether we just display the header of archives to be read
bool decremental
whether to produce a decremental backup (when merging)
bool display_finished
whether to display summary (space/compression ratio) for each completed directory
ent_params aux_remote
remote entrepot coordinates for the auxiliary archive
bool alter_atime
whether to reset the atime of file read during backup to their original value (resetting atime does m...
comparison_fields what_to_check
what fields to take into account when comparing/restoring files,
bool list_ea
whether to list Extended Attribute of files
infinint min_compr_size
below which size to never try compressing files
bool display_skipped
whether to display skipped files
bool multi_threaded
allows libdar to use multiple threads (requires libthreadar)
infinint pause
whether to pause between slices
bool furtive_read_mode
whether to use the furtive read mode
hash_algo kdf_hash
hash algo used for key derivation function
string output_pipe
if not an empty string, name of the pipe through which to write orders to dar_slave
entrepot relative parameters
U_32 crypto_size
block size by which to cypher data
infinint first_file_size
sice of the first slice to create
bool zeroing_neg_dates
whether to automatically zeroing negative dates while reading inode from filesystem
string slice_perm
permission to set when creating a slice
U_I network_retry
libcurl entrepot network retry time
string ent_port
entrepot port
modified_data_detection modet
how to detect that a file has changed since the archive of reference was done
defines how to calculate delta signature block size based of file size to delta sign
bool empty_dir
whether to store skipped directories as empty, whether to avoid restoring directory where no data is ...
mask * selection
filter files for the operation based on filename only
bool keep_compressed
when merging, whether to not uncompress/re-compress data in the process
infinint num_digits
minimum number of decimal for the slice number
const crit_action * overwrite
the overwriting policy
the class path is here to manipulate paths in the Unix notation: using'/'
infinint fixed_date
the data for the snapshot backup
bool info_details
whether to show processing messages
bool delta_sig
whether to calculate rsync signature of files
mask * delta_mask
which file to calculate delta sig when not using the default mask
U_32 crypto_size_ref
block size by which to uncypher data from the archive of reference
dirty_behavior dirty
what to do when comes the time to restore a file that is flagged as dirty
bool same_fs
whether to stick to a same filesystem
delta_sig_block_size delta_sig_len
block len to used for delta signature computation
bool exclude_by_ea
whether inode have to be check against a given EA before backup
bool snapshot
whether to perform a snapshot backup
mask * ea_mask
which EA to work on
void clear()
clear the string (set to an empty string)
string filename
basename of the archive to operate on
string * ref_filename
basename of the archive of reference (nullptr => no archive of reference)
path * sauv_root
where is the archive to operate on (create, read, etc.)
bool delta_diff
whether to save binary diff or whole file's data during a differential backup
comparison_fields
how to consider file change during comparison and incremental backup
string ent_host
entrepot hostname
compression algo
compression algorithm to use when generating an archive
infinint file_size
size of the slices to create (except the first)
bool not_deleted
whether to ignore deleted files
infinint delta_sig_min_size
size below which to never calculate delta signatures
string user_comment
user comment to add to the archive
mask * backup_hook_mask
which file have to considered for backup hook
U_I compression_level
compression level to use when generating an archive
string execute
if not an empty string, the command to execute between slices
listformat
defines the way archive listing is done:
ent_params ref_remote
remote entrepot coordinates for archive of reference
string * aux_filename
basename of the auxiliary archive if reference (nullptr => no auxiliary of reference)
modified_data_detection
how to detect data has changed when some fields
bool allow_over
whether to allow slice overwriting
path * ref_root
where is the archive of reference
bool display_treated
whether to show treated files
ent_params remote
remote entrepot coordinates
the main file of the libdar API definitions
the global action for overwriting
bool blind_signatures
whether to ignore signature check failures
bool only_deleted
whether to only consider deleted files
std::set< fsa_family > fsa_scope
set of fsa families
libdar namespace encapsulate all libdar symbols