Command Line Arguments

Top  Previous  Next

PeerLock Help > Command Line Arguments > Command Line Arguments

 

The applications Command Line Mode offers users the ability to configure a truly "hands-off" installation, where operation and distribution occurs from within an easily manageable, administrative environment.  This mode allows Actions to be executed from logon scripts, system batch or command (CMD) files, detailed shortcuts, and shell commands.

 

Notes:

 

1.For the command line arguments described in this topic, note that attention is paid to punctuation, to the order in which arguments are entered, and that appropriate spaces are used to separate these arguments.  Follow the format outlined in the examples provided.

 

2.Command Line Arguments can be added to the application Shortcut

 

 

Auto Start

/A

Auto Start: This argument is used to start PeerLock automatically.

/AM

Minimized*: This argument is used to run PeerLock automatically and  minimized.

 

Examples:

 

/A

Auto Start

/AM

Auto Start - Minimized

 

 

Detect/Lock Options

/DC[+-]

Check For File Name In Caption: Looks for the source file name in all open application captions when deciding if a file is open or not.  This option is on by default.

/DE[+-]

Strip File Extension (Check For File Name In Caption): When using the Check For File Name In Caption option this option will strip off the file extension when looking for file names in all open application captions.

/DP[+-]

Strip File Path (Check For File Name In Caption): When using the Check For File Name In Caption option this option will strip off the file path when looking for file names in all open application captions.  This option is on by default.

/DD[+-]

Detect Files when Target Does Not Exist (Create Target Stub File): If the opened source file does not have a corresponding target file, PeerLock will create a 0 size stub file on the remote target location(s). The stub file will be removed/cleared upon release of the source file. When using PeerSync with this option enabled, the stub file will be excluded by PeerSync. This feature will prevent files from being added to the target while its corresponding source file is open. By default this option is enabled.

/DL+

Allow No Access: Uses an exclusive lock on target files, meaning once the lock is applied no other applications can get a lock on the target file.  This option is disabled by default.

/DL-

Allow Read Access: The lock set on target files will allow for other applications to still obtain a handle and get their own lock on the file.  This option is disabled by default.

/DL>

Allow Access based on Source File: PeerLock will take into account the source file access and replicate the same exact handles to the target files. PeerLock will apply the same type of handle to the target file that is currently applied to the source file. This method will lock out users from the target file in the same fashion they are locked out from the source. This option is beneficial when working with applications that allow for various types of file access (i.e. some files are opened for read and write access while other related files will be opened for read only access). This option is enabled by default.

/DI[+-]

Interact with PeerSync and/or Save-N-Sync***: Communicates/Notifies PeerSync and/or Save-N-Sync to exclude source files that are detected as open until the file has been released.  This option is off by default and the caption of the option will display the name of the Peer Software product that is installed if applicable.

/DJ[+-]

Interact with Remote PeerLocks***: Communicates/Notifies remote PeerLocks that may be running on your target machine(s) to exclude the detection of the local PeerLock locking files on the remote machine.  This option should be enabled when running PeerLock on multiple machines pointing at each other.  This option is off by default .

/DO[+-]

Check for File Open On Detection: This open will validate for a false detection of an open file by doing a secondary validation that the file is open on detection of the open file.  This option is off by default.

/DS[+-]

Use File Server Mode Detection: If enabled, detection of locked files will be monitored by connections to the server made from other machines.  When this option is enabled files opened by the local machine will not be detected but open files will be detected and locked on the start of PeerLock.  If this option is not enabled detection of locked files will be monitored by a device driver running on the local machine the watches for changes made by any machine including the local machine but open files will  not be detected and locked on the start of PeerLock.  This option is on by default.

/DM:n

Set Detection Method Level (n = 1 - 31): PeerLock uses up to five methods of detection to determine if a file is open and in use.  Using a value between 1 and 31 will enable any combination of the five methods.  The first four methods are used by default (a value of 15 {1 + 2 + 4 + 7}) .  Each method is represented by 2 to the x value:

 

 1 = Method 1

 2 = Method 2

 4 = Method 3

 8 = Method 4

16 = Method 5

/DT[+-]

Use Local Detection: Detect source file open events that occur locally. Changes will be detected in Real-Time as source files are opened. Files opened prior to PeerLock running will not be detected. This option is disabled by default.

 

Note: Starting with version 3.0, PeerLock supports File Server Mode Detection only.

/DN[+-]

File Server Mode Detection: Detect source file open events that occur across the network. It will not do real time detection as the Local Detection mode. It will poll opened files from the Windows Open Files list based on the Lock Frequency. Therefore it will be able to detect files that were opened prior to PeerLock being started. This option is enabled by default.

 

Note: Starting with version 3.0, PeerLock supports File Server Mode Detection only.

 

Examples:

 

/DC-E+P+D+L+I-O-S+M15

Default Settings on servers

/DC-E-P-D-L-I-O-M31

All Options Off and All Detection Methods On

 

 

Release Options

/RS[+-]

Trigger Event: This option will check to see if the source file has been updated by looking at the current modified date/time stamp versus the stored modified date/time stamp.  If the file has been updated PeerLock will trigger an event to be detected by synchronization products to update the corresponding target file(s) with the updated source file upon release from the Lock List.

/RA[+-]

Wait for Associated Application to Close: This option will check to see if the application that opened the source file is still running before releasing the corresponding target file(s) from the Lock List.  This option is useful when an application does not retain a handle on the files that are opened by itself.  When this option is enabled, the target files will not be released until all instances of the application terminate.  By default some application names are excluded from this check (i.e. Explorer.exe).  The default exclusion list for this option can be modified by editing the configuration file (PLDef.cfg)

/RF:n

Release Frequency (n = frequency in milliseconds): Sets the  frequency to check for source files that have been closed or released.  The default is every 3000 milliseconds or 3 seconds.

/RI:n

Set Release Idle Time: Represents the interval, in seconds, of how long the target file will remain locked once the source file has been released. When the source file is closed PeerLock will wait n seconds before releasing the target file. During this period the file entry in the Locked list will be highlighted Yellow. This feature is intended to protect the releasing of files during file opens and saves. Certain applications may temporary release files during these procedures. With this feature enabled PeerLock will wait the set period of time to make sure the file is fully released before unlocking the corresponding target files. Once an item is released it will be added to the Release list. The default value is 5 seconds.

/RT+

Trigger Event - Include files that have not been updated: This option will allow for triggering of files that may have been open but not updated. By default this setting is disabled.

/RL:n

Set Lock Frequency: Represents the interval, in milliseconds, of how often PeerLock will check for locked source files. Once PeerLock detects that a source file is locked it will lock the corresponding target files. Default value is 1000 ms.

 

Examples:

 

/RS+A-F3000

Trigger Event On, Wait for Associated Application to Close Off and Check for Released Files every 3 Seconds (Default)

/RS-A+F1000

Trigger Event Off, Wait for Associated Application to Close On and Check for Released Files every 1 Second

 

 

Performance

/PF:n

Service Thread Sleep Frequency: Represents the sleep frequency value, in milliseconds, of the main service thread. The higher the frequency the more CPU will be used. By default this value is 50 ms. To achieve faster PeerLock response rate, increase the Sleep Frequency and decrease the Sleep Value. To achieve lower CPU usage, decrease the Sleep Frequency and increase the Sleep Value.

/PR:n

Retry Failed Connections (n = frequency in milliseconds): PeerLock will store failed connections and retry them on a ten minute cycle.  This should improve overall performance when connection losses occur.

 

Examples:

 

If n = 0

Will check connection failures and not retry until restarting the locking.

If n = -1

Will try to connect on every event. Only recommended to use when having intermitted connection failures.

If n = other positive value

Represents in milliseconds the retry frequency.

Default is 60000 ms = every 10 minutes

Minimum value is 1000 ms = every 1 second

/PV:n

Service Thread Sleep Value: Represents the sleep value, in milliseconds, of the main service thread. By default this value is 25 ms. To achieve faster PeerLock response rate, increase the Sleep Frequency and decrease the Sleep Value. To achieve lower CPU usage, decrease the Sleep Frequency and increase the Sleep Value.

 

Examples:

 

/PF50

Default Service Thread Sleep Frequency

/PV25

Default Service Thread Sleep Value

/PR60000

Default Retry Failed Connections setting

 

 

Internal File Management

/JL[+-]

Cache Locked File History: Maintains a list of all the files locked by PeerLock in the PeerLock installation folder (...\PeerLock\Cache\LFCache.txt). If the Clear Cache at start option is enabled, at the start-up of PeerLock, it will refer to this list to clean up the stub files and lock files left behind on the target folder.  Alternatively this can be done manually by hitting the clear cache button. This setting is enabled by default.

/JS[+-]

Clear Cache At Start: Clears out the cache file located in the Cache folder in the PeerLock installation folder when PeerLock is starting and begins to lock files down. This setting is enabled by default.

 

 

Application Include/Exclude

/I:a1;a2..an

Include Applications** (a =  Applications to Include during Detection): This argument is used to build a list of applications to Include during detection.  For multiple applications use a semi-colon delimiter.  By default all applications are included.  This can also be configured from the interface via the Application Include/Exclude Lists.

 

Examples:

 

/I:*

Include detection of file opens from all applications

/I:WINWORD.EXE;EXCEL.EXE

Include detection of file opens from MS Word and MS Excel

/E:a1;a2..an

Exclude Applications** (a =  Applications to Exclude during Detection): This argument is used to build a list of applications to Exclude during detection.  For multiple applications use a semi-colon delimiter.  By default a list of applications are excluded including Explorer, PeerLock, PeerSync and Save-N-Sync.  This can also be configured from the interface via the Application Include/Exclude Lists.

 

Examples:

 

/E:

Do not exclude any applications

/E:EXPLORER.EXE;PeerLock.EXE

Only exclude PeerLock and PeerSync

 

 

Notes:

 

1.Any arguments containing spaces must be enclosed by quotes.

 

2.Most of these options can be set from the interface via the Main Menu.

 

3.* The run minimized argument is not available during evaluation.

 

4.** By Observing at the Lock List Application Column you can determine what applications you may want to Include or Exclude.