phi-li / dotfiles

dotfiles

XDG Base Directory

https://wiki.archlinux.org/index.php/XDG_Base_Directory

Specification

Only XDG_RUNTIME_DIR is set by default through pam_systemd. It is up to the user to explicitly define the other variables, using absolute paths that point to existing directories.

User directories

• XDG_CONFIG_HOME

  • User-specific configurations (analogous to /etc)
  • Default: $HOME/.config

• XDG_CACHE_HOME

  • User-specific non-essential (cached) data (analogous to /var/cache)
  • Default: $HOME/.cache

• XDG_DATA_HOME

  • User-specific data files (analogous to /usr/share)
  • Default: $HOME/.local/share

• XDG_RUNTIME_DIR

System directories

List of directories seperated by : (analogous to PATH)

• XDG_DATA_DIRS

  • Default: /usr/local/share:/usr/share

• XDG_CONFIG_DIRS

  • Default: /etc/xdg

XDG user directories

https://wiki.archlinux.org/index.php/XDG_user_directories

Creating default directories

$ xdg-user-dirs-update

Creating custom directories

~/.config/user-dirs.dirs
---
XDG_DESKTOP_DIR="$HOME/Desktop"
XDG_DOCUMENTS_DIR="$HOME/Documents"
XDG_DOWNLOAD_DIR="$HOME/Downloads"
XDG_MUSIC_DIR="$HOME/Music"
XDG_PICTURES_DIR="$HOME/Pictures"
XDG_PUBLICSHARE_DIR="$HOME/Public"
XDG_TEMPLATES_DIR="$HOME/Templates"
XDG_VIDEOS_DIR="$HOME/Videos

$ xdg-user-dirs-update --set DOWNLOAD ~/Internet

Writing unit files

https://wiki.archlinux.org/index.php/systemd#Writing_unit_files

The syntax of systemd's unit files is inspired by XDG Desktop Entry Specification .desktop files, which are in turn inspired by Microsoft Windows .ini files. Unit files are loaded from multiple locations (to see the full list, run systemctl show --property=UnitPath), but the main ones are (listed from lowest to highest precedence):

• /usr/lib/systemd/system/: units provided by installed packages
• /etc/systemd/system/: units installed by the system administrator

systemd.unit — Unit configuration

https://www.freedesktop.org/software/systemd/man/systemd.unit.html

Unit File Load Path

Table 1. Load path when running in system mode (--system).

Path	Description
/etc/systemd/system.control	Persistent and transient configuration created using the dbus API
/run/systemd/system.control	(Same as above)
/run/systemd/transient	Dynamic configuration for transient units
/run/systemd/generator.early	Generated units with high priority (see early-dir in systemd.generator(7))
/etc/systemd/system	System units created by the administrator
/run/systemd/system	Runtime units
/run/systemd/generator	Generated units with medium priority (see normal-dir in systemd.generator(7))
/usr/local/lib/systemd/system	System units installed by the administrator
/usr/lib/systemd/system	System units installed by the distribution package manager
/run/systemd/generator.late	Generated units with low priority (see late-dir in systemd.generator(7))

Table 2. Load path when running in user mode (--user).

Path	Description
$XDG_CONFIG_HOME/systemd/user.control or ~/.config/systemd/user.control	Persistent and transient configuration created using the dbus API ($XDG_CONFIG_HOME is used if set, ~/.config otherwise)
$XDG_RUNTIME_DIR/systemd/user.control	(Same as above)
/run/systemd/transient	Dynamic configuration for transient units
/run/systemd/generator.early	Generated units with high priority (see early-dir in systemd.generator(7))
$XDG_CONFIG_HOME/systemd/user or $HOME/.config/systemd/user	User configuration ($XDG_CONFIG_HOME is used if set, ~/.config otherwise)
/etc/systemd/user	User units created by the administrator
$XDG_RUNTIME_DIR/systemd/user	Runtime units (only used when $XDG_RUNTIME_DIR is set)
/run/systemd/user	Runtime units
$XDG_RUNTIME_DIR/systemd/generator	Generated units with medium priority (see normal-dir in systemd.generator(7))
$XDG_DATA_HOME/systemd/user or $HOME/.local/share/systemd/user	Units of packages that have been installed in the home directory ($XDG_DATA_HOME is used if set, ~/.local/share otherwise)
$dir/systemd/user for each $dir in $XDG_DATA_DIRS	Additional locations for installed user units, one for each entry in $XDG_DATA_DIRS
/usr/local/lib/systemd/user	User units installed by the administrator
/usr/lib/systemd/user	User units installed by the distribution package manager
$XDG_RUNTIME_DIR/systemd/generator.late	Generated units with low priority (see late-dir in systemd.generator(7))

Zsh Startup/Shutdown files

Tip:

• See A User's Guide to the Z-Shell for explanation on interactive and login shells, and what to put in your startup files.
• You could consider implementing a standard path for your Zsh configuration files.

Note:

• If $ZDOTDIR is not set, $HOME is used instead.
• If option RCS is unset in any of the files, no configuration files will be read after that file.
• If option GLOBAL_RCS is unset in any of the files, no global configuration files (/etc/zsh/*) will be read after that file.

When starting, Zsh will read commands from the following files in this order by default:

1. /etc/zsh/zshenv Used for setting environment variables for all users; it should not contain commands that produce output or assume the shell is attached to a TTY. This file will always be read, this cannot be overridden.
2. $ZDOTDIR/.zshenv Used for setting user's environment variables; it should not contain commands that produce output or assume the shell is attached to a TTY. This file will always be read.
3. /etc/zsh/zprofile Used for executing commands at start for all users, will be read when starting as a login shell. Please note that on Arch Linux, by default it contains one line which source the /etc/profile.
   • /etc/profile This file should be sourced by all POSIX sh-compatible shells upon login: it sets up $PATH and other environment variables and application-specific (/etc/profile.d/*.sh) settings upon login.
4. $ZDOTDIR/.zprofile Used for executing user's commands at start, will be read when starting as a login shell. Typically used to autostart graphical sessions and to set session-wide environment variables.
5. /etc/zsh/zshrc Used for setting interactive shell configuration and executing commands for all users, will be read when starting as an interactive shell.
6. $ZDOTDIR/.zshrc Used for setting user's interactive shell configuration and executing commands, will be read when starting as an interactive shell.
7. /etc/zsh/zlogin Used for executing commands for all users at ending of initial progress, will be read when starting as a login shell.
8. $ZDOTDIR/.zlogin Used for executing user's commands at ending of initial progress, will be read when starting as a login shell. Typically used to autostart command line utilities. Should not be used to autostart graphical sessions, as at this point the session might contain configuration meant only for an interactive shell.
9. $ZDOTDIR/.zlogout Used for executing commands for all users when a login shell exits.
10. /etc/zsh/zlogout Used for executing commands when a login shell exits.

See the graphic representation.

Note:

• $HOME/.profile is not a part of the Zsh startup files and is not sourced by Zsh unless Zsh is invoked as sh or ksh and started as a login shell. For more details about the sh and ksh compatibility modes refer to zsh(1).
• The paths used in Arch's zsh package are different from the default ones used in the man pages (FS#48992).

Warning: Do not remove the default one line in /etc/zsh/zprofile, otherwise it will break the integrity of other packages which provide some scripts in /etc/profile.d/.