AppDirs

user_data_dir(appname=nothing, appauthor=nothing, version=nothing,
              roaming::Bool=false)

Return full path to the user-specific data dir for this application.

• appname is the name of application. If nothing, just the system directory is returned.

• appauthor (only used on Windows) is the name of the appauthor or distributing body for this application. Typically it is the owning company name. This falls back to appname. You may pass false to disable it.

• version is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>". Only applied when appname is present.

• roaming (default false) can be set true to use the Windows roaming appdata directory. That means that for users on a Windows network setup for roaming profiles, this user data will be sync'd on login. See here for a discussion of issues.

Typical user data directories are:

site_data_dir(appname=nothing, appauthor=nothing; version=nothing,
              multipath::Bool=false)

Return full path to the user-shared data dir for this application.

• appname is the name of application. If nothing, just the system directory is returned.

• appauthor (only used on Windows) is the name of the appauthor or distributing body for this application. Typically it is the owning company name. This falls back to appname. You may pass false to disable it.

• version is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>". Only applied when appname is present.

• multipath is an optional parameter only applicable to *nix which indicates that the entire list of data dirs should be returned. By default, the first item from XDG_DATA_DIRS is returned, or /usr/local/share/<AppName>, if XDG_DATA_DIRS is not set

Typical site data directories are:

user_config_dir(appname=nothing, appauthor=nothing; version=nothing,
                roaming::Bool=false)

Return full path to the user-specific config dir for this application.

• appname is the name of application. If nothing, just the system directory is returned.

• appauthor (only used on Windows) is the name of the appauthor or distributing body for this application. Typically it is the owning company name. This falls back to appname. You may pass false to disable it.

• version is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>". Only applied when appname is present.

• roaming (default false) can be set true to use the Windows roaming appdata directory. That means that for users on a Windows network setup for roaming profiles, this user data will be sync'd on login. See here for a discussion of issues.

Typical user config directories are:

site_config_dir(appname=nothing, appauthor=nothing; version=nothing,
                multipath::Bool=false)

Return full path to the user-shared config dir for this application.

• appname is the name of application. If nothing, just the system directory is returned.

• appauthor (only used on Windows) is the name of the appauthor or distributing body for this application. Typically it is the owning company name. This falls back to appname. You may pass false to disable it.

• version is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>". Only applied when appname is present.

• multipath is an optional parameter only applicable to *nix which indicates that the entire list of config dirs should be returned. By default, the first item from XDG_CONFIG_DIRS is returned, or /etc/xdg/<AppName>, if XDG_CONFIG_DIRS is not set

Typical site config directories are:

user_cache_dir(appname=nothing, appauthor=nothing; version=nothing,
               opinion::Bool=true)

Return full path to the user-specific cache dir for this application.

• appname is the name of application. If nothing, just the system directory is returned.

• appauthor (only used on Windows) is the name of the appauthor or distributing body for this application. Typically it is the owning company name. This falls back to appname. You may pass false to disable it.

• version is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>". Only applied when appname is present.

• opinion (default true) can be false to disable the appending of Cache to the base app data dir for Windows. See discussion below.

Typical user cache directories are:

On Windows the only suggestion in the MSDN docs is that local settings go in the CSIDL_LOCAL_APPDATA directory. This is identical to the non-roaming app data dir (the default returned by user_data_dir). Apps typically put cache data somewhere under the given dir here. Some examples:

• ...\Mozilla\Firefox\Profiles\<ProfileName>\Cache
• ...\Acme\SuperApp\Cache\1.0

user_state_dir(appname=nothing, appauthor=nothing; version=nothing,
               roaming::Bool=false)

Return full path to the user-specific state dir for this application.

• appname is the name of application. If nothing, just the system directory is returned.

• appauthor (only used on Windows) is the name of the appauthor or distributing body for this application. Typically it is the owning company name. This falls back to appname. You may pass false to disable it.

• version is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>". Only applied when appname is present.

• roaming (default false) can be set true to use the Windows roaming appdata directory. That means that for users on a Windows network setup for roaming profiles, this user data will be sync'd on login. See here for a discussion of issues.

Typical user state directories are:

user_log_dir(appname=nothing, appauthor=nothing, version=nothing,
             opinion::Bool=true)

Return full path to the user-specific log dir for this application.

• appname is the name of application. If nothing, just the system directory is returned.

• appauthor (only used on Windows) is the name of the appauthor or distributing body for this application. Typically it is the owning company name. This falls back to appname. You may pass false to disable it.

• version is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>". Only applied when appname is present.

• opinion (default true) can be false to disable the appending of Logs to the base app data dir for Windows, and log to the base cache dir for Unix. See discussion below.

Typical user log directories are:

On Windows the only suggestion in the MSDN docs is that local settings go in the CSIDL_LOCAL_APPDATA directory.

AppDir(appname=nothing, appauthor=nothing, version=nothing,
       roaming::Bool=false, multipath::Bool=false)

Convenience wrapper for getting application dirs, with the following fields:

• data: the output of user_data_dir
• site_data: the output of site_data_dir
• config: the output of user_config_dir
• site_config: the output of site_config_dir
• cache: the output of user_cache_dir
• state: the output of user_state_dir
• log: the output of user_log_dir