diff --git a/README.md b/README.md index 2a761c0..174dc47 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,44 @@ There is no place like $HOME. Home directory setup and bootstrapping guide. ## Table of Contents -* [Features](#features) +* [Directories](#directories) * [Todos](#todos) * [Usage](#usage) * [Acknowledgments](#acknowledgments) * [License](#license) -## Features -- [ ] Dotfiles -- [ ] XDG -- [ ] Setup Scripts +## Directories +xdg-user-dirs is a tool to help manage "well known" user directories like the +desktop folder and the music folder. It also handles localization +(i.e. translation) of the filenames. + +xdg-user-dirs-update is ran early in the login phase. It reads a configuration +file `/etc/xdg/xdg-user-dirs.defaults`. You should replace this file as root +before logging in or opening the file manager. Here is the updated file after +truncating names. + +```text +# Default settings for user directories +# +# The values are relative pathnames from the home directory and +# will be translated on a per-path-element basis into the users locale +DESKTOP=gui +DOWNLOAD=dl +TEMPLATES=eg +PUBLICSHARE=pub +DOCUMENTS=docs +MEDIA=media +MUSIC=media/music +PICTURES=media/pics +VIDEOS=media/vids +# Another alternative is: +#MUSIC=Documents/Music +#PICTURES=Documents/Pictures +#VIDEOS=Documents/Videos +``` +These are not all the directories, just the ones with XDG functionality. Some +of the may need to be downloaded. ## Todos