= Zsh Configuration for Alpine Linux :proj-name: alpine-zsh-config :gh-name: jirutka/{proj-name} // Enable kbd:[] macro :experimental: :osc133-spec-url: https://gitlab.freedesktop.org/Per_Bothner/specifications/blob/master/proposals/semantic-prompts.md
ifdef::env-github[] image:https://github.com/{gh-name}/workflows/CI/badge.svg[Binaries Workflow, link=https://github.com/{gh-name}/actions?query=workflow%3A%22CI%22] endif::env-github[]
The aim of this project is to provide a sensible default (system-wide) https://www.zsh.org/[Zsh] configuration that will meet the basic needs and expectations of most users. In other words, make Zsh easy to use right out of the box, without having to configure it, while not getting in the way of individual user customization.
== Features
/etc/inputrc
(and thus with ash, bash and any other program using readline). ^link:zshrc.d/50-key-bindings.zsh[50-key-bindings.zsh]^TIP: If you as a user want to disable some of these features, define variable zshrc_blacklist
with an array of the script names (without .zsh
suffix) in your $ZDOTDIR/.zshenv
footnote:zshenv[$ZDOTDIR/.zshenv
is by default ~/.config/zsh/.zshenv
, or ~/.zshenv
if ~/.zshrc
exists.], for example: zshrc_blacklist=(50-command-not-found 70-completion)
.
=== Key Bindings
List of key bindings defined in the emacs
, viins
, and vicmd
keymaps.
== Configuration Variables
Users can define the following configuration variables in their $ZDOTDIR/.zshenv
footnote:zshenv[] to override the default settings.
|=== | Variable Name | Default Value | Description
| ZSH_CACHE_DIR
| $XDG_CACHE_HOME/zsh
or $HOME/.cache/zsh
| Path to a directory where to store cache files (e.g. completion cache). If it doesn’t exist, it will be created.
| ZSH_DATA_DIR
| $XDG_DATA_HOME/zsh
or $HOME/.local/share/zsh
| Path to a directory where to store persistent data files (e.g. Zsh history). If it doesn’t exist, it will be created.
| ZSH_COMPDUMP
| $ZSH_CACHE_DIR/zcompdump
| Path to the Zsh completion dump file.
| HISTFILE
| $ZSH_DATA_DIR/history
or $ZDOTDIR/.zsh_history
or $HOME/.zsh_history
| Path to the Zsh history file. If ${ZDOTDIR:-$HOME}/.zsh_history
exists, it will be preferred.
| ZSH_CUTBUFFER_CLIPBOARD
| "primary"
| The system clipboard to synchronize the kill (cut) buffer with; either "primary"
(selection), or "clipboard"
(regular clipboard).
| osc52_supported_terms
| ('alacritty' 'foot' 'xterm-kitty')
| An array of $TERM
values that identify terminals with OSC 52 support (access to system clipboard). This is just a shortcut to skip dynamic detection using tty-copy --test
for known terminals.
|===
== Requirements
== Installation
Install package https://pkgs.alpinelinux.org/packages?name={proj-name}[{proj-name}] on Alpine Linux Edge, v3.16 or later:
[source, sh, subs="+attributes"] apk add {proj-name}
== License
This project is licensed under http://opensource.org/licenses/MIT/[MIT License]. For the full text of the license, see the link:LICENSE[LICENSE] file.