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 If set to zero (default), allows selection from a menu, if there are at least
105 five possible options of completion.
108 A non zero value disables precmd and preexec commands. These are functions
109 that are run before every command (setting xterm/screen titles etc.).
112 Show time (user, system and cpu) used by external commands, if they run longer
113 than the defined number of seconds (default: 5).
116 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
117 and to 10000 on an installation on hard disk.
120 As in tcsh(1) an array of login/logout events to be reported by the shell
121 builtin "log". For details see zshparam(1). Defaults to (notme root).
123 : **ZSH_NO_DEFAULT_LOCALE**
124 Import "/etc/default/locale", if set to zero (default).
127 A non zero value causes shell functions to be profiled. The results can be
128 obtained with the zprof builtin command (see zshmodules(1) for details).
131 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
134 = FEATURE DESCRIPTION =
135 This is an in depth description of non-standard features implemented by
138 == DIRSTACK HANDLING ==
139 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
140 file each time zsh's working directory is changed. That file can be configured
141 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
142 **DIRSTACKSIZE** variable defaults to **20** in this setup.
144 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
145 zshs inherit the dirstack of the zsh that most recently updated
148 If you would like to //disable// the persistent dirstack feature altogether,
149 you can do that by setting the boolean //enable// style to //false// in the
150 right context (the default is //true//):
153 zstyle ':grml:chpwd:dirstack' enable false
156 It is possible to apply a filter to the names of directories that will be
157 committed to the persistent dirstack file. There are two ways to configure this
158 filter: A general function based filter and a pattern based filter. Both are
159 setup via styles in the **':grml:chpwd:dirstack'** context.
161 To use a function based filter set the //filter// style for that context to the
162 name of a function to call every time a directory name is to be added to the
163 persistent dirstack. If the function's return value signals success (ie. return
164 value "0"), the directory name is filtered out and **not** added to the
165 persistent stack. Example:
168 function my_dirstack_filter() { [[ $1 == /tmp(|/*) ]] }
169 zstyle ':grml:chpwd:dirstack' filter my_dirstack_filter
172 The pattern based filter uses a list of patterns passed to the //exclude//
173 style in the aforementioned context. Each pattern is tested and the first that
174 matches will keep the directory name from being added to the persistent stack.
175 If none of the patterns matches, the name is added. example:
178 zstyle ':grml:chpwd:dirstack' exclude "/tmp(|/*)" "$HOME/tmp(|/*)"
181 The function based filter is more general, the pattern based filter easier to
182 set up. If both filter variants are used at the same time, the function based
183 filter will be executed //before// the pattern based one.
185 If you would like to apply your filters while //loading// the persistent
186 dirstack file, set the //filter-on-load// boolean style (the default is
190 zstyle ':grml:chpwd:dirstack' filter-on-load true
193 Setting the //filter-on-load// and //enable// styles needs to be done in
194 ".zshrc.pre" because the styles need to be set when the main setup is
195 executing! The other styles do not have this limitation, but enabling the
196 system as well as the initial filtering will obviously be done using settings
197 and filters that are configured **at** **that** **point**.
199 With respect to //filter-on-load//, the rule of thumb is: If you want to filter
200 on load, setup everything in ".zshrc.pre" otherwise ".zshrc.local" works just
204 == DIRECTORY BASED PROFILES ==
206 If you need to perform certain actions each time you enter certain
207 directory-trees, this is the feature you are looking for.
210 === Initialisation ===
211 To initialise the system, you need to call the function `chpwd_profiles' at
212 some point in your `zshrc.local'; preferably **after** you configured the
213 system. The configuration of the system is described further below.
215 If you need to do initialisations the first time `chpwd_profiles' is called
216 (which should be in your configuration file), you can do that in a function
217 called "chpwd_profiles_init". That function needs to be defined **before**
218 `chpwd_profiles' is called for this to work.
220 During the **first** call of `chpwd_profiles' (and therefore all its profile
221 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
222 all other cases, the parameter does not exist at all.
225 === Styles and Profile-names ===
226 To store its configuration, the system uses **functions** and **styles**
227 (zsh's context sensitive configuration system), such as this:
231 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
232 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
235 When that's done and you enter a directory that matches the pattern in the
236 third part of the context, a function called chpwd_profile_grml, for example,
237 is called (if it exists).
239 If no pattern matches (read: no profile is detected) the profile is set to
240 'default', which means chpwd_profile_default is attempted to be called.
242 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
243 which is used: The third part in the context is matched against ${PWD}. That's
244 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
245 profile is detected for all these values of ${PWD}:
252 So, if you want to make double damn sure a profile works in /foo/bar and
253 everywhere deeper in that tree, just use (|/|/*) and be happy.
255 The name of the detected profile will be available in a variable called
256 'profile' in your functions. You don't need to do anything, it'll just be
260 === Controlling Profile Execution ===
262 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
263 which is set to the profile that was is currently active (the default value is
264 "default"). That way you can avoid running code for a profile that is already
265 active, by running code such as the following at the start of your function:
268 function chpwd_profile_grml() {
269 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
274 If you know you are going to do that all the time for each and every
275 directory-profile function you are ever going to write, you may also set the
276 `re-execute' style to `false' (which only defaults to `true' for backwards
277 compatibility), like this:
280 zstyle ':chpwd:profiles:*' re-execute false
284 === Signaling availabily/profile changes ===
286 If you use this feature and need to know whether it is active in your current
287 shell, there are several ways to do that. Here are two simple ways:
289 a) If knowing if the profiles feature is active when zsh starts is good
290 enough for you, you can use the following snippet:
292 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
294 b) If that is not good enough, and you would prefer to be notified whenever a
295 profile changes, you can solve that by making sure you start **every**
296 profile function you create like this:
298 function chpwd_profile_myprofilename() {
299 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
300 print "chpwd(): Switching to profile: $profile"
304 That makes sure you only get notified if a profile is **changed**, not
305 everytime you change directory. (To avoid this, you may also set the newer
306 `re-execute' style like described further above instead of the test on top of
310 === Leaving Profiles ===
312 When the system switches from one profile to another, it executes a function
313 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
314 profile-function for the new profile.
317 === Version requirement ===
318 This feature requires zsh //4.3.3// or newer.
321 == ACCEPTLINE WRAPPER ==
322 The //accept-line// wiget is the one that is taking action when the **return**
323 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
326 This wrapper is configured via styles. That means, you issue commands, that look
330 zstyle 'context' style value
333 The context namespace, that we are using is 'acceptline'. That means, the actual
334 context for your commands look like: **':acceptline:<subcontext>'**.
336 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
340 === Recognized Contexts ===
342 This is the value, the context is initialized with.
343 The //compwarnfmt and //rehash// styles are looked up in this context.
346 If the first word in the command line is either a command, alias, function,
347 builtin or reserved word, you are in this context.
350 This is the context, that is used if you hit enter again, after being warned
351 about the existence of a _completion for the non-existing command you
355 This is the context, you are in if the command line is empty or only
356 consists of whitespace.
359 This context is in effect, if you entered something that does not match any
360 of the above. (e.g.: variable assignments).
363 === Available Styles ===
365 If you set this style to true, the warning about non existent commands,
366 for which completions exist will not be issued. (Default: **false**)
369 The message, that is displayed to warn about the _completion issue.
370 (default: **'%c will not execute and completion %f exists.'**)
371 '%c' is replaced by the command name, '%f' by the completion's name.
374 If this is set, we'll force rehashing, if appropriate. (Defaults to
375 **true** in //grmlzshrc//).
378 This can be a list of wigdets to call in a given context. If you need a
379 specific order for these to be called, name them accordingly. The default value
380 is an **empty list**.
383 The name of a widget, that is called after the widgets from 'actions'.
384 By default, this will be '.accept-line' (which is the built-in accept-line
388 If true in the current context, call the widget in the 'default_action'
389 style. (The default is **true** in all contexts.)
394 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
395 **promptinit** system. The three themes are called **grml**, **grml-large** and
398 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
399 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
400 non-empty, **grml-chroot** is used.
402 As usual, with promptinit themes, the user may switch to a different theme using
403 the //prompt// utility:
409 That will use the **grml-large** prompt theme.
411 The themes are highly customisable. The main source of documentation about
412 customisation is the main **grml** theme's doc-string, that is available via
413 the following command:
419 The other themes also come with doc-strings, but the main theme's is the
420 canonical reference about all of them.
422 This feature requires version //4.3.7// of the shell. Older versions will use
423 the classic grml prompt as a fallback.
425 A note to people who like customisation: If you are **not** using a prompt
426 theme for your customisation, but you're either statically setting $PS1 (or
427 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
428 function, make sure you are turning the zsh's prompt theme system **off**
429 before doing so. A correct example customisation could look like this:
432 # Turn the prompt system off:
434 # Customise the prompt yourself:
438 You also add your own tokens by using the \`grml_theme_add_token()' function.
439 Call the function without arguments for detailed documentation about that
442 == GNU/SCREEN STATUS SETTING ==
443 //grmlzshrc// sets screen's hardstatus lines to the currently running command
444 or **'zsh'** if the shell is idling at its prompt. If the current working
445 directory is inside a repository unter version control, screen status is set
446 to: **'zsh: <repository name>'** via zsh's vcs_info.
449 == PERSISTENT HISTORY ==
450 If you got commands you consider important enough to be included in every
451 shell's history, you can put them into $GRML_IMPORTANT_COMMANDS (which defaults
452 for backward compatibility to ~/.important_commands) and they will be available
453 via the usual history lookup widgets.
457 == ENVIRONMENT VARIABLES ==
458 //grmlzshrc// sets some environment variables, which influence the
459 behaviour of applications.
462 Set to "yes". Some applications read this to learn about properties
463 of the terminal they are running in.
466 If not already set, sets the default editor. Falls back to vi(1),
467 if vim(1) is not available.
470 Some environment variables that add colour support to less(1) for viewing
471 man pages. See termcap(5) for details.
474 The mailbox file for the current user is set to /var/mail/$USER, if not
475 already set otherwise.
478 Set less(1) as default pager, if not already set to something different.
482 Apart from zsh's default options, //grmlzshrc// sets some options
483 that change the behaviour of zsh. Options that change Z-shell's default
484 settings are marked by <grml>. But note, that zsh's defaults vary depending
485 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
488 Zsh sessions, that use //grmlzshrc//, will append their history list to the
489 history file, rather than replace it. Thus, multiple parallel zsh sessions
490 will all have the new entries from their history lists added to the history
491 file, in the order that they exit. The file will still be periodically
492 re-written to trim it when the number of lines grows 20% beyond the value
493 specified by $SAVEHIST.
496 If a command is issued that can't be executed as a normal command, and the
497 command is the name of a directory, perform the cd command to that directory.
499 : **auto_pushd** <grml>
500 Make cd push the old directory onto the directory stack.
502 : **completeinword** <grml>
503 If the cursor is inside a word, completion is done from both ends;
504 instead of moving the cursor to the end of the word first and starting
507 : **extended_glob** <grml>
508 Treat the '#', '~' and '^' characters as active globbing pattern characters.
510 : **extended_history** <grml>
511 Save each command's beginning timestamp (in seconds since the epoch) and the
512 duration (in seconds) to the history file.
515 Whenever a command completion is attempted, make sure the entire command
516 path is hashed first. This makes the first completion slower.
518 : **histignorealldups** <grml>
519 If a new command line being added to the history list duplicates an
520 older one, the older command is removed from the list, even if it is
521 not the previous event.
523 : **histignorespace** <grml>
524 Remove command lines from the history list when the first character on
525 the line is a space, or when one of the expanded aliases contains a
526 leading space. Note that the command lingers in the internal history
527 until the next command is entered before it vanishes.
529 : **longlistjobs** <grml>
530 List jobs in long format by default.
533 Avoid to beep on errors in zsh command line editing (zle).
536 A wildcard character never matches a leading '.'.
539 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
541 : **nonomatch** <grml>
542 If a pattern for filename generation has no matches, do not print an error
543 and leave it unchanged in the argument list. This also applies to file
544 expansion of an initial `~' or `='.
547 Report the status of background jobs immediately, rather than waiting until
548 just before printing a prompt.
550 : **pushd_ignore_dups** <grml>
551 Don't push multiple copies of the same directory onto the directory stack.
553 : **share_history** <grml>
554 As each line is added to the history file, it is checked to see if anything
555 else was written out by another shell, and if so it is included in the
556 history of the current shell too. Using !-style history, the commands from
557 the other sessions will not appear in the history list unless you explicitly
558 type the "history" command. This option is activated for zsh versions >= 4,
563 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
564 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
568 Edit the current command buffer in your favourite editor.
571 Deletes a word left of the cursor; seeing '/' as additional word separator.
574 Jump right after the first word.
577 Create directory under cursor or the selected area.
578 To select an area press ctrl-@ and use the cursor.
579 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
580 directory does not exist yet -> press **CTRL-xM** and problem solved.
583 Searches the last occurrence of string before the cursor in the command history.
586 Display help on keybindings and zsh line editor. Press consecutively to page through content.
589 Brings a job, which got suspended with CTRL-z back to foreground.
592 === Customisation ===
594 To customise keybindings, you can just use zsh's bindkey utility. However, if
595 you plan to use the `//zle-line-init//' or `//zle-line-finish//' hooks
596 yourself, make sure you call the following functions in the respective hook:
598 - **zle-line-init**: //zle-smkx//
599 - **zle-line-finish**: //zle-rmkx//
602 This is **required** so the keybindings set up by //grmlzshrc// work. The
603 reason for this is to turn the terminal into the right mode while zsh's line
604 editor (zle) is running. This enables us to query //terminfo// about escape
605 sequences for special keys and thus simplify and generalise our keybinding
609 == SHELL FUNCTIONS ==
610 //grmlzshrc// comes with a wide array of defined shell functions to ease the
613 : **855resolution()**
614 If 915resolution is available, issues a warning to the user to run it instead
615 to modify the resolution on intel graphics chipsets.
618 Lists files in current directory, which have been accessed within the
619 last N days. N is an integer to be passed as first and only argument.
620 If no argument is specified N is set to 1.
623 Lists processes matching given pattern.
626 Login on the host provided as argument using autossh. Then reattach a GNU screen
627 session if a detached session is around or detach a currently attached screen or
628 else start a new screen. This is especially useful for roadwarriors using GNU
632 Simple backup management of a file or directory using standard unix programs.
633 The target file name is the original name plus a time stamp attached. Symlinks
634 and file attributes like mode, ownership and timestamps are preserved.
637 If the original cdrecord is not installed, issues a warning to the user to
638 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
642 Creates a temporary directory using mktemp. Then changes current
643 working directory to it.
646 Lists files in current directory, which have been changed within the
647 last N days. N is an integer to be passed as first and only argument.
648 If no argument is specified N is set to 1.
651 Returns true if given command exists either as program, function, alias,
652 builtin or reserved word. If the option -c is given, only returns true,
653 if command is a program.
656 Changes directory to $HOME on first invocation of zsh. This is necessary on
657 Grml systems with autologin.
660 Changes current directory to the one supplied by argument and lists the files
661 in it, including file names starting with ".".
664 Shows the changelog of given package in $PAGER.
667 Shows the copyright of given package in $PAGER.
670 Tells the user to use grml-debootstrap, if she wants to install debian to
674 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
675 back interactive responsiveness after suspend, when the system is swapping
679 Shows the NEWS file for the given package in $PAGER.
685 Edit given shell function.
688 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
690 : **grml_vcs_info_toggle_colour()**
691 Toggles between coloured and uncoloured formats in vcs_info configuration.
692 This is useful with prompts that break if colour codes are in vcs_info
693 format expansions (like the `clint' prompt and every other prompt that
694 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
695 customised vcs_info formats, you shouldn't be using this function, since
696 it will set all formats to grml's default values (either coloured or plain)
700 Use GNU diff with options -ubwd for mercurial.
703 Displays diffstat between the revision given as argument and tip (no
704 argument means last revision).
707 Outputs highlighted diff; needs highstring(1).
710 Returns true, if zsh version is equal or greater than 4, else false.
713 Returns true, if zsh version is equal or greater than 4.1, else false.
716 Returns true, if zsh version is equal or greater than 4.2, else false.
719 Returns true, if zsh version is equal or greater than 4.2.5, else false.
722 Returns true, if zsh version is equal or greater than 4.3, else false.
725 Returns true, if zsh version is equal or greater than 4.3.3, else false.
728 Returns true, if running on darwin, else false.
731 Returns true, if running on FreeBSD, else false.
734 Returns true, if running on a grml system, else false.
737 Returns true, if running on a grml system from a live cd, else false.
740 Returns true, if run on grml-small, else false.
743 Returns true, if running on Linux, else false.
746 Changes every occurrence of the string iso885915 or ISO885915 in
747 environment variables to UTF-8.
750 Returns true, if running on OpenBSD, else false.
753 Returns true, if run within an utf environment, else false.
756 Creates directory including parent directories, if necessary. Then changes
757 current working directory to it.
760 Lists files in current directory, which have been modified within the
761 last N days. N is an integer to be passed as first and only argument.
762 If no argument is specified N is set to 1.
765 A helper function for the "e" glob qualifier to list all files newer
766 than a reference file.
770 % NTREF=/reference/file
773 % ls -l *(e:'nt /reference/file':)
777 Runs a command in zsh with profiling enabled (See startup variable
778 ZSH_PROFILE_RC above).
781 Creates an alias with sudo prepended, if $EUID is not zero. Run "salias -h"
782 for details. See also xunfunction() below.
784 : **simple-extract()**
785 Tries to uncompress/unpack given files with the appropriate programs. If an URI
786 starting with https, http or ftp is provided simple-extract tries to download
787 and then uncompress/unpack the file. The choice is made along the filename
788 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
789 .xz) unless you use the '-d' option.
792 Prints details of symlinks given as arguments.
794 : **ssl-cert-fingerprints**
795 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
796 First and only parameter must be a file containing a certificate. Use
797 /dev/stdin as file if you want to pipe a certificate to these
801 Prints all information of a x509 certificate including the SHA512,
802 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
803 containing a certificate. Use /dev/stdin as file if you want to pipe a
804 certificate to this function.
806 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
807 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
808 certificate. First and only parameter must be a file containing a
809 certificate. Use /dev/stdin as file if you want to pipe a certificate
812 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
813 Functions for controlling daemons.
820 Translates a word from german to english (-D) or vice versa (-E).
823 Shows upstreams changelog of a given package in $PAGER.
826 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
829 Changes every occurrence of the string UTF-8 or utf-8 in environment
830 variables to iso885915.
833 Wrapper for vim(1). It tries to set the title and hands vim the environment
834 variable VIM_OPTIONS on the command line. So the user may define command
835 line options, she always wants, in her .zshrc.local.
838 Searches the history for a given pattern and lists the results by date.
839 The first argument is the search pattern. The second and third ones are
840 optional and denote a search range (default: -100).
843 Tries to cat(1) file(s) given as parameter(s). Always returns true.
844 See also xunfunction() below.
847 Tries to source the file(s) given as parameter(s). Always returns true.
848 See zshbuiltins(1) for a detailed description of the source command.
849 See also xunfunction() below.
852 Changes the title of xterm window from within screen(1). Run without
853 arguments for details.
856 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
859 Wrapper around the autoload builtin. Loads the definitions of functions
860 from the file given as argument. Searches $fpath for the file. See also
864 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
865 where own modifications should go. See also zshbuiltins(1) for a description
866 of the source command.
870 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
871 life. A few aliases (like those involving //grep// or //ls//) use the option
872 //--color=auto// for colourizing output. That option is part of **GNU**
873 implementations of these tools, and will only be used if such an implementation
876 : **acp** (//apt-cache policy//)
877 With no arguments prints out the priorities of each source. If a package name
878 is given, it displays detailed information about the priority selection of the
881 : **acs** (//apt-cache search//)
882 Searches debian package lists for the regular expression provided as argument.
883 The search includes package names and descriptions. Prints out name and short
884 description of matching packages.
886 : **acsh** (//apt-cache show//)
887 Shows the package records for the packages provided as arguments.
889 : **adg** (//apt-get dist-upgrade//)
890 Performs an upgrade of all installed packages. Also tries to automatically
891 handle changing dependencies with new versions of packages. As this may change
892 the install status of (or even remove) installed packages, it is potentially
893 dangerous to use dist-upgrade; invoked by sudo, if necessary.
895 : **ag** (//apt-get upgrade//)
896 Downloads and installs the newest versions of all packages currently installed
897 on the system. Under no circumstances are currently installed packages removed,
898 or packages not already installed retrieved and installed. New versions of
899 currently installed packages that cannot be upgraded without changing the install
900 status of another package will be left at their current version. An update must
901 be performed first (see au below); run by sudo, if necessary.
903 : **agi** (//apt-get install//)
904 Downloads and installs or upgrades the packages given on the command line.
905 If a hyphen is appended to the package name, the identified package will be
906 removed if it is installed. Similarly a plus sign can be used to designate a
907 package to install. This may be useful to override decisions made by apt-get's
908 conflict resolution system.
909 A specific version of a package can be selected for installation by following
910 the package name with an equals and the version of the package to select. This
911 will cause that version to be located and selected for install. Alternatively a
912 specific distribution can be selected by following the package name with a slash
913 and the version of the distribution or the Archive name (stable, testing, unstable).
914 Gets invoked by sudo, if user id is not 0.
916 : **ati** (//aptitude install//)
917 Aptitude is a terminal-based package manager with a command line mode similar to
918 apt-get (see agi above); invoked by sudo, if necessary.
920 : **au** (//apt-get update//)
921 Resynchronizes the package index files from their sources. The indexes of
922 available packages are fetched from the location(s) specified in
923 /etc/apt/sources.list. An update should always be performed before an
924 upgrade or dist-upgrade; run by sudo, if necessary.
926 : **da** (//du -sch//)
927 Prints the summarized disk usage of the arguments as well as a grand total
928 in human readable format.
930 : **dbp** (//dpkg-buildpackage//)
931 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
933 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
934 Prints installed Packages sorted by size (descending).
936 : **dir** (//ls -lSrah//)
937 Lists files (including dot files) sorted by size (biggest last) in long and
938 human readable output format.
940 : **ge** (//grep-excuses//)
941 Searches the testing excuses files for a specific maintainer (See:
944 : **grep** (//grep --color=auto//)
945 Shows grep output in nice colors, if available.
947 : **grml-version** (//cat /etc/grml_version//)
948 Prints version of running grml.
950 : **hbp** (//hg-buildpackage//)
951 Helper program to maintain Debian packages with mercurial.
953 : **http** (//python -m SimpleHTTPServer//)
954 Basic HTTP server implemented in python. Listens on port 8000/tcp and
955 serves current directory. Implements GET and HEAD methods.
957 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
958 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
959 host key changes frequently, for example on virtualized test- or development-systems.
960 To be used only inside trusted networks, of course.
962 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
963 ssh with possible man-in-the-middle attack enabled
964 (for an explanation see insecscp above).
966 : **help-zshglob** (//H-Glob()//)
967 Runs the function H-Glob() to expand or explain wildcards.
969 : **j** (//jobs -l//)
970 Prints status of jobs in the current shell session in long format.
972 : **l** (//ls -l --color=auto//)
973 Lists files in long output format with indicator for filetype appended
974 to filename. If the terminal supports it, with colored output.
976 : **la** (//ls -la --color=auto//)
977 Lists files in long colored output format. Including file names
980 : **lad** (//ls -d .*(/)//)
981 Lists the dot directories (not their contents) in current directory.
983 : **lh** (//ls -hAl --color=auto//)
984 Lists files in long and human readable output format in nice colors,
985 if available. Includes file names starting with "." except "." and
988 : **ll** (//ls -l --color=auto//)
989 Lists files in long colored output format.
991 : **llog** (//$PAGER /var/log/syslog//)
992 Opens syslog in pager.
994 : **ls** (//ls -C --color=auto//)
995 Lists directory, entries are listed by columns and an indicator for
996 file type is appended to each file name. Additionally the output is
997 colored, if the terminal supports it.
999 : **lsa** (//ls -a .*(.)//)
1000 Lists dot files in current working directory.
1002 : **lsbig** (//ls -flh *(.OL[1,10])//)
1003 Displays the ten biggest files (long and human readable output format).
1005 : **lsd** (//ls -d *(/)//)
1008 : **lse** (//ls -d *(/^F)//)
1009 Shows empty directories.
1011 : **lsl** (//ls -l *(@)//)
1012 Lists symbolic links in current directory.
1014 : **lsnew** (//ls -rl *(D.om[1,10])//)
1015 Displays the ten newest files (long output format).
1017 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
1018 Displays the ten newest directories and ten newest .directories.
1020 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1021 Displays the ten oldest files (long output format).
1023 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
1024 Displays the ten oldest directories and ten oldest .directories.
1026 : **lss** (//ls -l *(s,S,t)//)
1027 Lists files in current directory that have the setuid, setgid or sticky bit
1030 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1031 Displays the ten smallest files (long output format).
1033 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1034 Displays all files which are world readable and/or world writable and/or
1035 world executable (long output format).
1037 : **lsx** (//ls -l *(*)//)
1038 Lists only executable files.
1040 : **mdstat** (//cat /proc/mdstat//)
1041 Lists all active md (i.e. linux software raid) devices with some information
1044 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1045 Executes the commands on the versioned patch queue from current repository.
1047 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1048 rmdir current working directory
1050 : **screen** (//screen -c file//)
1051 If invoking user is root, starts screen session with /etc/grml/screenrc
1052 as config file. If invoked by a regular user and users .screenc does not exist,
1053 starts screen with /etc/grml/screenrc_grml config if it exists, else fallbacks
1054 to /etc/grml/screenrc.
1056 : **su** (//sudo su//)
1057 If user is running a Grml live system, don't ask for any password, if she
1060 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1061 Sets mode from UTF-8 to ISO 2022 (See:
1062 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1064 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1065 Sets mode from ISO 2022 to UTF-8 (See:
1066 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1068 : **tlog** (//tail -f /var/log/syslog//)
1069 Prints syslog continuously (See tail(1)).
1071 : **up** (//aptitude update ; aptitude safe-upgrade//)
1072 Performs a system update followed by a system upgrade using aptitude; run
1073 by sudo, if necessary. See au and ag above.
1075 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1076 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1077 protect them from the shell.
1079 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1080 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1082 : **...** (//cd ../..///)
1083 Changes current directory two levels higher.
1087 This is a set of files, that - if they exist - can be used to customize the
1088 behaviour of //grmlzshrc//.
1091 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1092 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1095 # show battery status in RPROMPT
1096 GRML_DISPLAY_BATTERY=1
1097 # always load the complete setup, even for root
1098 GRML_ALWAYS_LOAD_ALL=1
1102 Sourced right before loading //grmlzshrc// is finished. There is a global
1103 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1107 Directory listing for persistent dirstack (see above).
1109 : **.important_commands**
1110 List of commands, used by persistent history (see above).
1113 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1114 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1115 (http://www.ubuntu.com) and similar systems - it is very easy to get
1116 //grmlzshrc// via grml's .deb repositories.
1118 On non-debian systems, that is not an option, but all is not lost:
1121 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1124 If you would also like to get separate function files (which you can put into
1125 your **$fpath**), you can browse and download them at:
1127 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1129 = ZSH REFCARD TAGS =
1130 If you read //grmlzshrc//'s code you may notice strange looking comments in
1131 it. These are there for a purpose. grml's zsh-refcard is automatically
1132 generated from the contents of the actual configuration file. However, we need
1133 a little extra information on which comments and what lines of code to take
1134 into account (and for what purpose).
1136 Here is what they mean:
1138 List of tags (comment types) used:
1140 Next line contains an important alias, that should be included in the
1141 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1144 Next line contains the beginning of an important function. (placement
1145 tag: @@INSERT-functions@@)
1148 Next line contains an important variable. (placement tag:
1149 @@INSERT-variables@@)
1152 Next line contains an important keybinding. (placement tag:
1153 @@INSERT-keybindings@@)
1156 Hashed directories list generation: //start//: denotes the start of a list of
1157 'hash -d' definitions. //end//: denotes its end. (placement tag:
1158 @@INSERT-hasheddirs@@)
1161 Abbreviation expansion list generation: //start//: denotes the beginning of
1162 abbreviations. //end//: denotes their end.
1164 Lines within this section that end in '#d .*' provide extra documentation to
1165 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1168 This tag allows you to manually generate refcard entries for code lines that
1169 are hard/impossible to parse.
1173 #m# k ESC-h Call the run-help function
1176 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1179 So the syntax is: #m# <section> <argument> <comment>
1182 This tag lets you insert entries to the 'other' hash. Generally, this should
1183 not be used. It is there for things that cannot be done easily in another way.
1184 (placement tag: @@INSERT-other-foobar@@)
1187 All of these tags (except for m and o) take two arguments, the first
1188 within the tag, the other after the tag:
1190 #<tag><section># <comment>
1192 Where <section> is really just a number, which are defined by the @secmap
1193 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1194 that for the reader, the tag should not differ much from a regular comment.
1195 For zsh, it is a regular comment indeed. The numbers have got the following
1220 So, the following will add an entry to the 'functions' table in the 'system'
1221 section, with a (hopefully) descriptive comment:
1224 #f1# Edit an alias via zle
1228 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1229 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1230 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1231 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1232 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1236 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1237 repository from git.grml.org:
1239 ``` % git clone git://git.grml.org/grml-etc-core.git
1241 Make your changes, commit them; use '**git format-patch**' to create a series
1242 of patches and send those to the following address via '**git send-email**':
1244 ``` grml-etc-core@grml.org
1246 Doing so makes sure the right people get your patches for review and
1251 This manual page is the **reference** manual for //grmlzshrc//.
1253 That means that in contrast to the existing refcard it should document **every**
1254 aspect of the setup.
1256 This manual is currently not complete. If you want to help improving it, visit
1257 the following pages:
1259 http://wiki.grml.org/doku.php?id=zshrcmanual
1261 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1263 Contributions are highly welcome.
1267 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1268 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1269 Beckert <abe@deuxchevaux.org>.
1273 Copyright (c) 2009-2013 Grml project <http://grml.org>
1275 This manpage is distributed under the terms of the GPL version 2.
1277 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1278 except for **accept-line()** which are distributed under the same conditions
1279 as zsh itself (which is BSD-like).