Changes between Version 22 and Version 23 of Help/CommandLineOptions

Timestamp:

2018-02-10T15:24:13+01:00 (3 months ago)

Author:

Hb---

Comment:

wip

Help/CommandLineOptions

@@ -1 +1 @@
 [[TranslatedPages]]
-
-== Up-to-date usage ==
-To get the up-to-date usage, run (information will be translated)
-{{{
-java -jar josm-tested.jar --help
+= Command Line Options =
+{{{#!comment
+unfinished hb- 
 }}}
-
-Respective part of the source code: [source:trunk/src/org/openstreetmap/josm/gui/MainApplication.java#L130 org/openstreetmap/josm/gui/MainApplication.java#L130].
-
-= Possibly outdated content below =
-== Usage ==
-
-usage:
-{{{
-#!sh
-java <Java options> <JOSM JVM options> -jar josm-tested.jar <Post jar options> [file]
-}}}
-
-or 
+Three groups of command line options can be involved in starting JOSM.
 
 {{{
 #!sh
-javaws https://josm.openstreetmap.de/download/josm.jnlp
-javaws [options] [URL or path to josm.jnlp file]
+# Running a jar file
+java [Java options] -jar josm-tested.jar [Programm arguments]
+
+# Launching a Web Start
+javaws [run-options] <URL|path/to/josm.jnlp>
 }}}
 
+Beginning on the right-hand-side of the command line these groups are:
 
-Java 8 docs about javaws: https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javaws.html
+Programm arguments or ''Post jar arguments'' for JOSM::
+ Control JOSM directly, for example `--language=ru` or `--skip-plugins` or `--help` 
+ <filename|URL>
+Java Virtual Machine options::
+ Control the handler of virtual machine, for example `--Xmx2048m`. The `--jar jarfile` part is a java option, too. 
+ Control the environment inside the virtual machine for JOSM, for example `-Djosm.home=/home/user/.josm_dev`
+WebStart run-options::
+ Control the startup of the handler, for example `-J--Xmx2048m` to hand over the string 'Xmx2048m' to the JVM
+`--offline`
 
-=== Java options ===
-{{{
--Xmx...m                                  Set maximum Java heap size in megabytes
-}}}
+The 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].
 
-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.
-{{{
--Xmx256m
--Xmx512m
--Xmx768m
--Xmx1024m
--Xmx1536m
--Xmx2048m
-}}}
-
-=== JOSM JVM options ===
-
-provided as Java system properties
-{{{
--Djosm.pref=/PATH/TO/JOSM/PREF            Set the preferences directory
--Djosm.userdata=/PATH/TO/JOSM/USERDATA    Set the user data directory
--Djosm.cache=/PATH/TO/JOSM/CACHE          Set the cache directory
--Djosm.home=/PATH/TO/JOSM/HOMEDIR         Relocate all 3 directories to homedir.
--Djosm.home=/path/to/JOSM/folder/         Change the folder for all user settings. Cache directory will be in homedir/cache
-}}}
-**Note**: `-Djosm.home` has lower precedence, i.e. the specific setting overrides the general one
-
-=== Post jar options ===
+=== Programm arguments ===#Postjararguments
 
 These options need to be provided after the -jar josm.jar part of the command line.
@@ -81 +54 @@
 }}}
 
+=== Java options ===#JOSMJVMoptions
+
+provided as Java system properties
+{{{
+-Djosm.pref=/PATH/TO/JOSM/PREF            Set the preferences directory
+-Djosm.userdata=/PATH/TO/JOSM/USERDATA    Set the user data directory
+-Djosm.cache=/PATH/TO/JOSM/CACHE          Set the cache directory
+-Djosm.home=/PATH/TO/JOSM/HOMEDIR         Relocate all 3 directories to homedir.
+}}}
+`-Djosm.home` has lower precedence, i.e. the specific setting overrides this general one.
+
+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.
+{{{
+-Xmx...m                                  Set maximum Java heap size in megabytes
+-Xmx256m
+-Xmx1024m
+-Xmx2048m
+}}}
+
 examples
 {{{