Changes between Version 41 and Version 47 of Help/CommandLineOptions


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

Legend:

Unmodified
Added
Removed
Modified

  • Help/CommandLineOptions

    v41 v47  
    55
    66Four types of command line options affect JOSM:
    7  * The [#Programarguments Program arguments⤓] directly control JOSM. They are called ''args'' by Java. 
     7 * The [#Programarguments Program arguments⤓] directly control JOSM. They are called ''args'' by Java.
    88 * The [#Javaoptions Java options⤓] affect its environment (JVM) and are sometimes named ''VM arguments''.
    9  * Involved in Web Start and diagnosis are the [#run-options Run-options⤓].
     9 * The [#run-options Run-options⤓] are involved in WebStart. Some are for diagnosis and import.
    1010 * Some [#Otheroptions Other options⤓] for helper programs.
    1111
    … …  
    1313#!sh
    1414# Running a jar
    15 java [Java options] -jar josm-tested.jar [Program arguments]
     15java [Java options] -jar josm.jar [Program arguments]
    1616
    1717# Launch a Web Start
    … …  
    1919}}}
    2020
    21 The [wikitr:/Help/Action/ShowStatusReport Status Report] lists the given Program arguments and Java options in its second section.
     21The [wikitr:/Help/Action/ShowStatusReport Status Report] from the Help menu lists the given Program arguments and Java options.
    2222Some [#Examples examples⤓] for both of them are shown below.
    23 As usual the arguments are separated by space from each other.
     23
     24**Note:** The term {{{josm.jar}}} is a common abbreviation for the file names ''josm-tested.jar'' and ''josm-latest.jar''.
     25The term ''josm.jnlp'' also stands for ''josm-latest.jnlp''.
     26As usual the command line arguments are separated by space from each other.
     27
    2428
    2529== Program arguments for JOSM ==#Programarguments
    2630
    27 The first argument can be a **command** for JOSM to make it work autonomous. 
     31The first argument can be a **command** for JOSM to make it work autonomous.
    2832The commands are `render`, `project` or `runjosm` as default.
    2933
    30 The remaining arguments are **options** for JOSM. 
    31 They can be URLs, filenames, coordinates, simple options and option=value pairs. 
    32 
    33 The options for runjosm are listed in the following. 
    34 At the bottom are the options for the commands  [#Programargumentsrendering render⤓] and [#Programargumentsproject project⤓].
     34The remaining arguments are **options** for JOSM.
     35They can be URLs, filenames, coordinates, simple options and option=value pairs.
     36
     37The options for runjosm are listed in the following.
     38At the bottom are the options for the commands [#Programargumentsrendering render⤓] and [#Programargumentsproject project⤓].
    3539
    3640{{{
    … …  
    4246        render      render data and save the result to an image file
    4347        project     convert coordinates from one coordinate reference system to another
     48        validate    validate data
    4449
    4550For details on the render and project commands, run them with the --help option.
    … …  
    5560        --downloadgps=<URL>                       Download the location at the URL (with lat=x&lon=y&zoom=z) as raw GPS
    5661        --selection=<searchstring>                Select with the given search
    57         --[no-]maximize                           Launch in maximised mode
     62        --[no-]maximize                           Launch in maximized mode
    5863        --reset-preferences                       Reset the preferences to default
    5964
    … …  
    6570
    6671        --version                                 Displays the JOSM version and exits
     72
     73        --status-report                           Show status report with useful information that can be attached to bugs
    6774
    6875        --debug                                   Print debugging messages to console
    … …  
    7582}}}
    7683
    77 The `--download=` part of the download option is optional. 
     84The `--download=` part of the download option is optional.
    7885The arguments `--download`, `--downloadgps` and `--selection` are processed in this order.
    7986The value `<url-to-xml>` can point to a local file with `file:relative/path/name.xml`.
    … …  
    8794{{{
    8895Java system properties options:
    89       -Djosm.dir.name=JOSM                      Change the JOSM directory name
    90       -Djosm.pref=/PATH/TO/JOSM/PREF            Set the preferences directory
    91                                                 Default: C:\Users\name\AppData\Roaming\JOSM
    92       -Djosm.userdata=/PATH/TO/JOSM/USERDATA    Set the user data directory
    93                                                 Default: /home/name/.local/share/JOSM
    94       -Djosm.cache=/PATH/TO/JOSM/CACHE          Set the cache directory
    95                                                 Default: <...>
    96       -Djosm.home=/PATH/TO/JOSM/HOMEDIR         Set the common directory for preferences,
    97                                                 user data and ./cache/. Lower precedence.
    98                                                 Will get overridden from specific setting.
    99       -Xmx...m                                  Set maximum Java heap size in megabytes.
    100                                                 May avoid Out-of-Memory errors.
     96    -Djosm.dir.name=JOSM                      Change the JOSM directory name
     97    -Djosm.pref=/PATH/TO/JOSM/PREF            Set the preferences directory
     98                                              Default (Linux XDG): /home/name/.config/JOSM
     99                                              Default (Windows): C:\Users\name\AppData\Roaming\JOSM
     100    -Djosm.userdata=/PATH/TO/JOSM/USERDATA    Set the user data directory
     101                                              Default (Linux XDG): /home/name/.local/share/JOSM
     102                                              Default (Windows): C:\Users\name\AppData\Roaming\JOSM
     103    -Djosm.cache=/PATH/TO/JOSM/CACHE          Set the cache directory
     104                                              Default (Linux XDG): /home/name/.cache/JOSM
     105                                              Default (Windows): C:\Users\name\AppData\Local\JOSM\cache
     106    -Djosm.home=/PATH/TO/JOSM/HOMEDIR         Set the common directory for preferences,
     107                                              user data and ./cache/. Lower precedence.
     108                                              Will get overridden from specific setting.
     109    -Xmx...m                                  Set maximum Java heap size in megabytes.
     110                                              May avoid Out-of-Memory errors.
    101111}}}
    102112
    … …  
    104114If you set a common directory with `Djosm.home` then JOSM will create the subdirectories ./autosave, ./cache and ./validator.
    105115If a value has spaces, then enclose it in quotation marks like `"josm dev"`.
     116
    106117When the non-ASCII characters in the command prompt are scrambled, use `-Dfile.encoding=Cp850` to receive text from Java in another [https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html code page].
    107118Which [https://msdn.microsoft.com/de-de/library/windows/desktop/dd317756%28v=vs.85%29.aspx code page] is used shows `chcp⏎` in the terminal.
    108 For UTF-8 on Windows, invoke `chcp 65001` in the Windows terminal window before launching JOSM using `java -Dfile.encoding=UTF-8 -jar josm-tested.jar`
     119For UTF-8 on Windows, invoke `chcp 65001` in the Windows terminal window before launching JOSM using `java -Dfile.encoding=UTF-8 -jar josm.jar`
     120
     121JOSMs Debian package `josm-latest` uses `-Djosm.dir.name=JOSM-latest` to offer parallel installations in the XDG base directories.
    109122
    110123[=#Examples **Examples for JOSM runjosm options and Java options**]
    … …  
    112125#!sh
    113126# Load three files
    114   java -jar josm-tested.jar track1.gpx BigBen.jpg "london data.osm"
     127  java -jar josm.jar track1.gpx BigBen.jpg "london data.osm"
    115128# Download from OSM according to an URL with zoom and coordinates
    116   java -jar josm-tested.jar https://www.openstreetmap.org/#map=19/51.51/-0.135
     129  java -jar josm.jar https://www.openstreetmap.org/#map=18/51.501/-0.124
    117130# Download a bounding box and select every element matching a string
    118   java -jar josm-tested.jar 51.505,-0.14,51.515,-0.13 --selection="Piccadilly Circus"
     131  java -jar josm.jar 51.500,-0.126,51.502,-0.122 --selection="Big Ben"
    119132#
    120133# Set directory for JOSM according to a property from the operating system
    121   java -Djosm.pref=$XDG_CONFIG_HOME -jar josm-tested.jar
     134  java -Djosm.pref=$XDG_CONFIG_HOME -jar josm.jar
    122135# Quotations for a value with space and show JOSMs GUI in English
    123   java -Djosm.dir.name="josm dev" -jar josm-latest.jar --language=en
    124 # Set the common directory in a sub-subdirectroy below the active command prompt
    125   java -Djosm.home=biketour2017/london -jar josm-tested.jar
    126 # More memory in the Canadian variant of an English spoken environment
    127   java -Xmx1024m -Duser.language=en -Duser.country=CA -jar josm-latest.jar
     136  java -Djosm.dir.name="josm dev" -jar josm.jar --language=en
     137# Set the common directory in a sub-subdirectory below the active command prompt
     138  java -Djosm.home=biketour2017/london -jar josm.jar
     139# More memory and without phoning home
     140  java -Xmx1024m --set=message.notifier.enabled=false -jar josm.jar
    128141#
    129 # Log debug info and do not get disturbed by JOSM phoning home
    130   java -verbose -jar josm-latest.jar --set=message.notifier.enabled=false --debug >WhatsUp.txt
     142# Start in an English environment and log debug info plus messages from stderr
     143  java -Duser.language=en -jar josm.jar --debug 1>logfile.txt 2>&1
    131144}}}
    132145
    133146
    134147== Run-options for Java Web Start ==#run-options
    135 The run-options are read by the `javaws` command. They control the Web Start mechanism, can encapsulate Java options and can diagnose Java.
    136 {{{
    137 #!sh
    138 # Control
     148
     149The run-options are read by the `javaws` command. They control the Web Start mechanism, can encapsulate Java options and can diagnose Java.
     150{{{
     151#!sh
     152# Control
    139153  -offline                  Allows to Web Start JOSM without internet access
    140154
    141155# Encapsulate
    142   -J<java option>           Supplies the <java option> to the JVM 
     156  -J<java option>           Supplies the <java option> to the JVM
    143157  -J-Xmx1024m               Here: Set maximum Java heap size to 1024 megabyte
    144158
    145159# Diagnosis
    146 javaws -viewer            Shows the Cache Viewer in the Java Control Panel 
     160javaws -viewer            Shows the Cache Viewer in the Java Control Panel
    147161# Allows to opens the Java Control Panel from the command line.
    148162
    149163javaws -clearcache        Removes all non-installed applications from the cache
    150 # Equal to 'Delete Files and Applications' from the 'Temporary File Settings' invoked 
     164# Equal to 'Delete Files and Applications' from the 'Temporary File Settings' invoked
    151165# by the 'Settings' button in the 'General' tab of the Java Control Panel.
    152166# javaws -Xclearcache on OpenJDK
    153167}}}
    154168
    155 The `-J` run-option takes its part behind the J letter and supplies that as Java option. 
    156 The [wikitr:/Help/jnlpOptions jnlp-File] used by [https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javaws.html Web Start] offers a second way to [https://docs.oracle.com/javase/8/docs/technotes/guides/javaws/developersguide/syntax.html  set options] for JRE and for the JOSM program directly. 
     169The `-J` run-option takes its part behind the J letter and supplies that as Java option.
     170The [wikitr:/Help/jnlpOptions jnlp-File] used by [https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javaws.html Web Start] offers a second way to [https://docs.oracle.com/javase/8/docs/technotes/guides/javaws/developersguide/syntax.html  set options] for JRE and for the JOSM program directly.
    157171
    158172The `javaws` command has some control options on all systems.
    … …  
    162176== Other options ==#Otheroptions
    163177
    164 The Launcher `josm.exe` aka [http://launch4j.sourceforge.net/docs.html#Runtime_options Launch4j] (only on [wikitr:/Download#Mswindowswrapper MS Windows]) may give some debug info. 
     178The Launcher `josm.exe` aka [http://launch4j.sourceforge.net/docs.html#Runtime_options Launch4j] (only on [wikitr:/Download#Mswindowswrapper MS Windows]) may give some debug info.
    165179{{{
    166180#!sh
    … …  
    171185== Command line for Render and Project ==
    172186
    173 === JOSM rendering Programm arguments ===#Programargumentsrendering
     187=== JOSM rendering Program arguments ===#Programargumentsrendering
    174188
    175189{{{
    … …  
    223237}}}
    224238
    225 === JOSM projection Programm arguments ===#Programargumentsprojection
     239=== JOSM projection Program arguments ===#Programargumentsprojection
    226240
    227241{{{
    … …  
    256270}}}
    257271
    258 On this page 'josm.jar' is short for one of the releases josm-tested.jar or josm-latest.jar.
    259272
    260273== See also ==