terabyteunlimited.com/2014.06.terabyteunlimited.com.tar/terabyteunlimited.com/ifwbatv2.zip/ProfileHelp.txt

Text File | 2008-03-06 | 15KB | 341 lines

####################################################################################################
This file will explain how to configure each of the SET commands in Profile.cmd.
####################################################################################################

set IFWPath=

   ** This setting is required, regardless of where images are to be saved.

   Specify the path to IMAGEW.EXE, including the file name itself.  Do not include quotation marks.

   Examples:

      set IFWPath=C:\Program Files\Image for Windows\imagew.exe
      set IFWPath=C:\Program Files\TeraByte Unlimited\Image for Windows\V2\imagew.exe

####################################################################################################

set IFWParms=

   ** This setting is required, regardless of where images are to be saved.

   Specify the parameters to be passed to Image for Windows, NOT including the target parameter
   (i.e. the parameter beginning with "/f:").  The script will add the "/f:" parameter on its own.

   To see what command line parameters are accepted by Image for Windows, refer to the PDF manual.
   You can also get a summary of accepted command line parameters by running "IMAGEW.EXE /?".

   Examples:

      set IFWParms=/b /d:w0@0x12 /rb:0 /cdws:32 /noej /cdrs:32 /vpd

####################################################################################################

set ImageName=

   ** This setting is required, regardless of where images are to be saved.

   Specify the name of the image file, with or without the TBI extension (but preferably without).

   The name used can use long file names (i.e. it may contain more than eight characters, and/or
   spaces).

   Examples:

      set ImageName=WINDOWS
      set ImageName=WINDOWS.TBI

####################################################################################################

set BackupParentDir=

   ** This setting is required when saving images to a hard drive.

   Specify the parent directory for backup files (i.e. one level above the directory where the image
   files themselves will be stored).  At the very least, this must be a root directory (i.e. "D:").
   Do not include quotation marks or a trailing backslash.

   The directory used can use long file names (i.e. it may contain more than eight characters,
   and/or spaces).

   Target device (i.e. "/f:d@p") format is not supported when saving images to a hard drive.  The
   target must be specified by path and file name (by specifying values for the BackupParentDir and
   ImageName settings).

   Examples:

      set BackupParentDir=E:\Backups\Images
      set BackupParentDir=E:\Backups\Image Files
      set BackupParentDir=F:

   More Information:
   -----------------

   When you use these scripts to save images to a hard drive, they save the image files in
   directories named according to the mask YYYYMMDD, which represents the date in effect when the
   imaging process begins.  The BackupParentDir setting described here is how you specify where the
   YYYYMMDD directories themselves will be stored.  For example, suppose you use the following
   setting:

      set BackupParentDir=D:\Backups

   If you were to begin the IFW batch process on July 4, 2005, the image files would be saved here:

      D:\Backups\20050704

   If you were to run the IFW batch process again on July 4, 2005 (and with the same profile), the
   scripts would begin saving the image files in numbered subdirectories:

      D:\Backups\20050704\001
      D:\Backups\20050704\002

   And so on.  Please note that when the "D:\Backups\20050704\001" directory is first created, the
   files originally stored in "D:\Backups\20050704" are moved to it, and the current image files
   will be saved under "D:\Backups\20050704\002".  This is the only circumstance under which image
   files are moved by these scripts.

   Please refer to the ReadMe.txt file for information on how the script attempts to determine
   your regional settings in order to correctly format the date for you in YYYYMMDD format.

   Currently, the maximum number of numbered subdirectories that the scripts can create and handle
   is 25.  That is, if you try running the scripts a 26th time on a given date (keeping in mind that
   the date is taken from the system), you will receive an error.

   If you never happen to run the IFW batch process more than once on any given date, then the
   numbered subdirectories will never be used.

####################################################################################################

set Space=

   ** This setting is required when saving images to a hard drive.

   Specify how many megabytes (MB) of free space must be available on the target partition to
   continue without first automatically deleting one or more old backup directories.  Use numbers
   only; do not include units (MB), or any commas.

   If you always want the oldest image backup to be deleted, regardless of the free space
   implications, use the word "oldest" here instead of a number (use with caution!).

   If you don't want old backups to be deleted automatically at all, use Space=0, or leave the
   setting blank.  Please note that if you do this, you must manually make sure that enough space
   exists on the target hard drive before attempting to save a new backup to that hard drive.

   Examples:

      set Space=0
      set Space=5120
      set Space=20480
      set Space=oldest
      set Space=

   More Information:
   -----------------

   When you use these scripts to save images to a hard drive, the (included) IsFree.exe utility uses
   the value you supply here to determine if the target hard drive has at least that much free space
   available (in megabytes).  If so, the IFW batch process simply continues.  If IsFree.exe
   determines that less free space exists on the target hard drive than the number you specify here,
   the scripts begin removing old backups, one set at a time.  The oldest backups are deleted first,
   and IsFree.exe checks the amount of free space available after each deletion.

   If you specify Space=oldest, rather than the number of megabytes that must be free, the scripts
   will delete the oldest backup set each time they are run.  This is true even if the current
   imaging process fails; so be careful if you are using Space=oldest option and retry an imaging
   process several times.

####################################################################################################

set TargetOpticalDrive=

   ** This setting is required when saving images to an optical drive.

   If you are saving images to an optical disc, specify the appropriate optical drive number here.
   If you are unsure what the optical drive number is, run "IMAGEW.EXE /R /CD" from a command line.
   If you are saving images to a hard drive, this option must be left blank!

   Examples:

      set TargetOpticalDrive=1
      set TargetOpticalDrive=2
      set TargetOpticalDrive=

####################################################################################################

set IFWScriptPath=

   ** This setting is optional, regardless of where images are to be saved.

   If the file IFWv2.cmd resides in the same directory as Profile.cmd, you can leave this option
   blank.  Othewise, you must specify the full path to IFWv2.cmd, including the file name itself.
   If you have renamed IFWv2.cmd, you must specify its full path, including file name, regardless of
   where it resides.  Omit quotation marks in all cases.

   Examples:

      set IFWScriptPath=C:\Program Files\Image for Windows\IFWv2.cmd
      set IFWScriptPath=C:\Scripts\IFWv2.cmd
      set IFWScriptPath=

####################################################################################################

set IFWLogPath=
set AppendToLog=

   ** These settings are optional, regardless of where images are to be saved.

   Specify the path and name to be used for the IFW log that is created by these command scripts.
   Omit quotation marks.  If you do not set this option at all, no logging will be performed.

   You can use the BackupParentDir and/or ImageName variables for IFWLogPath (e.g.
   %BackupParentDir%\%ImageName%.log).  If you use BackupParentDir, however, please ensure that the
   directory specified by BackupParentDir exists before the script is run.  This is because if the
   BackupParentDir directory doesn't exist when the script first runs, that directory will be
   created, but the "Image for Windows batch process started" message will not get logged.

   Use AppendToLog=1 if you want the log file to be appended to each time the IFW batch
   process is run.  If you want the log file to be overwritten instead, leave the AppendToLog
   option blank.

   Please note that if you allow a given log file to be appended to, you will need to clear it out
   manually from time to time.  The scripts will never delete any log file content.

   Examples:

      set IFWLogPath=C:\Program Files\Image for Windows\IFW.log
      set IFWLogPath=D:\Backups\Windows.log
      set IFWLogPath=E:\Images\%ImageName%.log
      set IFWLogPath=%BackupParentDir%\%ImageName%.log
      set IFWLogPath=%TEMP%\IFW.log
      set AppendToLog=1
      set AppendToLog=

####################################################################################################

set PromptBeforeRun=
set PromptText=
set PromptTimeout=

   ** These settings are optional, regardless of where images are to be saved.

   Use PromptBeforeRun=1 to have a dialog appear, prompting you to continue or exit before
   IFW runs.  Use PromptBeforeRun=0 (or leave it blank) to avoid being prompted, and have
   IFW run automatically.

   Important:  If this batch file will run as a scheduled task, use PromptBeforeRun=0.

   If you use PromptBeforeRun=1, you should also configure the PromptText= option, keeping in
   mind that the prompt will ask a Yes/No question (based on whether the script should/should
   not continue).

   Using PromptTimeout=X, where X is a non-zero positive integer, results in the prompt being
   automatically dismissed after X seconds.  If the prompt times out in this manner, a Yes
   response is implied.

   Examples:

      set PromptBeforeRun=0
      set PromptBeforeRun=1
      set PromptText=Backup the Windows partition now?
      set PromptText=Do you want to run the Image for Windows batch process for the '%ImageName%' image?
      set PromptTimeout=10

####################################################################################################

set NotifyComplete=

   ** This setting is optional, regardless of where images are to be saved.

   Use NotifyComplete=1 to receive a dialog that notifies you of IFW completion, whether IFW
   completes successfully, or encounters an error.  Use NotifyComplete=2 to receive a dialog
   only if IFW completes with an error.  Finally, use NotifyComplete=0 (or leave it blank) to
   prevent a dialog from appearing, regardless of whether IFW encountered an error or not.
   Configure with care.

   Please note that you will always be notified of errors that prevent IFW from running in the first
   place, such as script configuration errors, not enough space on the target, and so on.

   Examples:

      set NotifyComplete=0
      set NotifyComplete=1
      set NotifyComplete=2

####################################################################################################

set NotifyNormalTimeout=
set NotifyErrorTimeout=

   ** These settings are optional, regardless of where images are to be saved.

   Using NotifyNormalTimeout=X, where X is a non-zero positive integer, results in
   notification dialogs being automatically dismissed after X seconds, if the IFW batch
   process completes without error.

   Using NotifyErrorTimeout=X, where X is a non-zero positive integer, results in
   notification dialogs being automatically dismissed after X seconds, if the IFW batch
   process completes with an error.  Configure with care.

   The NotifyNormalTimeout setting does nothing unless you also use NotifyComplete=1.  The
   NotifyErrorTimeout setting does nothing unless you also use either NotifyComplete=1
   or NotifyComplete=2.

   Please note that some preeminent errors (e.g. those that occur before the main IFW script
   has even run) cannot be set to timeout.

   Examples:

      set NotifyNormalTimeout=5
      set NotifyNormalTimeout=600
      set NotifyErrorTimeout=300
      set NotifyErrorTimeout=900

####################################################################################################

set RunPriorXX=
set RunAfterAlwaysXX=
set RunAfterCondXX=

   ** These settings are optional, regardless of where images are to be saved.

   Using the RunPriorXX= entries, you can supply a series of command lines to be executed before
   IFW runs.  If you want the batch process to wait for the command to complete before continuing
   (i.e. before any other RunPriorXX entries, or IFW itself, runs), you should generally use the
   /WAIT parameter with the START command (e.g. "START "" /WAIT <command>").  Run the command
   "START /?" (without quotation marks) from a command prompt for more information on using the
   START command.

   Using the RunAfterAlwaysXX= entries, you can supply a series of command lines to be executed
   after IFW runs, whether it completes with or without an error (i.e. always).

   Using the RunAfterCondXX= entries, you can supply a series of command lines to be executed
   after IFW runs, but only if it completes without an error (i.e. conditionally).

   Any of these which are not used should be left blank (e.g. "set RunPriorXX="), or preceded with
   a double colon or "rem " (e.g. "set RunAfterAlways01=::<command line>" or
   e.g. "set RunAfterAlways01=rem <command line>").

   If you want to use a command line that will include the path of the image to be created, use the
   string "BackupChildDir" without--yes, WITHOUT!--enclosing it in percent symbols (as you normally
   would for a variable).  Please refer to the example using TBIView.exe below.

   If you wish to run a separate script using these settings, you may want to run CMD.EXE and pass
   the script as a parameter to it (e.g. START "" /WAIT CMD.EXE /C "D:\SCRIPTS\RUNTHIS.CMD").
   Please refer to the examples below.

   Examples:

      set RunPrior01=start "" /wait chkdsk /f /v /x %TargetDrive%:
      set RunPrior02=start "" /min /wait net pause "Task Scheduler"
      set RunAfterAlways01=start "" /min net continue "Task Scheduler"
      set RunAfterAlways02=start "" Notepad.exe "%IFWLogPath%"
      set RunAfterCond01=start "" "C:\Program Files\TBIView\TBIView.exe" "%BackupParentDir%\BackupChildDir\%ImageName%" /CreateIdx
      set RunAfterCond02=start "" /wait cmd.exe /c "D:\Batch Files\Script.cmd"
      set RunAfterCond03=

####################################################################################################

Copyright (c) 2008 TeraByte, Inc.  All Rights Reserved.

End of document