Changes between Version 52 and Version 99 of InstallNotes


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified

  • InstallNotes

    v52 v99  
    11[[TranslatedPages]]
    2 [[TOC(inline)]]
     2[[PageOutline(2-10,Table of Content)]]
    33
    4 == Semi-Stable Version ==
    5 The latest semi-stable version is always here: [http://josm.openstreetmap.de/josm-tested.jar] - we don't call it a "release" because while it is more robust than the nightly build, it doesn't usually run through as many checks as a release would.
    6 
    7 == Nightly Builds ==
    8 You can always grab the latest nightly build from [http://josm.openstreetmap.de/josm-latest.jar]. Many users actually use this for their daily work.
     4Read [wikitr:/Download#Recommendedoptions Recommended options] first.
    95
    106== Running ==
    11 A working Java Runtime Environment version 6.0 or newer is needed to run JOSM.
     7A working Java Runtime Environment version 11 or newer is needed to run JOSM.
    128
    139=== Microsoft Windows ===
    1410Double click on the jar file.
    1511
    16 If this does not work, you probably need to install the [http://java.com/download/index.jsp Java Runtime]
     12If this does not work, you probably need to [wikitr:/Download#Doubleclickonafiledoesnothing install the Java Runtime Environment].
    1713
    18 In more extensive edit sessions, you may get an "out of memory" error. To avoid this, the assigned memory can be increased.[[BR]]
    19 Create a shortcut like in the following example:
    20 {{{
    21 C:\WINNT\system32\java.exe -jar -Xmx512M "C:\PATH-TO-JOSM\josm-latest.jar"
    22 }}}
     14To avoid the Java console windows staying open, you can use `javaw.exe` instead of `java.exe`.
     15
     16Be careful if you run a 64-bit version of Windows, the Java Runtime (update every month) may be installed in 64-bit when visiting the Java website with a 64-bit version of your browser, or in 32-bit otherwise.
     17Both Java platforms will coexist on the PC, but by default the file associations will run first the 32-bit version, creating VMs limited to a maximum of 247MB (if your VM size reaches this limit, due to the volume of data loaded, JOSM may become very slow or unresponsive).
     18
     19But, the JAR extension will only be launched with the 32-bit version of the Java Runtime ("\Program files (x86)\bin" folder, instead of "\Program files\bin" for the 64-bit version) since the v8u66 if both versions are installed.
     20
     21Visit the www.java.com main site, choose to download java ... and chose the i586 package. You can keep the 64-bit package because it is not installed at the same location than the 32-bit (i586) package.
     22
     23If only a 64-bit version of Java is installed on a 64-bit version of Windows (and with a Java version higher or equal to the minimum version specified in the JNLP if you use JavaWebStart to download/update and launch JOSM), JOSM will start automatically in a 64-bit Java VM (with more memory available to handle larger volumes of data, and better performance). Otherwise, it will launch in a 32-bit Java VM, unless you add VM parameters to the command line to locate and use the 64-bit version of Java.
     24
     25But you may also uninstall any 32-bit versions of Java if you don't need applets in a 32-bit browser (the 32-bit version of Java remains useful when using an old 32-bit browser for using applets in web pages, or for 32-bit OSes where this is the only choice available on the web or in standalone usage).
    2326
    2427=== Linux / *BSD ===
     28''See also'': [wikitr:/HowTo/JOSM-under-Linux HowTo JOSM-under-Linux]
     29
    2530 **packages**::
    26  In some Distributions prepacked packages exist to install JOSM with your favourite package manage from the repositories.
     31 In some Distributions, prepacked packages exist to install JOSM with your favorite package manager from the repositories.
    2732 Although these packages might be a bit older than the .jar files on the main page, they usually fit better into the environment and install dependencies and a starter in the menu automatically.
    2833
    29  **Note**: There is no problem with installing the prepacked package and still using the .jar files listed above.
     34 **Note**: There is no problem with installing the prepacked package and still using the .jar files listed above but be careful with additional packages like josm-plugins (see #7483).
    3035
    31  If there exists no package or you do not want to use it you can download the JOSM .jar file from the main page (tested or latest version) or build it from source.
    3236
    33  '''using the shell'''::
     37 For SUSE and Ubuntu/Debian, there are also packages on this page available ( [wikitr:/Download#openSUSE SUSE], [wikitr:/Download#Ubuntu Ubuntu]).
     38 If there exists no package or you do not want to use it you can download the JOSM .jar file from the [wikitr:/WikiStart main page] (tested or latest version) or build it from source.
     39
     40 **using the shell**::
    3441  Go to the directory where the josm-latest.jar is and type
    3542{{{
    … …  
    3744java -jar josm-latest.jar
    3845}}}
    39   to launch. Replace `''josm-latest.jar''` with the name of the jar file you loaded, e.G. `josm.jar` for releases.
     46  to launch. Replace `josm-latest.jar` with the name of the jar file you loaded, e.G. `josm.jar` for releases.
    4047
    4148  If this doesn't help, try to set your JAVA_HOME variable to the java location (the root location, not the bin. As example:
    4249{{{
    4350#!sh
    44  export JAVA_HOME=/usr/lib/sun-j2se6.0-jdk
     51 export JAVA_HOME=/usr/lib/jvm/default-java
    4552 java -jar ''josm.jar''
    4653}}}
    4754
     55 See also [wikitr:/Help/CommandLineOptions command line options] and [wikitr:/HowTo/JOSM-under-Linux Josm under Linux Howto] for additional info.
    4856 '''KDE'''::
    49   There is a [http://josm.openstreetmap.de/download/tutorials/setting_up_kde.avi tutorial] on how to setup your environment to start jar-files by clicking on them.
     57  There is a [/download/tutorials/setting_up_kde.avi tutorial] on how to setup your environment to start jar-files by clicking on them.
    5058
    5159 '''GNOME'''::
    52   Right click on the JAR file, and select __O__pen with "Sun Java 6.0 Runtime", or whatever java version you have.
     60  Right-click on the JAR file, and select __O__pen with "OpenJDK11 Runtime", or whatever Java version you have.
    5361
    5462 '''XGL/Compiz'''::
    … …  
    5866export AWT_TOOLKIT=MToolkit && java -jar josm-test.jar
    5967}}}
    60   as described here: http://kubasik.net/blog/index.php/2006/06/19/java-sun-150-and-xglcompiz-on-ubuntu/
    61 
    62  '''Blank window on startup'''::
    63   AWT before JDK7 [http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6574362 doesn't play well] with non-reparenting window managers (i.e. xmonad, awesome, dwm, ratpoison, Ion3, ...), resulting in the main window not being displayed properly on startup.  The Awesome Wiki has [http://awesome.naquadah.org/wiki/Problems_with_Java workarounds] for this problem.  There is also an [http://xmonad.org/xmonad-docs/xmonad-contrib/XMonad-Hooks-SetWMName.html xmonad specific] way of doing the wmname thing.
     68  as described here: [https://web.archive.org/web/20060718112352/http://kubasik.net/blog/index.php/2006/06/19/java-sun-150-and-xglcompiz-on-ubuntu/ http://kubasik.net/blog/index.php/2006/06/19/java-sun-150-and-xglcompiz-on-ubuntu/]
    6469
    6570=== MacOS ===
    66  1. If you have downloaded "josm-latest.jar" you can start JOSM by clicking on the josm-latest.jar file in the MacOS Finder (you might get the warning that you are about to open a file from the internet - just accept).
     711. If you have downloaded `josm-latest.jar` you can start JOSM by clicking on the josm-latest.jar file in the MacOS Finder (you might get the warning that you are about to open a file from the internet - just accept).
    6772
    6873 This way to start JOSM should be sufficient in most cases.
     74 
     752. If you are running Mountain Lion, you will need to temporarily disable Gatekeeper. Otherwise, you will be unable to open josm and upon launching josm, receive the error message "JOSM.app is damaged and can't be opened. You should move it to the Trash". Disable Gatekeeper by opening System Preferences > Security & Privacy, and setting 'Allow applications downloaded from:' to 'Anywhere'. Once you open the application, you can re-enable gatekeeper, and it appears that JOSM will open again without a problem. See [osmwww:user/drnoble/diary/17636 this] and #7904 for more information.
    6976
    70  2. However, if you need to start it up with additional Java parameter(s) (e.g. -Xmx512M) you can also use the MacOS "Terminal" and start JOSM (Java) manually:
     773. If you get "The Java JAR file could not be launched", chances are you are running an old Java version.  Run from a terminal to check, as nothing appears in the system log.
     78[[Image(OSX_Error.png)]]
    7179
    72  Start the "Terminal" application (e.g. by typing "Terminal" into the Spotlight search)
     804. If you need to supply parameters (e.g. -Xmx2048M to run with more Java memory) you can use the MacOS "Terminal":
     81
     82 Start the "Terminal" application (e.g. by typing "Terminal" into the Spotlight Search, ⌘+space)
     83[[Image(SearchTerminal.png)]]
    7384
    7485* Now you have two options:
    7586 * type in the following command and press "Enter" to start JOSM without any special java options (simply starts up JOSM like under point 1):
    7687{{{
     88#!sh
    7789java -jar FOLDER/josm-latest.jar
    7890}}}
    79  Whereas "FOLDER" should be replaced by the name of the folder you have josm-latest.jar downloaded to. If you have downloaded it to the standard MacOS "Download" Folder it would look like:
     91 Whereas "FOLDER" should be replaced by the name of the folder you have josm-latest.jar downloaded to. If you have downloaded it to the standard Mac OS X "Downloads" Folder it would look like:
    8092{{{
    81 java -jar Download/josm-latest.jar
    82 
    83 }}}
    84  * to use additional java options just add them right after "java"
    85 
    86   If you for example have experienced the "Out of memory" warning (e.g. trying to load geo-tagged photos to JOSM) you would start JOSM like this:
    87 {{{
    88 java -Xmx256M -jar FOLDER/josm-latest.jar
    89 }}}
    90 
    91   This would allow JOSM to use up to 256 MB of RAM (memory). The java option "-Xmx256M" set's the maximum Java heap size to 265 MB. You are free to replace -Xmx256M by any number appropriate for your system (e.g. -Xmx512M or even -Xmx1024M).
    92 
    93   By the way. To get an overview of all Java start options you can type in:
    94 {{{
    95 java -help
    96 }}}
    97 
    98 == Getting the Source ==
    99 JOSM is available under GPL, and so of course you can get the sources and compile, modify or redistribute it by yourself. You can grab the sources via [http://subversion.tigris.org subversion]
    100 
    101  svn co http://josm.openstreetmap.de/svn/trunk josm
    102 
    103 Or you can inspect single files over the web frontend at http://josm.openstreetmap.de/svn.
    104 
    105 == Compiling ==
    106 === Using ant ===
    107 The easiest way to compile JOSM provided Java on your machine is properly set up is to go to the josm directory and type:
    108 
    109 {{{
    110  ant
    111 }}}
    112 
    113 That will create a `dist/josm-custom.jar` file if successful.
    114 
    115 === Using eclipse ===
    116 
    117 Use eclipse and the provided `.project` and `.classpath` file. Just add a new Java Project using the JOSM source folder as existing path.
    118 
    119 As of Eclipse 3.5.2 and the latest JOSM (August 10, 2011), you will have problems compiling, due to problems compiling Mappaint MapCSS with a fresh install of Eclipse. First you will need the [http://www.engr.mun.ca/~theo/JavaCC-FAQ/javacc-faq-moz.htm JavaCC] [http://eclipse-javacc.sourceforge.net/ plugin for Eclipse]. To install it in Eclipse, go to Help->New Software... then add the site [http://eclipse-javacc.sourceforge.net/] as a source, and install the JavaCC Eclipse Plug-in. Then in the Package Explorer, expand org.osm.josm.gui.mappaint.mapcss, right-click on MapCSSParser.jj, and "Compile with JavaCC". This should put new java files in a package called org.openstreetmap.josm.gui.mappaint.mapcss.parsergen, but if it doesn't, you will have to create the package manually (right-click and create package), then drag the new files into the package you just created (they should be easy to identify based on the light gray text that denotes it was compiled from MapCSSParser.jj). This should resolve any import issues in MapCSSStyleSource.java, and you should now be able to compile JOSM.
    120 
    121 If you try to compile the JOSM sources in Eclipse and get errors like "The method marktr(String) is undefined for the type SomeType" look at [http://lists.openstreetmap.org/pipermail/josm-dev/2008-August/001585.html solution suggested at mailing list].
    122 
    123 There are also two Videos available at youtube, which show [http://www.youtube.com/watch?v=-LoWGf-hqiQ how to checkout JOSM into Eclipse] and [http://www.youtube.com/watch?v=Z3OjG3nDvzA how to checkout a JOSM plugin into Eclipse].
    124 
    125 === Using javac ===
    126 
    127 You can also build josm without ant or eclipse. To do so, call `javac` on the file `org/openstreetmap/josm/gui/MainApplication.java` with all libs from `../lib/*.jar` in your classpath (you have to specify all subsequent). If running Linux, this would look like that:
    128 
    129  * Check out the sources
    130 
    131 {{{
    132 $ svn co http://josm.openstreetmap.de/svn/trunk josm
    133         ''tons of output here''
    134 $ cd josm/
    135 $ mkdir build
    136 }}}
    137  * Compile and run
    138 {{{
    139 $ javac -cp .:src -d build src/org/openstreetmap/josm/gui/MainApplication.java
    140 $ java -cp .:build org.openstreetmap.josm.gui.MainApplication
    141 }}}
    142 
    143 == Unit Tests ==
    144 
    145 It is most convenient, to run tests from an IDE like Eclipse or Netbeans. There is also an ant task to run all tests (but you cannot rerun individual tests).
    146 
    147 === Running Test from Command line ===
    148 
    149 You can run tests from the command line, as well. Include all libraries in the class path like this:
    150 {{{
    151 export TESTCP=".:test/unit:test/functional:dist/josm-custom.jar:test/lib/fest/fest-assert-1.0.jar:test/lib/fest/MRJToolkitStubs-1.0.jar:test/lib/fest/jcip-annotations-1.0.jar:test/lib/fest/fest-swing-1.1.jar:test/lib/fest/fest-reflect-1.1.jar:test/lib/fest/fest-util-1.0.jar:test/lib/fest/debug-1.0.jar:test/lib/junit/junit-4.6.jar:test/lib/jfcunit.jar:test/lib/unitils-core/ognl-2.6.9.jar:test/lib/unitils-core/commons-lang-2.3.jar:test/lib/unitils-core/unitils-core-3.1.jar:test/lib/unitils-core/junit-4.4.jar:test/lib/unitils-core/commons-logging-1.1.jar:test/lib/unitils-core/commons-collections-3.2.jar"
    152 }}}
    153 Then run for example
    154 {{{
    155 javac -cp $TESTCP test/unit/org/openstreetmap/josm/data/projection/ProjectionRefTest.java
    156 java -cp $TESTCP org.junit.runner.JUnitCore org.openstreetmap.josm.data.projection.ProjectionRefTest
     93#!sh
     94java -jar Downloads/josm-latest.jar
    15795}}}
    15896
    15997== See also ==
    160 [wiki:HowTo/JOSM-under-Linux HowTo JOSM-under-Linux]
     98* [[wikitr:/Source code#Getthesource|Get the source]]
     99* [[wikitr:/Source code#CompilingusingAnt|Compiling using Ant]]