source: subversion/applications/utils/osmosis/trunk/core/readme.txt @ 21925

Revision 21925, 2.0 KB checked in by bretth, 4 years ago (diff)

Merged the latest breakup branch changes. Includes a fix for the area filter plugin being located in the wrong location, and some package project configuration fixes to allow the application to run.

Line 
1INSTALLATION
2Unzip the distribution in the location of your choice.
3On unix/linux systems, make the bin/osmosis script executable (ie. chmod u+x osmosis).
4If desired, create a symbolic link to the osmosis script somewhere on your path (eg. ln -s appdir/bin/osmosis ~/bin/osmosis).
5
6CONFIGURATION
7Common command line options can be specified in configuration files.
8
9On Linux, the file can reside in the following locations with later files overriding earlier files:
10/etc/osmosis
11$HOME/.osmosis
12
13On Windows, the file can reside in the following locations with later files overriding earlier files:
14%ALLUSERSPROFILE%\osmosis.bat
15%USERPROFILE%\osmosis.bat
16
17The following variables can be defined in these files:
18JAVACMD - The java command to be invoked.  Default is "java".
19JAVACMD_OPTIONS - The java jvm options to apply (eg. -Xmx512M).
20OSMOSIS_OPTIONS - The osmosis options to apply (eg. -q or -plugin MyPluginLoaderClass).
21
22COMPILATION
23To perform a complete osmosis rebuild, the following command may be run from the osmosis root directory.
24
25ant all
26
27The "all" ant target performs all steps including creation of new distribution files, javadoc generation, and unit tests.
28To just recompile the main osmosis jar file, run the following command.
29
30ant build_binary
31
32Sometimes old files can be left hanging around causing problems.  It may be necessary to run the following command
33to clean up any old files.
34
35ant clean
36
37If you wish to rebuild the distribution zip and/or tar.gz files, the following command may be used.
38
39ant dist
40
41If any project dependencies are modified or if osmosis is downloaded directly from svn, the project dependencies
42will not be available.  This is because the ivy tool is used to manage project dependencies.
43To download all dependencies, run the following command.
44
45ant resolve
46
47HELP
48Osmosis documentation is available at:
49http://wiki.openstreetmap.org/index.php/Osmosis
50
51Please ask any questions, report any issues, or suggest enhancements using the Open Street Map talk or development mailing lists.
Note: See TracBrowser for help on using the repository browser.