| Disk ARchive 2.5.10 Full featured and portable backup and archiving tool

- Main Page
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

File List
Here is a list of all documented files with brief descriptions:

archive.hpp | Archive class is defined in this module
archive_options.hpp | This file contains a set of classes used to transmit options to archive operation
archive_version.hpp | Class archive_version that rules which archive format to follow
cache.hpp | Cache class
capabilities.hpp | Provide information about current thread (underlying using the widthdrawn POSIX.1e API)
cat_all_entrees.hpp | Include file gathering all entree found in a catalogue
cat_blockdev.hpp | Class used to record block special devices in a catalogue
cat_chardev.hpp | Class used to record character special devices in a catalogue
cat_detruit.hpp | Used to record information in a catalogue about a deleted file (differential backup context)
cat_device.hpp | Parent class for all special devices inodes
cat_directory.hpp | Class used to organize objects in tree in catalogue as like directories in a filesystem
cat_door.hpp | Class used in a catalogue to store solaris door filesystem entries
cat_entree.hpp | Base class for all object contained in a catalogue
cat_eod.hpp | Object exchanged with a catalogue (never stored in it) to signal the end of a directory
cat_etoile.hpp | Class holding an cat_inode object that get pointed by multiple mirage objects (smart pointers) to record hard links in a catalogue
cat_file.hpp | Class used to record plain files in a catalogue
cat_ignored.hpp | Class used to remember that an entry has been ignored and shall not be recorded as deleted using a detruit object in a catalogue
cat_ignored_dir.hpp | Class used to remember in a catalogue that a cat_directory has been ignored
cat_inode.hpp | Base object for all inode types, managed EA and FSA, dates, permissions, ownership, ..
cat_lien.hpp | Class used to store symbolic links in a catalogue
cat_mirage.hpp | Smart pointer to an etoile object. Used to store hard link information inside a catalogue
cat_nomme.hpp | Base class of all objects contained in a catalogue and that can be named
cat_prise.hpp | Class to record filesystem (UNIX) sockets in a catalogue
cat_tools.hpp | Set of routines used by catalogue related classes
cat_tube.hpp | Class to record named pipes in a catalogue
catalogue.hpp | Here is defined the many classed which is build of the catalogue
command_line.hpp | Routing in charge of the command-line and included files parsing
compile_time_features.hpp | Nested namespace containing routines that give features activated at compile time
compressor.hpp | Compression engine implementation
config.h |
config_file.hpp | Specific routines to manages included files's targets
crc.hpp | Class crc definition, used to handle Cyclic Redundancy Checks
crit_action_cmd_line.hpp | Routines to convert command-line overwriting criterium to their crit_action counterparts
criterium.hpp | Classes that let the user define the policy for overwriting files
crypto.hpp | Crypto algoritm definition
crypto_asym.hpp | Asymetric cryptographical algoritms relying on gpgme
crypto_sym.hpp |
cygwin_adapt.hpp | Thin adaptation layer to Cygwin specifities
dar.hpp | Main module for dar command-line tool
dar_suite.hpp | Routine to manage CLI's common initialization and ultimate exception catching
data_tree.hpp | Two classes used to store tree information in dar_manager databases
database.hpp | This file holds the database class definition
database_header.hpp | Defines the database structure in file
database_options.hpp | This file holds the options for database operations
datetime.hpp | This file contains the definition of class datetime that stores unix times in a portable way
deci.hpp | Manages the decimal representation of infinint
defile.hpp | Here is defined the defile class
ea.hpp | Set of routines to manage EA values associated to a file
ea_filesystem.hpp | Filesystem dependent Extended Attributes operationsThis file contains a set of routines used to manipulate (read, write or test the presence of) Extended Attributes
elastic.hpp | Here is defined the elastic class
entrepot.hpp | Defines the entrepot interface. Entrepot interface defines a generic way to interact with files (slices) on a filesystem. It is used to instanciate file-like objects (from class inherited from class fichier_global, in order to read or write data to such file. The entrepot_local and fichier_local classes are the only one classes available from libdar to implement the entrepot and fichier classes interfaces respectively. External applications like webdar can implement entrepot_ftp and fichier_ftp classes to provide transparent access to dar backup localted on a remote ftp server. More can follow in the future
entrepot_local.hpp | Defines the implementation for local filesystem entrepot The entrepot_local is the only implementation of an entrepot class present in libdar. It correspond to local filesystems. The reason of existence of the entrepot stuff is to allow external application like webdar to drop/read slices over the network using FTP protocol for example. External applications only have to define Their own implementation of the entrepot interface and file-like objects they generates (inherited from class fichier_global), libdar uses them throught the generic interface. This avoids having network related stuff inside libdar, which for security reason and functions/roles separation would not be a good idea
erreurs.hpp | All the excetion class thrown by libdar
erreurs_ext.hpp | Some additional exception class thrown by libdar
escape.hpp | Class escape definition, used for sequential reading of archivesThe class escape is used to insert escape sequences before each new file's data in an archive. The normal file's data is also rewritten if it contains such an escape sequence for it does not collide with real escape sequences At reading time, this class revert backs modification done to file's data containing escape sequences for they contain the original data. This class also provides the feature to skip to the next (real) escape sequence. This class inherits of generic files and its objects are to be used in a stack of generic file's objects. The object below contains modified data and escape sequences, the file over gets the normal file data and does never see escape sequences. Expected implementation is to have a compressor above an escape object and a sar or scrambler/blowfish/... object above it
escape_catalogue.hpp | Class escape_catalogue definition. Used for sequential writing to archives, as well as several other inherited classes from catalogue.hppThis class inherits from the class catalogue and implements the pre_add(...) method, which role is to add an escape sequence followed by an entry dump (usually used at the end of archive is the so called catalogue part of the archive). This sequence followed by entry dump is added before each file's data all along the archive. Other inherited classes, implement the escape specific part, used when performing sequential reading of the catalogue
etage.hpp | Definition of the etage structure is done here
fichier_global.hpp | Class fichier_global definition. This class is a pure virtual class class fichier_global is an abstraction of files objects whatever is their localisation like local filesystem, remote ftp server, etc. inherited classes (like fichier_local) provide full implementation
fichier_local.hpp | Class fichier_global definition. This is a full implementation/inherited class of class fichier_global this type of object are generated by entrepot_local
filesystem.hpp | Defines several classes that realize the interface with the filesystem
filesystem_specific_attribute.hpp | Filesystem specific attributes
filtre.hpp | Here is all the core routines for the operations
fsa_family.hpp | Filesystem specific attributes available families and fsa_scope definition
generic_file.hpp | Class generic_file is defined here as well as class fichierthe generic_file interface is widely used in libdar it defines the standard way of transmitting data between different part of the library
generic_file_overlay_for_gpgme.hpp | Adaptation class from gpgme data buffer to libdar generic_file interface
generic_thread.hpp | Class generic_thread provides a way to interact with a generic_file ran in an other thread
generic_to_global_file.hpp | This class provides an fichier_global interface for any type of generic_file object
getopt_decision.h | Switch routine to define which file to include based on the result of the configure script
gettext.h |
hash_fichier.hpp | Class hash_fichier definition.This is an inherited class from class fichier Objects of that class are write-only objects that provide a hash of the written data other hash algorithm may be added in the future
header.hpp | Slice header structure is defined here
header_version.hpp | Archive global header/trailer structure is defined here
hide_file.hpp | Class of base to split files in words
infinint.hpp | Switch module to limitint (32 ou 64 bits integers) or infinint
int_tools.hpp | Elementary operation for infinint integers
integers.hpp | Are defined here basic integer types that tend to be portable
label.hpp | Define the datastructure "label" used to identify slice membership to an archive
libdar.hpp | Main file of the libdar API definitions
limitint.hpp | Reviewed implementation of infinint based on system limited integersthe limitint template class implementation defined in this module can handle positive integers and detect overflow. It shares with infinint the same interface, so it can be use in place of it, but throw Elimitint exceptions if overflow is detected
line_tools.hpp | Set of general command line targeted routines
list_entry.hpp | Class of objects describing an entry in the archive, used by archive::get_children_in_table
macro_tools.hpp | Macroscopic tools for libdar internals
mask.hpp | Here lies a collection of mask classes
mask_list.hpp | Here lies a mask that selects files present in a given listThe mask_list classes defined here is to be used for filtering files in the libdar API calls
mem_allocator.hpp | This is the base class of object that can provide dynamically allocated memory blocks
mem_cluster.hpp | Defines mem_cluster class that holds a fixed set of fixed size allocatable memory blocks
mem_sized.hpp | Defines mem_sized class that holds a variable sized set of fixed sized blocks using class mem_cluster
mem_ui.hpp | Class mem_ui definition. This class is to be used as parent class to handle user_interaction object management
memory_check.hpp |
memory_file.hpp | Memory_file is a generic_file class that only uses virtual memory
memory_pool.hpp | Class memory_pool allocates and recycles blocks of memory for better performances it is expected to be used with classes that inherit from class on_pool
messaging.hpp | Messaging_decode and messaging_encode are used to insert messages in a flow if data blocks
my_config.h |
my_getopt_long.h | May lead to the definition of getopt_long to solve declaration conflicts in <unistd.h> and <getopt.h>
nls_swap.hpp | Set of macro to change the NLS from user application domaine to libdar domain and viceversa
no_comment.hpp | Class that transparently strips out the comments from configuration file
null_file.hpp | /dev/null type file implementation under the generic_file interfacethis class is used in particular when doing dry-run execution
on_pool.hpp | This is the base class of object that can be allocated on a memory pool
path.hpp | Here is the definition of the path classthe path class handle path and provide several operation on them
pile.hpp | Class pile definition. Used to manage a stack of generic_file objects
pile_descriptor.hpp | Optimization structure to quickly access some commonly used layers of a stack of generic_file
range.hpp | Class than provide a way to manipulate and represent range of integer numbers (infinint)
real_infinint.hpp | Original infinint class implementationthe infinint class implementation defined in this module can handle arbitrary large positive integer numbers
sar.hpp | Sar and trivial_sar classes, they manage the slicing layer
sar_tools.hpp | Set of tools aims to help Segmentation And Reassemblement (sar) class
scrambler.hpp | Definition of the scrambler class, a very weak encryption scheme
secu_memory_file.hpp | Secu_memory_file is a generic_file class that only uses secured memory (not swappable and zeroed after use)
secu_string.hpp | This file contains the definition of secu_string class, a std::string like class but allocated in secure memorysecure memory is a allocated memory that is never swapped out (wrote to disk) the implementation relies on gcrypt_malloc_secure() call (libgcrypt) rather than relying on mlock()/munlock() posix system call. as the need for secure string is for strong encryption, there is no much interest in re-inventing the wheel as the need is dependent on gcrypt availability
semaphore.hpp | Definition of class semaphore, used to manage invocation of backup hook for files
shell_interaction.hpp | User_interaction class for command_line tools
slave_thread.hpp | Class slave_thread is runs a I/O operations on a given genercif_file in a separated thread
slice_layout.hpp | Object describing the slicing of an archive
smart_pointer.hpp | Template class implementing memory efficient smart pointer
sparse_file.hpp | Class sparse_file definition, used to handle holes in filesthis class is used to receive plain file's data to be written to the archive or to be read out from an archive. The class uses escape sequences to replace holes in files (long serie of zeros) by the number of zeros preceeded by a escape sequence mark. this class internally uses an escape object, with a modifed fixed escape sequence that optimizes the use of sparse_file objects with other escape objects
statistics.hpp | Handle the statistic structure that gives a summary of treated files after each operatio
storage.hpp | Class that permits arbitrary large data storage
terminateur.hpp | Terminateur class which defines the position of the cataloguethe terminateur is a byte sequence present as the last bytes of an archive which indicates how much byte backward libdar must skip back to find the beginning of the catalogue
thread_cancellation.hpp | To be able to cancel libdar operation while running in a given thread.the class thread_cancellation implemented in this module permits to define checkpoints where is looked whether the current thread has been marked as to be canceled by the user The advantage of this class is that it then throws a Euser_abort exception which properly terminates the libdar operation in the thread freeing allocated memory and release mutex properly. Note that the thread is not canceled but libdar call in this thread returns as soon as a checkpoint is met during the execution
tlv.hpp | Generic Type Length Value data structures
tlv_list.hpp | List of Generic Type Length Value data structures
tools.hpp | Set of general purpose routines
trivial_sar.hpp | Trivial_sar classes manages the slicing layer when single slice is used
tronc.hpp | Defines a limited segment over another generic_file.This is used to read a part of a file as if it was a real file generating end of file behavior when reaching the given length
tronconneuse.hpp | Defines a block structured file.Mainly used for strong encryption
trontextual.hpp | Class trontextual is a contextual variant of class tronc
tuyau.hpp | Defines the implementation of pipe under the generic_file interface.mainly used between zapette and slave_zapette, this is a full implementation of the generic_file interface that takes care of dead lock when two pipes needs to be openned between the same two entities, each having one for reading and the other for writing
user_group_bases.hpp | Defines class that speed up the uid to username and gid to group name lookup
user_interaction.hpp | Defines the interaction between libdar and the user.Three classes are defined
wrapperlib.hpp | Libz and libbz2 wrapper to have identical interface to these libraries.libz and libbz2 library differ in the way they return values in certain circumpstances. This module defines the wrapperlib class that make their use homogeneous
zapette.hpp | Remote control between dar and dar_slave.Two classes are defined in this module