Primer for PARtriculation v 0.1

Until I have time to write proper documentation, this will serve to get beta-testers started with this product.

PARtriculation is a CLI (command-line interface) front-end for the PAR2 verification and repair features of Peter B. Clements' QuickPar. This allows the use of QuickPar's advancements over par2cmdline from the command-line environment with support for scanning multiple PAR2 sets with one operation, sequentially. In other words, PARtriculation will run QuickPar, once per every PAR2 set in a folder or folder structure, while obtaining the results and closing QuickPar when complete. Only one QuickPar operation is performed at a time so as to minimize hard drive thrashing.

Primer Contents

• Requirements
• Usage
• Scheduling to run periodically with Windows Task Scheduler
• Adding to Windows shell context menus

Requirements

• QuickPAR 0.9.1 (by Peter B. Clements) installed
• DLLs (you likely have all of these already in Windows):
  • msvcrt.dll (included in Microsoft Visual C++ 2005 SP1 x86 Redistributable Package | x64)
  • mfc71.dll (included in Microsoft Visual C++ 2005 SP1 x86 Redistributable Package | x64)
  • toolhelp.dll (included with Windows)
• Reading, understanding and accepting the terms in the LICENSE.TXT file accompanying PARtriculation.exe.

Usage

Synopsis:
    PARtriculation [options] [/d:PROCESSDIR] [/p:QUICKPAREXE]
Description:
    PROCESSDIR will be searched for all PAR2 sets.  For each set found,
    QuickPAR will be launched upon that PAR2 set.  Once it's operation is
    complete, it will be closed and processing will continue on to the next
    PAR2 set.

    If PROCESSDIR is omitted, the current working directory is used.
    Otherwise PROCESSDIR should be a full path to the directory on which
    to operate.  QUICKPAR is optional and is the full path to the QuickPAR
    executable.  If omitted, this path is retrived from the registry.
    Paths containing spaces must be surrounded with quotation marks.
Options (all optional):
    /c
      Force closed all QuickPAR processes on start and finish
    /n
      Hide repair progress
    /p
      Pause before exit
    /q
      Quiet mode - removes some output
    /r ###
      ### is the number of milliseconds between QuickPAR status refreses (1000)
    /R
      Recurse into all subdirectories of PROCESSDIR
    /R!
      Recurse into all subdirectories of PROCESSDIR except those starting with !
    /s
      Show the QuickPAR window
    /t ###
      ### is the number of seconds to wait for a QuickPAR operation (120)
    /T ###
      ### is the number of seconds to wait for QuickPAR to launch (20)

Scheduling to run periodically with Windows Task Scheduler (optional)

There are two main ways to schedule tasks in Windows. The first is using a Windows wizard interface. To access it in Windows XP, go to Start->Programs->Accessories->System Tools->Scheduled Tasks. Open Add Scheduled Task and follow the instructions.

For much more sophisticated options you can use the SCHTASKS.exe CLI application that is included in Windows XP and later. For details on how to use SCHTASKS there are many good articles on the net including this one at TechNet.

In either case, remember to include any command-line parameters it should use. /d:PROCESSDIR is mandatory when using the scheduler.

Adding to Windows shell context menus (optional)

You can easy add PARtriculation to the context menu that appears for folders in the Windows shell (including Windows Explorer) by using a very handy third-party application, Fast Explorer. I have created a Fast Explorer menu items file which you can modify to fit your installation scenario.

If you wish to use a preconfigured menu, first create a text file called PARtriculation.ini and paste the following text into it:

[Fast Explorer]
FormVersion=0
Flags=0
ShowCmd=1
PixelsPerInch=96
MinMaxPos(1600x1200)=-1,-1,-1,-1
MinMaxPos=-1,-1,-1,-1
NormPos(1600x1200)=478,401,1121,798
NormPos=478,401,1121,798
Visible=0

[Dynamic Items]
Parent1=0
Caption1=PARtriculation
Checked1=1
FileType1=Directory
Hint1=
IconFile1=
IconIndex1=0
Submenu1=1
Parent2=1
Application2=***PATH_TO_PARTRICULATION***\PARtriculation.exe
Parameters2=/d \"%1\" /P /c /r 500
Caption2=This Folder
Hint2=
IconFile2=***PATH_TO_PARTRICULATION***\PARtriculation.exe
IconIndex2=-1
Checked2=1
FileType2=Directory
Parent3=1
Application3=***PATH_TO_PARTRICULATION***\PARtriculation.exe
Parameters3=/d \"%1\" /R! /P /c /r 250 /q
Caption3=+ Subfolders
Hint3=
IconFile3=***PATH_TO_PARTRICULATION***\PARtriculation.exe
IconIndex3=-1
Checked3=1
FileType3=Directory
Parent4=1
Application4=***PATH_TO_PARTRICULATION***\PARtriculation.exe
Parameters4=/d \"%1\" /R! /P /c /r 250 /q /S
Caption4=+ Create Success File
Hint4=
IconFile4=***PATH_TO_PARTRICULATION***\PARtriculation.exe
IconIndex4=-1
Checked4=1
FileType4=Directory
Count=4

You will need to replace ***PATH_TO_PARTRICULATION*** with the full path to the folder containing PARtriculation.exe. Save the file somewhere (using the file extension .INI) and exit the text editor.

Next, install Fast Explorer, launch it, select the Submenu Items section and enable Enable Dynamic Items. Then click on the Menu button, click Open..., and navigate to and open the .INI file you just created. Edit the sub-menus as you see fit, and press Apply to create the menus.

Now, when you right-click on a folder in the Windows shell you will find a menu section called PARtriculation. Feel free to add or remove any entries or edit the command-line options as you see fit.