Changes between Version 46 and Version 47 of Help/CommandLineOptions


Ignore:
Timestamp:
2022-12-31T16:36:38+01:00 (2 years ago)
Author:
gaben
Comment:

partial help update

Legend:

Unmodified
Added
Removed
Modified
  • Help/CommandLineOptions

    v46 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''.
    99 * The [#run-options Run-options⤓] are involved in WebStart. Some are for diagnosis and import.
     
    1919}}}
    2020
    21 The [wikitr:/Help/Action/ShowStatusReport Status Report] from the Help menu lists the given Program arguments and Java options. 
     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.
    2323
     
    2929== Program arguments for JOSM ==#Programarguments
    3030
    31 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.
    3232The commands are `render`, `project` or `runjosm` as default.
    3333
    34 The remaining arguments are **options** for JOSM. 
    35 They can be URLs, filenames, coordinates, simple options and option=value pairs. 
    36 
    37 The options for runjosm are listed in the following. 
    38 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⤓].
    3939
    4040{{{
     
    4646        render      render data and save the result to an image file
    4747        project     convert coordinates from one coordinate reference system to another
     48        validate    validate data
    4849
    4950For details on the render and project commands, run them with the --help option.
     
    5960        --downloadgps=<URL>                       Download the location at the URL (with lat=x&lon=y&zoom=z) as raw GPS
    6061        --selection=<searchstring>                Select with the given search
    61         --[no-]maximize                           Launch in maximised mode
     62        --[no-]maximize                           Launch in maximized mode
    6263        --reset-preferences                       Reset the preferences to default
    6364
     
    7576
    7677        --skip-plugins                            Skip loading plugins
    77 
    7878
    7979        --offline=<OSM_API|JOSM_WEBSITE|CACHE_UPDATES|CERTIFICATES|ALL>
     
    8282}}}
    8383
    84 The `--download=` part of the download option is optional. 
     84The `--download=` part of the download option is optional.
    8585The arguments `--download`, `--downloadgps` and `--selection` are processed in this order.
    8686The value `<url-to-xml>` can point to a local file with `file:relative/path/name.xml`.
     
    9494{{{
    9595Java system properties options:
    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.
     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.
    111111}}}
    112112
     
    140140  java -Xmx1024m --set=message.notifier.enabled=false  -jar josm.jar
    141141#
    142 # Start in an English environment and log debug info plus messages from stderr 
     142# Start in an English environment and log debug info plus messages from stderr
    143143  java -Duser.language=en -jar josm.jar --debug 1>logfile.txt 2>&1
    144144}}}
     
    147147== Run-options for Java Web Start ==#run-options
    148148
    149 The 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 
     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
    153153  -offline                  Allows to Web Start JOSM without internet access
    154154
    155155# Encapsulate
    156   -J<java option>           Supplies the <java option> to the JVM 
     156  -J<java option>           Supplies the <java option> to the JVM
    157157  -J-Xmx1024m               Here: Set maximum Java heap size to 1024 megabyte
    158158
    159159# Diagnosis
    160 javaws -viewer            Shows the Cache Viewer in the Java Control Panel 
     160javaws -viewer            Shows the Cache Viewer in the Java Control Panel
    161161# Allows to opens the Java Control Panel from the command line.
    162162
    163163javaws -clearcache        Removes all non-installed applications from the cache
    164 # 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
    165165# by the 'Settings' button in the 'General' tab of the Java Control Panel.
    166166# javaws -Xclearcache on OpenJDK
    167167}}}
    168168
    169 The `-J` run-option takes its part behind the J letter and supplies that as Java option. 
    170 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.
    171171
    172172The `javaws` command has some control options on all systems.
     
    176176== Other options ==#Otheroptions
    177177
    178 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.
    179179{{{
    180180#!sh
     
    185185== Command line for Render and Project ==
    186186
    187 === JOSM rendering Programm arguments ===#Programargumentsrendering
     187=== JOSM rendering Program arguments ===#Programargumentsrendering
    188188
    189189{{{
     
    237237}}}
    238238
    239 === JOSM projection Programm arguments ===#Programargumentsprojection
     239=== JOSM projection Program arguments ===#Programargumentsprojection
    240240
    241241{{{