From 90e61f7094b4c0d6e2df020d0b703516937915a2 Mon Sep 17 00:00:00 2001 From: Lee Ockert Date: Mon, 23 Oct 2023 04:55:00 +0000 Subject: [PATCH] Update README Align README with new directions for each utility. --- README.md | 52 ++++++++++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 6ceb4aa..d5db9aa 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ **Installation** ---------------- -Simply save the utility in your system path and mark it as executable. +Simply save the utilities in your path and mark them as executable. If you don't know your system path, you can find it with this Terminal command: @@ -13,6 +13,7 @@ If you don't know your system path, you can find it with this Terminal command: To mark a utility as executable, use the `chmod` command: chmod +x tmimport.sh + chmod +x tmbless.sh chmod +x dirdedupe.sh If you're still lost, do this: @@ -42,20 +43,20 @@ ______________________________________________________________________________ DESCRIPTION - Time Machine Importer modifies the metadata of a backup drive to match the - current computer's model and unique identifiers (primary MAC address and - hardware platform UUID/provisioning UDID) and attempts to 'inherit' the - backup history. - + Time Machine Importer attempts to inherit the backup history of a backup + drive. If the backup drive is not paired to the current computer, Time + Machine Importer will attempt to pair the drive with the current computer + by modifying the model, MAC address, and UUID/UDID reflected in the + metadata of the backup drive. + The backup drive should be specified by disk or volume name (or path) or - the mount point of the backup drive. If Time Machine Importer cannot find - an appropriate disk volume or mount point, it will check to see if the - specified directory is a valid Backups.backupdb location (or a machine - directory under one). - - A future version may attempt to detect HFS+ or APFS partitions serving as - backup drives, and, if a backup drive is specified as a device path, it - will automagically choose the correct backup path. + the mount point of the backup drive. For example: + - ./tmimport.sh /dev/disk1s1 + - ./tmimport.sh /Volumes/TMBACKUP + + While some additional heuristics may assist in identifying a backup drive + that is specified in other ways, they are untested and not guaranteed + to work correctly. ______________________________________________________________________________ @@ -69,11 +70,14 @@ ______________________________________________________________________________ DESCRIPTION - Time Machine Blessing modifies the metadata of a snapshot directory - (i.e., a datestamped directory inside a Backups.backupdb/machinename/ - directory) so that the metadata reflects a backup completed on that date - and the metadata of the top-level drive matches that of the current drive. - + Time Machine Bless marks a snapshot directory as valid and recognizable + by Time Machine. + + It does this by modifying the metadata of the snapshot directory so that + the it accurately reflects the date the snapshot was created and the + metadata of the 'drive' subdirectory within that snapshot directory + matches the current drive. + These modifications should allow restoration of files within the Time Machine restore UI. ______________________________________________________________________________ @@ -85,13 +89,13 @@ ______________________________________________________________________________ USAGE - dirdedupe.sh [--execute] masterdir shadowdir + dirdedupe.sh [--execute] masterdir subjectdir DESCRIPTION - - For each file in shadowdir, replace it with a hard link to the matching file - (if any) in masterdir. A file will be considered a match if, and only if, - it shares the same file name, relative path, and contents. + + For each file in subjectdir, replace it with a hard link to the matching + file (if any) in masterdir. A file will be considered a match if, and + only if, it shares the same file name, relative path, and contents. OPTIONS