brandon/oam
1
0
Fork 0
mirror of https://gitea.com/mcereda/oam.git synced 2026-02-09 05:44:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e48c457d6689fd240f5af5c9666b1fed008cae8a
oam/knowledge base/zsh.md
Michele Cereda 4a7dd8d7c2 Added notes to the knowledge base
2022-04-20 21:17:16 +02:00

7.3 KiB
Raw Blame History

ZSH

TL;DR

Startup file sequence:

  1. /etc/zshenv and ${ZDOTDIR}/.zshenv
  2. login shells only: /etc/zprofile and ${ZDOTDIR}/.zprofile
  3. interactive shell only: /etc/zshrc and ${ZDOTDIR}/.zshrc
  4. login shells only: /etc/zlogin and ${ZDOTDIR}/.zlogin
  5. upon exit: /etc/zlogout and ${ZDOTDIR}/.zlogout

Aliases are expanded when the function definition is parsed, not when the function is executed. Define aliases before functions to avoid problems.

# create a function
function_name () { … }
function function_name { … }
function function_name () { … }

# regex match
[[ $OSTYPE =~ "darwin" ]]
[[ $OSTYPE -regex-match "darwin" ]]

# find broken symlinks in the current directory
ls **/*(-@)

# print all shell and environment variables
( setopt posixbuiltin; set; )

Alias expansion

When one writes an alias, one can also press ctrl-x followed by a to see the expansion of that alias.

Arrays

# get a slice (negative are backwards)
echo ${ARRAY[2,-1]}

# get all folders up to a non folder, backwards
local COMMAND
local FOLDERS=()
for (( I = $# ; I >= 0 ; I-- )); do
  if [[ -d "${@[$I]}" ]]; then
    FOLDERS+="${@[$I]}"
  else
    COMMAND="${@[1,-$((${#FOLDERS}+1))]}"
    break
  fi
done

# make entries in PATH unique
# see https://til.hashrocket.com/posts/7evpdebn7g-remove-duplicates-in-zsh-path
typeset -aU path

Tests

# regex match
[[ $OSTYPE =~ "darwin" ]]
[[ $OSTYPE -regex-match "darwin" ]]

Find broken symlinks in the current directory

ls **/*(-@)

Configuration

Config files read order

  1. /etc/zshenv; this cannot be overridden
    subsequent behaviour is modified by the RCS and GLOBAL_RCS options:

    • RCS affects all startup files
    • GLOBAL_RCS only affects global startup files (those shown here with an path starting with a /)

    If one of the options is unset at any point, any subsequent startup file(s) of the corresponding type will not be read.
    It is also possible for a file in $ZDOTDIR to re-enable GLOBAL_RCS.
    Both RCS and GLOBAL_RCS are set by default

  2. $ZDOTDIR/.zshenv

  3. if the shell is a login shell:

    1. /etc/zprofile
    2. $ZDOTDIR/.zprofile

  4. if the shell is interactive:

    1. /etc/zshrc
    2. $ZDOTDIR/.zshrc

  5. if the shell is a login shell:

    1. /etc/zlogin
    2. $ZDOTDIR/.zlogin

  6. when a login shell exits:

    1. $ZDOTDIR/.zlogout
    2. /etc/zlogout

    This happens with either an explicit exit via the exit or logout commands, or an implicit exit by reading end-of-file from the terminal.
    However, if the shell terminates due to exec’ing another process, the files are not read. These are also affected by the RCS and GLOBAL_RCS options.
    The RCS option affects the saving of history files, i.e. if RCS is unset when the shell exits, no history file will be saved.

If ZDOTDIR is unset, HOME is used instead. Files listed above as being in /etc may be in another directory, depending on the installation.

/etc/zshenv is run for all instances of zsh.
it is a good idea to put code that does not need to be run for every single shell behind a test of the form if [[ -o rcs ]]; then ... so that it will not be executed when zsh is invoked with the -f option.

When /etc/zprofile is installed it will override PATH and possibly other variables that a user may set in ~/.zshenv. Custom PATH settings and similar overridden variables can be moved to ~/.zprofile or other user startup files that are sourced after the /etc/zprofile.
If PATH must be set in ~/.zshenv to affect things like non-login ssh shells, one method is to use a separate path-setting file that is conditionally sourced in ~/.zshenv and also sourced from ~/.zprofile.

History

# The maximum number of events stored in the internal history list.
# If you use the HIST_EXPIRE_DUPS_FIRST option, setting this value larger than
# the SAVEHIST size will give you the difference as a cushion for saving
# duplicated history events.
HISTSIZE=1000

# The file to save the history in when an interactive shell exits.
# If unset, the history is not saved.
HISTFILE=~/.histfile

# The maximum number of history events to save in the history file.
SAVEHIST=1000

Completion

# Enable completion
autoload -U compinit
compinit

# Enable cache for the completions
zstyle ':completion::complete:*' use-cache true

Prompt management

# Enable prompt management
autoload -U promptinit
promptinit; prompt gentoo

Automatic source of files in a folder

# Configuration modules.
# All files in the configuration folder will be automatically loaded in
# numeric order. The last file setting a value overrides the previous ones.
# Links are only sourced if their reference exists.
ZSH_MODULES_DIR="${ZSH_MODULES_DIR:-$HOME/.zshrc.d}"
if [[ -d "${ZSH_MODULES_DIR}" ]]
then
	for ZSH_MODULE in ${ZSH_MODULES_DIR}/*
	do
		[[ -r ${ZSH_MODULE} ]] && source "${ZSH_MODULE}"
	done
	unset ZSH_MODULE
fi

Frameworks

Plugins

Troubleshooting

zsh compinit: insecure directories and files, run compaudit for list

compaudit | xargs chmod g-w

Further readings