File	Date	Author	Commit
.settings	2015-04-04	Jens Heidrich	[95a353] Restarted work.
docs	2015-05-10	Jens Heidrich	[b6dba3] Updated log.
icons	2015-04-04	Jens Heidrich	[95a353] Restarted work.
lib	2015-04-04	Jens Heidrich	[95a353] Restarted work.
release	2015-05-10	Jens Heidrich	[d451dc] Added ini file for 64bit Windows exe.
src	2015-05-30	Jens Heidrich	[76c882] - Removed file factory producer cancel and shut...
test	2023-12-16	heidrich	[bc7694] Clean test dir and correct gitignore
web	2015-04-04	Jens Heidrich	[95a353] Restarted work.
.classpath	2015-02-01	Jens Heidrich	[4a23e5] - Updated libraries.
.gitignore	2023-12-16	heidrich	[bc7694] Clean test dir and correct gitignore
.project	2023-12-16	heidrich	[bc7694] Clean test dir and correct gitignore
ReadMe.txt	2015-05-27	Jens Heidrich	[d6a588] - Made JFSElement comparable and fixed some sma...
build.xml	2023-12-16	heidrich	[bc7694] Clean test dir and correct gitignore

Read Me

JFileSync - Java File Synchronization
Copyright (C) 2002-2015, Jens Heidrich

Release Notes

1) Introduction
2) License and Usage Terms
3) Requirements
4) Installation and Application Start
5) Development Notes
6) Included Directories and Files
7) Contact and Further Information


1) Introduction

JFileSync is used to synchronize directories of (usually) two different file
systems. For instance, you have a laptop and a workstation and you want to
synchronize different directories on those machines in a platform-independent
way.

You may synchronize any directory locally available to the computer on which
JFileSync is installed. In addition JFileSync supports resources that can be
accessed by Apache's Commons Virtual File System (VFS), specifically the SFTP
protocol.

All functions of JFileSync can be controlled via the Graphical User Interface
(GUI). However, JFileSync provides full access to all features via the command
line interface. Call 'java -jar jfs.jar -help' for getting an overview of all
possible command line options.


2) License and Usage Terms

This program 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 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
St, Fifth Floor, Boston, MA, 02110-1301, USA

JFileSync uses libraries or parts of the following Open Source projects:
- Eclipse icons, Common Public License 1.0: http://www.eclipse.org/
- Commons VFS, Apache License 2.0: http://commons.apache.org/proper/commons-vfs/
- Commons Logging, Apache License 2.0: http://commons.apache.org/proper/commons-logging/
- JSch, BSD: http://www.jcraft.com/jsch/
- Appbundler, GNU GPL 2.0: https://java.net/projects/appbundler
- WinRun4J, Common Public License 1.0: http://winrun4j.sourceforge.net/

You can find a copy all licenses of JFileSync and the used libraries in the
'docs' sub directory of this distribution.


3) Requirements

- Java 8 Runtime Environment: http://java.sun.com


4) Installation and Application Start

Generic package
- Unzip the distribution file to a directory of your choice.
- Enter the 'lib' sub directory of the folder.
- Launch file 'jfs.jar' (or execute 'java -jar jfs.jar'
  from the command line).

Windows package
- Unzip the distribution file to a directory of your choice.
- Double click on 'JFileSync.exe'.

Mac OS package
- Mount the package DMG file.
- Move 'JFileSync' to your applications' folder.


5) Development Notes

Required packages for JFileSync development (not included in the distribution):
- Java 8 SDK: http://java.sun.com
- Apache Ant: http://ant.apache.org

Ant build targets:
- 'ant' creates a jar file named 'jfs.jar' to the 'lib' sub directory.
- 'clean' cleans the build directory.
- 'clean-all' cleans the whole development directory.
- 'docs' creates the API documentation to the 'docs' sub directory.
- 'releases' creates JFS end-user releases (generic, Windows, Mac OS).
- 'ant reset' resets the testing directories after a synchronization test.
- 'ant run' starts the JFS application.
- 'ant test' starts the JFS application in a test environment.
- 'ant test-native' starts the native language JFS application.
- 'ant test-param' starts the JFS application asking for launching parameters.
- 'ant src-license' replaces the license text of all source code files.
- 'ant web-preview' creates a preview of the JFS web pages.
- 'ant clean-web' cleans the preview of the JFS web pages.


6) Included Directories and Files

The following structure describes all directories included in the
JFileSync developer package (available via CVS) containing all
resources necessary to develop the application:
- classes: Temporary class file folder, generated by the Ant build file.
- docs: The program licenses, QA plan, and change history.
- icons: Icon resource files containing the JFileSync logo.
- lib: Necessary libraries in order to run the system.
- profiles: Sample user profiles.
- src: The source code of the overall application.
- release: Files for composing the different end user releases.
- test: A testing directory structure including test profiles.
- web: JFileSync web site sources.


7) Contact and Further Information

You may submit improvement suggestions, patches, and other enhancements to
Jens Heidrich <jens.heidrich@gmail.com>.

JFileSync is a SourceForge project and available via the following URL:
http://jfilesync.sourceforge.net/