Changes between Version 22 and Version 23 of Help/CommandLineOptions


Ignore:
Timestamp:
2018-02-10T15:24:13+01:00 (3 months ago)
Author:
Hb---
Comment:

wip

Legend:

Unmodified
Added
Removed
Modified
  • Help/CommandLineOptions

    v22 v23  
    11[[TranslatedPages]]
    2 
    3 == Up-to-date usage ==
    4 To get the up-to-date usage, run (information will be translated)
    5 {{{
    6 java -jar josm-tested.jar --help
     2= Command Line Options =
     3{{{#!comment
     4unfinished hb-
    75}}}
    8 
    9 Respective part of the source code: [source:trunk/src/org/openstreetmap/josm/gui/MainApplication.java#L130 org/openstreetmap/josm/gui/MainApplication.java#L130].
    10 
    11 = Possibly outdated content below =
    12 == Usage ==
    13 
    14 usage:
    15 {{{
    16 #!sh
    17 java <Java options> <JOSM JVM options> -jar josm-tested.jar <Post jar options> [file]
    18 }}}
    19 
    20 or
     6Three groups of command line options can be involved in starting JOSM.
    217
    228{{{
    239#!sh
    24 javaws https://josm.openstreetmap.de/download/josm.jnlp
    25 javaws [options] [URL or path to josm.jnlp file]
     10# Running a jar file
     11java [Java options] -jar josm-tested.jar [Programm arguments]
     12
     13# Launching a Web Start
     14javaws [run-options] <URL|path/to/josm.jnlp>
    2615}}}
    2716
     17Beginning on the right-hand-side of the command line these groups are:
    2818
    29 Java 8 docs about javaws: https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javaws.html
     19Programm arguments or ''Post jar arguments'' for JOSM::
     20 Control JOSM directly, for example `--language=ru` or `--skip-plugins` or `--help`
     21 <filename|URL>
     22Java Virtual Machine options::
     23 Control the handler of virtual machine, for example `--Xmx2048m`. The `--jar jarfile` part is a java option, too.
     24 Control the environment inside the virtual machine for JOSM, for example `-Djosm.home=/home/user/.josm_dev`
     25WebStart run-options::
     26 Control the startup of the handler, for example `-J--Xmx2048m` to hand over the string 'Xmx2048m' to the JVM
     27`--offline`
    3028
    31 === Java options ===
    32 {{{
    33 -Xmx...m                                  Set maximum Java heap size in megabytes
    34 }}}
     29The option group names used here follow the documentation on [https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html#CBBIJCHG Runtime Engine] and on [https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javaws.html Web Start].
    3530
    36 For some tasks, JOSM has a large appetite for memory. On the one hand, it may be necessary to configure an  -Xmx memory size that supports more JOSM plugins and other JOSM editing features. On the other hand, slow systems or those systems with few memory resources, can be stabilized by restricting JOSM memory use.  These example Java memory settings provide examples that start with systems that have few memory resources to systems with vast amounts of memory.
    37 {{{
    38 -Xmx256m
    39 -Xmx512m
    40 -Xmx768m
    41 -Xmx1024m
    42 -Xmx1536m
    43 -Xmx2048m
    44 }}}
    45 
    46 === JOSM JVM options ===
    47 
    48 provided as Java system properties
    49 {{{
    50 -Djosm.pref=/PATH/TO/JOSM/PREF            Set the preferences directory
    51 -Djosm.userdata=/PATH/TO/JOSM/USERDATA    Set the user data directory
    52 -Djosm.cache=/PATH/TO/JOSM/CACHE          Set the cache directory
    53 -Djosm.home=/PATH/TO/JOSM/HOMEDIR         Relocate all 3 directories to homedir.
    54 -Djosm.home=/path/to/JOSM/folder/         Change the folder for all user settings. Cache directory will be in homedir/cache
    55 }}}
    56 **Note**: `-Djosm.home` has lower precedence, i.e. the specific setting overrides the general one
    57 
    58 === Post jar options ===
     31=== Programm arguments ===#Postjararguments
    5932
    6033These options need to be provided after the -jar josm.jar part of the command line.
     
    8154}}}
    8255
     56=== Java options ===#JOSMJVMoptions
     57
     58provided as Java system properties
     59{{{
     60-Djosm.pref=/PATH/TO/JOSM/PREF            Set the preferences directory
     61-Djosm.userdata=/PATH/TO/JOSM/USERDATA    Set the user data directory
     62-Djosm.cache=/PATH/TO/JOSM/CACHE          Set the cache directory
     63-Djosm.home=/PATH/TO/JOSM/HOMEDIR         Relocate all 3 directories to homedir.
     64}}}
     65`-Djosm.home` has lower precedence, i.e. the specific setting overrides this general one.
     66
     67For some tasks, JOSM has a large appetite for memory. On the one hand, it may be necessary to configure an  -Xmx memory size that supports more JOSM plugins and other JOSM editing features. On the other hand, slow systems or those systems with few memory resources, can be stabilized by restricting JOSM memory use.  These example Java memory settings provide examples that start with systems that have few memory resources to systems with vast amounts of memory.
     68{{{
     69-Xmx...m                                  Set maximum Java heap size in megabytes
     70-Xmx256m
     71-Xmx1024m
     72-Xmx2048m
     73}}}
     74
    8375examples
    8476{{{