From 74a98e499e098c3e54224bcd7c6d536183224e9f Mon Sep 17 00:00:00 2001 From: Lee Ockert Date: Tue, 19 Jul 2022 12:04:22 -0400 Subject: [PATCH] README improvements Modified the README to include installation instructions and synchronized command line and README usage message. --- README.md | 92 +++++++++++++++++++++++++++++++++++++++------------- dirdedupe.sh | 20 ++++++++---- tmimport.sh | 34 +++++++++++-------- 3 files changed, 103 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 52f51a0..c0410d9 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,79 @@ -# tmimport - Time Machine Importer +**Time Machine Utilities** +========================== - tmimport.sh - 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. +**Installation** +---------------- +Simply save the utility in your system path and mark it as executable. - 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). +If you don't know your system path, you can find it with this Terminal command: - 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. + echo "${PATH}" + +To mark a utility as executable, use the `chmod` command: + + chmod +x tmimport.sh + chmod +x dirdedupe.sh + +If you're still lost, do this: + 1. In your Home folder, create a new folder called `.bin` + 2. Download and save the utilities to your new `.bin` folder + 3. Use a text editor to open `.zshrc` (or `.bash_profile` on older Macs) + from your Home folder and add the following line at the end: + + `PATH=${PATH}:${HOME}/.bin` + + 4. In Terminal, run the following commands: + + `chmod +x ~/.bin/*.sh` + + 5. Quit (or restart) the Terminal. + +______________________________________________________________________________ + + +**tmimport** +------------ + TIME MACHINE IMPORT + + USAGE -# dirdedupe - Directory De-Duplication ("Dirty Dupe") + tmimport.sh + + 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. + + 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. +______________________________________________________________________________ - dirdedupe.sh [--execute] masterdir shadowdir - 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. +**dirdedupe** +------------- + DIRECTORY DE-DUPLICATOR + + USAGE + + dirdedupe.sh [--execute] masterdir shadowdir + + 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. OPTIONS - --execute Actually remove and link duplicate files. By default, this - program runs in test mode. \ No newline at end of file + --execute Actually remove and link duplicate files. By default, this + program runs in test mode. diff --git a/dirdedupe.sh b/dirdedupe.sh index 6c79693..a2994c8 100755 --- a/dirdedupe.sh +++ b/dirdedupe.sh @@ -21,18 +21,26 @@ ############################################################################ printusage() { echo " -DIRECTORY DE-DUPLICATION (\"Dirty Dupe\") +DIRECTORY DE-DUPLICATOR -${0} [--execute] masterdir shadowdir +USAGE -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. + dirdedupe.sh [--execute] masterdir shadowdir + +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. OPTIONS - --execute Actually remove and link duplicate files. By default, this + --execute Actually remove and link duplicate files. By default, this program runs in test mode. + +MISC + + The name of this utility is pronounced "dirty dupe." " } diff --git a/tmimport.sh b/tmimport.sh index 0c9f48a..ed59d73 100755 --- a/tmimport.sh +++ b/tmimport.sh @@ -21,22 +21,28 @@ function dispusage() { printf "%s\n\n" "${1}" fi echo "\ -Time Machine Importer" - echo - echo "\ -Usage: ${0} +TIME MACHINE IMPORT -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), attempts to associate the primary -disk with the backup, and attempts to 'inherit' the backup history. +USAGE -The backup drive should be specified by volume name or mount point. If the -backup drive is specified by the disk device name or path, Time Machine -Importer will try to find an HFS+ partition on it. If there is one, or if a -partition name or path is specified, Time Machine Importer will attempt to -find the mount point and check for the existence of a Backups.backupdb -folder. + ${0} + +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. + + 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. " }