From 35e48b188329bf1048dfe154247b3259441de29f Mon Sep 17 00:00:00 2001 From: Chris Wilson Date: Sat, 28 Mar 2009 12:25:05 +0000 Subject: Reorganise docs in trunk to match distribution layout, which is cleaner, and makes Makefile work on distributions and trunk equally. --- docs/api-notes/backup/lib_backupclient.txt | 46 ++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/api-notes/backup/lib_backupclient.txt (limited to 'docs/api-notes/backup/lib_backupclient.txt') diff --git a/docs/api-notes/backup/lib_backupclient.txt b/docs/api-notes/backup/lib_backupclient.txt new file mode 100644 index 00000000..3e4a079b --- /dev/null +++ b/docs/api-notes/backup/lib_backupclient.txt @@ -0,0 +1,46 @@ +TITLE lib/backupclient + +Classes used on the store and on the server. + +See documentation in the files for more details. + + +SUBTITLE BackupStoreDirectory + +The directory listing class, containing a number of entries, representing files. + + +SUBTITLE BackupStoreFile + +Handles compressing and encrypting files, and decoding files downloaded from the server. + + +SUBTITLE BackupStoreFilename + +An encrypted filename. + + +SUBTITLE BackupStoreFilenameClear + +Derived from BackupStoreFilename, but with the ability to encrypt and decrypt filenames. Client side only. + + +SUBTITLE BackupClientFileAttributes + +Only used on the client -- the server treats attributes as blocks of opaque data. + +This reads attributes from files on discs, stores them, encrypts them, and applies them to new files. + +Also has a static function to generate filename attribute hashes given a struct stat and the filename. + + +SUBTITLE BackupClientRestore + +Routines to restore files from the server onto the client filesystem. + + +SUBTITLE BackupClientCryptoKeys + +This reads the key material from disc, and sets up the crypto for storing files, attributes and directories. + + -- cgit v1.2.3