Context: :grml:completion:compinit¶

This context revolves around the zshrc’s compinit function call, that initialises zsh’s function based completion system.

arguments

zstyle ':grml:completion:compinit' arguments -i

Only do this, if you know what sort of security checks are disabled if compaudit is not active and if that’s acceptable with your specific setup.

This style has to be set at the point that Grml’s zshrc runs compinit. A possible way to achieve this is to set it in ~/.zshrc.pre (see AUXILIARY FILES below for details).

dirstack handling¶

The dirstack in grmlzshrc has a persistent nature. It is stored into a file each time zsh’s working directory is changed. That file can be configured via the DIRSTACKFILE variable and it defaults to ~/.zdirs. The DIRSTACKSIZE variable defaults to 20 in this setup.

The DIRSTACKFILE is loaded each time zsh starts, therefore freshly started zshs inherit the dirstack of the zsh that most recently updated DIRSTACKFILE.

If you would like to disable the persistent dirstack feature altogether, you can do that by setting the boolean enable style to false in the right context (the default is true):

zstyle ':grml:chpwd:dirstack' enable false

It is possible to apply a filter to the names of directories that will be committed to the persistent dirstack file. There are two ways to configure this filter: A general function based filter and a pattern based filter. Both are setup via styles in the ':grml:chpwd:dirstack' context.

To use a function based filter set the filter style for that context to the name of a function to call every time a directory name is to be added to the persistent dirstack. If the function’s return value signals success (ie. return value "0"), the directory name is filtered out and not added to the persistent stack. Example:

function my_dirstack_filter() { [[ $1 == /tmp(|/*) ]] }
zstyle ':grml:chpwd:dirstack' filter my_dirstack_filter

The pattern based filter uses a list of patterns passed to the exclude style in the aforementioned context. Each pattern is tested and the first that matches will keep the directory name from being added to the persistent stack. If none of the patterns matches, the name is added. example:

zstyle ':grml:chpwd:dirstack' exclude "/tmp(|/*)" "$HOME/tmp(|/*)"

The function based filter is more general, the pattern based filter easier to set up. If both filter variants are used at the same time, the function based filter will be executed before the pattern based one.

If you would like to apply your filters while loading the persistent dirstack file, set the filter-on-load boolean style (the default is false):

zstyle ':grml:chpwd:dirstack' filter-on-load true

Setting the filter-on-load and enable styles needs to be done in ".zshrc.pre" because the styles need to be set when the main setup is executing! The other styles do not have this limitation, but enabling the system as well as the initial filtering will obviously be done using settings and filters that are configured at that point.

With respect to filter-on-load, the rule of thumb is: If you want to filter on load, setup everything in ".zshrc.pre" otherwise ".zshrc.local" works just as well.

Directory-based Profiles¶

If you need to perform certain actions each time you enter certain directory-trees, this is the feature you are looking for.

Initialisation¶

To initialise the system, you need to call the function `chpwd_profiles' at some point in your `zshrc.local'; preferably after you configured the system. The configuration of the system is described further below.

If you need to do initialisations the first time `chpwd_profiles' is called (which should be in your configuration file), you can do that in a function called "chpwd_profiles_init". That function needs to be defined before `chpwd_profiles' is called for this to work.

During the first call of `chpwd_profiles' (and therefore all its profile functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In all other cases, the parameter does not exist at all.

Styles and Profile-names¶

To store its configuration, the system uses functions and styles (zsh’s context sensitive configuration system), such as this:

zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)'   profile grml
zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian

When that’s done and you enter a directory that matches the pattern in the third part of the context, a function called chpwd_profile_grml, for example, is called (if it exists).

If no pattern matches (read: no profile is detected) the profile is set to 'default', which means chpwd_profile_default is attempted to be called.

A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command) which is used: The third part in the context is matched against ${PWD}. That’s why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the profile is detected for all these values of ${PWD}:

/foo/bar
/foo/bar/
/foo/bar/baz

So, if you want to make double damn sure a profile works in /foo/bar and everywhere deeper in that tree, just use (|/|/*) and be happy.

The name of the detected profile will be available in a variable called 'profile' in your functions. You don’t need to do anything, it’ll just be there.

Controlling Profile Execution¶

During its initialisation run, the system creates a parameter $CHPWD_PROFILE, which is set to the profile that was is currently active (the default value is "default"). That way you can avoid running code for a profile that is already active, by running code such as the following at the start of your function:

function chpwd_profile_grml() {


    [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1


  ...
}

If you know you are going to do that all the time for each and every directory-profile function you are ever going to write, you may also set the `re-execute' style to `false' (which only defaults to `true' for backwards compatibility), like this:

zstyle ':chpwd:profiles:*' re-execute false

Signaling availabily/profile changes¶

If you use this feature and need to know whether it is active in your current shell, there are several ways to do that. Here are two simple ways:

a) If knowing if the profiles feature is active when zsh starts is good enough for you, you can use the following snippet:

(( ${+functions[chpwd_profiles]} )) && print "directory profiles active"

b) If that is not good enough, and you would prefer to be notified whenever a profile changes, you can solve that by making sure you start every profile function you create like this:

function chpwd_profile_myprofilename() {


    [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1


    print "chpwd(): Switching to profile: $profile"


  ...
}

That makes sure you only get notified if a profile is changed, not everytime you change directory. (To avoid this, you may also set the newer `re-execute' style like described further above instead of the test on top of the function.

Leaving Profiles¶

When the system switches from one profile to another, it executes a function named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the profile-function for the new profile.

Accept-Line wrapper¶

The accept-line widget is the one that is taking action when the return key is hit. grmlzshrc uses a wrapper around that widget, which adds new functionality.

This wrapper is configured via styles. That means, you issue commands, that look like:

zstyle 'context' style value

The context namespace, that we are using is 'acceptline'. That means, the actual context for your commands look like: ':acceptline:<subcontext>'.

Where <subcontext> is one of: default, normal, force, misc or empty.

Recognized Contexts¶

default

normal

force

empty

misc

Available Styles¶

nocompwarn

compwarnfmt

rehash

actions

default_action

call_default

Prompt¶

The grmlzshrc now supplies three prompt themes compatible with zsh’s promptinit system. The three themes are called grml, grml-large and grml-chroot.

By default, grml is used, unless $GRMLPROMPT is set to a value larger than zero, in which case grml-large is used. Lastly, if $GRML_CHROOT is non-empty, grml-chroot is used.

As usual, with promptinit themes, the user may switch to a different theme using the prompt utility:

prompt grml-large

That will use the grml-large prompt theme.

The themes are highly customisable. The main source of documentation about customisation is the main grml theme’s doc-string, that is available via the following command:

prompt -h grml

The other themes also come with doc-strings, but the main theme’s is the canonical reference about all of them.

This feature requires version 4.3.7 of the shell. Older versions will use the classic grml prompt as a fallback.

A note to people who like customisation: If you are not using a prompt theme for your customisation, but you’re either statically setting $PS1 (or $PROMPT) or you’re constructing one of those variables in zsh’s \`precmd()' function, make sure you are turning the zsh’s prompt theme system off before doing so. A correct example customisation could look like this:

# Turn the prompt system off:
prompt off
# Customise the prompt yourself:
PS1='%~ %# '

You also add your own tokens by using the \`grml_theme_add_token()' function. Call the function without arguments for detailed documentation about that procedure.

GNU screen Status¶

grmlzshrc sets screen’s hardstatus lines to the currently running command or 'zsh' if the shell is idling at its prompt. If the current working directory is inside a repository unter version control, screen status is set to: 'zsh: <repository name>' via zsh’s vcs_info.

Persistent History¶

If you got commands you consider important enough to be included in every shell’s history, you can put them into $GRML_IMPORTANT_COMMANDS (which defaults for backward compatibility to ~/.important_commands) and they will be available via the usual history lookup widgets.

Environment Variables¶

grmlzshrc sets some environment variables, which influence the behaviour of applications.

COLORTERM

EDITOR

LESS_TERMCAP_*

MAIL

PAGER

Options¶

Apart from zsh’s default options, grmlzshrc sets some options that change the behaviour of zsh. Options that change Z-shell’s default settings are marked by <grml>. But note, that zsh’s defaults vary depending on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).

append_history

auto_cd <grml>

auto_pushd <grml>

completeinword <grml>

extended_glob <grml>

extended_history <grml>

hash_list_all

histignorespace <grml>

longlistjobs <grml>

nobeep <grml>

noglobdots

nohup <grml>

nonomatch <grml>

notify

pushd_ignore_dups <grml>

share_history <grml>

Keybindings¶

Apart from zsh’s default key bindings, grmlzshrc comes with its own set of key bindings. Note that bindings like ESC-e can also be typed as ALT-e on PC keyboards.

ESC-e

ESC-v

CTRL-x-1

CTRL-x-M()

CTRL-x-p

CTRL-x-z

CTRL-z

Customisation¶

To customise keybindings, you can just use zsh’s bindkey utility. However, if you plan to use the `zle-line-init' or `zle-line-finish' hooks yourself, make sure you call the following functions in the respective hook:

This is required so the keybindings set up by grmlzshrc work. The reason for this is to turn the terminal into the right mode while zsh’s line editor (zle) is running. This enables us to query terminfo about escape sequences for special keys and thus simplify and generalise our keybinding section.

Shell Functions¶

grmlzshrc comes with a wide array of defined shell functions to ease the user’s life.

accessed()

any()

asc()

bk()

cdt()

changed()

check_com()

cl()

dchange()

dcopyright()

debian2hd()

deswap()

dnews()

edalias()

edfunc()

freload()

grml_status_features()

grml_vcs_info_toggle_colour()

hgdi()

hgstat()

hidiff()

isdarwin()

isfreebsd()

isgrml()

isgrmlcd()

isgrmlsmall()

islinux()

isopenbsd()

isutfenv()

mkcd()

modified()

nt()

% NTREF=/reference/file
% ls -l *(e:nt:)
% # Inline:
% ls -l *(e:'nt /reference/file':)

profile()

salias()

simple-extract()

sll()

ssl-cert-fingerprints

ssl-cert-info

ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()

Start(), Restart(), Stop(), Force-Reload(), Reload()

% Restart ssh

trans()

uchange()

vim()

whatwhen()

xcat()

xsource()

xtrename()

zrcautoload()

zrclocal()

Aliases¶

grmlzshrc comes with a wide array of predefined aliases to ease the user’s life. A few aliases (like those involving grep or ls) use the option --color=auto for colourizing output. That option is part of GNU implementations of these tools, and will only be used if such an implementation is detected.

acp (apt-cache policy)

acs (apt search)

acsh (apt show)

adg (apt dist-upgrade)

ag (apt upgrade)

agi (apt install)

ati (aptitude install)

au (apt update)

afs (apt-file search)

da (du -sch)

dbp (dpkg-buildpackage)

debs-by-size (grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn)

dir (ls -lSrah)

ge (grep-excuses)

grep (grep --color=auto)

grml-version (cat /etc/grml_version)

insecscp (scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null")

insecssh (ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null")

help-zshglob (H-Glob())

l (ls -l --color=auto)

la (ls -la --color=auto)

lad (ls -d .*(/))

lh (ls -hAl --color=auto)

ll (ls -l --color=auto)

llog ($PAGER /var/log/syslog)

ls (ls -C --color=auto)

lsa (ls -a .*(.))

lsbig (ls -flh *(.OL[1,10]))

lsd (ls -d *(/))

lse (ls -d *(/^F))

lsl (ls -l *(@))

lsnew (ls -rl *(D.om[1,10]))

lsnewdir (ls -rthdl *(/om[1,10]) .*(D/om[1,10]))

lsold (ls -rtlh *(D.om[1,10]))

lsolddir (ls -rthdl *(/Om[1,10]) .*(D/Om[1,10]))

lss (ls -l *(s,S,t))

lssmall (ls -Srl *(.oL[1,10]))

lsw (ls -ld *(R,W,X.^ND/))

lsx (ls -l *(*))

mdstat (cat /proc/mdstat)

mq (hg -R $(readlink -f $(hg root)/.hg/patches))

rmcdir ('cd ..; rmdir $OLDPWD || cd $OLDPWD)

screen (screen -c file)

su (sudo su)

tlog (tail --follow=name /var/log/syslog)

up (aptitude update ; aptitude safe-upgrade)

url-quote (autoload -U url-quote-magic ; zle -N self-insert url-quote-magic)

$(uname -r)-reboot (kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)")

... (cd ../../)