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 It is possible to apply a filter to the names of directories that will be
140 committed to the persistent dirstack file. There are two ways to configure this
141 filter: A general function based filter and a pattern based filter. Both are
142 setup via styles in the **':grml:chpwd:dirstack'** context.
144 To use a function based filter set the //filter// style for that context to the
145 name of a function to call every time a directory name is to be added to the
146 persistent dirstack. If the function's return value signals success (ie. return
147 value "0"), the directory name is filtered out and **not** added to the
148 persistent stack. Example:
151 function my_dirstack_filter() { [[ $1 == /tmp(|/*) ]] }
152 zstyle ':grml:chpwd:dirstack' filter my_dirstack_filter
155 The pattern based filter uses a list of patterns passed to the //exclude//
156 style in the aforementioned context. Each pattern is tested and the first that
157 matches will keep the directory name from being added to the persistent stack.
158 If none of the patterns matches, the name is added. example:
161 zstyle ':grml:chpwd:dirstack' exclude "/tmp(|/*)" "$HOME/tmp(|/*)"
164 The function based filter is more general, the pattern based filter easier to
165 set up. If both filter variants are used at the same time, the function based
166 filter will be executed //before// the pattern based one.
168 If you would like to apply your filters while //loading// the persistent
169 dirstack file, set the //filter-on-load// boolean style (the default is
173 zstyle ':grml:chpwd:dirstack' filter-on-load true
176 Setting the //filter-on-load// needs to be done in ".zshrc.pre" because the
177 style needs to be set when the main setup is executing! The other styles do not
178 have this limitation, but the initial filtering will obviously be done using
179 the filters that are configured **at** **that** **point**. The rule of thumb
180 is: If you want to filter on load, setup everything in ".zshrc.pre" otherwise
181 ".zshrc.local" works just as well.
184 == DIRECTORY BASED PROFILES ==
186 If you need to perform certain actions each time you enter certain
187 directory-trees, this is the feature you are looking for.
190 === Initialisation ===
191 To initialise the system, you need to call the function `chpwd_profiles' at
192 some point in your `zshrc.local'; preferably **after** you configured the
193 system. The configuration of the system is described further below.
195 If you need to do initialisations the first time `chpwd_profiles' is called
196 (which should be in your configuration file), you can do that in a function
197 called "chpwd_profiles_init". That function needs to be defined **before**
198 `chpwd_profiles' is called for this to work.
200 During the **first** call of `chpwd_profiles' (and therefore all its profile
201 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
202 all other cases, the parameter does not exist at all.
205 === Styles and Profile-names ===
206 To store its configuration, the system uses **functions** and **styles**
207 (zsh's context sensitive configuration system), such as this:
211 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
212 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
215 When that's done and you enter a directory that matches the pattern in the
216 third part of the context, a function called chpwd_profile_grml, for example,
217 is called (if it exists).
219 If no pattern matches (read: no profile is detected) the profile is set to
220 'default', which means chpwd_profile_default is attempted to be called.
222 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
223 which is used: The third part in the context is matched against ${PWD}. That's
224 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
225 profile is detected for all these values of ${PWD}:
232 So, if you want to make double damn sure a profile works in /foo/bar and
233 everywhere deeper in that tree, just use (|/|/*) and be happy.
235 The name of the detected profile will be available in a variable called
236 'profile' in your functions. You don't need to do anything, it'll just be
240 === Controlling Profile Execution ===
242 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
243 which is set to the profile that was is currently active (the default value is
244 "default"). That way you can avoid running code for a profile that is already
245 active, by running code such as the following at the start of your function:
248 function chpwd_profile_grml() {
249 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
254 If you know you are going to do that all the time for each and every
255 directory-profile function you are ever going to write, you may also set the
256 `re-execute' style to `false' (which only defaults to `true' for backwards
257 compatibility), like this:
260 zstyle ':chpwd:profiles:*' re-execute false
264 === Signaling availabily/profile changes ===
266 If you use this feature and need to know whether it is active in your current
267 shell, there are several ways to do that. Here are two simple ways:
269 a) If knowing if the profiles feature is active when zsh starts is good
270 enough for you, you can use the following snippet:
272 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
274 b) If that is not good enough, and you would prefer to be notified whenever a
275 profile changes, you can solve that by making sure you start **every**
276 profile function you create like this:
278 function chpwd_profile_myprofilename() {
279 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
280 print "chpwd(): Switching to profile: $profile"
284 That makes sure you only get notified if a profile is **changed**, not
285 everytime you change directory. (To avoid this, you may also set the newer
286 `re-execute' style like described further above instead of the test on top of
290 === Leaving Profiles ===
292 When the system switches from one profile to another, it executes a function
293 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
294 profile-function for the new profile.
297 === Version requirement ===
298 This feature requires zsh //4.3.3// or newer.
301 == ACCEPTLINE WRAPPER ==
302 The //accept-line// wiget is the one that is taking action when the **return**
303 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
306 This wrapper is configured via styles. That means, you issue commands, that look
310 zstyle 'context' style value
313 The context namespace, that we are using is 'acceptline'. That means, the actual
314 context for your commands look like: **':acceptline:<subcontext>'**.
316 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
320 === Recognized Contexts ===
322 This is the value, the context is initialized with.
323 The //compwarnfmt and //rehash// styles are looked up in this context.
326 If the first word in the command line is either a command, alias, function,
327 builtin or reserved word, you are in this context.
330 This is the context, that is used if you hit enter again, after being warned
331 about the existence of a _completion for the non-existing command you
335 This is the context, you are in if the command line is empty or only
336 consists of whitespace.
339 This context is in effect, if you entered something that does not match any
340 of the above. (e.g.: variable assignments).
343 === Available Styles ===
345 If you set this style to true, the warning about non existent commands,
346 for which completions exist will not be issued. (Default: **false**)
349 The message, that is displayed to warn about the _completion issue.
350 (default: **'%c will not execute and completion %f exists.'**)
351 '%c' is replaced by the command name, '%f' by the completion's name.
354 If this is set, we'll force rehashing, if appropriate. (Defaults to
355 **true** in //grmlzshrc//).
358 This can be a list of wigdets to call in a given context. If you need a
359 specific order for these to be called, name them accordingly. The default value
360 is an **empty list**.
363 The name of a widget, that is called after the widgets from 'actions'.
364 By default, this will be '.accept-line' (which is the built-in accept-line
368 If true in the current context, call the widget in the 'default_action'
369 style. (The default is **true** in all contexts.)
374 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
375 **promptinit** system. The three themes are called **grml**, **grml-large** and
378 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
379 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
380 non-empty, **grml-chroot** is used.
382 As usual, with promtinit themes, the user may switch to a different theme using
383 the //prompt// utility:
389 That will use the **grml-large** prompt theme.
391 The themes are highly customisable. The main source of documentation about
392 customisation is the main **grml** theme's doc-string, that is available via
393 the following command:
399 The other themes also come with doc-strings, but the main theme's is the
400 canonical reference about all of them.
402 This feature requires version //4.3.7// of the shell. Older versions will use
403 the classic grml prompt as a fallback.
405 A note to people who like customisation: If you are **not** using a prompt
406 theme for your customisation, but you're either statically setting $PS1 (or
407 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
408 function, make sure you are turning the zsh's prompt theme system **off**
409 before doing so. A correct example customisation could look like this:
412 # Turn the prompt system off:
414 # Customise the prompt yourself:
418 You also add your own tokens by using the \`grml_theme_add_token()' function.
419 Call the function without arguments for detailed documentation about that
422 == GNU/SCREEN STATUS SETTING ==
423 //grmlzshrc// sets screen's hardstatus lines to the currently running command
424 or **'zsh'** if the shell is idling at its prompt. If the current working
425 directory is inside a repository unter version control, screen status is set
426 to: **'zsh: <repository name>'** via zsh's vcs_info.
429 == PERSISTENT HISTORY ==
430 If you got commands you consider important enough to be included in every
431 shell's history, you can put them into ~/.important_commands and they will be
432 available via the usual history lookup widgets.
436 == ENVIRONMENT VARIABLES ==
437 //grmlzshrc// sets some environment variables, which influence the
438 behaviour of applications.
441 Set to "yes". Some applications read this to learn about properties
442 of the terminal they are running in.
445 If not already set, sets the default editor. Falls back to vi(1),
446 if vim(1) is not available.
449 Some environment variables that add colour support to less(1) for viewing
450 man pages. See termcap(5) for details.
453 The mailbox file for the current user is set to /var/mail/$USER, if not
454 already set otherwise.
457 Set less(1) as default pager, if not already set to something different.
461 Apart from zsh's default options, //grmlzshrc// sets some options
462 that change the behaviour of zsh. Options that change Z-shell's default
463 settings are marked by <grml>. But note, that zsh's defaults vary depending
464 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
467 Zsh sessions, that use //grmlzshrc//, will append their history list to the
468 history file, rather than replace it. Thus, multiple parallel zsh sessions
469 will all have the new entries from their history lists added to the history
470 file, in the order that they exit. The file will still be periodically
471 re-written to trim it when the number of lines grows 20% beyond the value
472 specified by $SAVEHIST.
475 If a command is issued that can't be executed as a normal command, and the
476 command is the name of a directory, perform the cd command to that directory.
478 : **auto_pushd** <grml>
479 Make cd push the old directory onto the directory stack.
481 : **completeinword** <grml>
482 If the cursor is inside a word, completion is done from both ends;
483 instead of moving the cursor to the end of the word first and starting
486 : **extended_glob** <grml>
487 Treat the '#', '~' and '^' characters as active globbing pattern characters.
489 : **extended_history** <grml>
490 Save each command's beginning timestamp (in seconds since the epoch) and the
491 duration (in seconds) to the history file.
494 Whenever a command completion is attempted, make sure the entire command
495 path is hashed first. This makes the first completion slower.
497 : **histignorealldups** <grml>
498 If a new command line being added to the history list duplicates an
499 older one, the older command is removed from the list, even if it is
500 not the previous event.
502 : **histignorespace** <grml>
503 Remove command lines from the history list when the first character on
504 the line is a space, or when one of the expanded aliases contains a
505 leading space. Note that the command lingers in the internal history
506 until the next command is entered before it vanishes.
508 : **longlistjobs** <grml>
509 List jobs in long format by default.
512 Avoid to beep on errors in zsh command line editing (zle).
515 A wildcard character never matches a leading '.'.
518 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
520 : **nonomatch** <grml>
521 If a pattern for filename generation has no matches, do not print an error
522 and leave it unchanged in the argument list. This also applies to file
523 expansion of an initial `~' or `='.
526 Report the status of background jobs immediately, rather than waiting until
527 just before printing a prompt.
529 : **pushd_ignore_dups** <grml>
530 Don't push multiple copies of the same directory onto the directory stack.
532 : **share_history** <grml>
533 As each line is added to the history file, it is checked to see if anything
534 else was written out by another shell, and if so it is included in the
535 history of the current shell too. Using !-style history, the commands from
536 the other sessions will not appear in the history list unless you explicitly
537 type the "history" command. This option is activated for zsh versions >= 4,
542 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
543 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
547 Edit the current command buffer in your favourite editor.
550 Deletes a word left of the cursor; seeing '/' as additional word separator.
553 Jump right after the first word.
556 Create directory under cursor or the selected area.
557 To select an area press ctrl-@ and use the cursor.
558 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
559 directory does not exist yet -> press **CTRL-xM** and problem solved.
562 Searches the last occurence of string before the cursor in the command history.
565 Display help on keybindings and zsh line editor. Press consecutively to page through content.
568 Brings a job, which got suspended with CTRL-z back to foreground.
571 === Customisation ===
573 To customise keybindings, you can just use zsh's bindkey utility. However, if
574 you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
575 yourself, make sure you call the following functions in the respective hook:
577 - **zle-line-init**: //zle-smkx//
578 - **zle-line-finish**: //zle-rmkx//
581 This is **required** so the keybindings set up by //grmlzshrc// work. The
582 reason for this is to turn the terminal into the right mode while zsh's line
583 editor (zle) is running. This enables us to query //terminfo// about escape
584 sequences for special keys and thus simplify and generalise our keybinding
588 == SHELL FUNCTIONS ==
589 //grmlzshrc// comes with a wide array of defined shell functions to ease the
592 : **855resolution()**
593 If 915resolution is available, issues a warning to the user to run it instead
594 to modify the resolution on intel graphics chipsets.
597 Lists files in current directory, which have been accessed within the
598 last N days. N is an integer to be passed as first and only argument.
599 If no argument is specified N is set to 1.
602 Lists processes matching given pattern.
605 Login on the host provided as argument using autossh. Then reattach a GNU screen
606 session if a detached session is around or detach a currently attached screen or
607 else start a new screen. This is especially useful for roadwarriors using GNU
611 Simple backup management of a file or directory using standard unix programs.
612 The target file name is the original name plus a time stamp attached. Symlinks
613 and file attributes like mode, ownership and timestamps are preserved.
616 If the original cdrecord is not installed, issues a warning to the user to
617 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
621 Creates a temporary directory using mktemp. Then changes current
622 working directory to it.
625 Lists files in current directory, which have been changed within the
626 last N days. N is an integer to be passed as first and only argument.
627 If no argument is specified N is set to 1.
630 Returns true if given command exists either as program, function, alias,
631 builtin or reserved word. If the option -c is given, only returns true,
632 if command is a program.
635 Changes directory to $HOME on first invocation of zsh. This is necessary on
636 Grml systems with autologin.
639 Changes current directory to the one supplied by argument and lists the files
640 in it, including file names starting with ".".
643 Shows the changelog of given package in $PAGER.
646 Shows the copyright of given package in $PAGER.
649 Tells the user to use grml-debootstrap, if she wants to install debian to
653 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
654 back interactive responsiveness after suspend, when the system is swapping
658 Shows the NEWS file for the given package in $PAGER.
664 Edit given shell function.
667 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
669 : **grml_vcs_info_toggle_colour()**
670 Toggles between coloured and uncoloured formats in vcs_info configuration.
671 This is useful with prompts that break if colour codes are in vcs_info
672 format expansions (like the `clint' prompt and every other prompt that
673 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
674 customised vcs_info formats, you shouldn't be using this function, since
675 it will set all formats to grml's default values (either coloured or plain)
679 Use GNU diff with options -ubwd for mercurial.
682 Displays diffstat between the revision given as argument and tip (no
683 argument means last revision).
686 Outputs highlighted diff; needs highstring(1).
689 Returns true, if zsh version is equal or greater than 4, else false.
692 Returns true, if zsh version is equal or greater than 4.1, else false.
695 Returns true, if zsh version is equal or greater than 4.2, else false.
698 Returns true, if zsh version is equal or greater than 4.2.5, else false.
701 Returns true, if zsh version is equal or greater than 4.3, else false.
704 Returns true, if zsh version is equal or greater than 4.3.3, else false.
707 Returns true, if running on darwin, else false.
710 Returns true, if running on FreeBSD, else false.
713 Returns true, if running on a grml system, else false.
716 Returns true, if running on a grml system from a live cd, else false.
719 Returns true, if run on grml-small, else false.
722 Returns true, if running on Linux, else false.
725 Changes every occurrence of the string iso885915 or ISO885915 in
726 environment variables to UTF-8.
729 Returns true, if running on OpenBSD, else false.
732 Returns true, if run within an utf environment, else false.
735 Creates directory including parent directories, if necessary. Then changes
736 current working directory to it.
739 Lists files in current directory, which have been modified within the
740 last N days. N is an integer to be passed as first and only argument.
741 If no argument is specified N is set to 1.
744 A helper function for the "e" glob qualifier to list all files newer
745 than a reference file.
749 % NTREF=/reference/file
752 % ls -l *(e:'nt /reference/file':)
756 Runs a command in zsh with profiling enabled (See startup variable
757 ZSH_PROFILE_RC above).
760 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
761 for details. See also xunfunction() below.
763 : **simple-extract()**
764 Tries to uncompress/unpack given files with the appropriate programs. If an URI
765 starting with https, http or ftp is provided simple-extract tries to download
766 and then uncompress/unpack the file. The choice is made along the filename
767 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
768 .xz) unless you use the '-d' option.
771 Prints details of symlinks given as arguments.
773 : **ssl-cert-fingerprints**
774 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
775 First and only parameter must be a file containing a certificate. Use
776 /dev/stdin as file if you want to pipe a certificate to these
780 Prints all information of a x509 certificate including the SHA512,
781 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
782 containing a certificate. Use /dev/stdin as file if you want to pipe a
783 certificate to this function.
785 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
786 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
787 certificate. First and only parameter must be a file containing a
788 certificate. Use /dev/stdin as file if you want to pipe a certificate
791 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
792 Functions for controlling daemons.
799 Translates a word from german to english (-D) or vice versa (-E).
802 Shows upstreams changelog of a given package in $PAGER.
805 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
808 Changes every occurrence of the string UTF-8 or utf-8 in environment
809 variables to iso885915.
812 Wrapper for vim(1). It tries to set the title and hands vim the environment
813 variable VIM_OPTIONS on the command line. So the user may define command
814 line options, she always wants, in her .zshrc.local.
817 Searches the history for a given pattern and lists the results by date.
818 The first argument is the search pattern. The second and third ones are
819 optional and denote a search range (default: -100).
822 Tries to cat(1) file(s) given as parameter(s). Always returns true.
823 See also xunfunction() below.
826 Tries to source the file(s) given as parameter(s). Always returns true.
827 See zshbuiltins(1) for a detailed description of the source command.
828 See also xunfunction() below.
831 Changes the title of xterm window from within screen(1). Run without
832 arguments for details.
835 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
838 Wrapper around the autoload builtin. Loads the definitions of functions
839 from the file given as argument. Searches $fpath for the file. See also
843 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
844 where own modifications should go. See also zshbuiltins(1) for a description
845 of the source command.
849 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
850 life. A few aliases (like those involving //grep// or //ls//) use the option
851 //--color=auto// for colourizing output. That option is part of **GNU**
852 implementations of these tools, and will only be used if such an implementation
855 : **acp** (//apt-cache policy//)
856 With no arguments prints out the priorities of each source. If a package name
857 is given, it displays detailed information about the priority selection of the
860 : **acs** (//apt-cache search//)
861 Searches debian package lists for the regular expression provided as argument.
862 The search includes package names and descriptions. Prints out name and short
863 description of matching packages.
865 : **acsh** (//apt-cache show//)
866 Shows the package records for the packages provided as arguments.
868 : **adg** (//apt-get dist-upgrade//)
869 Performs an upgrade of all installed packages. Also tries to automatically
870 handle changing dependencies with new versions of packages. As this may change
871 the install status of (or even remove) installed packages, it is potentially
872 dangerous to use dist-upgrade; invoked by sudo, if necessary.
874 : **ag** (//apt-get upgrade//)
875 Downloads and installs the newest versions of all packages currently installed
876 on the system. Under no circumstances are currently installed packages removed,
877 or packages not already installed retrieved and installed. New versions of
878 currently installed packages that cannot be upgraded without changing the install
879 status of another package will be left at their current version. An update must
880 be performed first (see au below); run by sudo, if necessary.
882 : **agi** (//apt-get install//)
883 Downloads and installs or upgrades the packages given on the command line.
884 If a hyphen is appended to the package name, the identified package will be
885 removed if it is installed. Similarly a plus sign can be used to designate a
886 package to install. This may be useful to override decisions made by apt-get's
887 conflict resolution system.
888 A specific version of a package can be selected for installation by following
889 the package name with an equals and the version of the package to select. This
890 will cause that version to be located and selected for install. Alternatively a
891 specific distribution can be selected by following the package name with a slash
892 and the version of the distribution or the Archive name (stable, testing, unstable).
893 Gets invoked by sudo, if user id is not 0.
895 : **ati** (//aptitude install//)
896 Aptitude is a terminal-based package manager with a command line mode similar to
897 apt-get (see agi above); invoked by sudo, if necessary.
899 : **au** (//apt-get update//)
900 Resynchronizes the package index files from their sources. The indexes of
901 available packages are fetched from the location(s) specified in
902 /etc/apt/sources.list. An update should always be performed before an
903 upgrade or dist-upgrade; run by sudo, if necessary.
905 : **da** (//du -sch//)
906 Prints the summarized disk usage of the arguments as well as a grand total
907 in human readable format.
909 : **dbp** (//dpkg-buildpackage//)
910 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
912 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
913 Prints installed Packages sorted by size (descending).
915 : **dir** (//ls -lSrah//)
916 Lists files (including dot files) sorted by size (biggest last) in long and
917 human readable output format.
919 : **ge** (//grep-excuses//)
920 Searches the testing excuses files for a specific maintainer (See:
923 : **grep** (//grep --color=auto//)
924 Shows grep output in nice colors, if available.
926 : **grml-version** (//cat /etc/grml_version//)
927 Prints version of running grml.
929 : **hbp** (//hg-buildpackage//)
930 Helper program to maintain Debian packages with mercurial.
932 : **http** (//python -m SimpleHTTPServer//)
933 Basic HTTP server implemented in python. Listens on port 8000/tcp and
934 serves current directory. Implements GET and HEAD methods.
936 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
937 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
938 host key changes frequently, for example on virtualized test- or development-systems.
939 To be used only inside trusted networks, of course.
941 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
942 ssh with possible man-in-the-middle attack enabled
943 (for an explanation see insecscp above).
945 : **help-zshglob** (//H-Glob()//)
946 Runs the function H-Glob() to expand or explain wildcards.
948 : **j** (//jobs -l//)
949 Prints status of jobs in the current shell session in long format.
951 : **l** (//ls -l --color=auto//)
952 Lists files in long output format with indicator for filetype appended
953 to filename. If the terminal supports it, with colored output.
955 : **la** (//ls -la --color=auto//)
956 Lists files in long colored output format. Including file names
959 : **lad** (//ls -d .*(/)//)
960 Lists the dot directories (not their contents) in current directory.
962 : **lh** (//ls -hAl --color=auto//)
963 Lists files in long and human readable output format in nice colors,
964 if available. Includes file names starting with "." except "." and
967 : **ll** (//ls -l --color=auto//)
968 Lists files in long colored output format.
970 : **llog** (//$PAGER /var/log/syslog//)
971 Opens syslog in pager.
973 : **ls** (//ls -C --color=auto//)
974 Lists directory, entries are listed by columns and an indicator for
975 file type is appended to each file name. Additionally the output is
976 colored, if the terminal supports it.
978 : **lsa** (//ls -a .*(.)//)
979 Lists dot files in current working directory.
981 : **lsbig** (//ls -flh *(.OL[1,10])//)
982 Displays the ten biggest files (long and human readable output format).
984 : **lsd** (//ls -d *(/)//)
987 : **lse** (//ls -d *(/^F)//)
988 Shows empty directories.
990 : **lsl** (//ls -l *(@)//)
991 Lists symbolic links in current directory.
993 : **lsnew** (//ls -rl *(D.om[1,10])//)
994 Displays the ten newest files (long output format).
996 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
997 Displays the ten newest directories and ten newest .directories.
999 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1000 Displays the ten oldest files (long output format).
1002 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
1003 Displays the ten oldest directories and ten oldest .directories.
1005 : **lss** (//ls -l *(s,S,t)//)
1006 Lists files in current directory that have the setuid, setgid or sticky bit
1009 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1010 Displays the ten smallest files (long output format).
1012 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1013 Displays all files which are world readable and/or world writable and/or
1014 world executable (long output format).
1016 : **lsx** (//ls -l *(*)//)
1017 Lists only executable files.
1019 : **mdstat** (//cat /proc/mdstat//)
1020 Lists all active md (i.e. linux software raid) devices with some information
1023 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1024 Executes the commands on the versioned patch queue from current repository.
1026 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1027 rmdir current working directory
1029 : **screen** (//screen -c file//)
1030 If invoking user is root, starts screen session with /etc/grml/screenrc
1031 as config file. If invoked by a regular user and users .screenc does not exist,
1032 starts screen with /etc/grml/screenrc_grml config if it exists, else fallbacks
1033 to /etc/grml/screenrc.
1035 : **su** (//sudo su//)
1036 If user is running a Grml live system, don't ask for any password, if she
1039 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1040 Sets mode from UTF-8 to ISO 2022 (See:
1041 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1043 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1044 Sets mode from ISO 2022 to UTF-8 (See:
1045 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1047 : **tlog** (//tail -f /var/log/syslog//)
1048 Prints syslog continuously (See tail(1)).
1050 : **up** (//aptitude update ; aptitude safe-upgrade//)
1051 Performs a system update followed by a system upgrade using aptitude; run
1052 by sudo, if necessary. See au and ag above.
1054 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1055 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1056 protect them from the shell.
1058 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1059 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1061 : **...** (//cd ../..///)
1062 Changes current directory two levels higher.
1066 This is a set of files, that - if they exist - can be used to customize the
1067 behaviour of //grmlzshrc//.
1070 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1071 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1074 # show battery status in RPROMPT
1075 GRML_DISPLAY_BATTERY=1
1076 # always load the complete setup, even for root
1077 GRML_ALWAYS_LOAD_ALL=1
1081 Sourced right before loading //grmlzshrc// is finished. There is a global
1082 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1086 Directory listing for persistent dirstack (see above).
1088 : **.important_commands**
1089 List of commands, used by persistent history (see above).
1092 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1093 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1094 (http://www.ubuntu.com) and similar systems - it is very easy to get
1095 //grmlzshrc// via grml's .deb repositories.
1097 On non-debian systems, that is not an option, but all is not lost:
1100 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1103 If you would also like to get separate function files (which you can put into
1104 your **$fpath**), you can browse and download them at:
1106 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1108 = ZSH REFCARD TAGS =
1109 If you read //grmlzshrc//'s code you may notice strange looking comments in
1110 it. These are there for a purpose. grml's zsh-refcard is automatically
1111 generated from the contents of the actual configuration file. However, we need
1112 a little extra information on which comments and what lines of code to take
1113 into account (and for what purpose).
1115 Here is what they mean:
1117 List of tags (comment types) used:
1119 Next line contains an important alias, that should be included in the
1120 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1123 Next line contains the beginning of an important function. (placement
1124 tag: @@INSERT-functions@@)
1127 Next line contains an important variable. (placement tag:
1128 @@INSERT-variables@@)
1131 Next line contains an important keybinding. (placement tag:
1132 @@INSERT-keybindings@@)
1135 Hashed directories list generation: //start//: denotes the start of a list of
1136 'hash -d' definitions. //end//: denotes its end. (placement tag:
1137 @@INSERT-hasheddirs@@)
1140 Abbreviation expansion list generation: //start//: denotes the beginning of
1141 abbreviations. //end//: denotes their end.
1143 Lines within this section that end in '#d .*' provide extra documentation to
1144 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1147 This tag allows you to manually generate refcard entries for code lines that
1148 are hard/impossible to parse.
1152 #m# k ESC-h Call the run-help function
1155 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1158 So the syntax is: #m# <section> <argument> <comment>
1161 This tag lets you insert entries to the 'other' hash. Generally, this should
1162 not be used. It is there for things that cannot be done easily in another way.
1163 (placement tag: @@INSERT-other-foobar@@)
1166 All of these tags (except for m and o) take two arguments, the first
1167 within the tag, the other after the tag:
1169 #<tag><section># <comment>
1171 Where <section> is really just a number, which are defined by the @secmap
1172 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1173 that for the reader, the tag should not differ much from a regular comment.
1174 For zsh, it is a regular comment indeed. The numbers have got the following
1199 So, the following will add an entry to the 'functions' table in the 'system'
1200 section, with a (hopefully) descriptive comment:
1203 #f1# Edit an alias via zle
1207 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1208 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1209 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1210 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1211 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1215 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1216 repository from git.grml.org:
1218 ``` % git clone git://git.grml.org/grml-etc-core.git
1220 Make your changes, commit them; use '**git format-patch**' to create a series
1221 of patches and send those to the following address via '**git send-email**':
1223 ``` grml-etc-core@grml.org
1225 Doing so makes sure the right people get your patches for review and
1230 This manual page is the **reference** manual for //grmlzshrc//.
1232 That means that in contrast to the existing refcard it should document **every**
1233 aspect of the setup.
1235 This manual is currently not complete. If you want to help improving it, visit
1236 the following pages:
1238 http://wiki.grml.org/doku.php?id=zshrcmanual
1240 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1242 Contributions are highly welcome.
1246 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1247 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1248 Beckert <abe@deuxchevaux.org>.
1252 Copyright (c) 2009-2013 Grml project <http://grml.org>
1254 This manpage is distributed under the terms of the GPL version 2.
1256 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1257 except for **accept-line()** which are distributed under the same conditions
1258 as zsh itself (which is BSD-like).