The Comprehensive Guide to Using Syncless
Table of Contents i.......preface 1. Welcome to Syncless... 1 1.1. Why Use Syncless?... 2 1.1.1. N-way Synchronization... 2 1.1.2. Seamless Synchronization... 2 1.1.3. Filtering... 3 1.1.4. Archiving... 3 1.1.5. Time Synchronization... 3 1.1.6. Portability... 4 1.2. What is a Tag?... 6 1.3. What You'll Need... 6 1.4. What Is Recommended... 6 1.5. The Syncless Interface... 6 2. Getting Started... 8 2.1. Understand the Syncless Interface... 8 2.1.1. Window Toolbar... 8 2.1.2. Main Toolbar... 8 2.1.3. Tag Info Panel... 9 2.2. How to Tag and Synchronize?... 9 2.2.1. Tag Folders... 9 2.2.2. View tag information... 13 2.2.3. Synchronize the folders... 14 2.2.4. Switch to Seamless Mode... 15 2.2.5. Unmonitor Removable Drive to Prepare for Removal... 16
2.2.6. Create a Filter... 16 3. Continue to Explore Syncless... 18 3.1. How to Configure Syncless?... 18 3.1.1. General and User Interface Settings... 19 3.1.2. Archiving Settings... 21 3.2. How is Syncless User-friendly?... 22 3.2.1. Preview Synchronization Results... 22 3.2.2. Viewing Logs... 24 3.2.3. Tag Name Auto Completion... 25 3.2.4. Filter Tag List... 26 3.2.5. Keyboard Shortcuts... 27 3.2.6. Accessing Syncless Through Tray... 28 3.2.7. Accessing Tags Through Right-clicking... 28 3.2.8. Accessing Tagged Folders Through Right-clicking... 29 3.2.9. Tray Notification... 30 4. Known Issues... 31 4.1. General... 31 4.1.1. Errors Accessing Some Hard Disks... 31 4.1.2. Exception Thrown At Program Start Up... 31 4.1.3. Cannot Sync File With Very Long Name... 31 4.1.4. Unable To Handle Disk With Not Enough Space... 32 4.2. Tagging... 32 4.2.1. Recursive Tagging... 32 4.3. CompareAndSync... 32 4.3.1. Finalizing Can Be Optimized... 32
4.4. Monitor... 32 4.4.1. Drive Plugin May Not Be Detected... 32 4.4.2. Removable Drive... 33 4.4.3. Seamless Synchronization Limitation... 33 4.5. User Interface... 33 4.5.1. Progress Bar Remains On Screen After Tags Are Removed... 33 4.5.2. Changes Made After Every Sync Not Shown... 33 4.5.3. Datagrid Rendering Issue... 33 4.5.4. No Notification When Cancelling/Switching To Seamless Mode... 34 5. Ending Note... 34
Preface This user's guide provides a detailed insight into the functionality available in Syncless. If you wish to have a quick overview of the basic functions provided in Syncless, you can refer to the Getting Started section here. i
1. Welcome to Syncless Synchronization is taken on a whole new level with Syncless. This user's guide familiarizes you with the basic features in Syncless and introduces you to the concepts of tagging and n-way seamless synchronization in Syncless. Syncless allows you to synchronize your files and folders automatically through the use of tags, even across removable drives. With Syncless, you can quickly tag multiple folders and configure them to be either in seamless or manual synchronization mode. Syncless is designed to have the finest usability that caters to each individual's workflow. Lastly, Syncless is a portable application, so it will run off any removable drive with no installation required. 1
1.1. Why Use Syncless? Why choose Syncless over other synchronization tools? The reason is simple. Syncless provides many powerful features which are rarely found in one single synchronization tool in the market. N-way Synchronization: Why restrict yourself to just syncing two folders? Let Syncless perform n-way synchronization between multiple folders for you. Seamless Synchronization: Any changes in the tagged folders can be detected and synchronized without any human intervention. Filtering: Use Syncless's filtering features for the ultimate control in synchronization. Currently, Syncless is able to include or exclude files and folders by extension and path. Archiving: Syncless archives files and folders which have been removed. Every file and folder can either be sent to the Recycle Bin or archived up to 10 copies. Time Synchronization: Syncless can automatically keep your computer clock in sync with an internet time server to ensure accurate synchronisation. Portability: Be the ultimate on-the-go warrior and carry Syncless on your removable drive instead of leaving it on your computer. 1.1.1. N-way Synchronization The traditional way to keep a few folders in sync is to create multiple jobs because many tools provide synchronization between 2 folders only. Syncless is capable of synchronizing multiple folders without you having to create multiple jobs. Simply tag multiple folders with the same tag name and Syncless will keep them all in sync. 1.1.2. Seamless Synchronization Seamless synchronization allows folders that are tagged to be synchronized automatically if there are changes to the files within the folders. You can just leave the program running while attending to other tasks at hand. At the end of the day, you will find that all your folders are in sync! 2
1.1.3. Filtering Syncless currently provides basic filtering capabilities for files. There are 2 main kinds of filters, inclusion and exclusion filters. Exclusion filters will always have a higher priority over inclusion filters. In this user guide, we are going to take a look at how you can construct filters to suit your needs. 1.1.4. Archiving With the archiving feature, you do not need to worry about losing an important file if you accidentally delete it and the change is propagated to other folders in the same tag. Syncless will either send the deleted file to the Recycle Bin, or keep up to 10 copies of the deleted file in an archive folder, depending on your preference. This archive folder will be created in all the other folders in the same tag. Note that the file itself will not be archived in the folder where the file deletion is initiated by the user. To illustrate, let's say you tagged D:\Lecture and E:\Notes to a tag named "Lecture", both containing the file Chapter1.pdf. You accidentally deleted Chapter1.pdf under D:\Lecture. Syncless will keep a copy of Chapter1.pdf in the archive folder under E:\Notes. If you need to restore that file, simply copy the archived file back to D:\Lecture. 1.1.5. Time Synchronization Files may be out-of-sync if the system clocks are not consistent across multiple computers. Why worry that your most updated file will be overwritten because the system clock is earlier than the actual time? Simply allow Syncless to synchronize your system clock with the Internet Time 3
Server and you can be rest assured that the file will remain as the most updated version across all your computers. 1.1.6. Portability Syncless can run from a removable drive such as a thumbdrive. If you frequently use your removable storage drive for the purpose of synchronizing files and folders on various computers, Syncless can automate this job for you. For example, a student has a home computer, as well as a regular workstation in his school lab. He wishes to keep his school work synchronized across both computers. By tagging his school work folders on both his home computer and school workstation with the same tag, say "Lectures", Syncless will auto-detect and synchronize each time the removable storage drive is inserted. See the diagrams below for a clearer illustration: 4
5
1.2. What is a Tag? The concept of tagging is not uncommon today. In Syncless' context, it is simply an identity or a label associated with folders you want to keep in sync. Associate several folders to the same tag name and Syncless will keep them all in sync for you. It is as simple as that. You simply tag the folders you want to keep in sync and Syncless will handle everything else. We will discuss the various ways of tagging folders in the subsequent section of this tutorial. 1.3. What You'll Need Before continuing, make sure you have the following: Windows Operating System (XP and above).net 3.5 SP1 Framework (Get it from http://msdn.microsoft.com/enus/netframework/cc378097.aspx) To download Syncless, please visit http://code.google.com/p/big5sync/downloads/list to get the latest version (ver 2.0) of Syncless. After that, unzip the package to a location of your choice and run SynclessUI.exe. Absolutely no installation of Syncless is required. 1.4. What Is Recommended Internet access is needed to use the Time Synchronization Feature. However, it is not needed to run the program. 1.5. The Syncless Interface When you run Syncless, you will be greeted with the main window, which allows you to choose what you want to do next, such as creating a tag, tagging a folder or viewing tag details. The interface also incorporates a lot of useful shortcuts to speed up productivity. 6
7
2. Getting Started 2.1. Understand the Syncless Interface Before you continue, you may want to find out what each button in Syncless does. 2.1.1. Window Toolbar : Displays the list of shortcut keys in Syncless : Configure Syncless settings : Minimize Syncless main window : Exit Syncless 2.1.2. Main Toolbar : Create a tag : Remove a tag : Tag a folder : Untag a folder : View tag properties : View log : Unmonitor removable drives : Synchronize computer time 8
2.1.3. Tag Info Panel : Indicates that the current synchronization is in manual mode, click to switch to seamless mode : Indicates that the current synchronization is in seamless mode, click to switch to manual mode : Indicates that the selected tag is switching from manual mode to seamless mode : Preview synchronization result, only available in manual mode : Start synchronization for currently selected tag, only available in manual mode : Cancel synchronization, only available during analyzing or queued stage in manual mode : Preparing to cancel synchronization 2.2. How to Tag and Synchronize? You have folders on your computer and removable drives that you wish to synchronize automatically. Let us get started on using Syncless! 2.2.1. Tag Folders To synchronize 2 or more folders, you must first tag them with the same name. This tagging process can be initiated in multiple ways. 9
Tagging from Syncless Tag a folder through the button (You can also use the keyboard shortcut equivalent Ctrl-T.) 10
Drag-and-Drop folder(s) into the Main Window 11
Tag Directly from Windows Explorer 12
2.2.2. View tag information After tagging the folders, you may view the details under the tag information panel through the button. You will see a list of folder paths associated with the selected tag. On the right of the folder path list, there are a few options for synchronization. During synchronization, the progress bar will show the percentage of completion and status of the synchronization. 13
2.2.3. Synchronize the folders After you have tagged the required folders, click on the button. Syncless will take care of the rest and keep the folders in sync. 14
2.2.4. Switch to Seamless Mode Switching to seamless mode is a simple matter of pressing the button. After clicking the synchronization mode button, Syncless will automatically perform an initial synchronization. At the moment, button is shown to indicate that switching is in progress. After which, it will monitor any changes in the tagged folders and keep them in sync without you having to do it manually. 15
2.2.5. Unmonitor Removable Drive to Prepare for Removal You can access this through the button or by using its keyboard shortcut equivalent (Ctrl-I). Syncless cares about the safety of your removable drives. Unmonitoring will stop all monitoring actions on any folders that are currently in seamless mode, thus allowing the removable drive to be safely removed. 2.2.6. Create a Filter Click the button in the toolbar to open up the tag properties panel. Inside the properties panel, choose the Filtering property. You should see a list of filters and it will likely be blank since no filters have been added yet. 16
Now, click on the button to add a new filter. You can now set the "Ext. Mask" and the "Mode". 17
Construct a Filter Ext. mask can be an actual filename, or simply a name with wildcards. Some examples are "Storyboard.ppt", "*.exe" or "File?.txt". * - Wildcard for any number of characters. For example, s*t could mean sit, sat, shoot, skit, etc.? Wildcard for exactly one character. For example, s?t could mean sit, sat, etc. Mode can be set to exclusion or inclusion mode. If a filter is set to exclusion mode, then all files that match the ext. mask will be excluded. On the contrary, if a filter is set to inclusion mode, then all files matching the ext. mask will be included. Now, let us look at some real-world examples. For example, if you want to include all Powerpoint files, but exclude a particular one, say "Introduction.ppt", you will create 2 filters: 1. Ext. Mask: *.ppt, Mode: Inclusion 2. Ext. Mask: Introduction.ppt, Mode: Exclusion As seen from the above, creating a filter is a simple and intuitive task in Syncless. 3. Continue to Explore Syncless 3.1. How to Configure Syncless? You can personalize Syncless through the button. After which, you will see a window with two settings to choose from, General and User Interface Settings and Archiving Settings. 18
3.1.1. General and User Interface Settings 19
Options enabled by default are prefixed with * *Show Welcome Screen on Application Start Syncless has an informative welcome screen which highlights the unique features of Syncless. Each feature has a link to the Syncless online User s Guide where each feature is explained in more details. You can choose to show the welcome screen on startup by checking the option. *Enable Shell Integration Syncless makes tagging easy for you by integrating directly into Windows Explorer. You can simply right-click on any folder you wish to tag. In the case where you rather not have this function, you can uncheck the option. *Enable Window Animation on Application Start/Exit Syncless's main window will animate upon start up or exit. You may choose to disable the function by unchecking the option. *Enable Tray Notifications Syncless notifies you through tray notification upon initialization/completion of synchronization. Enable/disable the function by checking/unchecking the option. *Enable Notification Sounds Syncless not only notifies you of synchronization initialization/completion through tray notification. It also plays notification sounds to notify you when you are not viewing the screen. Enable the function by checking the option. *When Minimizing, Minimize to Tray Syncless can minimize to tray so that your task bar will be kept as clean as possible. However, if you wish to access Syncless more quickly through the task bar, you can disable the function by unchecking the option. 20
Attempt to Synchronize Computer Clock On Application Startup Worried that your files are out-of-sync because the system clocks are not consistent across your computers? Syncless provides the option of synchronizing your system clock with the Internet Time Server on startup so that the system clock is always consistent. Enable time synchronization by checking the option. Note that Administrative Rights is required to synchronize your system clock. 3.1.2. Archiving Settings Syncless makes synchronization even safer by providing archiving option. Just in case you accidentally delete a file and perform synchronization on this file, you can still retrieve it from either the Recycle Bin or the Syncless' archive folder. 21
Options enabled by default are prefixed with * Send to Recycle Bin To send deleted files to Recycle Bin, simply check the option. Uncheck the option if you do not wish to send any file to Recycle Bin. Move Last N Changes to _synclessarchive To move deleted files to Syncless' archive folder (_synclessarchive), simply check the option. You can select up to 10 archive files to keep by moving the track bar. Uncheck the option if you do not wish to move any file to Syncless' archive folder. 3.2. How is Syncless User-friendly? Syncless makes your user experience as pleasant as possible by providing several user-friendly functionalities. 3.2.1. Preview Synchronization Results Want to know what changes will be made to your files and folders before committing the changes? Syncless allows you to preview the synchronization result so that you can confirm the changes you want to make, just in case an unintended operation is performed on your files and folders. Access the preview result window through the button. Each operation is explained by the arrow legend as shown below: 22
23
3.2.2. Viewing Logs You do not have to remember the changes you have made to your folders and files. Syncless keeps a log of the changes in your folders and files and lets you view them easily. Access the event log through the button. You can filter out log messages by checking/unchecking the following options. 24
3.2.3. Tag Name Auto Completion Do you have a tag with a long name? Syncless understands the inconvenience you experience when trying to tag folders to a tag with a long name. As such, Syncless provides an autocompletion function when you type in a tag name. Simply type in part of the tag name and Syncless will display the full name for you. 25
3.2.4. Filter Tag List Do you have many tags to maintain and have difficulty finding that exact tag from the long list? Syncless supports filtering of tags so that you can search for the tag you want by just entering the tag name. Let us say you have many tags in the tag list. You want to filter out only tags related to your photo folders. Simply enter the word 'Photos' in the text box and only tag names containing 'Photos' will be displayed. 26
3.2.5. Keyboard Shortcuts Syncless helps you to save time and increase productivity by providing keyboard shortcuts to the many commonly used operations. Below is the list of keyboard shortcuts provided by Syncless. If you forget the shortcut keys, simply go to at the window toolbar and view the list again. 27
3.2.6. Accessing Syncless Through Tray If you have chosen the option to minimize Syncless to tray, you can still access the application easily through tray options. Simply go to the tray, right-click on the Syncless icon and select the operation you wish to perform. You can modify application settings, tag a folder, unmonitor a drive or exit Syncless. 3.2.7. Accessing Tags Through Right-clicking If you prefer right-clicking than clicking buttons, Syncless provides you the option to access your tags through context menu. 28
Simply right-click on the tag under the tag list and you can choose to tag more folders, view tag properties or remove the tag. 3.2.8. Accessing Tagged Folders Through Right-clicking Suppose you have many folders tagged with the same tag. When you want to view the folders in Windows Explorer, you will most probably have to go through Start Menu -> My Computer -> D: -> Your folders many times to open up the various folders. Why go through the hassle when you can simply open up the folders in Syncless? Simply right-click on the tagged path in the tag info panel and choose to Open in Windows Explorer or just double-click on it. The folder will immediately be opened in Explorer Window. 29
3.2.9. Tray Notification Syncless allows you to perform other tasks as well when you synchronize large amount of files. You will still be kept updated of the synchronization status even when you are not viewing the Syncless main window. Whenever a synchronization task is initiated or completed, Syncless will notify you through tray notifications. 30
4. Known Issues These are the current known issues with Syncless V2.0 and will be handled at a later version. For a list of how Syncless handles certain unique sequence of actions, please visit http://code.google.com/p/big5sync/wiki/specialcases. Note: As much as we try to keep this page updated, please take a look at the project s issue tracker at http://code.google.com/p/big5sync/issues/list before reporting any bugs. Thank you. 4.1. General 4.1.1. Errors Accessing Some Hard Disks There might be errors accessing some hard disks. See Issue 40 for more information. 4.1.2. Exception Thrown At Program Start Up Sometimes unhandled exception is thrown at program start up. We are still looking into it. Refer to Issue 185. 4.1.3. Cannot Sync File With Very Long Name As of version 2.0, the file/folder with PathTooLongException will simply not be synced. No error will be thrown. Will try to implement a notification to inform user of such error in future releases. The user may view the logs to see what is happening. Refer to Issue 8. 31
4.1.4. Unable To Handle Disk With Not Enough Space As of version 2.0, when a disk runs out of space, synchronizing will complete the synchronization, without hanging or crashing. The user may view the logs to see what is happening. Refer to Issue 8. 4.2. Tagging 4.2.1. Recursive Tagging If Folder A is tagged with Folder D and Folder B is tagged with Folder C, a recursion will occur and folders will be created in them until they hit the maximum file path length. Refer to Issue 6. 4.3. CompareAndSync 4.3.1. Finalizing Can Be Optimized Finalizing can be optimized further. Refer to Issue 178. 4.4. Monitor 4.4.1. Drive Plugin May Not Be Detected Syncless will detect drive plug-in events most of the time. However, from time to time, Syncless will not be able to catch such an event. Although it is very rare, it happens. If it happens, we 32
suggest the user restarts Syncless, or remove the drive and plug in again. Refer to Issue 192 for more information. 4.4.2. Removable Drive Removing a drive while Syncless is synchronizing to it will cause finalizing to take a very long time. Also, Syncless may end unexpectedly. Refer to Issue 204. 4.4.3. Seamless Synchronization Limitation Due to limitation of the FileSystemWatcher, when performing mass filesystem operations within a short period of time in seamless synchronization, some files/folders may not be propagated. Refer to Issue 179. 4.5. User Interface 4.5.1. Progress Bar Remains On Screen After Tags Are Removed Sometime progress bar still remains on screen after tags are removed. Refer to Issue 201. 4.5.2. Changes Made After Every Sync Not Shown Currently, the program does not show a list of changes made to the filesystem after every synchronization. Refer to Issue 148. 4.5.3. Datagrid Rendering Issue Slight rendering issue on Log Window. The log table might automatically resize after scrolling the window, most likely due to a custom component bug. 33
4.5.4. No Notification When Cancelling/Switching To Seamless Mode Refer to Issue 203. 5. Ending Note Thank you for taking time to read through the User Guide! We hope that you find it informative in guiding you through using Syncless' unique features. Please report any bugs you find to http://code.google.com/p/big5sync/issues/list, thank you! You may wish to take a look at http://code.google.com/p/big5sync/wiki/knownissues20 for the known bugs in version 2.0. You may also contact us at big5.syncless@gmail.com. Interested in what is coming after version 2.0? Take a look at http://code.google.com/p/big5sync/wiki/comingsoon! Are you a developer? Interested to further improve Syncless? Have a look at http://code.google.com/p/big5sync/wiki/developerguide! For complete and up-to-date information about Syncless, go to Syncless's website at http://code.google.com/p/big5sync/. 34