Client Manual v2.0219 by Dominic

Options are case insensitive, and dash can be used instead of slash:

• /c : compare rather than backup (--compare)
• /d : force deletion of pre-existing volume shadow sets (overrides setting in ConfigFile)
• /f conf : use ConfigFile 'conf'
• /g : run with debug messages
• /h /? : see these instructions (html)
• /q : reduce output messages (quiet)
• /t : do everything except call rdiff-backup (test)
• /v : show version of TimeDicer
• /x : if error occurs, proceed to exit at end of run instead of pausing
• List Versions: [recover_path\file] on command line will list timediced versions of file
• Recover Options: [/r] [/o] [recover_path\file] [when] [recover_to]
  • /r : recover a file
  • /o : with /r, allow overwrite of existing local file
  • recover_path\file : the original-path\file to recover
  • when : optionally, if recovering, specify datetime of version to recover - after recover_file
  • recover_to : optionally, if recovering, specify where to recover to - default %TEMP%

#TimeDicer.txt file - example/template config file

#Lines that are blank or any text after # on a line are ignored, lines
#beginning with SET are processed, all other lines are assumed to be part
#of the list of sources and destinations. The file must terminate with
#an end-of-line.

#The only required lines are one beginning SET server= (specifying the address
#of the TimeDicer Server), and at least one comma-separated line specifying a
#source folder and destination archive.

#'server' is the DNS name or IP address of the TimeDicer Server, and
#must be supplied here.
SET server=192.168.100.125

#'excludelist' optionally identifies a file which lists (in Windows format,
#case insensitive) files/paths to be excluded from backup e.g. thumbs.db.
#Each file/path should appear on a separate line in the file. Do not begin
#or end an entry in the list with * as this is prefixed/suffixed
#anyway, and do not use quotes. So a line:
#"C:\Documents And Settings\Fred\My Documents\thumbs.*"
#should instead be written as:
#C:\Documents And Settings\Fred\My Documents\thumbs.
#or even:
#thumbs.
#(which will exclude all files or paths which contain the text 'thumbs.')
#SET excludelist=c:\exclfolders.txt

#Backups:a comma-separated list of source directories and their
#destination archives, with an optional third parameter holding extra
#parameters to be added to the rdiff-backup command line (these appear before
#any 'excludelist' and 'options' parameters and thus are
#processed after them). Environment variables can be embedded as shown.
#Directories should not have surrounding quotes, and there should not
#be any terminating backslash (\).
%USERPROFILE%\My Documents,mydocs,--exclude **/*.accd? --exclude **/*.md?
%USERPROFILE%\Desktop,desktop
c:\Utils,utils
c:\Bas,bas

You will not normally need to use these more advanced options:

#'user' is the login name of the user on the TimeDicer Server, it is
#optional and defaults to lower-case %USERNAME%-%USERDOMAIN% with 
#any spaces stripped. 'user' must not contain spaces
SET user=fred

#'key' is ppk file (created with Puttygen and containing private key, the
#corresponding public key must be saved on the TimeDicer Server in
# ~/.ssh/authorized_keys). For TimeDicer to run unattended, the public key
#must be saved without passphrase. 'key' is optional; if not supplied it
#defaults to %APPDATA%\TimeDicer\privatekey.ppk.
SET key=C:\Documents and Settings\Fred\mykey.ppk

#'port' is the ssh port on or to the TimeDicer Server, default 22.
SET port=21

#'basearchive' is optional, all archive destinations will have this prefix.
#Unless 'basearchive' starts with / it will be defined in relation to the home
#directory of the user on the TimeDicer Server; if it is undefined, archives
#will be directly located in that home directory. If using ecryptfs under
#Ubuntu then 'basearchive=Private' should provide good protection against data
#theft resulting from physical theft of the TimeDicer Server, but it does not
#prevent the administrator of the TimeDicer Server (superuser) getting access
#to your data. Note that 'basearchive' is case sensitive.
SET basearchive=archives/

#'options' is optional and contains additional command-line options for
#rdiff-backup, it appears before 'excludelist' and thus is processed after it.
SET options=-v5

#'vss' is optionally y or n (default: y) -  set to n to disable Volume Shadow
#Services. You need to do this is if the source drive is formatted with FAT32
#(or FAT) or if you are backing up from a non-local drive.
SET vss=n

#'skip_on_no_change' is optionally y or n (default: y) - set to n to disable
#skipping of backup if the source data has not changed since last time. After
#each run TimeDicer records the date of each successful backup and if 
#'skip_on_no_change' is 'y' then it looks for changes in the source data
#(using xcopy) since [and including] that date. Backup is skipped if there
#are no changes. This can avoid bloating of backups on the TimeDicer Server
#especially with sources that rarely change.
SET skip_on_no_change=n

#'skip-rdiff-backup-test' is optionally y (default: n) - this forces TimeDicer
#to skip an initial test for the presence and version of rdiff-backup on the
#server. In rare situations, e.g. restricted access rights to the server, this
#might be helpful.
SET skip-rdiff-backup-test=y

#'log' is optional location for log file and it defaults to 
#%APPDATA%\TimeDicer\timedicer-log.txt. If you do not want a log set it to NUL.
SET log=J:\mylog.txt