Changes between Version 1 and Version 36 of Help/Preferences


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

Legend:

Unmodified
Added
Removed
Modified
  • Help/Preferences

    v1 v36  
     1[[TranslatedPages]]
     2[[PageOutline(2-10,Table of Contents)]]
    13
    2 == Default location ==
     4= Preferences Overview =
     5The preference data in JOSM is composed of a set of name->value pairs. The setting names are mostly ''namespaced'' with dot `.` separated words. Many JOSM plugins store their preferences grouped in a namespace.
    36
    4 (expand)
     7You can get a similar raw view by viewing these files, but the preferences' panel [[JOSMImage(preferences/advanced,link=,24,middle)]] [wikitr:/Help/Preferences/Advanced advanced preferences] is intended to provide an easier alternative.
    58
    6 == Menus ==
    7 
    8 Most of the settings can be reached via menus
    9 * [[Help/Action/Preferences]] (see also [[Help/Keys%20by%20menu]])
     9Most of the settings can be reached via menus in the [[JOSMImage(preference)]] [wikitr:/Help/Action/Preferences preferences dialog].
    1010
    1111== Other preferences ==
     12* [wikitr:"/Help/JOSM interface customization" JOSM interface customization]
    1213
    13 * [[Help/JOSM interface customization]]
    14 * [[Help/Preferences/Advanced]]
     14
     15== JOSM preference/data/cache directories ==#JOSMpreferencedatacachedirectories
     16{{{#!comment
     17#JOSMpreferencedatacachedirectories is called from Help/Preferences/Plugins - Manual installation
     18}}}
     19
     20JOSM stores 3 kinds of files in different directories:
     21 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.
     22 User data:: User-specific data files, for example, autosave data, plugins and ignored validator errors
     23 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.
     24
     25The default location of the directories depends on your operating system and is listed in the [wikitr:/Help/Action/About#InstallationDetails Installation details] tab of the [[JOSMImage(logo_48x48x32,link=,middle,24)]][wikitr:/Help/Action/About About dialog] in the [wikitr:/Help/Menu/Help Help menu]
     26
     27=== Windows ===
     28**Preferences** and **user data** is stored in
     29{{{
     30%APPDATA%\JOSM
     31}}}
     32To locate this folder, try opening Explorer window and paste the 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=== MacOS===
     45On MacOS, the default locations are as follows:
     46 Preferences:: `Users/<YourName>/Library/Preferences/JOSM`
     47 User data:: `Users/<YourName>/Library/JOSM`
     48 Cache:: `Users/<YourName>/Library/Caches/JOSM`
     49
     50=== Linux ===
     51Since r11162, JOSM uses the [https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html XDG Base Directory Specification] for fresh installations, i.e.
     52 Preferences:: `$HOME/.config/JOSM`
     53 User data:: `$HOME/.local/share/JOSM`
     54 Cache:: `$HOME/.cache/JOSM`
     55
     56JOSM respects the `$XDG_CONFIG_HOME`, `$XDG_DATA_HOME` and `$XDG_CACHE_HOME` environment variables to change these locations.
     57
     58Prior to r11162, the locations were
     59 Preferences:: `$HOME/.josm`
     60 User data:: `$HOME/.josm`
     61 Cache:: `$HOME/.josm/cache`
     62
     63If JOSM is installed via flatpak, the locations are
     64 Preferences:: `$HOME/.var/app/org.openstreetmap.josm/config`
     65 User data:: `$HOME/.var/app/org.openstreetmap.josm/data`
     66 Cache:: `$HOME/.var/app/org.openstreetmap.josm/cache`
     67
     68
     69JOSM 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.
     70
     71Note 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`.
     72
     73=== Customization (all operating systems) === #Customizationalloperatingsystems
     74==== Setting all 3 locations ====
     75The locations can be set using system properties specified from the [wikitr:/Help/CommandLineOptions command line]:
     76 Preferences:: `-Djosm.pref=...`
     77 User data:: `-Djosm.userdata=...`
     78 Cache:: `-Djosm.cache=...`
     79
     80For example to store the cache located in `D:\cache\JOSM`, you would need to run a command like this:
     81{{{
     82java -Djosm.cache=D:\cache\JOSM -jar josm.jar
     83}}}
     84
     85==== Setting a common directory ====
     86Alternatively, all 3 locations can be moved to a common location using the system property `-Djosm.home=...`.
     87For example with
     88{{{
     89java -Djosm.home=D:\myJOSM -jar josm.jar
     90}}}
     91the locations change to
     92 Preferences:: `D:\myJOSM`
     93 User data:: `D:\myJOSM`
     94 Cache:: `D:\myJOSM\cache`
     95
     96==== Changing the directory base name ====
     97Instead 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 version like this:
     98{{{#!sh
     99java -Djosm.dir.name=JOSM-dev -jar josm-latest.jar
     100}}}
     101On Linux, the directories would then change to
     102 Preferences:: `$HOME/.config/JOSM-dev`
     103 User data:: `$HOME/.local/share/JOSM-dev`
     104 Cache:: `$HOME/.cache/JOSM-dev`
     105
     106(For locations in the style prior to r11162, the lower-case version with the prepended dot will be used, e.g. `$HOME/.josm-dev`.)
     107
     108
     109=== preferences.xml Schema ===
     110See [/preferences-1.0.xml].
     111
     112Some descriptions can be found in [wikitr:/Help/Preferences/ImportExport Custom configuration XML files for JOSM]
     113
     114=== Auto save subfolder ===
     115Utilized by [wikitr:/Help/Action/AutoSave autosave function].
     116
    15117
    16118== See also ==
    17 * [[Help/CommandLineOptions]]
     119* [wikitr:/Help/Action/About#InstallationDetails Installation details]
     120* [wikitr:/Help/ResetPreferences Reset preferences] - ways to reset preferences
     121* [wikitr:/Help/Action/AutoSave Autosave] feature
     122* [wikitr:/Help/CommandLineOptions Command line options] - how to change/load custom settings via command line
     123
     124
     125----
     126Back to [wikitr:/Help/Action/Preferences Preferences dialog] \\
     127Back to [wikitr:/Help Main Help]