README improvements

Modified the README to include installation instructions
and synchronized command line and README usage message.
This commit is contained in:
Lee Ockert
2022-07-19 12:04:22 -04:00
parent 56b6d79d54
commit 74a98e499e
3 changed files with 103 additions and 43 deletions

View File

@ -1,33 +1,79 @@
# tmimport
Time Machine Importer
**Time Machine Utilities**
==========================
tmimport.sh <backup drive>
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 <backup drive>
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.
--execute Actually remove and link duplicate files. By default, this
program runs in test mode.