Changes between Version 20 and Version 21 of Help/Preferences


Ignore:
Timestamp:
2016-11-04T16:28:54+01:00 (9 years ago)
Author:
bastiK
Comment:

expand table to multiple sections

Legend:

Unmodified
Added
Removed
Modified
  • Help/Preferences

    v20 v21  
    1717= JOSM preference/data/cache directories =
    1818
    19 ||= Priority  =||= Preference =||= Data =||= Cache =||
    20 || 1. specific system property specified from [[Help/CommandLineOptions|commandline]] || `-Djosm.pref=...` || `-Djosm.userdata=...` || `-Djosm.cache=...` ||
    21 || 2. `josm.home` system property specified from commandline || `-Djosm.home=...` || `-Djosm.home=...` || `-Djosm.home=...`[[BR]]→`{josm.home}/cache` ||
    22 || 3a. Windows defaults (since r7829) || `%APPDATA%\<JOSM>` || `%APPDATA%\<JOSM>` || `%LOCALAPPDATA%\<JOSM>\cache` or[[BR]] `%APPDATA%\<JOSM>\cache` ||
    23 || 3b. Mac OS X defaults (since r7829) || `$HOME/Library/Preferences/<JOSM>` || `$HOME/Library/<JOSM>` || `$HOME/Library/Caches/<JOSM>` ||
    24 || 3c. Linux defaults (for fresh installations after r11162) || `$XDG_CONFIG_HOME/<JOSM>` or[[BR]]`$HOME/.config/<JOSM>` || `$XDG_DATA_HOME/<JOSM>` or[[BR]]`$HOME/.local/share/<JOSM>` || `$XDG_CACHE_HOME/<JOSM>` or[[BR]]`$HOME/.cache/<JOSM>` ||
    25 || 3d. Linux defaults (prior r11162) || `$HOME/.<josm>` || `$HOME/.<josm>` || `$HOME/.<josm>`/cache ||
     19JOSM stores 3 kinds of files in different directories:
     20 Preferences:: Configuration data and settings, such as authentication for the OSM server, list of last opened files, selection of expandable dialogs on the right, etc.
     21 User data:: User specific data files, for example autosave data, plugins and ignored validator errors
     22 Cache:: Files downloaded from the internet and stored for a limited time to avoid repeated downloads and allow faster access. For example imagery tiles and startup news.
    2623
    27 Notes:
    28 * `<JOSM>` defaults to JOSM and can be customized using `-Djosm.dir.name=...`, and `<josm>` corresponds to lowercase `<JOSM>`
    29 * Windows: try opening Explorer window and paste following text in location, then hit enter: {{{%APPDATA%\JOSM}}}.
    30 * Linux: To show the contents of the hidden folder, use the file manager and enter "~/.josm" in the address line (if no address line is visible just try to enter a letter and hopefully a popup to enter the address will open). Alternatively it is possible to "show hidden" files and folders in the file manager, using the keyboard shortcut ''Ctrl+H''.
     24The default location of the directories depends on your operating system.
     25
     26== Windows ==
     27
     28'''Preferences''' and '''user data''' is stored in
     29{{{
     30%APPDATA%\JOSM
     31}}}
     32To locate this folder, try opening Explorer window and paste following text in location, then hit enter: `%APPDATA%\JOSM`, On Windows Vista and later, it should be something like `C:\Users\<YourName>\AppData\Roaming\JOSM`. Note, that the directory `C:\Users\<YourName>\AppData` can be hidden by default.
     33
     34The '''cache''' is located in
     35{{{
     36%LOCALAPPDATA%\JOSM\cache
     37}}}
     38for Windows Vista and later.
     39
     40This is typically `C:\Users\<YourName>\AppData\Local\JOSM\cache`.
     41
     42On Windows XP and earlier, the cache is in `%APPDATA%\JOSM\cache`.
     43
     44== Mac OS X ==
     45
     46On Mac OS X, the default locations are as follows:
     47 Preferences:: `$HOME/Library/Preferences/JOSM`
     48 User data:: `$HOME/Library/JOSM`
     49 Cache:: `$HOME/Library/Caches/JOSM`
     50
     51== Linux ==
     52
     53Since r11162, JOSM uses the [https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html XDG Base Directory Specification] for fresh installations, i.e.
     54 Preferences:: `$HOME/.config/JOSM`
     55 User data:: `$HOME/.local/share/JOSM`
     56 Cache:: `$HOME/.cache/JOSM`
     57
     58JOSM respects the `$XDG_CONFIG_HOME`, `$XDG_DATA_HOME` and `$XDG_CACHE_HOME` environment variables to chance these locations.
     59
     60Prior to r11162, the locations were
     61 Preferences:: `$HOME/.josm`
     62 User data:: `$HOME/.josm`
     63 Cache:: `$HOME/.josm/cache`
     64
     65JOSM will continue to use the old locations, if the directory `$HOME/.josm` exists. If you have a fresh installation, but prefer the old scheme, you can create the `$HOME/.josm` directory by hand.
     66
     67Note on hidden files: File names beginning with a dot are hidden on Linux. To show the contents of the hidden folder, use the file manager and enter "~/.josm" in the address line (if no address line is visible just try to enter a letter and hopefully a popup to enter the address will open). Alternatively it is possible to "show hidden" files and folders in the file manager, using the keyboard shortcut Ctrl+H.
     68
     69== Customization (all operating systems) ==
     70
     71=== Setting all 3 locations ===
     72The locations can be set using system properties specified from the [[Help/CommandLineOptions|commandline]]:
     73 Preferences:: `-Djosm.pref=...`
     74 User data:: `-Djosm.userdata=...`
     75 Cache:: `-Djosm.cache=...`
     76
     77For example to store the cache in `D:\cache\JOSM`, you would need to run a command like this:
     78{{{
     79java -Djosm.cache=D:\cache\JOSM -jar josm.jar
     80}}}
     81
     82=== Setting a common directory ===
     83
     84Alternatively, all 3 locations can be moved to a common location using the system property `-Djosm.home=...`.
     85For example with
     86{{{
     87java -Djosm.home=D:\myJOSM -jar josm.jar
     88}}}
     89the locations change to
     90 Preferences:: `D:\myJOSM`
     91 User data:: `D:\myJOSM`
     92 Cache:: `D:\myJOSM\cache`
     93
     94=== Changing the directory base name ===
     95
     96Instead of specifying the full path for the JOSM directories, you can use the system property `-Djosm.dir.name=` to modify just the name of the last directory component, which is `JOSM` by default. This is especially useful in order to keep multiple ''profiles'' on one computer, which should not interfere. For example to have one profile for productive work with the stable tested version and one for the experimental development version, you would start the development verison like this:
     97{{{
     98java -Djosm.dir.name=JOSM-dev -jar josm-latest.jar
     99}}}
     100On Linux, the directories would then change to
     101 Preferences:: `$HOME/.config/JOSM-dev`
     102 User data:: `$HOME/.local/share/JOSM-dev`
     103 Cache:: `$HOME/.cache/JOSM-dev`
     104
     105(For locations in the style prior to r11162, the lower-case version with prepended dot will be used, e.g. `$HOME/.josm-dev`.)
    31106
    32107== preferences.xml Schema ==