6 %!postproc(man): "^(\.TH.*) 1 " "\1 5 "
10 grmlzshrc - Grml's zsh setup
14 //zsh// [**options**]...
18 The Grml project provides a fairly exhaustive interactive setup (referred to
19 as //grmlzshrc// throughout this document) for the amazing unix shell zsh
20 (http://zsh.sourceforge.net). This is the reference manual for that
23 To use //grmlzshrc//, you need at least version 3.1.7 of zsh (although not all
24 features are enabled in every version).
26 //grmlzshrc// behaves differently depending on which user loads it. For the
27 root user (**EUID** == 0) only a subset of features is loaded by default. This
28 behaviour can be altered by setting the **GRML_ALWAYS_LOAD_ALL** STARTUP
31 Users may want to keep an up-to-date version of the setup (possibly from the
32 git-sources) in //~/.zshrc//. If that happens on a system where the global
33 zshrc is also a //grmlzshrc// (but possibly an older one), you can inhibit
34 loading the global version by doing:
37 echo setopt no_global_rcs >> ~/.zshenv
40 Note, that this will disable //ANY// global files, except for the global
44 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
45 variables. These may be set temporarily when starting zsh like this:
49 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
52 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
53 put the battery status into the right hand side interactive prompt.
55 : **COMMAND_NOT_FOUND**
56 A non zero value activates a handler, which is called when a command can not
57 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
59 : **GRML_ZSH_CNF_HANDLER**
60 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
61 and defaults to "/usr/share/command-not-found/command-not-found".
63 : **GRMLSMALL_SPECIFIC**
64 Set this to zero to remove items in zsh config, which do not work in
68 Where zsh saves the history. Default: ${HOME}/.zsh_history.
71 Number of commands to be kept in the history. On a Grml-CD this defaults to
72 500, on a hard disk installation to 5000.
75 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
76 A value of zero turns off checking.
79 Non zero values deactivate automatic correction of commands.
82 If set to zero (default), allows selection from a menu, if there are at least
83 five possible options of completion.
86 A non zero value disables precmd and preexec commands. These are functions
87 that are run before every command (setting xterm/screen titles etc.).
90 Show time (user, system and cpu) used by external commands, if they run longer
91 than the defined number of seconds (default: 5).
94 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
95 and to 10000 on an installation on hard disk.
98 As in tcsh(1) an array of login/logout events to be reported by the shell
99 builtin "log". For details see zshparam(1). Defaults to (notme root).
101 : **ZSH_NO_DEFAULT_LOCALE**
102 Import "/etc/default/locale", if set to zero (default).
105 A non zero value causes shell functions to be profiled. The results can be
106 obtained with the zprof builtin command (see zshmodules(1) for details).
109 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
112 = FEATURE DESCRIPTION =
113 This is an in depth description of non-standard features implemented by
116 == DIRSTACK HANDLING ==
117 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
118 file each time zsh's working directory is changed. That file can be configured
119 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
120 **DIRSTACKSIZE** variable defaults to **20** in this setup.
122 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
123 zshs inherit the dirstack of the zsh that most recently updated
126 == DIRECTORY BASED PROFILES ==
128 If you need to perform certain actions each time you enter certain
129 directory-trees, this is the feature you are looking for.
132 === Initialisation ===
133 To initialise the system, you need to call the function `chpwd_profiles' at
134 some point in your `zshrc.local'; preferably **after** you configured the
135 system. The configuration of the system is described further below.
137 If you need to do initialisations the first time `chpwd_profiles' is called
138 (which should be in your configuration file), you can do that in a function
139 called "chpwd_profiles_init". That function needs to be defined **before**
140 `chpwd_profiles' is called for this to work.
142 During the **first** call of `chpwd_profiles' (and therefore all its profile
143 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
144 all other cases, the parameter does not exist at all.
147 === Styles and Profile-names ===
148 To store its configuration, the system uses **functions** and **styles**
149 (zsh's context sensitive configuration system), such as this:
153 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
154 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
157 When that's done and you enter a directory that matches the pattern in the
158 third part of the context, a function called chpwd_profile_grml, for example,
159 is called (if it exists).
161 If no pattern matches (read: no profile is detected) the profile is set to
162 'default', which means chpwd_profile_default is attempted to be called.
164 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
165 which is used: The third part in the context is matched against ${PWD}. That's
166 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
167 profile is detected for all these values of ${PWD}:
174 So, if you want to make double damn sure a profile works in /foo/bar and
175 everywhere deeper in that tree, just use (|/|/*) and be happy.
177 The name of the detected profile will be available in a variable called
178 'profile' in your functions. You don't need to do anything, it'll just be
182 === Controlling Profile Execution ===
184 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
185 which is set to the profile that was is currently active (the default value is
186 "default"). That way you can avoid running code for a profile that is already
187 active, by running code such as the following at the start of your function:
190 function chpwd_profile_grml() {
191 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
196 If you know you are going to do that all the time for each and every
197 directory-profile function you are ever going to write, you may also set the
198 `re-execute' style to `false' (which only defaults to `true' for backwards
199 compatibility), like this:
202 zstyle ':chpwd:profiles:*' re-execute false
206 === Signaling availabily/profile changes ===
208 If you use this feature and need to know whether it is active in your current
209 shell, there are several ways to do that. Here are two simple ways:
211 a) If knowing if the profiles feature is active when zsh starts is good
212 enough for you, you can use the following snippet:
214 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
216 b) If that is not good enough, and you would prefer to be notified whenever a
217 profile changes, you can solve that by making sure you start **every**
218 profile function you create like this:
220 function chpwd_profile_myprofilename() {
221 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
222 print "chpwd(): Switching to profile: $profile"
226 That makes sure you only get notified if a profile is **changed**, not
227 everytime you change directory. (To avoid this, you may also set the newer
228 `re-execute' style like described further above instead of the test on top of
232 === Leaving Profiles ===
234 When the system switches from one profile to another, it executes a function
235 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
236 profile-function for the new profile.
239 === Version requirement ===
240 This feature requires zsh //4.3.3// or newer.
243 == ACCEPTLINE WRAPPER ==
244 The //accept-line// wiget is the one that is taking action when the **return**
245 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
248 This wrapper is configured via styles. That means, you issue commands, that look
252 zstyle 'context' style value
255 The context namespace, that we are using is 'acceptline'. That means, the actual
256 context for your commands look like: **':acceptline:<subcontext>'**.
258 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
262 === Recognized Contexts ===
264 This is the value, the context is initialized with.
265 The //compwarnfmt and //rehash// styles are looked up in this context.
268 If the first word in the command line is either a command, alias, function,
269 builtin or reserved word, you are in this context.
272 This is the context, that is used if you hit enter again, after being warned
273 about the existence of a _completion for the non-existing command you
277 This is the context, you are in if the command line is empty or only
278 consists of whitespace.
281 This context is in effect, if you entered something that does not match any
282 of the above. (e.g.: variable assignments).
285 === Available Styles ===
287 If you set this style to true, the warning about non existent commands,
288 for which completions exist will not be issued. (Default: **false**)
291 The message, that is displayed to warn about the _completion issue.
292 (default: **'%c will not execute and completion %f exists.'**)
293 '%c' is replaced by the command name, '%f' by the completion's name.
296 If this is set, we'll force rehashing, if appropriate. (Defaults to
297 **true** in //grmlzshrc//).
300 This can be a list of wigdets to call in a given context. If you need a
301 specific order for these to be called, name them accordingly. The default value
302 is an **empty list**.
305 The name of a widget, that is called after the widgets from 'actions'.
306 By default, this will be '.accept-line' (which is the built-in accept-line
310 If true in the current context, call the widget in the 'default_action'
311 style. (The default is **true** in all contexts.)
316 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
317 **promptinit** system. The three themes are called **grml**, **grml-large** and
320 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
321 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
322 non-empty, **grml-chroot** is used.
324 As usual, with promtinit themes, the user may switch to a different theme using
325 the //prompt// utility:
331 That will use the **grml-large** prompt theme.
333 The themes are highly customisable. The main source of documentation about
334 customisation is the main **grml** theme's doc-string, that is available via
335 the following command:
341 The other themes also come with doc-strings, but the main theme's is the
342 canonical reference about all of them.
344 This feature requires version //4.3.7// of the shell. Older versions will use
345 the classic grml prompt as a fallback.
347 A note to people who like customisation: If you are **not** using a prompt
348 theme for your customisation, but you're either statically setting $PS1 (or
349 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
350 function, make sure you are turning the zsh's prompt theme system **off**
351 before doing so. A correct example customisation could look like this:
354 # Turn the prompt system off:
356 # Customise the prompt yourself:
360 You also add your own tokens by using the \`grml_theme_add_token()' function.
361 Call the function without arguments for detailed documentation about that
364 == GNU/SCREEN STATUS SETTING ==
365 //grmlzshrc// sets screen's hardstatus lines to the currently running command
366 or **'zsh'** if the shell is idling at its prompt. If the current working
367 directory is inside a repository unter version control, screen status is set
368 to: **'zsh: <repository name>'** via zsh's vcs_info.
371 == PERSISTENT HISTORY ==
372 If you got commands you consider important enough to be included in every
373 shell's history, you can put them into ~/.important_commands and they will be
374 available via the usual history lookup widgets.
378 == ENVIRONMENT VARIABLES ==
379 //grmlzshrc// sets some environment variables, which influence the
380 behaviour of applications.
383 Set to "yes". Some applications read this to learn about properties
384 of the terminal they are running in.
387 If not already set, sets the default editor. Falls back to vi(1),
388 if vim(1) is not available.
391 Some environment variables that add colour support to less(1) for viewing
392 man pages. See termcap(5) for details.
395 The mailbox file for the current user is set to /var/mail/$USER, if not
396 already set otherwise.
399 Set less(1) as default pager, if not already set to something different.
402 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
403 default to /bin/sh or /bin/bash.
407 Apart from zsh's default options, //grmlzshrc// sets some options
408 that change the behaviour of zsh. Options that change Z-shell's default
409 settings are marked by <grml>. But note, that zsh's defaults vary depending
410 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
413 Zsh sessions, that use //grmlzshrc//, will append their history list to the
414 history file, rather than replace it. Thus, multiple parallel zsh sessions
415 will all have the new entries from their history lists added to the history
416 file, in the order that they exit. The file will still be periodically
417 re-written to trim it when the number of lines grows 20% beyond the value
418 specified by $SAVEHIST.
421 If a command is issued that can't be executed as a normal command, and the
422 command is the name of a directory, perform the cd command to that directory.
424 : **auto_pushd** <grml>
425 Make cd push the old directory onto the directory stack.
427 : **completeinword** <grml>
428 If the cursor is inside a word, completion is done from both ends;
429 instead of moving the cursor to the end of the word first and starting
432 : **extended_glob** <grml>
433 Treat the '#', '~' and '^' characters as active globbing pattern characters.
435 : **extended_history** <grml>
436 Save each command's beginning timestamp (in seconds since the epoch) and the
437 duration (in seconds) to the history file.
440 Whenever a command completion is attempted, make sure the entire command
441 path is hashed first. This makes the first completion slower.
443 : **histignorealldups** <grml>
444 If a new command line being added to the history list duplicates an
445 older one, the older command is removed from the list, even if it is
446 not the previous event.
448 : **histignorespace** <grml>
449 Remove command lines from the history list when the first character on
450 the line is a space, or when one of the expanded aliases contains a
451 leading space. Note that the command lingers in the internal history
452 until the next command is entered before it vanishes.
454 : **longlistjobs** <grml>
455 List jobs in long format by default.
458 Avoid to beep on errors in zsh command line editing (zle).
461 A wildcard character never matches a leading '.'.
464 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
466 : **nonomatch** <grml>
467 If a pattern for filename generation has no matches, do not print an error
468 and leave it unchanged in the argument list. This also applies to file
469 expansion of an initial `~' or `='.
472 Report the status of background jobs immediately, rather than waiting until
473 just before printing a prompt.
475 : **pushd_ignore_dups** <grml>
476 Don't push multiple copies of the same directory onto the directory stack.
478 : **share_history** <grml>
479 As each line is added to the history file, it is checked to see if anything
480 else was written out by another shell, and if so it is included in the
481 history of the current shell too. Using !-style history, the commands from
482 the other sessions will not appear in the history list unless you explicitly
483 type the "history" command. This option is activated for zsh versions >= 4,
488 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
489 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
493 Edit the current command buffer in your favourite editor.
496 Deletes a word left of the cursor; seeing '/' as additional word separator.
499 Jump right after the first word.
502 Create directory under cursor or the selected area.
503 To select an area press ctrl-@ and use the cursor.
504 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
505 directory does not exist yet -> press **CTRL-xM** and problem solved.
508 Searches the last occurence of string before the cursor in the command history.
511 Display help on keybindings and zsh line editor. Press consecutively to page through content.
514 Brings a job, which got suspended with CTRL-z back to foreground.
517 === Customisation ===
519 To customise keybindings, you can just use zsh's bindkey utility. However, if
520 you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
521 yourself, make sure you call the following functions in the respective hook:
523 - **zle-line-init**: //zle-smkx//
524 - **zle-line-finish**: //zle-rmkx//
527 This is **required** so the keybindings set up by //grmlzshrc// work. The
528 reason for this is to turn the terminal into the right mode while zsh's line
529 editor (zle) is running. This enables us to query //terminfo// about escape
530 sequences for special keys and thus simplify and generalise our keybinding
534 == SHELL FUNCTIONS ==
535 //grmlzshrc// comes with a wide array of defined shell functions to ease the
538 : **855resolution()**
539 If 915resolution is available, issues a warning to the user to run it instead
540 to modify the resolution on intel graphics chipsets.
543 Lists files in current directory, which have been accessed within the
544 last N days. N is an integer to be passed as first and only argument.
545 If no argument is specified N is set to 1.
548 Sets all ulimit values to "unlimited".
551 Lists processes matching given pattern.
554 Login on the host provided as argument using autossh. Then reattach a GNU screen
555 session if a detached session is around or detach a currently attached screen or
556 else start a new screen. This is especially useful for roadwarriors using GNU
560 Simple backup of a file or directory using cp(1). The target file name is the
561 original name plus a time stamp attached. Symlinks and file attributes like mode,
562 ownership and timestamps are preserved.
565 If the original cdrecord is not installed, issues a warning to the user to
566 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
570 Creates a temporary directory using mktemp. Then changes current
571 working directory to it.
574 Lists files in current directory, which have been changed within the
575 last N days. N is an integer to be passed as first and only argument.
576 If no argument is specified N is set to 1.
579 Returns true if given command exists either as program, function, alias,
580 builtin or reserved word. If the option -c is given, only returns true,
581 if command is a program.
584 Changes directory to $HOME on first invocation of zsh. This is neccessary on
585 grml systems with autologin.
588 Changes current directory to the one supplied by argument and lists the files
589 in it, including file names starting with ".".
592 Shows the changelog of given package in $PAGER.
595 Shows the copyright of given package in $PAGER.
598 Tells the user to use grml-debootstrap, if she wants to install debian to
602 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
603 back interactive responsiveness after suspend, when the system is swapping
607 Shows the NEWS file for the given package in $PAGER.
613 Edit given shell function.
616 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
618 : **grml_vcs_info_toggle_colour()**
619 Toggles between coloured and uncoloured formats in vcs_info configuration.
620 This is useful with prompts that break if colour codes are in vcs_info
621 format expansions (like the `clint' prompt and every other prompt that
622 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
623 customised vcs_info formats, you shouldn't be using this function, since
624 it will set all formats to grml's default values (either coloured or plain)
628 Use GNU diff with options -ubwd for mercurial.
631 Displays diffstat between the revision given as argument and tip (no
632 argument means last revision).
635 Outputs highlighted diff; needs highstring(1).
638 Returns true, if zsh version is equal or greater than 4, else false.
641 Returns true, if zsh version is equal or greater than 4.1, else false.
644 Returns true, if zsh version is equal or greater than 4.2, else false.
647 Returns true, if zsh version is equal or greater than 4.2.5, else false.
650 Returns true, if zsh version is equal or greater than 4.3, else false.
653 Returns true, if zsh version is equal or greater than 4.3.3, else false.
656 Returns true, if running on darwin, else false.
659 Returns true, if running on a grml system, else false.
662 Returns true, if running on a grml system from a live cd, else false.
665 Returns true, if run on grml-small, else false.
668 Changes every occurrence of the string iso885915 or ISO885915 in
669 environment variables to UTF-8.
672 Returns true, if run within an utf environment, else false.
675 Creates directory including parent directories, if necessary. Then changes
676 current working directory to it.
679 Lists files in current directory, which have been modified within the
680 last N days. N is an integer to be passed as first and only argument.
681 If no argument is specified N is set to 1.
684 A helper function for the "e" glob qualifier to list all files newer
685 than a reference file.
689 % NTREF=/reference/file
692 % ls -l *(e:'nt /reference/file':)
696 Runs a command in $SHELL with profiling enabled (See startup variable
697 ZSH_PROFILE_RC above).
700 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
701 for details. See also xunfunction() below.
703 : **simple-extract()**
704 Tries to uncompress/unpack given files with the appropriate programs. If an URI
705 starting with https, http or ftp is provided simple-extract tries to download
706 and then uncompress/unpack the file. The choice is made along the filename
707 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
708 .xz) unless you use the '-d' option.
711 Prints details of symlinks given as arguments.
713 : **ssl-cert-fingerprints**
714 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
715 First and only parameter must be a file containing a certificate. Use
716 /dev/stdin as file if you want to pipe a certificate to these
720 Prints all information of a x509 certificate including the SHA512,
721 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
722 containing a certificate. Use /dev/stdin as file if you want to pipe a
723 certificate to this function.
725 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
726 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
727 certificate. First and only parameter must be a file containing a
728 certificate. Use /dev/stdin as file if you want to pipe a certificate
731 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
732 Functions for controlling daemons.
739 Translates a word from german to english (-D) or vice versa (-E).
742 Shows upstreams changelog of a given package in $PAGER.
745 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
748 Changes every occurrence of the string UTF-8 or utf-8 in environment
749 variables to iso885915.
752 Wrapper for vim(1). It tries to set the title and hands vim the environment
753 variable VIM_OPTIONS on the command line. So the user may define command
754 line options, she always wants, in her .zshrc.local.
757 Searches the history for a given pattern and lists the results by date.
758 The first argument is the search pattern. The second and third ones are
759 optional and denote a search range (default: -100).
762 Tries to cat(1) file(s) given as parameter(s). Always returns true.
763 See also xunfunction() below.
766 Tries to source the file(s) given as parameter(s). Always returns true.
767 See zshbuiltins(1) for a detailed description of the source command.
768 See also xunfunction() below.
771 Changes the title of xterm window from within screen(1). Run without
772 arguments for details.
775 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
778 Wrapper around the autoload builtin. Loads the definitions of functions
779 from the file given as argument. Searches $fpath for the file. See also
783 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
784 where own modifications should go. See also zshbuiltins(1) for a description
785 of the source command.
789 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
790 life. A few aliases (like those involving //grep// or //ls//) use the option
791 //--color=auto// for colourizing output. That option is part of **GNU**
792 implementations of these tools, and will only be used if such an implementation
795 : **acp** (//apt-cache policy//)
796 With no arguments prints out the priorities of each source. If a package name
797 is given, it displays detailed information about the priority selection of the
800 : **acs** (//apt-cache search//)
801 Searches debian package lists for the regular expression provided as argument.
802 The search includes package names and descriptions. Prints out name and short
803 description of matching packages.
805 : **acsh** (//apt-cache show//)
806 Shows the package records for the packages provided as arguments.
808 : **adg** (//apt-get dist-upgrade//)
809 Performs an upgrade of all installed packages. Also tries to automatically
810 handle changing dependencies with new versions of packages. As this may change
811 the install status of (or even remove) installed packages, it is potentially
812 dangerous to use dist-upgrade; invoked by sudo, if necessary.
814 : **ag** (//apt-get upgrade//)
815 Downloads and installs the newest versions of all packages currently installed
816 on the system. Under no circumstances are currently installed packages removed,
817 or packages not already installed retrieved and installed. New versions of
818 currently installed packages that cannot be upgraded without changing the install
819 status of another package will be left at their current version. An update must
820 be performed first (see au below); run by sudo, if necessary.
822 : **agi** (//apt-get install//)
823 Downloads and installs or upgrades the packages given on the command line.
824 If a hyphen is appended to the package name, the identified package will be
825 removed if it is installed. Similarly a plus sign can be used to designate a
826 package to install. This may be useful to override decisions made by apt-get's
827 conflict resolution system.
828 A specific version of a package can be selected for installation by following
829 the package name with an equals and the version of the package to select. This
830 will cause that version to be located and selected for install. Alternatively a
831 specific distribution can be selected by following the package name with a slash
832 and the version of the distribution or the Archive name (stable, testing, unstable).
833 Gets invoked by sudo, if user id is not 0.
835 : **ati** (//aptitude install//)
836 Aptitude is a terminal-based package manager with a command line mode similar to
837 apt-get (see agi above); invoked by sudo, if necessary.
839 : **au** (//apt-get update//)
840 Resynchronizes the package index files from their sources. The indexes of
841 available packages are fetched from the location(s) specified in
842 /etc/apt/sources.list. An update should always be performed before an
843 upgrade or dist-upgrade; run by sudo, if necessary.
845 : **da** (//du -sch//)
846 Prints the summarized disk usage of the arguments as well as a grand total
847 in human readable format.
849 : **dbp** (//dpkg-buildpackage//)
850 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
852 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
853 Prints installed Packages sorted by size (descending).
855 : **dir** (//ls -lSrah//)
856 Lists files (including dot files) sorted by size (biggest last) in long and
857 human readable output format.
859 : **ge** (//grep-excuses//)
860 Searches the testing excuses files for a specific maintainer (See:
863 : **grep** (//grep --color=auto//)
864 Shows grep output in nice colors, if available.
866 : **grml-version** (//cat /etc/grml_version//)
867 Prints version of running grml.
869 : **hbp** (//hg-buildpackage//)
870 Helper program to maintain Debian packages with mercurial.
872 : **http** (//python -m SimpleHTTPServer//)
873 Basic HTTP server implemented in python. Listens on port 8000/tcp and
874 serves current directory. Implements GET and HEAD methods.
876 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
877 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
878 host key changes frequently, for example on virtualized test- or development-systems.
879 To be used only inside trusted networks, of course.
881 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
882 ssh with possible man-in-the-middle attack enabled
883 (for an explanation see insecscp above).
885 : **help-zshglob** (//H-Glob()//)
886 Runs the function H-Glob() to expand or explain wildcards.
888 : **j** (//jobs -l//)
889 Prints status of jobs in the current shell session in long format.
891 : **l** (//ls -lF --color=auto//)
892 Lists files in long output format with indicator for filetype appended
893 to filename. If the terminal supports it, with colored output.
895 : **la** (//ls -la --color=auto//)
896 Lists files in long colored output format. Including file names
899 : **lad** (//ls -d .*(/)//)
900 Lists the dot directories (not their contents) in current directory.
902 : **lh** (//ls -hAl --color=auto//)
903 Lists files in long and human readable output format in nice colors,
904 if available. Includes file names starting with "." except "." and
907 : **ll** (//ls -l --color=auto//)
908 Lists files in long colored output format.
910 : **llog** (//$PAGER /var/log/syslog//)
911 Opens syslog in pager.
913 : **ls** (//ls -CF --color=auto//)
914 Lists directory, entries are listed by columns and an indicator for
915 file type is appended to each file name. Additionally the output is
916 colored, if the terminal supports it.
918 : **lsa** (//ls -a .*(.)//)
919 Lists dot files in current working directory.
921 : **lsbig** (//ls -flh *(.OL[1,10])//)
922 Displays the ten biggest files (long and human readable output format).
924 : **lsd** (//ls -d *(/)//)
927 : **lse** (//ls -d *(/^F)//)
928 Shows empty directories.
930 : **lsl** (//ls -l *(@)//)
931 Lists symbolic links in current directory.
933 : **lsnew** (//ls -rl *(D.om[1,10])//)
934 Displays the ten newest files (long output format).
936 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
937 Displays the ten newest directories and ten newest .directories.
939 : **lsold** (//ls -rtlh *(D.om[1,10])//)
940 Displays the ten oldest files (long output format).
942 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
943 Displays the ten oldest directories and ten oldest .directories.
945 : **lss** (//ls -l *(s,S,t)//)
946 Lists files in current directory that have the setuid, setgid or sticky bit
949 : **lssmall** (//ls -Srl *(.oL[1,10])//)
950 Displays the ten smallest files (long output format).
952 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
953 Displays all files which are world readable and/or world writable and/or
954 world executable (long output format).
956 : **lsx** (//ls -l *(*)//)
957 Lists only executable files.
959 : **mdstat** (//cat /proc/mdstat//)
960 Lists all active md (i.e. linux software raid) devices with some information
963 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
964 Executes the commands on the versioned patch queue from current repository.
966 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
967 rmdir current working directory
969 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
970 If invoking user is root, starts screen session with /etc/grml/screenrc
971 as config file. If invoked by a regular user, start a screen session
972 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
975 : **su** (//sudo su//)
976 If user is running a grml live-CD, dont ask for any password, if she
979 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
980 Sets mode from UTF-8 to ISO 2022 (See:
981 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
983 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
984 Sets mode from ISO 2022 to UTF-8 (See:
985 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
987 : **tlog** (//tail -f /var/log/syslog//)
988 Prints syslog continuously (See tail(1)).
990 : **up** (//aptitude update ; aptitude safe-upgrade//)
991 Performs a system update followed by a system upgrade using aptitude; run
992 by sudo, if necessary. See au and ag above.
994 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
995 After calling, characters of URLs as typed get automatically escaped, if necessary, to
996 protect them from the shell.
998 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
999 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1001 : **...** (//cd ../..///)
1002 Changes current directory two levels higher.
1006 This is a set of files, that - if they exist - can be used to customize the
1007 behaviour of //grmlzshrc//.
1010 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1011 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1014 # show battery status in RPROMPT
1016 # always load the complete setup, even for root
1017 GRML_ALWAYS_LOAD_ALL=1
1021 Sourced right before loading //grmlzshrc// is finished. There is a global
1022 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1026 Directory listing for persistent dirstack (see above).
1028 : **.important_commands**
1029 List of commands, used by persistent history (see above).
1032 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1033 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1034 (http://www.ubuntu.com) and similar systems - it is very easy to get
1035 //grmlzshrc// via grml's .deb repositories.
1037 On non-debian systems, that is not an option, but all is not lost:
1040 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1043 If you would also like to get seperate function files (which you can put into
1044 your **$fpath**), you can browse and download them at:
1046 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1048 = ZSH REFCARD TAGS =
1049 If you read //grmlzshrc//'s code you may notice strange looking comments in
1050 it. These are there for a purpose. grml's zsh-refcard is automatically
1051 generated from the contents of the actual configuration file. However, we need
1052 a little extra information on which comments and what lines of code to take
1053 into account (and for what purpose).
1055 Here is what they mean:
1057 List of tags (comment types) used:
1059 Next line contains an important alias, that should be included in the
1060 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1063 Next line contains the beginning of an important function. (placement
1064 tag: @@INSERT-functions@@)
1067 Next line contains an important variable. (placement tag:
1068 @@INSERT-variables@@)
1071 Next line contains an important keybinding. (placement tag:
1072 @@INSERT-keybindings@@)
1075 Hashed directories list generation: //start//: denotes the start of a list of
1076 'hash -d' definitions. //end//: denotes its end. (placement tag:
1077 @@INSERT-hasheddirs@@)
1080 Abbreviation expansion list generation: //start//: denotes the beginning of
1081 abbreviations. //end//: denotes their end.
1083 Lines within this section that end in '#d .*' provide extra documentation to
1084 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1087 This tag allows you to manually generate refcard entries for code lines that
1088 are hard/impossible to parse.
1092 #m# k ESC-h Call the run-help function
1095 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1098 So the syntax is: #m# <section> <argument> <comment>
1101 This tag lets you insert entries to the 'other' hash. Generally, this should
1102 not be used. It is there for things that cannot be done easily in another way.
1103 (placement tag: @@INSERT-other-foobar@@)
1106 All of these tags (except for m and o) take two arguments, the first
1107 within the tag, the other after the tag:
1109 #<tag><section># <comment>
1111 Where <section> is really just a number, which are defined by the @secmap
1112 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1113 that for the reader, the tag should not differ much from a regular comment.
1114 For zsh, it is a regular comment indeed. The numbers have got the following
1139 So, the following will add an entry to the 'functions' table in the 'system'
1140 section, with a (hopefully) descriptive comment:
1143 #f1# Edit an alias via zle
1147 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1148 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1149 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1150 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1151 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1155 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1156 repository from git.grml.org:
1158 ``` % git clone git://git.grml.org/grml-etc-core.git
1160 Make your changes, commit them; use '**git format-patch**' to create a series
1161 of patches and send those to the following address via '**git send-email**':
1163 ``` grml-etc-core@grml.org
1165 Doing so makes sure the right people get your patches for review and
1170 This manual page is the **reference** manual for //grmlzshrc//.
1172 That means that in contrast to the existing refcard it should document **every**
1173 aspect of the setup.
1175 This manual is currently not complete. If you want to help improving it, visit
1176 the following pages:
1178 http://wiki.grml.org/doku.php?id=zshrcmanual
1180 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1182 Contributions are highly welcome.
1186 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1187 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1188 Beckert <abe@deuxchevaux.org>.
1192 Copyright (c) 2009-2013 Grml project <http://grml.org>
1194 This manpage is distributed under the terms of the GPL version 2.
1196 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1197 except for **accept-line()** which are distributed under the same conditions
1198 as zsh itself (which is BSD-like).