Changes between Version 1 and Version 32 of Help/Preferences

(multiple changes)
(multiple changes)
(multiple changes)


  • Help/Preferences

    v1 v32  
    2 == Default location ==
     3= Preferences Overview =
     4The 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.
    4 (expand)
     6You 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.
    69== Menus ==
     10Most of the settings can be reached via menus in the [[JOSMImage(preference)]] [wikitr:/Help/Action/Preferences preferences dialog], See the individual panel pages:
     13English names
    8 Most of the settings can be reached via menus
    9 * [[Help/Action/Preferences]] (see also [[Help/Keys%20by%20menu]])
     16The same list with the translated names:
     17[wikitr:/Help/Preferences/Audio Audio], [wikitr:/Help/Preferences/Connection Connexion], [wikitr:/Help/Preferences/Display Affichage], [wikitr:/Help/Preferences/Imagery Imagerie], [wikitr:/Help/Preferences/ImportExport Importation Exportation], [wikitr:/Help/Preferences/Map Carte], [wikitr:/Help/Preferences/Plugins Greffons], [wikitr:/Help/Preferences/RemoteControl Contrôle à Distance], [wikitr:/Help/Preferences/Shortcuts Raccourcis clavier], [wikitr:/Help/Preferences/Toolbar barre d'outils], [wikitr:/Help/Preferences/Validator Validateur]
    1121== Other preferences ==
     22* [wikitr:"/Help/JOSM interface customization" JOSM interface customization]
    13 * [[Help/JOSM interface customization]]
    14 * [[Help/Preferences/Advanced]]
     25== JOSM preference/data/cache directories ==#JOSMpreferencedatacachedirectories
     27#JOSMpreferencedatacachedirectories is called from Help/Preferences/Plugins - Manual installation
     30JOSM stores 3 kinds of files in different directories:
     31 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.
     32 User data:: User-specific data files, for example, autosave data, plugins and ignored validator errors
     33 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.
     35The 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]
     37=== Windows ===
     38**Preferences** and **user data** is stored in
     42To 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.
     44The **cache** is located in
     48for Windows Vista and later.
     50This is typically `C:\Users\<YourName>\AppData\Local\JOSM\cache`.
     52On Windows XP and earlier, the cache is in `%APPDATA%\JOSM\cache`.
     54=== MacOS===
     55On MacOS, the default locations are as follows:
     56 Preferences:: `Users/<YourName>/Library/Preferences/JOSM`
     57 User data:: `Users/<YourName>/Library/JOSM`
     58 Cache:: `Users/<YourName>/Library/Caches/JOSM`
     60=== Linux ===
     61Since r11162, JOSM uses the [ XDG Base Directory Specification] for fresh installations, i.e.
     62 Preferences:: `$HOME/.config/JOSM`
     63 User data:: `$HOME/.local/share/JOSM`
     64 Cache:: `$HOME/.cache/JOSM`
     66JOSM respects the `$XDG_CONFIG_HOME`, `$XDG_DATA_HOME` and `$XDG_CACHE_HOME` environment variables to change these locations.
     68Prior to r11162, the locations were
     69 Preferences:: `$HOME/.josm`
     70 User data:: `$HOME/.josm`
     71 Cache:: `$HOME/.josm/cache`
     73JOSM 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.
     75Note 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`.
     77=== Customization (all operating systems) ===
     78==== Setting all 3 locations ====
     79The locations can be set using system properties specified from the [wikitr:/Help/CommandLineOptions command line]:
     80 Preferences:: `-Djosm.pref=...`
     81 User data:: `-Djosm.userdata=...`
     82 Cache:: `-Djosm.cache=...`
     84For example to store the cache located in `D:\cache\JOSM`, you would need to run a command like this:
     86java -Djosm.cache=D:\cache\JOSM -jar josm.jar
     89==== Setting a common directory ====
     90Alternatively, all 3 locations can be moved to a common location using the system property `-Djosm.home=...`.
     91For example with
     93java -Djosm.home=D:\myJOSM -jar josm.jar
     95the locations change to
     96 Preferences:: `D:\myJOSM`
     97 User data:: `D:\myJOSM`
     98 Cache:: `D:\myJOSM\cache`
     100==== Changing the directory base name ====
     101Instead of specifying the full path for the JOSM directories, you can use the system property `` 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:
     103java -jar josm-latest.jar
     105On Linux, the directories would then change to
     106 Preferences:: `$HOME/.config/JOSM-dev`
     107 User data:: `$HOME/.local/share/JOSM-dev`
     108 Cache:: `$HOME/.cache/JOSM-dev`
     110(For locations in the style prior to r11162, the lower-case version with the prepended dot will be used, e.g. `$HOME/.josm-dev`.)
     113=== preferences.xml Schema ===
     114See [/preferences-1.0.xml].
     116Some descriptions can be found in [wikitr:/Help/Preferences/ImportExport Custom configuration XML files for JOSM]
     118=== Auto save subfolder ===
     119Utilized by [wikitr:/Help/Action/AutoSave autosave function].
    16122== See also ==
    17 * [[Help/CommandLineOptions]]
     123* [wikitr:/Help/Action/About#InstallationDetails Installation details]
     124* [wikitr:/Help/ResetPreferences Reset preferences] - ways to reset preferences
     125* [wikitr:/Help/Action/AutoSave Autosave] feature
     126* [wikitr:/Help/CommandLineOptions Command line options] - how to change/load custom settings via command line
     130Back to [wikitr:/Help/Action/Preferences Preferences dialog] \\
     131Back to [wikitr:/Help Main Help]