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:
47 ``` % GRML_DISPLAY_BATTERY=1 zsh
49 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
52 Deprecated. Use **GRML_DISPLAY_BATTERY** instead.
54 : **COMMAND_NOT_FOUND**
55 A non zero value activates a handler, which is called when a command can not
56 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
58 : **GRML_COMP_CACHING**
59 If set to //yes// (the default), the setup will enable zsh's completion caching
60 mechanism, with the caching data being placed into //$GRML_COMP_CACHE_DIR//.
62 : **GRML_COMP_CACHE_DIR**
63 This defines where zsh's completion caching data will be placed, if
64 //$GRML_COMP_CACHING// is active. The default is //${ZDOTDIR:-$HOME}/.cache//.
65 The setup will ensure the directory exists before attempting to use it.
67 : **GRML_DISPLAY_BATTERY**
68 If set to a value greater than zero, //grmlzshrc// will put the battery status
69 into the right hand side interactive prompt. Supported OSes are //GNU/Linux//,
70 //FreeBSD//, //OpenBSD// and //Darwin//.
72 : **GRML_ZSH_CNF_HANDLER**
73 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
74 and defaults to "/usr/share/command-not-found/command-not-found".
76 : **GRML_NO_APT_ALIASES**
77 A non-empty value inhibits the definition of apt-specific short aliases,
78 such as ag, agi, ati etc.
80 : **GRML_NO_SMALL_ALIASES**
81 A non-empty value inhibits the definition of 2-letter aliases such as da.
82 ls, ll, la and other common ls-related aliases are exempt from this, as are
83 the aliases inhibited by GRML_NO_APT_ALIASES.
85 : **GRMLSMALL_SPECIFIC**
86 Set this to zero to remove items in zsh config, which do not work in
90 Where zsh saves the history. Default: ${HOME}/.zsh_history.
93 Number of commands to be kept in the history. On a Grml-CD this defaults to
94 500, on a hard disk installation to 5000.
97 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
98 A value of zero turns off checking.
101 Non zero values deactivate automatic correction of commands.
104 Non zero values deactivate parsing of "/etc/hosts" disabling host completion
105 using file's contents.
108 If set to zero (default), allows selection from a menu, if there are at least
109 five possible options of completion.
112 A non zero value disables precmd and preexec commands. These are functions
113 that are run before every command (setting xterm/screen titles etc.).
116 Show time (user, system and cpu) used by external commands, if they run longer
117 than the defined number of seconds (default: 5).
120 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
121 and to 10000 on an installation on hard disk.
124 As in tcsh(1) an array of login/logout events to be reported by the shell
125 builtin "log". For details see zshparam(1). Defaults to (notme root).
127 : **ZSH_NO_DEFAULT_LOCALE**
128 Import "/etc/default/locale", if set to zero (default).
131 A non zero value causes shell functions to be profiled. The results can be
132 obtained with the zprof builtin command (see zshmodules(1) for details).
135 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
138 = GRML-ZSHRC SPECIFIC STYLES =
140 Styles are a context sensitive configuration mechanism included with zsh. The
141 shell uses it extensively in sub-systems like the completion and the VCS info
142 system. It lives outside of the classic shell variable namespace, so it avoids
143 polluting it. New functionality in grml's zshrc will likely use styles instead
144 of variables. Some features of the setup (like the directory stack handling)
145 already use styles. Those styles are documented with the specific features.
146 This section documents more general styles.
148 == Context: :grml:completion:compinit ==
149 This context revolves around the zshrc's //compinit// function call, that
150 initialises zsh's function based completion system.
153 This style allows the injection of arguments to the command line that is used
154 to run compinit. It is a list style and its default is the empty list. Using
155 this style, it's possible to add **-i** to //compinit// in order to disable
159 zstyle ':grml:completion:compinit' arguments -i
162 Only do this, if you know what sort of security checks are disabled if
163 //compaudit// is not active and if that's acceptable with your specific setup.
165 This style has to be set at the point that Grml's zshrc runs //compinit//. A
166 possible way to achieve this is to set it in //~/.zshrc.pre// (see AUXILIARY
167 FILES below for details).
170 = FEATURE DESCRIPTION =
171 This is an in depth description of non-standard features implemented by
174 == DIRSTACK HANDLING ==
175 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
176 file each time zsh's working directory is changed. That file can be configured
177 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
178 **DIRSTACKSIZE** variable defaults to **20** in this setup.
180 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
181 zshs inherit the dirstack of the zsh that most recently updated
184 If you would like to //disable// the persistent dirstack feature altogether,
185 you can do that by setting the boolean //enable// style to //false// in the
186 right context (the default is //true//):
189 zstyle ':grml:chpwd:dirstack' enable false
192 It is possible to apply a filter to the names of directories that will be
193 committed to the persistent dirstack file. There are two ways to configure this
194 filter: A general function based filter and a pattern based filter. Both are
195 setup via styles in the **':grml:chpwd:dirstack'** context.
197 To use a function based filter set the //filter// style for that context to the
198 name of a function to call every time a directory name is to be added to the
199 persistent dirstack. If the function's return value signals success (ie. return
200 value "0"), the directory name is filtered out and **not** added to the
201 persistent stack. Example:
204 function my_dirstack_filter() { [[ $1 == /tmp(|/*) ]] }
205 zstyle ':grml:chpwd:dirstack' filter my_dirstack_filter
208 The pattern based filter uses a list of patterns passed to the //exclude//
209 style in the aforementioned context. Each pattern is tested and the first that
210 matches will keep the directory name from being added to the persistent stack.
211 If none of the patterns matches, the name is added. example:
214 zstyle ':grml:chpwd:dirstack' exclude "/tmp(|/*)" "$HOME/tmp(|/*)"
217 The function based filter is more general, the pattern based filter easier to
218 set up. If both filter variants are used at the same time, the function based
219 filter will be executed //before// the pattern based one.
221 If you would like to apply your filters while //loading// the persistent
222 dirstack file, set the //filter-on-load// boolean style (the default is
226 zstyle ':grml:chpwd:dirstack' filter-on-load true
229 Setting the //filter-on-load// and //enable// styles needs to be done in
230 ".zshrc.pre" because the styles need to be set when the main setup is
231 executing! The other styles do not have this limitation, but enabling the
232 system as well as the initial filtering will obviously be done using settings
233 and filters that are configured **at** **that** **point**.
235 With respect to //filter-on-load//, the rule of thumb is: If you want to filter
236 on load, setup everything in ".zshrc.pre" otherwise ".zshrc.local" works just
240 == DIRECTORY BASED PROFILES ==
242 If you need to perform certain actions each time you enter certain
243 directory-trees, this is the feature you are looking for.
246 === Initialisation ===
247 To initialise the system, you need to call the function `chpwd_profiles' at
248 some point in your `zshrc.local'; preferably **after** you configured the
249 system. The configuration of the system is described further below.
251 If you need to do initialisations the first time `chpwd_profiles' is called
252 (which should be in your configuration file), you can do that in a function
253 called "chpwd_profiles_init". That function needs to be defined **before**
254 `chpwd_profiles' is called for this to work.
256 During the **first** call of `chpwd_profiles' (and therefore all its profile
257 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
258 all other cases, the parameter does not exist at all.
261 === Styles and Profile-names ===
262 To store its configuration, the system uses **functions** and **styles**
263 (zsh's context sensitive configuration system), such as this:
267 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
268 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
271 When that's done and you enter a directory that matches the pattern in the
272 third part of the context, a function called chpwd_profile_grml, for example,
273 is called (if it exists).
275 If no pattern matches (read: no profile is detected) the profile is set to
276 'default', which means chpwd_profile_default is attempted to be called.
278 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
279 which is used: The third part in the context is matched against ${PWD}. That's
280 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
281 profile is detected for all these values of ${PWD}:
288 So, if you want to make double damn sure a profile works in /foo/bar and
289 everywhere deeper in that tree, just use (|/|/*) and be happy.
291 The name of the detected profile will be available in a variable called
292 'profile' in your functions. You don't need to do anything, it'll just be
296 === Controlling Profile Execution ===
298 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
299 which is set to the profile that was is currently active (the default value is
300 "default"). That way you can avoid running code for a profile that is already
301 active, by running code such as the following at the start of your function:
304 function chpwd_profile_grml() {
305 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
310 If you know you are going to do that all the time for each and every
311 directory-profile function you are ever going to write, you may also set the
312 `re-execute' style to `false' (which only defaults to `true' for backwards
313 compatibility), like this:
316 zstyle ':chpwd:profiles:*' re-execute false
320 === Signaling availabily/profile changes ===
322 If you use this feature and need to know whether it is active in your current
323 shell, there are several ways to do that. Here are two simple ways:
325 a) If knowing if the profiles feature is active when zsh starts is good
326 enough for you, you can use the following snippet:
328 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
330 b) If that is not good enough, and you would prefer to be notified whenever a
331 profile changes, you can solve that by making sure you start **every**
332 profile function you create like this:
334 function chpwd_profile_myprofilename() {
335 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
336 print "chpwd(): Switching to profile: $profile"
340 That makes sure you only get notified if a profile is **changed**, not
341 everytime you change directory. (To avoid this, you may also set the newer
342 `re-execute' style like described further above instead of the test on top of
346 === Leaving Profiles ===
348 When the system switches from one profile to another, it executes a function
349 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
350 profile-function for the new profile.
353 === Version requirement ===
354 This feature requires zsh //4.3.3// or newer.
357 == ACCEPTLINE WRAPPER ==
358 The //accept-line// wiget is the one that is taking action when the **return**
359 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
362 This wrapper is configured via styles. That means, you issue commands, that look
366 zstyle 'context' style value
369 The context namespace, that we are using is 'acceptline'. That means, the actual
370 context for your commands look like: **':acceptline:<subcontext>'**.
372 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
376 === Recognized Contexts ===
378 This is the value, the context is initialized with.
379 The //compwarnfmt and //rehash// styles are looked up in this context.
382 If the first word in the command line is either a command, alias, function,
383 builtin or reserved word, you are in this context.
386 This is the context, that is used if you hit enter again, after being warned
387 about the existence of a _completion for the non-existing command you
391 This is the context, you are in if the command line is empty or only
392 consists of whitespace.
395 This context is in effect, if you entered something that does not match any
396 of the above. (e.g.: variable assignments).
399 === Available Styles ===
401 If you set this style to true, the warning about non existent commands,
402 for which completions exist will not be issued. (Default: **false**)
405 The message, that is displayed to warn about the _completion issue.
406 (default: **'%c will not execute and completion %f exists.'**)
407 '%c' is replaced by the command name, '%f' by the completion's name.
410 If this is set, we'll force rehashing, if appropriate. (Defaults to
411 **true** in //grmlzshrc//).
414 This can be a list of wigdets to call in a given context. If you need a
415 specific order for these to be called, name them accordingly. The default value
416 is an **empty list**.
419 The name of a widget, that is called after the widgets from 'actions'.
420 By default, this will be '.accept-line' (which is the built-in accept-line
424 If true in the current context, call the widget in the 'default_action'
425 style. (The default is **true** in all contexts.)
430 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
431 **promptinit** system. The three themes are called **grml**, **grml-large** and
434 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
435 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
436 non-empty, **grml-chroot** is used.
438 As usual, with promptinit themes, the user may switch to a different theme using
439 the //prompt// utility:
445 That will use the **grml-large** prompt theme.
447 The themes are highly customisable. The main source of documentation about
448 customisation is the main **grml** theme's doc-string, that is available via
449 the following command:
455 The other themes also come with doc-strings, but the main theme's is the
456 canonical reference about all of them.
458 This feature requires version //4.3.7// of the shell. Older versions will use
459 the classic grml prompt as a fallback.
461 A note to people who like customisation: If you are **not** using a prompt
462 theme for your customisation, but you're either statically setting $PS1 (or
463 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
464 function, make sure you are turning the zsh's prompt theme system **off**
465 before doing so. A correct example customisation could look like this:
468 # Turn the prompt system off:
470 # Customise the prompt yourself:
474 You also add your own tokens by using the \`grml_theme_add_token()' function.
475 Call the function without arguments for detailed documentation about that
478 == GNU/SCREEN STATUS SETTING ==
479 //grmlzshrc// sets screen's hardstatus lines to the currently running command
480 or **'zsh'** if the shell is idling at its prompt. If the current working
481 directory is inside a repository unter version control, screen status is set
482 to: **'zsh: <repository name>'** via zsh's vcs_info.
485 == PERSISTENT HISTORY ==
486 If you got commands you consider important enough to be included in every
487 shell's history, you can put them into $GRML_IMPORTANT_COMMANDS (which defaults
488 for backward compatibility to ~/.important_commands) and they will be available
489 via the usual history lookup widgets.
493 == ENVIRONMENT VARIABLES ==
494 //grmlzshrc// sets some environment variables, which influence the
495 behaviour of applications.
498 Set to "yes". Some applications read this to learn about properties
499 of the terminal they are running in.
502 If not already set, sets the default editor. Falls back to vi(1),
503 if vim(1) is not available.
506 Some environment variables that add colour support to less(1) for viewing
507 man pages. See termcap(5) for details.
510 The mailbox file for the current user is set to /var/mail/$USER, if not
511 already set otherwise.
514 Set less(1) as default pager, if not already set to something different.
518 Apart from zsh's default options, //grmlzshrc// sets some options
519 that change the behaviour of zsh. Options that change Z-shell's default
520 settings are marked by <grml>. But note, that zsh's defaults vary depending
521 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
524 Zsh sessions, that use //grmlzshrc//, will append their history list to the
525 history file, rather than replace it. Thus, multiple parallel zsh sessions
526 will all have the new entries from their history lists added to the history
527 file, in the order that they exit. The file will still be periodically
528 re-written to trim it when the number of lines grows 20% beyond the value
529 specified by $SAVEHIST.
532 If a command is issued that can't be executed as a normal command, and the
533 command is the name of a directory, perform the cd command to that directory.
535 : **auto_pushd** <grml>
536 Make cd push the old directory onto the directory stack.
538 : **completeinword** <grml>
539 If the cursor is inside a word, completion is done from both ends;
540 instead of moving the cursor to the end of the word first and starting
543 : **extended_glob** <grml>
544 Treat the '#', '~' and '^' characters as active globbing pattern characters.
546 : **extended_history** <grml>
547 Save each command's beginning timestamp (in seconds since the epoch) and the
548 duration (in seconds) to the history file.
551 Whenever a command completion is attempted, make sure the entire command
552 path is hashed first. This makes the first completion slower.
554 : **histignorespace** <grml>
555 Remove command lines from the history list when the first character on
556 the line is a space, or when one of the expanded aliases contains a
557 leading space. Note that the command lingers in the internal history
558 until the next command is entered before it vanishes.
560 : **longlistjobs** <grml>
561 List jobs in long format by default.
564 Avoid to beep on errors in zsh command line editing (zle).
567 A wildcard character never matches a leading '.'.
570 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
572 : **nonomatch** <grml>
573 If a pattern for filename generation has no matches, do not print an error
574 and leave it unchanged in the argument list. This also applies to file
575 expansion of an initial `~' or `='.
578 Report the status of background jobs immediately, rather than waiting until
579 just before printing a prompt.
581 : **pushd_ignore_dups** <grml>
582 Don't push multiple copies of the same directory onto the directory stack.
584 : **share_history** <grml>
585 As each line is added to the history file, it is checked to see if anything
586 else was written out by another shell, and if so it is included in the
587 history of the current shell too. Using !-style history, the commands from
588 the other sessions will not appear in the history list unless you explicitly
589 type the "history" command. This option is activated for zsh versions >= 4,
594 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
595 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
599 Edit the current command buffer in your favourite editor.
602 Deletes a word left of the cursor; seeing '/' as additional word separator.
605 Jump right after the first word.
608 Create directory under cursor or the selected area.
609 To select an area press ctrl-@ and use the cursor.
610 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
611 directory does not exist yet -> press **CTRL-xM** and problem solved.
614 Searches the last occurrence of string before the cursor in the command history.
617 Display help on keybindings and zsh line editor. Press consecutively to page through content.
620 Brings a job, which got suspended with CTRL-z back to foreground.
623 === Customisation ===
625 To customise keybindings, you can just use zsh's bindkey utility. However, if
626 you plan to use the `//zle-line-init//' or `//zle-line-finish//' hooks
627 yourself, make sure you call the following functions in the respective hook:
629 - **zle-line-init**: //zle-smkx//
630 - **zle-line-finish**: //zle-rmkx//
633 This is **required** so the keybindings set up by //grmlzshrc// work. The
634 reason for this is to turn the terminal into the right mode while zsh's line
635 editor (zle) is running. This enables us to query //terminfo// about escape
636 sequences for special keys and thus simplify and generalise our keybinding
640 == SHELL FUNCTIONS ==
641 //grmlzshrc// comes with a wide array of defined shell functions to ease the
644 : **855resolution()**
645 If 915resolution is available, issues a warning to the user to run it instead
646 to modify the resolution on intel graphics chipsets.
649 Lists files in current directory, which have been accessed within the
650 last N days. N is an integer to be passed as first and only argument.
651 If no argument is specified N is set to 1.
654 Lists processes matching given pattern.
657 Login on the host provided as argument using autossh. Then reattach a GNU screen
658 session if a detached session is around or detach a currently attached screen or
659 else start a new screen. This is especially useful for roadwarriors using GNU
663 Simple backup management of a file or directory using standard unix programs.
664 The target file name is the original name plus a time stamp attached. Symlinks
665 and file attributes like mode, ownership and timestamps are preserved.
668 If the original cdrecord is not installed, issues a warning to the user to
669 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
673 Creates a temporary directory using mktemp. Then changes current
674 working directory to it.
677 Lists files in current directory, which have been changed within the
678 last N days. N is an integer to be passed as first and only argument.
679 If no argument is specified N is set to 1.
682 Returns true if given command exists either as program, function, alias,
683 builtin or reserved word. If the option -c is given, only returns true,
684 if command is a program.
687 Changes directory to $HOME on first invocation of zsh. This is necessary on
688 Grml systems with autologin.
691 Changes current directory to the one supplied by argument and lists the files
692 in it, including file names starting with ".".
695 Shows the changelog of given package in $PAGER.
698 Shows the copyright of given package in $PAGER.
701 Tells the user to use grml-debootstrap, if she wants to install debian to
705 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
706 back interactive responsiveness after suspend, when the system is swapping
710 Shows the NEWS file for the given package in $PAGER.
716 Edit given shell function.
719 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
721 : **grml_status_features()**
722 Prints a summary of features the grml setup is trying to load. The result of
723 loading a feature is recorded. This function lets you query the result. The
724 function takes one argument: "-h" or "--help" to display this help text, "+" to
725 display a list of all successfully loaded features, "-" for a list of all
726 features that failed to load. "+-" to show a list of all features with their
727 statuses. Any other word is considered to by a feature and prints its status.
729 The default mode is "+-".
731 : **grml_vcs_info_toggle_colour()**
732 Toggles between coloured and uncoloured formats in vcs_info configuration.
733 This is useful with prompts that break if colour codes are in vcs_info
734 format expansions (like the `clint' prompt and every other prompt that
735 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
736 customised vcs_info formats, you shouldn't be using this function, since
737 it will set all formats to grml's default values (either coloured or plain)
741 Use GNU diff with options -ubwd for mercurial.
744 Displays diffstat between the revision given as argument and tip (no
745 argument means last revision).
748 Outputs highlighted diff; needs highstring(1).
751 Returns true, if zsh version is equal or greater than 4, else false.
754 Returns true, if zsh version is equal or greater than 4.1, else false.
757 Returns true, if zsh version is equal or greater than 4.2, else false.
760 Returns true, if zsh version is equal or greater than 4.2.5, else false.
763 Returns true, if zsh version is equal or greater than 4.3, else false.
766 Returns true, if zsh version is equal or greater than 4.3.3, else false.
769 Returns true, if running on darwin, else false.
772 Returns true, if running on FreeBSD, else false.
775 Returns true, if running on a grml system, else false.
778 Returns true, if running on a grml system from a live cd, else false.
781 Returns true, if run on grml-small, else false.
784 Returns true, if running on Linux, else false.
787 Changes every occurrence of the string iso885915 or ISO885915 in
788 environment variables to UTF-8.
791 Returns true, if running on OpenBSD, else false.
794 Returns true, if run within an utf environment, else false.
797 Creates directory including parent directories, if necessary. Then changes
798 current working directory to it.
801 Lists files in current directory, which have been modified within the
802 last N days. N is an integer to be passed as first and only argument.
803 If no argument is specified N is set to 1.
806 A helper function for the "e" glob qualifier to list all files newer
807 than a reference file.
811 % NTREF=/reference/file
814 % ls -l *(e:'nt /reference/file':)
818 Runs a command in zsh with profiling enabled (See startup variable
819 ZSH_PROFILE_RC above).
822 Creates an alias with sudo prepended, if $EUID is not zero. Run "salias -h"
823 for details. See also xunfunction() below.
825 : **simple-extract()**
826 Tries to uncompress/unpack given files with the appropriate programs. If an URI
827 starting with https, http or ftp is provided simple-extract tries to download
828 and then uncompress/unpack the file. The choice is made along the filename
829 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
830 .xz) unless you use the '-d' option.
833 Prints details of symlinks given as arguments.
835 : **ssl-cert-fingerprints**
836 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
837 First and only parameter must be a file containing a certificate. Use
838 /dev/stdin as file if you want to pipe a certificate to these
842 Prints all information of a x509 certificate including the SHA512,
843 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
844 containing a certificate. Use /dev/stdin as file if you want to pipe a
845 certificate to this function.
847 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
848 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
849 certificate. First and only parameter must be a file containing a
850 certificate. Use /dev/stdin as file if you want to pipe a certificate
853 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
854 Functions for controlling daemons.
861 Translates a word from german to english (-D) or vice versa (-E).
864 Shows upstreams changelog of a given package in $PAGER.
867 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
870 Changes every occurrence of the string UTF-8 or utf-8 in environment
871 variables to iso885915.
874 Wrapper for vim(1). It tries to set the title and hands vim the environment
875 variable VIM_OPTIONS on the command line. So the user may define command
876 line options, she always wants, in her .zshrc.local.
879 Searches the history for a given pattern and lists the results by date.
880 The first argument is the search pattern. The second and third ones are
881 optional and denote a search range (default: -100).
884 Tries to cat(1) file(s) given as parameter(s). Always returns true.
885 See also xunfunction() below.
888 Tries to source the file(s) given as parameter(s). Always returns true.
889 See zshbuiltins(1) for a detailed description of the source command.
890 See also xunfunction() below.
893 Changes the title of xterm window from within screen(1). Run without
894 arguments for details.
897 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
900 Wrapper around the autoload builtin. Loads the definitions of functions
901 from the file given as argument. Searches $fpath for the file. See also
905 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
906 where own modifications should go. See also zshbuiltins(1) for a description
907 of the source command.
911 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
912 life. A few aliases (like those involving //grep// or //ls//) use the option
913 //--color=auto// for colourizing output. That option is part of **GNU**
914 implementations of these tools, and will only be used if such an implementation
917 : **acp** (//apt-cache policy//)
918 With no arguments prints out the priorities of each source. If a package name
919 is given, it displays detailed information about the priority selection of the
922 : **acs** (//apt search//)
923 Searches debian package lists for the regular expression provided as argument.
924 The search includes package names and descriptions. Prints out name and short
925 description of matching packages.
927 : **acsh** (//apt show//)
928 Shows the package records for the packages provided as arguments.
930 : **adg** (//apt dist-upgrade//)
931 Performs an upgrade of all installed packages. Also tries to automatically
932 handle changing dependencies with new versions of packages. As this may change
933 the install status of (or even remove) installed packages, it is potentially
934 dangerous to use dist-upgrade; invoked by sudo, if necessary.
936 : **ag** (//apt upgrade//)
937 Downloads and installs the newest versions of all packages currently installed
938 on the system. Under no circumstances are currently installed packages removed,
939 or packages not already installed retrieved and installed. New versions of
940 currently installed packages that cannot be upgraded without changing the install
941 status of another package will be left at their current version. An update must
942 be performed first (see au below); run by sudo, if necessary.
944 : **agi** (//apt install//)
945 Downloads and installs or upgrades the packages given on the command line.
946 If a hyphen is appended to the package name, the identified package will be
947 removed if it is installed. Similarly a plus sign can be used to designate a
948 package to install. This may be useful to override decisions made by apt's
949 conflict resolution system.
950 A specific version of a package can be selected for installation by following
951 the package name with an equals and the version of the package to select. This
952 will cause that version to be located and selected for install. Alternatively a
953 specific distribution can be selected by following the package name with a slash
954 and the version of the distribution or the Archive name (stable, testing, unstable).
955 Gets invoked by sudo, if user id is not 0.
957 : **ati** (//aptitude install//)
958 Aptitude is a terminal-based package manager with a command line mode similar to
959 apt (see agi above); invoked by sudo, if necessary.
961 : **au** (//apt update//)
962 Resynchronizes the package index files from their sources. The indexes of
963 available packages are fetched from the location(s) specified in
964 /etc/apt/sources.list. An update should always be performed before an
965 upgrade or dist-upgrade; run by sudo, if necessary.
967 : **da** (//du -sch//)
968 Prints the summarized disk usage of the arguments as well as a grand total
969 in human readable format.
971 : **dbp** (//dpkg-buildpackage//)
972 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
974 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
975 Prints installed Packages sorted by size (descending).
977 : **dir** (//ls -lSrah//)
978 Lists files (including dot files) sorted by size (biggest last) in long and
979 human readable output format.
981 : **ge** (//grep-excuses//)
982 Searches the testing excuses files for a specific maintainer (See:
985 : **grep** (//grep --color=auto//)
986 Shows grep output in nice colors, if available.
988 : **grml-version** (//cat /etc/grml_version//)
989 Prints version of running grml.
991 : **hbp** (//hg-buildpackage//)
992 Helper program to maintain Debian packages with mercurial.
994 : **http** (//python -m SimpleHTTPServer//)
995 Basic HTTP server implemented in python. Listens on port 8000/tcp and
996 serves current directory. Implements GET and HEAD methods.
998 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
999 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
1000 host key changes frequently, for example on virtualized test- or development-systems.
1001 To be used only inside trusted networks, of course.
1003 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1004 ssh with possible man-in-the-middle attack enabled
1005 (for an explanation see insecscp above).
1007 : **help-zshglob** (//H-Glob()//)
1008 Runs the function H-Glob() to expand or explain wildcards.
1010 : **j** (//jobs -l//)
1011 Prints status of jobs in the current shell session in long format.
1013 : **l** (//ls -l --color=auto//)
1014 Lists files in long output format with indicator for filetype appended
1015 to filename. If the terminal supports it, with colored output.
1017 : **la** (//ls -la --color=auto//)
1018 Lists files in long colored output format. Including file names
1021 : **lad** (//ls -d .*(/)//)
1022 Lists the dot directories (not their contents) in current directory.
1024 : **lh** (//ls -hAl --color=auto//)
1025 Lists files in long and human readable output format in nice colors,
1026 if available. Includes file names starting with "." except "." and
1029 : **ll** (//ls -l --color=auto//)
1030 Lists files in long colored output format.
1032 : **llog** (//$PAGER /var/log/syslog//)
1033 Opens syslog in pager.
1035 : **ls** (//ls -C --color=auto//)
1036 Lists directory, entries are listed by columns and an indicator for
1037 file type is appended to each file name. Additionally the output is
1038 colored, if the terminal supports it.
1040 : **lsa** (//ls -a .*(.)//)
1041 Lists dot files in current working directory.
1043 : **lsbig** (//ls -flh *(.OL[1,10])//)
1044 Displays the ten biggest files (long and human readable output format).
1046 : **lsd** (//ls -d *(/)//)
1049 : **lse** (//ls -d *(/^F)//)
1050 Shows empty directories.
1052 : **lsl** (//ls -l *(@)//)
1053 Lists symbolic links in current directory.
1055 : **lsnew** (//ls -rl *(D.om[1,10])//)
1056 Displays the ten newest files (long output format).
1058 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
1059 Displays the ten newest directories and ten newest .directories.
1061 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1062 Displays the ten oldest files (long output format).
1064 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
1065 Displays the ten oldest directories and ten oldest .directories.
1067 : **lss** (//ls -l *(s,S,t)//)
1068 Lists files in current directory that have the setuid, setgid or sticky bit
1071 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1072 Displays the ten smallest files (long output format).
1074 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1075 Displays all files which are world readable and/or world writable and/or
1076 world executable (long output format).
1078 : **lsx** (//ls -l *(*)//)
1079 Lists only executable files.
1081 : **mdstat** (//cat /proc/mdstat//)
1082 Lists all active md (i.e. linux software raid) devices with some information
1085 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1086 Executes the commands on the versioned patch queue from current repository.
1088 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1089 rmdir current working directory
1091 : **screen** (//screen -c file//)
1092 If invoking user is root, starts screen session with /etc/grml/screenrc
1093 as config file. If invoked by a regular user and users .screenc does not exist,
1094 starts screen with /etc/grml/screenrc_grml config if it exists, else fallbacks
1095 to /etc/grml/screenrc.
1097 : **su** (//sudo su//)
1098 If user is running a Grml live system, don't ask for any password, if she
1101 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1102 Sets mode from UTF-8 to ISO 2022 (See:
1103 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1105 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1106 Sets mode from ISO 2022 to UTF-8 (See:
1107 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1109 : **tlog** (//tail --follow=name /var/log/syslog//)
1110 Prints syslog continuously (See tail(1)).
1112 : **up** (//aptitude update ; aptitude safe-upgrade//)
1113 Performs a system update followed by a system upgrade using aptitude; run
1114 by sudo, if necessary. See au and ag above.
1116 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1117 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1118 protect them from the shell.
1120 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1121 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1123 : **...** (//cd ../..///)
1124 Changes current directory two levels higher.
1128 This is a set of files, that - if they exist - can be used to customize the
1129 behaviour of //grmlzshrc//.
1132 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1133 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1136 # show battery status in RPROMPT
1137 GRML_DISPLAY_BATTERY=1
1138 # always load the complete setup, even for root
1139 GRML_ALWAYS_LOAD_ALL=1
1143 Sourced right before loading //grmlzshrc// is finished. There is a global
1144 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1148 Directory listing for persistent dirstack (see above).
1150 : **.important_commands**
1151 List of commands, used by persistent history (see above).
1154 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1155 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1156 (http://www.ubuntu.com) and similar systems - it is very easy to get
1157 //grmlzshrc// via grml's .deb repositories.
1159 On non-debian systems, that is not an option, but all is not lost:
1162 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1165 If you would also like to get separate function files (which you can put into
1166 your **$fpath**), you can browse and download them at:
1168 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1170 = ZSH REFCARD TAGS =
1171 If you read //grmlzshrc//'s code you may notice strange looking comments in
1172 it. These are there for a purpose. grml's zsh-refcard is automatically
1173 generated from the contents of the actual configuration file. However, we need
1174 a little extra information on which comments and what lines of code to take
1175 into account (and for what purpose).
1177 Here is what they mean:
1179 List of tags (comment types) used:
1181 Next line contains an important alias, that should be included in the
1182 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1185 Next line contains the beginning of an important function. (placement
1186 tag: @@INSERT-functions@@)
1189 Next line contains an important variable. (placement tag:
1190 @@INSERT-variables@@)
1193 Next line contains an important keybinding. (placement tag:
1194 @@INSERT-keybindings@@)
1197 Hashed directories list generation: //start//: denotes the start of a list of
1198 'hash -d' definitions. //end//: denotes its end. (placement tag:
1199 @@INSERT-hasheddirs@@)
1202 Abbreviation expansion list generation: //start//: denotes the beginning of
1203 abbreviations. //end//: denotes their end.
1205 Lines within this section that end in '#d .*' provide extra documentation to
1206 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1209 This tag allows you to manually generate refcard entries for code lines that
1210 are hard/impossible to parse.
1214 #m# k ESC-h Call the run-help function
1217 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1220 So the syntax is: #m# <section> <argument> <comment>
1223 This tag lets you insert entries to the 'other' hash. Generally, this should
1224 not be used. It is there for things that cannot be done easily in another way.
1225 (placement tag: @@INSERT-other-foobar@@)
1228 All of these tags (except for m and o) take two arguments, the first
1229 within the tag, the other after the tag:
1231 #<tag><section># <comment>
1233 Where <section> is really just a number, which are defined by the @secmap
1234 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1235 that for the reader, the tag should not differ much from a regular comment.
1236 For zsh, it is a regular comment indeed. The numbers have got the following
1261 So, the following will add an entry to the 'functions' table in the 'system'
1262 section, with a (hopefully) descriptive comment:
1265 #f1# Edit an alias via zle
1269 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1270 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1271 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1272 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1273 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1277 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1278 repository from git.grml.org:
1280 ``` % git clone git://git.grml.org/grml-etc-core.git
1282 Make your changes, commit them; use '**git format-patch**' to create a series
1283 of patches and send those to the following address via '**git send-email**':
1285 ``` grml-etc-core@grml.org
1287 Doing so makes sure the right people get your patches for review and
1292 This manual page is the **reference** manual for //grmlzshrc//.
1294 That means that in contrast to the existing refcard it should document **every**
1295 aspect of the setup.
1297 This manual is currently not complete. If you want to help improving it, visit
1298 the following pages:
1300 http://wiki.grml.org/doku.php?id=zshrcmanual
1302 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1304 Contributions are highly welcome.
1308 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1309 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1310 Beckert <abe@deuxchevaux.org>.
1314 Copyright (c) 2009-2013 Grml project <http://grml.org>
1316 This manpage is distributed under the terms of the GPL version 2.
1318 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1319 except for **accept-line()** which are distributed under the same conditions
1320 as zsh itself (which is BSD-like).