Dirsync Pro Manual: ©2008-2016, O. Givi
Dirsync Pro Manual: ©2008-2016, O. Givi
Manual v. 1.52
1.2 License
DirSyncPro is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, either version
3 of the License, or (at your option) any later version. The file GPL.txt which is provided
along with DirSync Pro, contains a copy of the GNU General Public License. If you could
not find this file, see http://www.gnu.org/licenses/.
The icons used in DirSync Pro are from the Kommon Desktop Environment KDE
(www.kde.org) released under the GPL.
3 User Interface
Synchronize can be configured via a GUI. You can use the GUI to execute a
synchronization, or you can use the GUI to create a jobset file and run the synchronization
in console mode.
1. The Sync Queue tab: shows the synchronization queue. You'll see here all the
files which are going to be synchronized.
2. The Summary tab: shows some statistics about the synchronization:
number/size of Analyzed files/directories, number/size of files/directories to be
synchronized, number/size of New files/directories, number/size of Modified
files, number/size of Larger files, number/size of files which are Larger and
modified and number/size of files/directories to be deleted.
3. The statistics of the current synchronization.
4. The number of Analyzed files/directories.
5. The number of files/directories To be Synchronized.
6. The number of files/directories To be copied Always.
7. The number of New files/directories.
8. The number of Modified files/directories.
9. The number of Larger files.
10. The number of Larger AND modified files.
1. The View tab: allows filtering the view of the synchronization. This filter does not
affect the synchronization queue. It only affects files/directories currently being
shown.
2. Show New files/dirs.
3. Show Modified files.
4. Show Larger files.
5. Show Larger & Modified files.
6. Show Files to be deleted.
1. The Filter tab: allows filtering the synchronization queue. This helps you to make a
selection of files to be synchronized. This filter does affect the synchronization
queue. Only the files that remain in the queue are synchronized during the
synchronization process.
2. Show New files/dirs.
3. Show Modified files.
4. Show Larger files.
5. Show Larger & Modified files.
6. Show Files to be deleted.
7. Show Dirs to be deleted.
8. Reset the view filters.
9. Show Conflict items
If you right mouse click an entry in the synchronization queue, a context menu appears in
which you always may:
1. Remove this entry from the synchronization queue (not from the file system). This
means that the corresponding file pair will not be synchronized.
2. Remove all of this mode from the synchronization queue, which means all the
entry of which the synchronization mode is the same as the selected entry, will be
removed from the synchronization queue (not from the file system) and so will not
be synchronized.
3. Remove all selected from the synchronization queue, which means all selected
(highlighted) entries will be removed from the synchronization queue (not from the
file system) and so will not be synchronized. In the synchronization queue you may
select multiple entries using the CTRL and/or SHIFT key in combination with left
mouse click.
Additionally, depending on which column you right click, some other options will appear.
If you right click on the name of a folder or a file, you may:
4. Open the file/directory in the system file explorer. If the file is associated with an
application, the file is then opened in the regarding application.
5. Open the parent folder of a file in the system file explorer.
If you right click on the name/date/size of a file/directory, youll get a submenu:
14. Add Exclude Filter with which you may quickly add a context-aware filter. The filter
dialog will then open automatically in which you may fine-tune the filter.
This context-aware filter holds various options based on the data of the selected
file/directory. If you right click the name of a file/directory, you may:
7. Add a Pattern filter based on the name of the file/directory. After the filter dialog has
appeared, you may fine-tune the pattern manually.
synchronization process.
2. Allows filtering the Info messages.
3. Allows filtering the Warning messages.
4. Allows filtering the Error messages.
5. Allows filtering the File operations.
6. Reset the view filters.
7. Apply (OK) the filters.
8. Clean the Messages list.
Important note: Some tabs get only available only in a custom synchronization mode.
2. Compare file sizes and modification dates. With this option, the file gets copied:
1. when the file in Dir A is modified later than the file in Dir B (in case of
New/Modified copy options), or:
2. when the file is Dir A is larger than the file in Dir B (in case of Larger copy
option).
3. Compare file sizes, modification dates and meta data (attributes, permissions,
ownerships): With this option, the conditions from the previous option apply, plus
that the file meta data is taken into account. The file will get copied if the
modification data is changed (New/Modified copy option), file size is larger (Larger
copy option) or attributes/POSIX permissions/POSIX ownerships are changed.
4. Compare file contents: with this option, the file contents will be compared byte by
byte if the file sizes are the same. If file sizes differ, a sync conflict will occur.
Please note that comparing file contents is a very time consuming task.
5. Context Information about this tab.
2. Copies All files and directories. If a file already exists in the destination directory it
will always be overwritten with that one from the source directory. If you specify this
option, all other copy options will be ignored.
3. Copies only New (not existing in destination directory) files and directories. Files
that exist in the source directory but not in the destination directory will be copied to
the destination directory.
4. Copies only Larger files and directories. If there already is a file with the same
name in the destination directory, it will only be overwritten with the file from the
source directory if its size is smaller than the size of the original file in the source
directory.
5. Copies only Modified files and directories. If there already is a file with the same
name in the destination directory, it will only be overwritten with the file from the
source directory if its modified-date is older than the modified-date of the original file
in the source directory.
6. Copies only Larger AND Modified files and directories. If there already is a file with
the same name in the destination directory, it will only be overwritten with the file
from the source directory if its size is smaller and its modified-date is older than the
size and date of the original file in the source directory. If you specify the option
'Copy larger' or 'Copy modified', this option will be ignored (you already copied this
files).
7. Context Information about this tab.
1. The Conflict Resolution tab: shows options when conflicts happens while using a
mono-directional or bi-directional synchronization. You may set these options only if
the Sync Mode is set to bi-directional or a custom mode.
2. Mono-directional conflict resolution tab.
1. Mono-directional sync conflict resolution through Overwriting the file in
destination with the file from the source: when synchronizing from mono-
directional in a custom mode, if the file in destination is modified later (file is newer),
the file from the source is copied over the file in destination; the file in destination
will be overwritten.
2. No Mono-directional sync conflict resolution Do nothing. Just warn me: when
synchronizing from mono-directional in a custom mode, if the file in destination is
modified later (file is newer), nothing will be copied. Instead the user gets a warning
and could fix the conflict manually.
3. No Mono-directional sync conflict resolution Do nothing. Just skip silently: when
synchronizing from mono-directional in a custom mode, if the file in destination is
modified later (file is newer), the file will be skipped silently.
1. The Conflict Resolution tab: shows options when conflicts happens while using a
mono-directional or bi-directional synchronization. You may set these options only if
the Sync Mode is set to bi-directional or a custom mode.
2. Bi-directional conflict resolution tab.
3. Bidirectional sync conflict resolution through Copying the latest modified file to
both directories: when synchronizing bidirectionally, if two files are modified in
both directories individually, the latest modified file will be copied to both directories.
4. Bidirectional sync conflict resolution through copying the largest file to both
directories: when synchronizing bidirectionally, if two files are modified in both
directories individually, the largest file will be copied to both directories.
5. Bidirectional sync conflict resolution through renaming copying both files to both
directories: when synchronizing bidirectionally, if two files are modified in both
directories individually, they are postfixed (renamed with added extensions .DirA
and .DirB) and they both will be copied to both directories.
6. No Bidirectional sync conflict resolution Do nothing. Just warn me: when
synchronizing bidirectionally, if two files are modified in both directories individually,
none of the files are copied. Instead the user gets a warning and could fix the
conflict manually.
7. No Bi-directional sync conflict resolution Do nothing. Just skip silently: when
synchronizing bidirectionally, if two files are modified in both directories individually,
the files will be skipped silently.
8. Context Information about this tab.
1. The Basics tab to define the the type of the filter and whether to include/exclude
items.
2. Select here whether to Include or Exclude the matched files or directories.
3. Include the matched files or directories.
4. Exclude the matched files or directories.
5. Select here the Filter type. One of the tabs By Pattern and By Size will get enabled
according to the selected filter type.
6. Filter based on File/dir pattern. This filter affects files and directories of which the
name matches a text pattern.
7. Filter based on File Size. This filter affects files of which the size satisfy some
conditions.
8. Filter based on File Date. This filter affects files of which the modification date
satisfy some conditions.
1. The By File Attribute tab to define filters based on DOS attributes of the file.
2. Match files with the Read only.
3. Match files with the Hidden attribute.
4. Match files with the System attribute.
5. Match files with the Archive attribute.
6. Context Information about this tab.
1. The By File Ownership tab to define filters based on Posix ownerships of the
file/directory.
2. Match files/directories with the specified Owner.
3. Match files/directories with the specified Group.
4. Context Information about this tab.
1. The By File Ownership tab to define filters based on Posix permissions of the
file/directory.
2. Match files/directories with the specified bit-wise permissions. Once you edit these
check-boxes, the Numeric value will be calculated and updated automatically in the
corresponding field.
3. Match files/directories with the specified Numeric permission. Once you edit this
value, the bit-wise permissions will be calculated and updated automatically in the
corresponding check-boxes.
4. Context Information about this tab.
1. The Deletion tab to define the deletion behavior after the synchronization. You may
redefine these options if the Sync Mode is set to custom.
2. Delete files not existing in the source directory from the destination directory. Files
that have been deleted in the source directory, but still exist in the destination
directory will be deleted in the destination directory.
3. Delete directories not existing in the source directory from the destination
directory. Directories that have been deleted in the source directory, but still exist in
the destination directory will be deleted in the destination directory.
4. Delete Excluded Files from Dir A. When this option is selected all files which
match the Excluded Files pattern will be cleaned up (deleted) from Dir A.
5. Delete Excluded Directories from Dir A. When this option is selected all files
which match the Excluded Directories pattern will be cleaned up (deleted) from Dir
A.
6. Delete Excluded Files from Dir B. When this option is selected all files which
match the Excluded Files pattern will be cleaned up (deleted) from Dir A.
7. Delete Excluded Directories from Dir B. When this option is selected all files
which match the Excluded Directories pattern will be cleaned up (deleted) from Dir
A.
8. Context Information about this tab.
1. The Log tab to define the logging behavior after the synchronization.
2. Enable or disable separate logging for this job.
3. The Logfile. Normally the name of the job (label) is used to create the initial
filename for the log. You may also specify a custom filename. New log entries are
appended to the existing logfiles and hence they will not be overwritten.
You can specify here the following (case sensitive) wildcards:
<date> for the current date, and
<DD> for the current day,
<MM> for the current month,
<YYYY> for the current year.
<time> for the current time, and
<hh> for the current hour,
<mm> for the current minute,
<ss> for the current second.
<username> for the name of the current user, and
<userhome> for the home directory of the current user.
4. Browse for the logfile or directory.
5. Context Information about this tab.
1. The Schedules tab to define schedules for this job. Schedules cause this job to
1.The Basics tab to define the the type of the schedule and some general settings.
2.Select here the Schedule type. There are 6 types are schedules available.
3.Once: This schedule runs only once on a certain date/time.
4.Minutely: This schedule runs recurrently every X minutes.
5.Hourly: This schedule runs recurrently every X hours.
6.Daily: This schedule runs recurrently on a certain time daily.
7.Weekly: This schedule runs recurrently on a certain time and in specific months
every X weeks.
8.Monthly: This schedule runs recurrently every month on day number X, on a
certain time and in specific months.
9.Define here if the task should run only during a time frame (From To).
10. Enable Time frame From constraint.
11. Time frame From date value. If defined, the task will run only if its next event
date is after this date.
1. The Schedule Once tab in which you may define a task which runs once on a
certain time. If a Once schedule is not run, e.g. because other tasks are running all
the time, it will be queued for execution and will run later again. A Once schedule
which is older than 24 hours, will not run anymore.
2. The Time on which this schedule will run.
3. Context Information about this tab.
1. The Schedule Minutely tab in which you may define a task which runs recurrently
every X minutes. The first occurrence will get scheduled for 'now'.
2. The interval in minutes.
3. Context Information about this tab.
1. The Schedule Hourly tab in which you may define a task which runs recurrently
every X hours. The first occurrence will get scheduled for the next complete hours
(01:00, 02:00, 03:00, ).
2. The interval in hours.
3. Context Information about this tab.
1. The Schedule Daily tab in which you may define a task which runs recurrently
every X days on a certain time.
2. The interval in days.
3. The time of the day on which this task should run.
4. Context Information about this tab.
1. The Schedule Weekly tab in which you may define a task which runs recurrently
every X weeks on a certain time and on specific weekdays.
2. The interval in weeks.
3. The time of the day on which this task should run.
4. Checkboxes to select on which weekdays this schedule task should run.
5. Context Information about this tab.
1. The Schedule Monthly tab in which you may define a task which runs recurrently
every month on day number X, on a certain time and in specific months.
2. The Xth day of the month.
3. The time of the day on which this task should run.
4. Checkboxes to select on which months this schedule task should run.
5. Context Information about this tab.
On Windows:
dirsyncpro /sync /quit <jobset file>
On Windows:
dirsyncpro /nogui <jobset file>
[AutoRun]
ACTION=Backup
Open=java -jar dirsyncpro\dirsyncpro.jar JobsetFile.dsc
And in case you want it to quit right away after the synchronization:
[AutoRun]
ACTION=Backup
Open=java -jar dirsyncpro\dirsyncpro.jar JobsetFile.dsc /sync
/quit