Module platformdirs.platforms.unix
respect XDG base directories and XDG user directories
Functions
| getenv (env, default) | |
| M.PlatformDirs:new (platformdirs) | |
| M.PlatformDirs.get_home () |
user/site directories
| M.PlatformDirs:user_data_dir () | /home/$USER/.local/share/$app/$version |
| M.PlatformDirs:site_data_dirs () | |
| M.PlatformDirs:site_data_dir () | /usr/share/$app/$version:/usr/local/share/$app/$version |
| M.PlatformDirs:user_config_dir () | /home/$USER/.config/$app/$version |
| M.PlatformDirs:site_config_dirs () | |
| M.PlatformDirs:site_config_dir () | /etc/xdg/$app/$version |
| M.PlatformDirs:user_cache_dir () | /home/$USER/.cache/$app/$version |
| M.PlatformDirs:site_cache_dir () | /var/cache/$app/$version |
| M.PlatformDirs:user_state_dir () | /home/$USER/.local/state/$app/$version |
| M.PlatformDirs:user_runtime_dir () | Linux: /run/user/1000/$app/$version
BSD: /var/run/user/1000/$app/$version
fallback: /tmp/runtime-1000/$app/$version |
| M.PlatformDirs:site_runtime_dir () | Linux: /run/$app/$version
BSD: /var/run/$app/$version |
user directories
| M.PlatformDirs:user_documents_dir () | /home/$USER/Documents |
| M.PlatformDirs:user_downloads_dir () | /home/$USER/Downloads |
| M.PlatformDirs:user_pictures_dir () | /home/$USER/Pictures |
| M.PlatformDirs:user_videos_dir () | /home/$USER/Videos |
| M.PlatformDirs:user_music_dir () | /home/$USER/Music |
| M.PlatformDirs:user_desktop_dir () | /home/$USER/Desktop |
Functions
- getenv (env, default)
-
Parameters:
- env string
- default string
Returns:
-
string
- M.PlatformDirs:new (platformdirs)
-
Parameters:
- platformdirs table?
Returns:
-
table platformdirs
- M.PlatformDirs.get_home ()
-
Returns:
-
string
user/site directories
- M.PlatformDirs:user_data_dir ()
-
/home/$USER/.local/share/$app/$versionReturns:
-
string
- M.PlatformDirs:site_data_dirs ()
-
Returns:
-
string[]
- M.PlatformDirs:site_data_dir ()
-
/usr/share/$app/$version:/usr/local/share/$app/$versionReturns:
-
string
- M.PlatformDirs:user_config_dir ()
-
/home/$USER/.config/$app/$versionReturns:
-
string
- M.PlatformDirs:site_config_dirs ()
-
Returns:
-
string[]
- M.PlatformDirs:site_config_dir ()
-
/etc/xdg/$app/$versionReturns:
-
string
- M.PlatformDirs:user_cache_dir ()
-
/home/$USER/.cache/$app/$versionReturns:
-
string
- M.PlatformDirs:site_cache_dir ()
-
/var/cache/$app/$versionReturns:
-
string
- M.PlatformDirs:user_state_dir ()
-
/home/$USER/.local/state/$app/$versionReturns:
-
string
- M.PlatformDirs:user_runtime_dir ()
-
Linux:
/run/user/1000/$app/$versionBSD:/var/run/user/1000/$app/$versionfallback:/tmp/runtime-1000/$app/$versionReturns:
-
string
- M.PlatformDirs:site_runtime_dir ()
-
Linux:
/run/$app/$versionBSD:/var/run/$app/$versionReturns:
-
string
user directories
- M.PlatformDirs:user_documents_dir ()
-
/home/$USER/DocumentsReturns:
-
string
- M.PlatformDirs:user_downloads_dir ()
-
/home/$USER/DownloadsReturns:
-
string
- M.PlatformDirs:user_pictures_dir ()
-
/home/$USER/PicturesReturns:
-
string
- M.PlatformDirs:user_videos_dir ()
-
/home/$USER/VideosReturns:
-
string
- M.PlatformDirs:user_music_dir ()
-
/home/$USER/MusicReturns:
-
string
- M.PlatformDirs:user_desktop_dir ()
-
/home/$USER/DesktopReturns:
-
string