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 : **GRMLSMALL_SPECIFIC**
77 Set this to zero to remove items in zsh config, which do not work in
81 Where zsh saves the history. Default: ${HOME}/.zsh_history.
84 Number of commands to be kept in the history. On a Grml-CD this defaults to
85 500, on a hard disk installation to 5000.
88 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
89 A value of zero turns off checking.
92 Non zero values deactivate automatic correction of commands.
95 If set to zero (default), allows selection from a menu, if there are at least
96 five possible options of completion.
99 A non zero value disables precmd and preexec commands. These are functions
100 that are run before every command (setting xterm/screen titles etc.).
103 Show time (user, system and cpu) used by external commands, if they run longer
104 than the defined number of seconds (default: 5).
107 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
108 and to 10000 on an installation on hard disk.
111 As in tcsh(1) an array of login/logout events to be reported by the shell
112 builtin "log". For details see zshparam(1). Defaults to (notme root).
114 : **ZSH_NO_DEFAULT_LOCALE**
115 Import "/etc/default/locale", if set to zero (default).
118 A non zero value causes shell functions to be profiled. The results can be
119 obtained with the zprof builtin command (see zshmodules(1) for details).
122 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
125 = FEATURE DESCRIPTION =
126 This is an in depth description of non-standard features implemented by
129 == DIRSTACK HANDLING ==
130 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
131 file each time zsh's working directory is changed. That file can be configured
132 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
133 **DIRSTACKSIZE** variable defaults to **20** in this setup.
135 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
136 zshs inherit the dirstack of the zsh that most recently updated
139 If you would like to //disable// the persistent dirstack feature altogether,
140 you can do that by setting the boolean //enable// style to //false// in the
141 right context (the default is //true//):
144 zstyle ':grml:chpwd:dirstack' enable false
147 It is possible to apply a filter to the names of directories that will be
148 committed to the persistent dirstack file. There are two ways to configure this
149 filter: A general function based filter and a pattern based filter. Both are
150 setup via styles in the **':grml:chpwd:dirstack'** context.
152 To use a function based filter set the //filter// style for that context to the
153 name of a function to call every time a directory name is to be added to the
154 persistent dirstack. If the function's return value signals success (ie. return
155 value "0"), the directory name is filtered out and **not** added to the
156 persistent stack. Example:
159 function my_dirstack_filter() { [[ $1 == /tmp(|/*) ]] }
160 zstyle ':grml:chpwd:dirstack' filter my_dirstack_filter
163 The pattern based filter uses a list of patterns passed to the //exclude//
164 style in the aforementioned context. Each pattern is tested and the first that
165 matches will keep the directory name from being added to the persistent stack.
166 If none of the patterns matches, the name is added. example:
169 zstyle ':grml:chpwd:dirstack' exclude "/tmp(|/*)" "$HOME/tmp(|/*)"
172 The function based filter is more general, the pattern based filter easier to
173 set up. If both filter variants are used at the same time, the function based
174 filter will be executed //before// the pattern based one.
176 If you would like to apply your filters while //loading// the persistent
177 dirstack file, set the //filter-on-load// boolean style (the default is
181 zstyle ':grml:chpwd:dirstack' filter-on-load true
184 Setting the //filter-on-load// needs to be done in ".zshrc.pre" because the
185 style needs to be set when the main setup is executing! The other styles do not
186 have this limitation, but the initial filtering will obviously be done using
187 the filters that are configured **at** **that** **point**. The rule of thumb
188 is: If you want to filter on load, setup everything in ".zshrc.pre" otherwise
189 ".zshrc.local" works just as well.
192 == DIRECTORY BASED PROFILES ==
194 If you need to perform certain actions each time you enter certain
195 directory-trees, this is the feature you are looking for.
198 === Initialisation ===
199 To initialise the system, you need to call the function `chpwd_profiles' at
200 some point in your `zshrc.local'; preferably **after** you configured the
201 system. The configuration of the system is described further below.
203 If you need to do initialisations the first time `chpwd_profiles' is called
204 (which should be in your configuration file), you can do that in a function
205 called "chpwd_profiles_init". That function needs to be defined **before**
206 `chpwd_profiles' is called for this to work.
208 During the **first** call of `chpwd_profiles' (and therefore all its profile
209 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
210 all other cases, the parameter does not exist at all.
213 === Styles and Profile-names ===
214 To store its configuration, the system uses **functions** and **styles**
215 (zsh's context sensitive configuration system), such as this:
219 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
220 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
223 When that's done and you enter a directory that matches the pattern in the
224 third part of the context, a function called chpwd_profile_grml, for example,
225 is called (if it exists).
227 If no pattern matches (read: no profile is detected) the profile is set to
228 'default', which means chpwd_profile_default is attempted to be called.
230 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
231 which is used: The third part in the context is matched against ${PWD}. That's
232 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
233 profile is detected for all these values of ${PWD}:
240 So, if you want to make double damn sure a profile works in /foo/bar and
241 everywhere deeper in that tree, just use (|/|/*) and be happy.
243 The name of the detected profile will be available in a variable called
244 'profile' in your functions. You don't need to do anything, it'll just be
248 === Controlling Profile Execution ===
250 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
251 which is set to the profile that was is currently active (the default value is
252 "default"). That way you can avoid running code for a profile that is already
253 active, by running code such as the following at the start of your function:
256 function chpwd_profile_grml() {
257 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
262 If you know you are going to do that all the time for each and every
263 directory-profile function you are ever going to write, you may also set the
264 `re-execute' style to `false' (which only defaults to `true' for backwards
265 compatibility), like this:
268 zstyle ':chpwd:profiles:*' re-execute false
272 === Signaling availabily/profile changes ===
274 If you use this feature and need to know whether it is active in your current
275 shell, there are several ways to do that. Here are two simple ways:
277 a) If knowing if the profiles feature is active when zsh starts is good
278 enough for you, you can use the following snippet:
280 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
282 b) If that is not good enough, and you would prefer to be notified whenever a
283 profile changes, you can solve that by making sure you start **every**
284 profile function you create like this:
286 function chpwd_profile_myprofilename() {
287 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
288 print "chpwd(): Switching to profile: $profile"
292 That makes sure you only get notified if a profile is **changed**, not
293 everytime you change directory. (To avoid this, you may also set the newer
294 `re-execute' style like described further above instead of the test on top of
298 === Leaving Profiles ===
300 When the system switches from one profile to another, it executes a function
301 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
302 profile-function for the new profile.
305 === Version requirement ===
306 This feature requires zsh //4.3.3// or newer.
309 == ACCEPTLINE WRAPPER ==
310 The //accept-line// wiget is the one that is taking action when the **return**
311 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
314 This wrapper is configured via styles. That means, you issue commands, that look
318 zstyle 'context' style value
321 The context namespace, that we are using is 'acceptline'. That means, the actual
322 context for your commands look like: **':acceptline:<subcontext>'**.
324 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
328 === Recognized Contexts ===
330 This is the value, the context is initialized with.
331 The //compwarnfmt and //rehash// styles are looked up in this context.
334 If the first word in the command line is either a command, alias, function,
335 builtin or reserved word, you are in this context.
338 This is the context, that is used if you hit enter again, after being warned
339 about the existence of a _completion for the non-existing command you
343 This is the context, you are in if the command line is empty or only
344 consists of whitespace.
347 This context is in effect, if you entered something that does not match any
348 of the above. (e.g.: variable assignments).
351 === Available Styles ===
353 If you set this style to true, the warning about non existent commands,
354 for which completions exist will not be issued. (Default: **false**)
357 The message, that is displayed to warn about the _completion issue.
358 (default: **'%c will not execute and completion %f exists.'**)
359 '%c' is replaced by the command name, '%f' by the completion's name.
362 If this is set, we'll force rehashing, if appropriate. (Defaults to
363 **true** in //grmlzshrc//).
366 This can be a list of wigdets to call in a given context. If you need a
367 specific order for these to be called, name them accordingly. The default value
368 is an **empty list**.
371 The name of a widget, that is called after the widgets from 'actions'.
372 By default, this will be '.accept-line' (which is the built-in accept-line
376 If true in the current context, call the widget in the 'default_action'
377 style. (The default is **true** in all contexts.)
382 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
383 **promptinit** system. The three themes are called **grml**, **grml-large** and
386 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
387 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
388 non-empty, **grml-chroot** is used.
390 As usual, with promtinit themes, the user may switch to a different theme using
391 the //prompt// utility:
397 That will use the **grml-large** prompt theme.
399 The themes are highly customisable. The main source of documentation about
400 customisation is the main **grml** theme's doc-string, that is available via
401 the following command:
407 The other themes also come with doc-strings, but the main theme's is the
408 canonical reference about all of them.
410 This feature requires version //4.3.7// of the shell. Older versions will use
411 the classic grml prompt as a fallback.
413 A note to people who like customisation: If you are **not** using a prompt
414 theme for your customisation, but you're either statically setting $PS1 (or
415 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
416 function, make sure you are turning the zsh's prompt theme system **off**
417 before doing so. A correct example customisation could look like this:
420 # Turn the prompt system off:
422 # Customise the prompt yourself:
426 You also add your own tokens by using the \`grml_theme_add_token()' function.
427 Call the function without arguments for detailed documentation about that
430 == GNU/SCREEN STATUS SETTING ==
431 //grmlzshrc// sets screen's hardstatus lines to the currently running command
432 or **'zsh'** if the shell is idling at its prompt. If the current working
433 directory is inside a repository unter version control, screen status is set
434 to: **'zsh: <repository name>'** via zsh's vcs_info.
437 == PERSISTENT HISTORY ==
438 If you got commands you consider important enough to be included in every
439 shell's history, you can put them into ~/.important_commands and they will be
440 available via the usual history lookup widgets.
444 == ENVIRONMENT VARIABLES ==
445 //grmlzshrc// sets some environment variables, which influence the
446 behaviour of applications.
449 Set to "yes". Some applications read this to learn about properties
450 of the terminal they are running in.
453 If not already set, sets the default editor. Falls back to vi(1),
454 if vim(1) is not available.
457 Some environment variables that add colour support to less(1) for viewing
458 man pages. See termcap(5) for details.
461 The mailbox file for the current user is set to /var/mail/$USER, if not
462 already set otherwise.
465 Set less(1) as default pager, if not already set to something different.
469 Apart from zsh's default options, //grmlzshrc// sets some options
470 that change the behaviour of zsh. Options that change Z-shell's default
471 settings are marked by <grml>. But note, that zsh's defaults vary depending
472 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
475 Zsh sessions, that use //grmlzshrc//, will append their history list to the
476 history file, rather than replace it. Thus, multiple parallel zsh sessions
477 will all have the new entries from their history lists added to the history
478 file, in the order that they exit. The file will still be periodically
479 re-written to trim it when the number of lines grows 20% beyond the value
480 specified by $SAVEHIST.
483 If a command is issued that can't be executed as a normal command, and the
484 command is the name of a directory, perform the cd command to that directory.
486 : **auto_pushd** <grml>
487 Make cd push the old directory onto the directory stack.
489 : **completeinword** <grml>
490 If the cursor is inside a word, completion is done from both ends;
491 instead of moving the cursor to the end of the word first and starting
494 : **extended_glob** <grml>
495 Treat the '#', '~' and '^' characters as active globbing pattern characters.
497 : **extended_history** <grml>
498 Save each command's beginning timestamp (in seconds since the epoch) and the
499 duration (in seconds) to the history file.
502 Whenever a command completion is attempted, make sure the entire command
503 path is hashed first. This makes the first completion slower.
505 : **histignorealldups** <grml>
506 If a new command line being added to the history list duplicates an
507 older one, the older command is removed from the list, even if it is
508 not the previous event.
510 : **histignorespace** <grml>
511 Remove command lines from the history list when the first character on
512 the line is a space, or when one of the expanded aliases contains a
513 leading space. Note that the command lingers in the internal history
514 until the next command is entered before it vanishes.
516 : **longlistjobs** <grml>
517 List jobs in long format by default.
520 Avoid to beep on errors in zsh command line editing (zle).
523 A wildcard character never matches a leading '.'.
526 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
528 : **nonomatch** <grml>
529 If a pattern for filename generation has no matches, do not print an error
530 and leave it unchanged in the argument list. This also applies to file
531 expansion of an initial `~' or `='.
534 Report the status of background jobs immediately, rather than waiting until
535 just before printing a prompt.
537 : **pushd_ignore_dups** <grml>
538 Don't push multiple copies of the same directory onto the directory stack.
540 : **share_history** <grml>
541 As each line is added to the history file, it is checked to see if anything
542 else was written out by another shell, and if so it is included in the
543 history of the current shell too. Using !-style history, the commands from
544 the other sessions will not appear in the history list unless you explicitly
545 type the "history" command. This option is activated for zsh versions >= 4,
550 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
551 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
555 Edit the current command buffer in your favourite editor.
558 Deletes a word left of the cursor; seeing '/' as additional word separator.
561 Jump right after the first word.
564 Create directory under cursor or the selected area.
565 To select an area press ctrl-@ and use the cursor.
566 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
567 directory does not exist yet -> press **CTRL-xM** and problem solved.
570 Searches the last occurence of string before the cursor in the command history.
573 Display help on keybindings and zsh line editor. Press consecutively to page through content.
576 Brings a job, which got suspended with CTRL-z back to foreground.
579 === Customisation ===
581 To customise keybindings, you can just use zsh's bindkey utility. However, if
582 you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
583 yourself, make sure you call the following functions in the respective hook:
585 - **zle-line-init**: //zle-smkx//
586 - **zle-line-finish**: //zle-rmkx//
589 This is **required** so the keybindings set up by //grmlzshrc// work. The
590 reason for this is to turn the terminal into the right mode while zsh's line
591 editor (zle) is running. This enables us to query //terminfo// about escape
592 sequences for special keys and thus simplify and generalise our keybinding
596 == SHELL FUNCTIONS ==
597 //grmlzshrc// comes with a wide array of defined shell functions to ease the
600 : **855resolution()**
601 If 915resolution is available, issues a warning to the user to run it instead
602 to modify the resolution on intel graphics chipsets.
605 Lists files in current directory, which have been accessed within the
606 last N days. N is an integer to be passed as first and only argument.
607 If no argument is specified N is set to 1.
610 Lists processes matching given pattern.
613 Login on the host provided as argument using autossh. Then reattach a GNU screen
614 session if a detached session is around or detach a currently attached screen or
615 else start a new screen. This is especially useful for roadwarriors using GNU
619 Simple backup management of a file or directory using standard unix programs.
620 The target file name is the original name plus a time stamp attached. Symlinks
621 and file attributes like mode, ownership and timestamps are preserved.
624 If the original cdrecord is not installed, issues a warning to the user to
625 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
629 Creates a temporary directory using mktemp. Then changes current
630 working directory to it.
633 Lists files in current directory, which have been changed within the
634 last N days. N is an integer to be passed as first and only argument.
635 If no argument is specified N is set to 1.
638 Returns true if given command exists either as program, function, alias,
639 builtin or reserved word. If the option -c is given, only returns true,
640 if command is a program.
643 Changes directory to $HOME on first invocation of zsh. This is necessary on
644 Grml systems with autologin.
647 Changes current directory to the one supplied by argument and lists the files
648 in it, including file names starting with ".".
651 Shows the changelog of given package in $PAGER.
654 Shows the copyright of given package in $PAGER.
657 Tells the user to use grml-debootstrap, if she wants to install debian to
661 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
662 back interactive responsiveness after suspend, when the system is swapping
666 Shows the NEWS file for the given package in $PAGER.
672 Edit given shell function.
675 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
677 : **grml_vcs_info_toggle_colour()**
678 Toggles between coloured and uncoloured formats in vcs_info configuration.
679 This is useful with prompts that break if colour codes are in vcs_info
680 format expansions (like the `clint' prompt and every other prompt that
681 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
682 customised vcs_info formats, you shouldn't be using this function, since
683 it will set all formats to grml's default values (either coloured or plain)
687 Use GNU diff with options -ubwd for mercurial.
690 Displays diffstat between the revision given as argument and tip (no
691 argument means last revision).
694 Outputs highlighted diff; needs highstring(1).
697 Returns true, if zsh version is equal or greater than 4, else false.
700 Returns true, if zsh version is equal or greater than 4.1, else false.
703 Returns true, if zsh version is equal or greater than 4.2, else false.
706 Returns true, if zsh version is equal or greater than 4.2.5, else false.
709 Returns true, if zsh version is equal or greater than 4.3, else false.
712 Returns true, if zsh version is equal or greater than 4.3.3, else false.
715 Returns true, if running on darwin, else false.
718 Returns true, if running on FreeBSD, else false.
721 Returns true, if running on a grml system, else false.
724 Returns true, if running on a grml system from a live cd, else false.
727 Returns true, if run on grml-small, else false.
730 Returns true, if running on Linux, else false.
733 Changes every occurrence of the string iso885915 or ISO885915 in
734 environment variables to UTF-8.
737 Returns true, if running on OpenBSD, else false.
740 Returns true, if run within an utf environment, else false.
743 Creates directory including parent directories, if necessary. Then changes
744 current working directory to it.
747 Lists files in current directory, which have been modified within the
748 last N days. N is an integer to be passed as first and only argument.
749 If no argument is specified N is set to 1.
752 A helper function for the "e" glob qualifier to list all files newer
753 than a reference file.
757 % NTREF=/reference/file
760 % ls -l *(e:'nt /reference/file':)
764 Runs a command in zsh with profiling enabled (See startup variable
765 ZSH_PROFILE_RC above).
768 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
769 for details. See also xunfunction() below.
771 : **simple-extract()**
772 Tries to uncompress/unpack given files with the appropriate programs. If an URI
773 starting with https, http or ftp is provided simple-extract tries to download
774 and then uncompress/unpack the file. The choice is made along the filename
775 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
776 .xz) unless you use the '-d' option.
779 Prints details of symlinks given as arguments.
781 : **ssl-cert-fingerprints**
782 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
783 First and only parameter must be a file containing a certificate. Use
784 /dev/stdin as file if you want to pipe a certificate to these
788 Prints all information of a x509 certificate including the SHA512,
789 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
790 containing a certificate. Use /dev/stdin as file if you want to pipe a
791 certificate to this function.
793 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
794 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
795 certificate. First and only parameter must be a file containing a
796 certificate. Use /dev/stdin as file if you want to pipe a certificate
799 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
800 Functions for controlling daemons.
807 Translates a word from german to english (-D) or vice versa (-E).
810 Shows upstreams changelog of a given package in $PAGER.
813 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
816 Changes every occurrence of the string UTF-8 or utf-8 in environment
817 variables to iso885915.
820 Wrapper for vim(1). It tries to set the title and hands vim the environment
821 variable VIM_OPTIONS on the command line. So the user may define command
822 line options, she always wants, in her .zshrc.local.
825 Searches the history for a given pattern and lists the results by date.
826 The first argument is the search pattern. The second and third ones are
827 optional and denote a search range (default: -100).
830 Tries to cat(1) file(s) given as parameter(s). Always returns true.
831 See also xunfunction() below.
834 Tries to source the file(s) given as parameter(s). Always returns true.
835 See zshbuiltins(1) for a detailed description of the source command.
836 See also xunfunction() below.
839 Changes the title of xterm window from within screen(1). Run without
840 arguments for details.
843 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
846 Wrapper around the autoload builtin. Loads the definitions of functions
847 from the file given as argument. Searches $fpath for the file. See also
851 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
852 where own modifications should go. See also zshbuiltins(1) for a description
853 of the source command.
857 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
858 life. A few aliases (like those involving //grep// or //ls//) use the option
859 //--color=auto// for colourizing output. That option is part of **GNU**
860 implementations of these tools, and will only be used if such an implementation
863 : **acp** (//apt-cache policy//)
864 With no arguments prints out the priorities of each source. If a package name
865 is given, it displays detailed information about the priority selection of the
868 : **acs** (//apt-cache search//)
869 Searches debian package lists for the regular expression provided as argument.
870 The search includes package names and descriptions. Prints out name and short
871 description of matching packages.
873 : **acsh** (//apt-cache show//)
874 Shows the package records for the packages provided as arguments.
876 : **adg** (//apt-get dist-upgrade//)
877 Performs an upgrade of all installed packages. Also tries to automatically
878 handle changing dependencies with new versions of packages. As this may change
879 the install status of (or even remove) installed packages, it is potentially
880 dangerous to use dist-upgrade; invoked by sudo, if necessary.
882 : **ag** (//apt-get upgrade//)
883 Downloads and installs the newest versions of all packages currently installed
884 on the system. Under no circumstances are currently installed packages removed,
885 or packages not already installed retrieved and installed. New versions of
886 currently installed packages that cannot be upgraded without changing the install
887 status of another package will be left at their current version. An update must
888 be performed first (see au below); run by sudo, if necessary.
890 : **agi** (//apt-get install//)
891 Downloads and installs or upgrades the packages given on the command line.
892 If a hyphen is appended to the package name, the identified package will be
893 removed if it is installed. Similarly a plus sign can be used to designate a
894 package to install. This may be useful to override decisions made by apt-get's
895 conflict resolution system.
896 A specific version of a package can be selected for installation by following
897 the package name with an equals and the version of the package to select. This
898 will cause that version to be located and selected for install. Alternatively a
899 specific distribution can be selected by following the package name with a slash
900 and the version of the distribution or the Archive name (stable, testing, unstable).
901 Gets invoked by sudo, if user id is not 0.
903 : **ati** (//aptitude install//)
904 Aptitude is a terminal-based package manager with a command line mode similar to
905 apt-get (see agi above); invoked by sudo, if necessary.
907 : **au** (//apt-get update//)
908 Resynchronizes the package index files from their sources. The indexes of
909 available packages are fetched from the location(s) specified in
910 /etc/apt/sources.list. An update should always be performed before an
911 upgrade or dist-upgrade; run by sudo, if necessary.
913 : **da** (//du -sch//)
914 Prints the summarized disk usage of the arguments as well as a grand total
915 in human readable format.
917 : **dbp** (//dpkg-buildpackage//)
918 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
920 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
921 Prints installed Packages sorted by size (descending).
923 : **dir** (//ls -lSrah//)
924 Lists files (including dot files) sorted by size (biggest last) in long and
925 human readable output format.
927 : **ge** (//grep-excuses//)
928 Searches the testing excuses files for a specific maintainer (See:
931 : **grep** (//grep --color=auto//)
932 Shows grep output in nice colors, if available.
934 : **grml-version** (//cat /etc/grml_version//)
935 Prints version of running grml.
937 : **hbp** (//hg-buildpackage//)
938 Helper program to maintain Debian packages with mercurial.
940 : **http** (//python -m SimpleHTTPServer//)
941 Basic HTTP server implemented in python. Listens on port 8000/tcp and
942 serves current directory. Implements GET and HEAD methods.
944 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
945 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
946 host key changes frequently, for example on virtualized test- or development-systems.
947 To be used only inside trusted networks, of course.
949 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
950 ssh with possible man-in-the-middle attack enabled
951 (for an explanation see insecscp above).
953 : **help-zshglob** (//H-Glob()//)
954 Runs the function H-Glob() to expand or explain wildcards.
956 : **j** (//jobs -l//)
957 Prints status of jobs in the current shell session in long format.
959 : **l** (//ls -l --color=auto//)
960 Lists files in long output format with indicator for filetype appended
961 to filename. If the terminal supports it, with colored output.
963 : **la** (//ls -la --color=auto//)
964 Lists files in long colored output format. Including file names
967 : **lad** (//ls -d .*(/)//)
968 Lists the dot directories (not their contents) in current directory.
970 : **lh** (//ls -hAl --color=auto//)
971 Lists files in long and human readable output format in nice colors,
972 if available. Includes file names starting with "." except "." and
975 : **ll** (//ls -l --color=auto//)
976 Lists files in long colored output format.
978 : **llog** (//$PAGER /var/log/syslog//)
979 Opens syslog in pager.
981 : **ls** (//ls -C --color=auto//)
982 Lists directory, entries are listed by columns and an indicator for
983 file type is appended to each file name. Additionally the output is
984 colored, if the terminal supports it.
986 : **lsa** (//ls -a .*(.)//)
987 Lists dot files in current working directory.
989 : **lsbig** (//ls -flh *(.OL[1,10])//)
990 Displays the ten biggest files (long and human readable output format).
992 : **lsd** (//ls -d *(/)//)
995 : **lse** (//ls -d *(/^F)//)
996 Shows empty directories.
998 : **lsl** (//ls -l *(@)//)
999 Lists symbolic links in current directory.
1001 : **lsnew** (//ls -rl *(D.om[1,10])//)
1002 Displays the ten newest files (long output format).
1004 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
1005 Displays the ten newest directories and ten newest .directories.
1007 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1008 Displays the ten oldest files (long output format).
1010 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
1011 Displays the ten oldest directories and ten oldest .directories.
1013 : **lss** (//ls -l *(s,S,t)//)
1014 Lists files in current directory that have the setuid, setgid or sticky bit
1017 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1018 Displays the ten smallest files (long output format).
1020 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1021 Displays all files which are world readable and/or world writable and/or
1022 world executable (long output format).
1024 : **lsx** (//ls -l *(*)//)
1025 Lists only executable files.
1027 : **mdstat** (//cat /proc/mdstat//)
1028 Lists all active md (i.e. linux software raid) devices with some information
1031 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1032 Executes the commands on the versioned patch queue from current repository.
1034 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1035 rmdir current working directory
1037 : **screen** (//screen -c file//)
1038 If invoking user is root, starts screen session with /etc/grml/screenrc
1039 as config file. If invoked by a regular user and users .screenc does not exist,
1040 starts screen with /etc/grml/screenrc_grml config if it exists, else fallbacks
1041 to /etc/grml/screenrc.
1043 : **su** (//sudo su//)
1044 If user is running a Grml live system, don't ask for any password, if she
1047 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1048 Sets mode from UTF-8 to ISO 2022 (See:
1049 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1051 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1052 Sets mode from ISO 2022 to UTF-8 (See:
1053 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1055 : **tlog** (//tail -f /var/log/syslog//)
1056 Prints syslog continuously (See tail(1)).
1058 : **up** (//aptitude update ; aptitude safe-upgrade//)
1059 Performs a system update followed by a system upgrade using aptitude; run
1060 by sudo, if necessary. See au and ag above.
1062 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1063 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1064 protect them from the shell.
1066 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1067 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1069 : **...** (//cd ../..///)
1070 Changes current directory two levels higher.
1074 This is a set of files, that - if they exist - can be used to customize the
1075 behaviour of //grmlzshrc//.
1078 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1079 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1082 # show battery status in RPROMPT
1083 GRML_DISPLAY_BATTERY=1
1084 # always load the complete setup, even for root
1085 GRML_ALWAYS_LOAD_ALL=1
1089 Sourced right before loading //grmlzshrc// is finished. There is a global
1090 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1094 Directory listing for persistent dirstack (see above).
1096 : **.important_commands**
1097 List of commands, used by persistent history (see above).
1100 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1101 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1102 (http://www.ubuntu.com) and similar systems - it is very easy to get
1103 //grmlzshrc// via grml's .deb repositories.
1105 On non-debian systems, that is not an option, but all is not lost:
1108 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1111 If you would also like to get separate function files (which you can put into
1112 your **$fpath**), you can browse and download them at:
1114 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1116 = ZSH REFCARD TAGS =
1117 If you read //grmlzshrc//'s code you may notice strange looking comments in
1118 it. These are there for a purpose. grml's zsh-refcard is automatically
1119 generated from the contents of the actual configuration file. However, we need
1120 a little extra information on which comments and what lines of code to take
1121 into account (and for what purpose).
1123 Here is what they mean:
1125 List of tags (comment types) used:
1127 Next line contains an important alias, that should be included in the
1128 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1131 Next line contains the beginning of an important function. (placement
1132 tag: @@INSERT-functions@@)
1135 Next line contains an important variable. (placement tag:
1136 @@INSERT-variables@@)
1139 Next line contains an important keybinding. (placement tag:
1140 @@INSERT-keybindings@@)
1143 Hashed directories list generation: //start//: denotes the start of a list of
1144 'hash -d' definitions. //end//: denotes its end. (placement tag:
1145 @@INSERT-hasheddirs@@)
1148 Abbreviation expansion list generation: //start//: denotes the beginning of
1149 abbreviations. //end//: denotes their end.
1151 Lines within this section that end in '#d .*' provide extra documentation to
1152 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1155 This tag allows you to manually generate refcard entries for code lines that
1156 are hard/impossible to parse.
1160 #m# k ESC-h Call the run-help function
1163 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1166 So the syntax is: #m# <section> <argument> <comment>
1169 This tag lets you insert entries to the 'other' hash. Generally, this should
1170 not be used. It is there for things that cannot be done easily in another way.
1171 (placement tag: @@INSERT-other-foobar@@)
1174 All of these tags (except for m and o) take two arguments, the first
1175 within the tag, the other after the tag:
1177 #<tag><section># <comment>
1179 Where <section> is really just a number, which are defined by the @secmap
1180 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1181 that for the reader, the tag should not differ much from a regular comment.
1182 For zsh, it is a regular comment indeed. The numbers have got the following
1207 So, the following will add an entry to the 'functions' table in the 'system'
1208 section, with a (hopefully) descriptive comment:
1211 #f1# Edit an alias via zle
1215 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1216 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1217 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1218 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1219 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1223 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1224 repository from git.grml.org:
1226 ``` % git clone git://git.grml.org/grml-etc-core.git
1228 Make your changes, commit them; use '**git format-patch**' to create a series
1229 of patches and send those to the following address via '**git send-email**':
1231 ``` grml-etc-core@grml.org
1233 Doing so makes sure the right people get your patches for review and
1238 This manual page is the **reference** manual for //grmlzshrc//.
1240 That means that in contrast to the existing refcard it should document **every**
1241 aspect of the setup.
1243 This manual is currently not complete. If you want to help improving it, visit
1244 the following pages:
1246 http://wiki.grml.org/doku.php?id=zshrcmanual
1248 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1250 Contributions are highly welcome.
1254 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1255 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1256 Beckert <abe@deuxchevaux.org>.
1260 Copyright (c) 2009-2013 Grml project <http://grml.org>
1262 This manpage is distributed under the terms of the GPL version 2.
1264 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1265 except for **accept-line()** which are distributed under the same conditions
1266 as zsh itself (which is BSD-like).