- Gsync Runner (Service)
- Run Options
- Activation of Command Line License
- Global Program Options
- Job Commands
- Job Options
- Connectoid Options
- General Options
- Filter Options
- Auto Options
- Script Options
- Advanced Options Sync Time
- Advanced Options Analyze Time
- Side Options
GSYNC is the command line version of GoodSync. It is ideal for calling from batch files and other programs. It is also the standard version for Linux environments.
Command line call has this general format:
gsync [<global-option>] <command> <command-options>
GSYNC runs all jobs specified in the command line sequentially,
in the order in which jobs appear in Job List.
Log files are written to stdout.
gsync /runner models behavior of the GUI GoodSync, as it relates to Auto jobs:
- It starts and runs all jobs that are in Auto Mode, such as On File Change jobs.
- It does not show any GUI, so job results become known through global and job logs.
- It does not consume any graphical resources, as it runs as a pure command line process.
- To terminate Gsync Runner, send CTRL+C to its console.
- If /runner option is not specified, then regular gsync options (listed below) apply.
Gsync Runner (Service)
New in ver 9.9.56 and 10.0.24.
gsync /runner-service=(profile-folder-path) does the same thing as 'gsync /runner', only:
- It runs in Windows Service or MacOS launched process,
- Do Not start 'gsync /runner-service' manually; it is done only by OS means.
- In Windows, if you have Unattended Jobs, they are run in Gsync Runner Service
- Runner Service is created when you put the first job into Unattended Auto mode.
- Runner Service runs your jobs even when you are logged off from the computer.
- To take a job away from Runner Service and back into GUI GoodSync, uncheck the Unattended box in Job Options.
Run Options
/profile=<profile-folder>
GoodSync Profile folder -- a folder from which GoodSync reads job list file, global options file, and to which it writes global logs.
If not specified, profile folder is 'C:\Users\User Name\AppData\Roaming\GoodSync' on Windows 7/8 or 'C:\Documents and Settings\User Name\Application Data\GoodSync' on Windows XP.
On UNIX systems profile folder defaults to ~/.goodsync
Path should be an absolute path on local computer.
/jobs-file=<job-file-path>
If defined then load Job List and Global Options from the specified file in TIC or TIX format, depending on file extension.
If not defined then load job list from file jobs.tic in the profile folder.
/default-values=yes|no
If set to yes, then save options that have default value, when saving in TIX format.
If set to no, then do not write out options that have default value, for shorter TIX file.
/lf=<log-folder>
Write global log to <log-folder>.
If not specified, write global log to profile folder.
Path should be an absolute path on local computer.
/ll=0|1|2|3|9
Set log level to N (number from 1 to 3).
0 -- critical messages (job start and stop),
1 -- error messages
2 -- informational messages (default level)
3 -- detailed messages
9 -- no log at all.
/check-ver
If set then check whether this GSYNC version is current, report to stdout.
/license
If set then show current license and exit.
/progress=yes|no
Show progress messages when downloading or uploading files.
Default: No.
/list-changes=yes|no
Print List of changes detected by Analyze to the log.
/cleanup=yes|no (default: yes)
If set to 'yes' then clean up old log files and temporary files when GSYNC starts.
If set to 'no' then do not perform cleanup when GSYNC starts.
Old log files are defined as log files that are older than the number of days to retain the logs option.
You should use this option only if there is no other GoodSync or GSYNC processes running on this computer, as this option deletes all qualifying log and temp files, including that of other running Goodsyncs.
/override-locks=yes|no
If set to 'yes' then override lock files on Analyze.
Lock file is created in sync folder by a running Sync job and it is deleted when the job finishes.
Default: No.
Activation of Command Line License
Use these command line options to activate GSYNC license.
This is the only way to activate GoodSync on Linux, as there is no GUI version.
/orderid=1234567890
/username="John Smith"
If /orderid and /username options are specified then GoodSync Pro is automatically activated upon install using the specified OrderID and User Name. Note that this is online activation, so GoodSync.exe should be able to get to www.goodsync.com.
By default, standard browser proxy is used.
You can set proxy authentication or use different proxy by setting these options:
/proxy-auto=yes|no
Use WinInet proxy (the one used by Internet Explorer).
/proxy-host=<host-name>
Use proxy server set here by IP address or name, negates /proxy-auto option.
/proxy-port=<port-number>
Use this port on the proxy server specified in /proxy-host.
/proxy-userid=<userid>
UserID for proxy, both manual and auto.
/proxy-passwd=<password>
Password for proxy, both manual and auto.
Global Program Options
These commands modify Program Option, which are shown by GUI in Tools -> Program Options.
/system-tray=yes|no
Show system tray icon. Default: yes.
Applies to Windows GUI only.
/tray-on-close=yes|no
Closing GoodSync causes its minimization to system tray. Default: no.
Applies to Windows GUI only.
/check-new-ver=yes|no
Check for New Version from time to time. Default: yes.
/auto-hide-mini-win=yes|no
Auto-hide mini-window when there is no job activity. Default: yes.
Applies to Windows GUI only.
/warn-about-time-range=yes|no
Warn about file/folder modification time being out of range. Default: no.
/parallel-auto-jobs=NNN
Maximal number of Auto-mode jobs to be run in parallel. Default: 1.
/auto-jobs-quant=NNN
Quant (in seconds) used in starting Auto jobs. Default: 3.
/compare-prog=<ExeFilePath>
Use this program to compare two files diff style when user selects Compare from item context menu.
If nothing is specified then UNIX diff is used.
Applies to Windows GUI only.
** Log Options
/log-retain-days=NNN
Number of days for which old logs are retained. Default: 7.
/group-log-lines=yes|no
Group similar log lines. Default: yes.
** Proxy Options
/proxy-auto=yes|no
Use WinInet proxy (the one used by Internet Explorer).
/proxy-host=<host-name>
Use proxy server set here by IP address or name, negates /proxy-auto option.
/proxy-port=<port-number>
Use this port on the proxy server specified in /proxy-host.
/proxy-userid=<userid>
UserID for proxy, both manual and auto.
/proxy-passwd=<password>
Password for proxy, both manual and auto.
** SMTP Options
/smtp-host=<host-name>
Use SMTP server set here by IP address or name.
/smtp-port=<port-number>
Use this port on the SMTP server specified in /smtp-host.
/smtp-secure=yes|no
Use SSL-encrypted connection when submitting email to SMTP server.
/smtp-starttls=yes|no
Use STARTTLS to switch to encrypted connection when submitting email to SMTP server.
/smtp-userid=<userid>
UserID for SMTP server.
/smtp-passwd=<password>
Password for SMTP server.
/smtp-sender=<name-email>
Sender of Emails: "email@company.com" or "FirstName LastName <email@company.com>".
Job Commands
analyze /all
Analyze all jobs.
analyze <job-list>
Analyze listed jobs, job names are separated by space.
Job names containing spaces must be enclosed in quotes like this: "Job Name"
sync /all
Synchronize all jobs.
sync <job-list>
Sync listed jobs, job names are separated by space.
Job names containing spaces must be enclosed in quotes like this: "Job Name"
job-tmp <job-name> [<job-options>]
Create a temporary job with specified job options and Analyze/Sync it.
This job is never added to the list of jobs and it exists only in memory during execution.
job <job-name> [<job-options>]
Create a new job or update an existing job with specified job options.
job-new <job-name> [<job-options>]
Create a job with specified job options.
job-update <job-name> [<job-options>]
Change specified options in the existing job.
job-delete <job-name>
Delete existing job.
Job Options
/analyze
Analyze Job after it has been created or updated.
/sync
Analyze and Sync Job after it has been created or updated.
Connectoid Options
Correct combinations are:
/fN=URL | URL + Connectoid defined here in command line, NOT looked up Account Manager |
/uN=URL /nN=AccountName | URL + Connectoid, looked up in Account Manager, by AccountName |
/uN=URL /kN=AccountKey | URL + Connectoid, looked up in Account Manager, by AccountKey |
/f1=<full-folder-URL>
Left sync folder.
Full Folder Path should be in one of these formats:
file:///C:/folder1/folder2
file://share/disk/folder1/folder2
ftp://server.domain.com:port/folder
sftp://server.domain.com:port/folder
http://server.domain.com:port/folder
Use quotes around paths with spaces.
/f2=<full-folder-path>
Right sync folder.
For Full Folder Path format see the above item.
/u1=<folder-URL>
Left sync folder URL, look it up in Account Manager.
/u2=<folder-URL>
Right sync folder URL, look it up in Account Manager.
/k1=<Account-Key>
Left sync folder Account Key, look up Account by it. Requires /u1.
/k2=<Account-Key>
Right sync folder Account Key, look up Account by it. Requires /u2.
/n1=<Account-Name>
Left sync folder Account Name, look up Account by it. Requires /u1.
/n2=<Account-Name>
Left sync folder Account Name, look up Account by it. Requires /u2.
/userid1=<user-id>
UserID for left sync folder.
/userid2=<user-id>
UserID for right sync folder.
/password1=<password>
Password for left sync folder, clear text.
/password2=<password>
Password for right sync folder, clear text.
/pwd-encr-1=<password>
Password for left sync folder, pre-encrypted.
/pwd-encr-2=<password>
Password for right sync folder, pre-encrypted.
/fat-like1(2)=yes|no
This should be treated as a FAT file system, with 1-hour seasonal time shift, even though it does not report itself to be FAT. May be needed for NAS devices that misreport their FAT disks as NTFS.
/compress1(2)=yes|no
Compress files in the left (right) sync folder using NTFS compressed files.
/uncompress1(2)=yes|no
Uncompress files in the left (right) sync folder, if they were compressed by NTFS.
/bad-certs1(2)=yes|no
Do not check SSL server certificates for left (right) folder.
/useproxy1(2)=yes|no
Use proxy to connect to the left (right) folder.
/wininet(2)=yes|no
Use WinInet implementation of the file system in the left (right) for DAV, S3, FTP.
/utf8-1(2)=yes|no
UTF-8 encoding (No: ANSI) for left (right) folder.
/hostbased1(2)=yes|no
Use host-based addressing (S3).
/reduced-redundancy1(2)=yes|no
Use reduced redundancy bucket (S3).
/server-encrypt1(2)=yes|no
Use server side encryption (S3).
/accesspolicy1(2)==<access-policy>
Pre-cooked access policy for left (right) folder (S3).
/show-native1(2)=yes|no
Show native Google Docs/Drive files, by converting them to external format. This makes Analyze and Sync run very slow, as even Analyze of a native file requires to convert it. (GDocs)
/active1(2)=yes|no
Active FTP mode (No: passive) for left (right) folder.
/mdtm1(2)=yes|no
Use MDTM command for left (right) FTP folder.
/mlsd1(2)=yes|no
Use MLSD command for left (right) FTP folder.
/implicit1(2)=yes|no
Implicit FTPS mode (No: Explicit mode) for the left (right) folder.
/pk1(2)=<folder-path>
SFTP private key file absolute path, for left (right) sync folder.
WebDAV/GSTP private certificate file absolute path, for left (right) sync folder.
General Options
/dir=2way | ltor | rtol
Job direction: 2-way, Left to Right (ltor), or Right to Left (rtol).
/deletions=yes|no
Propagate Deletions option.
/balloon-msg=none|errors|changes
Show Balloon option.
/create-if-not-found=yes|no
Create job sync folder(s) if not found. Default: no.
/save-prev-version=yes|no
Saved files overwritten or deleted by GoodSync to _gsdata_\_saved_ folder.
Only one last version of the file is saved.
/cleanup-prev-version=yes|no
Whether to cleanup Previous File Version.
/days-prev-version=<number>
Number of days for which to keep Previous File Version.
/save-past-versions=yes|no
Saved past versions of file overwritten or deleted by GoodSync to _gsdata_\_history_ folder.
Many file versions are saved, one per every overwrite or delete of the file.
/cleanup-past-versions=yes|no
Whether to cleanup Past File Versions.
/days-past-versions=<number>
Number of days for which to keep Past File Versions.
/cleanup-old-generations=yes|no
Whether to cleanup old generations of files and folders.
/months-old-generations=<number>
Number of months for which to keep old generations.
/reconnect-secs=<number>
Number of seconds for Reconnect Attempts.
/run-parallel-threads=yes|no
Run parallel worker threads when doing Sync.
/worker-threads=<N>
Number of worker thread to execute in parallel on Sync.
/speed-limit=<number>
File Copy Speed Limit in Kb/sec.
Filter Options
/exclude=<file-mask>
Exclude filter.
File Mask is a |-separated list of patterns such as *.obj or \folder\file.
Several /exclude options may be provided, their values will be glued together, separated by '|'.
/include=<file-mask>
Include filter.
File Mask is a |-separated list of patterns such as *.obj or \folder\file.
Several /exclude options may be provided, their values will be glued together, separated by '|'.
/exclude-empty=yes|no
Exclude Empty Folder option.
/exclude-hidden=yes|no
Exclude Hidden Files and Folders option.
/exclude-system=yes|no
Exclude System Files and Folders option.
Auto Options
/on-start=analyze|sync|no
Automatically Analyze/Sync on Start of GoodSync.
/autostart-delay=NN
On Start delay in seconds.
/on-folder-connect=analyze|sync|no
Automatically Analyze/Sync on Folder Connect.
/on-file-change=analyze|sync|no
Automatically Analyze/Sync on any File Change inside local sync folders.
/on-schedule=analyze|sync|no
Automatically Sync on Schedule.
/schedule-min=list-of-number-ranges (0 to 59)
Minutes on which to run in /on-schedule.
/schedule-hour=list-of-number-ranges (0 to 23)
Hours on which to run in /on-schedule.
/schedule-day=list-of-number-ranges (1 to 31)
Days Of Month on which to run in /on-schedule.
/schedule-month=list-of-number-ranges (1 to 12)
Months on which to run in /on-schedule.
/schedule-dow=list-of-number-ranges (0=Sun to 6=Sat)
Days Of Week on which to run in /on-schedule.
/on-logout=sync|no
Automatically Sync on Logoff from Windows account.
/on-timer=analyze|sync|no
Automatically Analyze/Sync on Timer (every N minutes).
/timer-period=<NN>
Timer period in minutes for /on-timer option.
/auto-unattended=yes|no
Run Job Without User Interface (Unattended).
/limit-changes=<NN>
No Sync If Too Many Files Changed option.
NN is a number from 0 to 100.
/autoresolve=no|left|right|newer
Auto-Resolve Conflicts option: No Copy, Left wins, Right wins, Newer wins.
/rename-losing-file=yes|no
Rename losing file in the conflict, instead of deleting it.
/wait-for-locks=yes|no
Wait for Locks, instead of producing error.
/wait-for-locks-minutes=<NN>
Waiting period for Wait for Locks, in minutes.
/autoclear=yes|no
Auto Clear tree after Sync.
Script Options
/pre-analyze-action=<email-addr|program-path>
Pre Analyze Program.
/post-analyze-action=<email-addr|program-path>
Post Analyze Email or Program.
/post-sync-action=<email-addr|program-path>
Post Sync Email or Program.
Advanced Options Sync Time
/copy-create-time=yes|no
Copy File/Folder creation time.
/copy-attrs=yes|no
Copy Attributes (a la rwx).
/copy-owner=yes|no
Copy File Owner: not needed if Copy ACL is On.
/copy-acl=yes|no
Copy ACL security attributes.
/copy-ext-attrs=yes|no
Copy Extended Attributes (MAC only).
/move-mode=yes|no
Move Mode: Delete Source Files after Copy.
/delete-empty-folders-on-move=yes|no
Move Mode: Delete Empty Source Folders after Copy.
/copy-locked=yes|no
Copy Locked Files using Shadow Copy Service.
/uber-unlocked=yes|no
Uber-unlocked mode for files being read.
/retry-sync-if-file-changes=yes|no
Retry file sync if source file changes during Sync.
Advanced Options Analyze Time
/compare-md5=yes|no
Compare MD5 checksums in Analyze, for all files.
/detect-moves=yes|no
Detect File and Folder Moves and Renames, instead of doing Copy + Delete.
/est-req-space=yes|no
Estimate Required Free Space needed for Sync.
/links=ignore|copy-asis|drill-down
Folder symbolic links processing mode.
/conflict-on-diff-item-no-common-history=yes|no
Produce Conflict when GS encounters different files not seen before.
Side Options
/compare-checksums1(2)=yes|no
Compare Checksums of files on this side.
/compare-attrs1(2)=yes|no
Compare Attributes (Permissions) of files/folders on this side.
/compare-owner1(2)=yes|no
Compare Owner of files/folders on this side.
/compare-acl1(2)=yes|no
Compare ACL of files/folders on this side.
/compare-ext-attrs1(2)=yes|no
Compare Extended Attributes of files/folders on this side.
/no-gsdata1(2)=yes|no
No _GSDATA_ folder on this side.
/no-list-dir1(2)=yes|no
No ListDir, trust state file on this side.
/temp-dest-file1(2)=yes|no
Use / Not Use temp files when uploading file to this side.
/encrypt-files1(2)=yes|no
Encrypt file bodies on this side.
/encrypt-paths1(2)=yes|no
Encrypt file paths on this side.
/encrypt-password1(2)=string
Encryption password for file paths / bodies.