CommandLine Reference

<< Click to Display Table of Contents >>

Navigation:  Developer Edition > CommandLine Utility >

CommandLine Reference

Previous pageReturn to chapter overviewNext page

 

This page contains the syntax of the command line utility and a description of all variables, commands and settings.

 

Syntax

synk[.exe]

  [/dir={Parent folder}]

  [/src={Source folder/file}]

  [/tgt={Target folder/file}]

  [/xml={Synkronizer project file}]

  [/rep={Report folder}]

  [/log={Log file}]

  [/m={Matching options}]

  [/r={Report options}]

  [/c]

  [/x]

 

 

Variables

/dir={Parent folder}

Optional. Name/location of the parent folder. The difference reports and log files will be stored within this folder if not defined separately.

 

/src={Source folder/file}

Required. Folder of the source files or the name of the source file. If you want to compare all files of a folder you need to enter a folder otherwise enter a file name. You can enter an absolute path/file or a path/file name relative to the parent directory (/dir).

 

/tgt={Target folder/file}

Required. Folder of the target files or the name of the target file. If you want to compare all files of a folder you need to enter a folder otherwise enter a file name. You can enter an absolute path/file or a path/file name relative to the parent directory (/dir).

 

/xml={Synkronizer Project file}

Optional. Name of the Synkronizer project file. All other settings like Contents, Formats or Filters are taken from this project file. If no project file is defined, the Synkronizer default settings are used.

 

/rep={Folder for difference reports}

Optional. Name of the folder in which the difference reports are saved. If this parameter is empty, the difference reports are written into the parent folder (/dir).

 

/log={Name of Synkronizer log file}

Optional. Name of the log file. If this parameter is defined, a log file will be created.

 

 

Note

If the folders or file names contain spaces and you are working with batch files and/or Windows shortcuts you need to use apostrophes (double quotes) for addressing the folders/file names.

 

 

Tools

matching (/m=)

Optional. Matching options. You can define how the worksheets shall be matched. The following options are allowed:

 1=Compare all worksheets by name (default setting)

 2=Compare all worksheets by index

 -1=Compare first worksheets by name

 -2=Compare first worksheets by index

 

highlight (/h=)

Optional. Highlighting options. The following options are allowed:

 1=Differences are highlighted

 0=No differences are highlighted (default setting)

 

report (/r=)

Optional. Difference report options. The following options are allowed:

 1=A standard difference report is created (default setting)

 2=A difference with hyperlinks will be created.

 0=No difference report will be created.

 

 

Commands

/?

Synkronizer CommandLine Utility help. All commands and settings are displayed.

 

/f

Files to be compared. You can see which files will be compared and which not.

 

/v

The settings of the current project are displayed. You can see the folders, file names and comparison settings.

 

/c

Starts the comparison process. You can enter ctrl-c to terminate the comparison process.

 

/cs

Starts the comparison process and saves the files at the end under a new name. The original remain files unchanged. You can enter ctrl-c to terminate the comparison process.

 

/x

The Synkronizer CommandLine Utility will be closed.