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_DISPLAY_BATTERY**
59 If set to a value greater than zero, //grmlzshrc// will put the battery status
60 into the right hand side interactive prompt. Supported OSes are //GNU/Linux//,
61 //FreeBSD//, //OpenBSD// and //Darwin//.
63 : **GRML_ZSH_CNF_HANDLER**
64 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
65 and defaults to "/usr/share/command-not-found/command-not-found".
67 : **GRMLSMALL_SPECIFIC**
68 Set this to zero to remove items in zsh config, which do not work in
72 Where zsh saves the history. Default: ${HOME}/.zsh_history.
75 Number of commands to be kept in the history. On a Grml-CD this defaults to
76 500, on a hard disk installation to 5000.
79 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
80 A value of zero turns off checking.
83 Non zero values deactivate automatic correction of commands.
86 If set to zero (default), allows selection from a menu, if there are at least
87 five possible options of completion.
90 A non zero value disables precmd and preexec commands. These are functions
91 that are run before every command (setting xterm/screen titles etc.).
94 Show time (user, system and cpu) used by external commands, if they run longer
95 than the defined number of seconds (default: 5).
98 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
99 and to 10000 on an installation on hard disk.
102 As in tcsh(1) an array of login/logout events to be reported by the shell
103 builtin "log". For details see zshparam(1). Defaults to (notme root).
105 : **ZSH_NO_DEFAULT_LOCALE**
106 Import "/etc/default/locale", if set to zero (default).
109 A non zero value causes shell functions to be profiled. The results can be
110 obtained with the zprof builtin command (see zshmodules(1) for details).
113 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
116 = FEATURE DESCRIPTION =
117 This is an in depth description of non-standard features implemented by
120 == DIRSTACK HANDLING ==
121 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
122 file each time zsh's working directory is changed. That file can be configured
123 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
124 **DIRSTACKSIZE** variable defaults to **20** in this setup.
126 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
127 zshs inherit the dirstack of the zsh that most recently updated
130 It is possible to apply a filter to the names of directories that will be
131 committed to the persistent dirstack file. There are two ways to configure this
132 filter: A general function based filter and a pattern based filter. Both are
133 setup via styles in the **':grml:chpwd:dirstack'** context.
135 To use a function based filter set the //filter// style for that context to the
136 name of a function to call every time a directory name is to be added to the
137 persistent dirstack. If the function's return value signals success (ie. return
138 value "0"), the directory name is filtered out and **not** added to the
139 persistent stack. Example:
142 function my_dirstack_filter() { [[ $1 == /tmp(|/*) ]] }
143 zstyle ':grml:chpwd:dirstack' filter my_dirstack_filter
146 The pattern based filter uses a list of patterns passed to the //exclude//
147 style in the aforementioned context. Each pattern is tested and the first that
148 matches will keep the directory name from being added to the persistent stack.
149 If none of the patterns matches, the name is added. example:
152 zstyle ':grml:chpwd:dirstack' exclude "/tmp(|/*)" "$HOME/tmp(|/*)"
155 The function based filter is more general, the pattern based filter easier to
156 set up. If both filter variants are used at the same time, the function based
157 filter will be executed //before// the pattern based one.
159 If you would like to apply your filters while //loading// the persistent
160 dirstack file, set the //filter-on-load// boolean style (the default is
164 zstyle ':grml:chpwd:dirstack' filter-on-load true
167 Setting the //filter-on-load// needs to be done in ".zshrc.pre" because the
168 style needs to be set when the main setup is executing! The other styles do not
169 have this limitation, but the initial filtering will obviously be done using
170 the filters that are configured **at** **that** **point**. The rule of thumb
171 is: If you want to filter on load, setup everything in ".zshrc.pre" otherwise
172 ".zshrc.local" works just as well.
175 == DIRECTORY BASED PROFILES ==
177 If you need to perform certain actions each time you enter certain
178 directory-trees, this is the feature you are looking for.
181 === Initialisation ===
182 To initialise the system, you need to call the function `chpwd_profiles' at
183 some point in your `zshrc.local'; preferably **after** you configured the
184 system. The configuration of the system is described further below.
186 If you need to do initialisations the first time `chpwd_profiles' is called
187 (which should be in your configuration file), you can do that in a function
188 called "chpwd_profiles_init". That function needs to be defined **before**
189 `chpwd_profiles' is called for this to work.
191 During the **first** call of `chpwd_profiles' (and therefore all its profile
192 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
193 all other cases, the parameter does not exist at all.
196 === Styles and Profile-names ===
197 To store its configuration, the system uses **functions** and **styles**
198 (zsh's context sensitive configuration system), such as this:
202 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
203 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
206 When that's done and you enter a directory that matches the pattern in the
207 third part of the context, a function called chpwd_profile_grml, for example,
208 is called (if it exists).
210 If no pattern matches (read: no profile is detected) the profile is set to
211 'default', which means chpwd_profile_default is attempted to be called.
213 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
214 which is used: The third part in the context is matched against ${PWD}. That's
215 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
216 profile is detected for all these values of ${PWD}:
223 So, if you want to make double damn sure a profile works in /foo/bar and
224 everywhere deeper in that tree, just use (|/|/*) and be happy.
226 The name of the detected profile will be available in a variable called
227 'profile' in your functions. You don't need to do anything, it'll just be
231 === Controlling Profile Execution ===
233 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
234 which is set to the profile that was is currently active (the default value is
235 "default"). That way you can avoid running code for a profile that is already
236 active, by running code such as the following at the start of your function:
239 function chpwd_profile_grml() {
240 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
245 If you know you are going to do that all the time for each and every
246 directory-profile function you are ever going to write, you may also set the
247 `re-execute' style to `false' (which only defaults to `true' for backwards
248 compatibility), like this:
251 zstyle ':chpwd:profiles:*' re-execute false
255 === Signaling availabily/profile changes ===
257 If you use this feature and need to know whether it is active in your current
258 shell, there are several ways to do that. Here are two simple ways:
260 a) If knowing if the profiles feature is active when zsh starts is good
261 enough for you, you can use the following snippet:
263 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
265 b) If that is not good enough, and you would prefer to be notified whenever a
266 profile changes, you can solve that by making sure you start **every**
267 profile function you create like this:
269 function chpwd_profile_myprofilename() {
270 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
271 print "chpwd(): Switching to profile: $profile"
275 That makes sure you only get notified if a profile is **changed**, not
276 everytime you change directory. (To avoid this, you may also set the newer
277 `re-execute' style like described further above instead of the test on top of
281 === Leaving Profiles ===
283 When the system switches from one profile to another, it executes a function
284 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
285 profile-function for the new profile.
288 === Version requirement ===
289 This feature requires zsh //4.3.3// or newer.
292 == ACCEPTLINE WRAPPER ==
293 The //accept-line// wiget is the one that is taking action when the **return**
294 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
297 This wrapper is configured via styles. That means, you issue commands, that look
301 zstyle 'context' style value
304 The context namespace, that we are using is 'acceptline'. That means, the actual
305 context for your commands look like: **':acceptline:<subcontext>'**.
307 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
311 === Recognized Contexts ===
313 This is the value, the context is initialized with.
314 The //compwarnfmt and //rehash// styles are looked up in this context.
317 If the first word in the command line is either a command, alias, function,
318 builtin or reserved word, you are in this context.
321 This is the context, that is used if you hit enter again, after being warned
322 about the existence of a _completion for the non-existing command you
326 This is the context, you are in if the command line is empty or only
327 consists of whitespace.
330 This context is in effect, if you entered something that does not match any
331 of the above. (e.g.: variable assignments).
334 === Available Styles ===
336 If you set this style to true, the warning about non existent commands,
337 for which completions exist will not be issued. (Default: **false**)
340 The message, that is displayed to warn about the _completion issue.
341 (default: **'%c will not execute and completion %f exists.'**)
342 '%c' is replaced by the command name, '%f' by the completion's name.
345 If this is set, we'll force rehashing, if appropriate. (Defaults to
346 **true** in //grmlzshrc//).
349 This can be a list of wigdets to call in a given context. If you need a
350 specific order for these to be called, name them accordingly. The default value
351 is an **empty list**.
354 The name of a widget, that is called after the widgets from 'actions'.
355 By default, this will be '.accept-line' (which is the built-in accept-line
359 If true in the current context, call the widget in the 'default_action'
360 style. (The default is **true** in all contexts.)
365 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
366 **promptinit** system. The three themes are called **grml**, **grml-large** and
369 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
370 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
371 non-empty, **grml-chroot** is used.
373 As usual, with promtinit themes, the user may switch to a different theme using
374 the //prompt// utility:
380 That will use the **grml-large** prompt theme.
382 The themes are highly customisable. The main source of documentation about
383 customisation is the main **grml** theme's doc-string, that is available via
384 the following command:
390 The other themes also come with doc-strings, but the main theme's is the
391 canonical reference about all of them.
393 This feature requires version //4.3.7// of the shell. Older versions will use
394 the classic grml prompt as a fallback.
396 A note to people who like customisation: If you are **not** using a prompt
397 theme for your customisation, but you're either statically setting $PS1 (or
398 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
399 function, make sure you are turning the zsh's prompt theme system **off**
400 before doing so. A correct example customisation could look like this:
403 # Turn the prompt system off:
405 # Customise the prompt yourself:
409 You also add your own tokens by using the \`grml_theme_add_token()' function.
410 Call the function without arguments for detailed documentation about that
413 == GNU/SCREEN STATUS SETTING ==
414 //grmlzshrc// sets screen's hardstatus lines to the currently running command
415 or **'zsh'** if the shell is idling at its prompt. If the current working
416 directory is inside a repository unter version control, screen status is set
417 to: **'zsh: <repository name>'** via zsh's vcs_info.
420 == PERSISTENT HISTORY ==
421 If you got commands you consider important enough to be included in every
422 shell's history, you can put them into ~/.important_commands and they will be
423 available via the usual history lookup widgets.
427 == ENVIRONMENT VARIABLES ==
428 //grmlzshrc// sets some environment variables, which influence the
429 behaviour of applications.
432 Set to "yes". Some applications read this to learn about properties
433 of the terminal they are running in.
436 If not already set, sets the default editor. Falls back to vi(1),
437 if vim(1) is not available.
440 Some environment variables that add colour support to less(1) for viewing
441 man pages. See termcap(5) for details.
444 The mailbox file for the current user is set to /var/mail/$USER, if not
445 already set otherwise.
448 Set less(1) as default pager, if not already set to something different.
452 Apart from zsh's default options, //grmlzshrc// sets some options
453 that change the behaviour of zsh. Options that change Z-shell's default
454 settings are marked by <grml>. But note, that zsh's defaults vary depending
455 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
458 Zsh sessions, that use //grmlzshrc//, will append their history list to the
459 history file, rather than replace it. Thus, multiple parallel zsh sessions
460 will all have the new entries from their history lists added to the history
461 file, in the order that they exit. The file will still be periodically
462 re-written to trim it when the number of lines grows 20% beyond the value
463 specified by $SAVEHIST.
466 If a command is issued that can't be executed as a normal command, and the
467 command is the name of a directory, perform the cd command to that directory.
469 : **auto_pushd** <grml>
470 Make cd push the old directory onto the directory stack.
472 : **completeinword** <grml>
473 If the cursor is inside a word, completion is done from both ends;
474 instead of moving the cursor to the end of the word first and starting
477 : **extended_glob** <grml>
478 Treat the '#', '~' and '^' characters as active globbing pattern characters.
480 : **extended_history** <grml>
481 Save each command's beginning timestamp (in seconds since the epoch) and the
482 duration (in seconds) to the history file.
485 Whenever a command completion is attempted, make sure the entire command
486 path is hashed first. This makes the first completion slower.
488 : **histignorealldups** <grml>
489 If a new command line being added to the history list duplicates an
490 older one, the older command is removed from the list, even if it is
491 not the previous event.
493 : **histignorespace** <grml>
494 Remove command lines from the history list when the first character on
495 the line is a space, or when one of the expanded aliases contains a
496 leading space. Note that the command lingers in the internal history
497 until the next command is entered before it vanishes.
499 : **longlistjobs** <grml>
500 List jobs in long format by default.
503 Avoid to beep on errors in zsh command line editing (zle).
506 A wildcard character never matches a leading '.'.
509 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
511 : **nonomatch** <grml>
512 If a pattern for filename generation has no matches, do not print an error
513 and leave it unchanged in the argument list. This also applies to file
514 expansion of an initial `~' or `='.
517 Report the status of background jobs immediately, rather than waiting until
518 just before printing a prompt.
520 : **pushd_ignore_dups** <grml>
521 Don't push multiple copies of the same directory onto the directory stack.
523 : **share_history** <grml>
524 As each line is added to the history file, it is checked to see if anything
525 else was written out by another shell, and if so it is included in the
526 history of the current shell too. Using !-style history, the commands from
527 the other sessions will not appear in the history list unless you explicitly
528 type the "history" command. This option is activated for zsh versions >= 4,
533 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
534 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
538 Edit the current command buffer in your favourite editor.
541 Deletes a word left of the cursor; seeing '/' as additional word separator.
544 Jump right after the first word.
547 Create directory under cursor or the selected area.
548 To select an area press ctrl-@ and use the cursor.
549 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
550 directory does not exist yet -> press **CTRL-xM** and problem solved.
553 Searches the last occurence of string before the cursor in the command history.
556 Display help on keybindings and zsh line editor. Press consecutively to page through content.
559 Brings a job, which got suspended with CTRL-z back to foreground.
562 === Customisation ===
564 To customise keybindings, you can just use zsh's bindkey utility. However, if
565 you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
566 yourself, make sure you call the following functions in the respective hook:
568 - **zle-line-init**: //zle-smkx//
569 - **zle-line-finish**: //zle-rmkx//
572 This is **required** so the keybindings set up by //grmlzshrc// work. The
573 reason for this is to turn the terminal into the right mode while zsh's line
574 editor (zle) is running. This enables us to query //terminfo// about escape
575 sequences for special keys and thus simplify and generalise our keybinding
579 == SHELL FUNCTIONS ==
580 //grmlzshrc// comes with a wide array of defined shell functions to ease the
583 : **855resolution()**
584 If 915resolution is available, issues a warning to the user to run it instead
585 to modify the resolution on intel graphics chipsets.
588 Lists files in current directory, which have been accessed within the
589 last N days. N is an integer to be passed as first and only argument.
590 If no argument is specified N is set to 1.
593 Lists processes matching given pattern.
596 Login on the host provided as argument using autossh. Then reattach a GNU screen
597 session if a detached session is around or detach a currently attached screen or
598 else start a new screen. This is especially useful for roadwarriors using GNU
602 Simple backup management of a file or directory using standard unix programs.
603 The target file name is the original name plus a time stamp attached. Symlinks
604 and file attributes like mode, ownership and timestamps are preserved.
607 If the original cdrecord is not installed, issues a warning to the user to
608 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
612 Creates a temporary directory using mktemp. Then changes current
613 working directory to it.
616 Lists files in current directory, which have been changed within the
617 last N days. N is an integer to be passed as first and only argument.
618 If no argument is specified N is set to 1.
621 Returns true if given command exists either as program, function, alias,
622 builtin or reserved word. If the option -c is given, only returns true,
623 if command is a program.
626 Changes directory to $HOME on first invocation of zsh. This is necessary on
627 Grml systems with autologin.
630 Changes current directory to the one supplied by argument and lists the files
631 in it, including file names starting with ".".
634 Shows the changelog of given package in $PAGER.
637 Shows the copyright of given package in $PAGER.
640 Tells the user to use grml-debootstrap, if she wants to install debian to
644 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
645 back interactive responsiveness after suspend, when the system is swapping
649 Shows the NEWS file for the given package in $PAGER.
655 Edit given shell function.
658 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
660 : **grml_vcs_info_toggle_colour()**
661 Toggles between coloured and uncoloured formats in vcs_info configuration.
662 This is useful with prompts that break if colour codes are in vcs_info
663 format expansions (like the `clint' prompt and every other prompt that
664 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
665 customised vcs_info formats, you shouldn't be using this function, since
666 it will set all formats to grml's default values (either coloured or plain)
670 Use GNU diff with options -ubwd for mercurial.
673 Displays diffstat between the revision given as argument and tip (no
674 argument means last revision).
677 Outputs highlighted diff; needs highstring(1).
680 Returns true, if zsh version is equal or greater than 4, else false.
683 Returns true, if zsh version is equal or greater than 4.1, else false.
686 Returns true, if zsh version is equal or greater than 4.2, else false.
689 Returns true, if zsh version is equal or greater than 4.2.5, else false.
692 Returns true, if zsh version is equal or greater than 4.3, else false.
695 Returns true, if zsh version is equal or greater than 4.3.3, else false.
698 Returns true, if running on darwin, else false.
701 Returns true, if running on FreeBSD, else false.
704 Returns true, if running on a grml system, else false.
707 Returns true, if running on a grml system from a live cd, else false.
710 Returns true, if run on grml-small, else false.
713 Returns true, if running on Linux, else false.
716 Changes every occurrence of the string iso885915 or ISO885915 in
717 environment variables to UTF-8.
720 Returns true, if running on OpenBSD, else false.
723 Returns true, if run within an utf environment, else false.
726 Creates directory including parent directories, if necessary. Then changes
727 current working directory to it.
730 Lists files in current directory, which have been modified within the
731 last N days. N is an integer to be passed as first and only argument.
732 If no argument is specified N is set to 1.
735 A helper function for the "e" glob qualifier to list all files newer
736 than a reference file.
740 % NTREF=/reference/file
743 % ls -l *(e:'nt /reference/file':)
747 Runs a command in zsh with profiling enabled (See startup variable
748 ZSH_PROFILE_RC above).
751 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
752 for details. See also xunfunction() below.
754 : **simple-extract()**
755 Tries to uncompress/unpack given files with the appropriate programs. If an URI
756 starting with https, http or ftp is provided simple-extract tries to download
757 and then uncompress/unpack the file. The choice is made along the filename
758 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
759 .xz) unless you use the '-d' option.
762 Prints details of symlinks given as arguments.
764 : **ssl-cert-fingerprints**
765 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
766 First and only parameter must be a file containing a certificate. Use
767 /dev/stdin as file if you want to pipe a certificate to these
771 Prints all information of a x509 certificate including the SHA512,
772 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
773 containing a certificate. Use /dev/stdin as file if you want to pipe a
774 certificate to this function.
776 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
777 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
778 certificate. First and only parameter must be a file containing a
779 certificate. Use /dev/stdin as file if you want to pipe a certificate
782 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
783 Functions for controlling daemons.
790 Translates a word from german to english (-D) or vice versa (-E).
793 Shows upstreams changelog of a given package in $PAGER.
796 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
799 Changes every occurrence of the string UTF-8 or utf-8 in environment
800 variables to iso885915.
803 Wrapper for vim(1). It tries to set the title and hands vim the environment
804 variable VIM_OPTIONS on the command line. So the user may define command
805 line options, she always wants, in her .zshrc.local.
808 Searches the history for a given pattern and lists the results by date.
809 The first argument is the search pattern. The second and third ones are
810 optional and denote a search range (default: -100).
813 Tries to cat(1) file(s) given as parameter(s). Always returns true.
814 See also xunfunction() below.
817 Tries to source the file(s) given as parameter(s). Always returns true.
818 See zshbuiltins(1) for a detailed description of the source command.
819 See also xunfunction() below.
822 Changes the title of xterm window from within screen(1). Run without
823 arguments for details.
826 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
829 Wrapper around the autoload builtin. Loads the definitions of functions
830 from the file given as argument. Searches $fpath for the file. See also
834 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
835 where own modifications should go. See also zshbuiltins(1) for a description
836 of the source command.
840 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
841 life. A few aliases (like those involving //grep// or //ls//) use the option
842 //--color=auto// for colourizing output. That option is part of **GNU**
843 implementations of these tools, and will only be used if such an implementation
846 : **acp** (//apt-cache policy//)
847 With no arguments prints out the priorities of each source. If a package name
848 is given, it displays detailed information about the priority selection of the
851 : **acs** (//apt-cache search//)
852 Searches debian package lists for the regular expression provided as argument.
853 The search includes package names and descriptions. Prints out name and short
854 description of matching packages.
856 : **acsh** (//apt-cache show//)
857 Shows the package records for the packages provided as arguments.
859 : **adg** (//apt-get dist-upgrade//)
860 Performs an upgrade of all installed packages. Also tries to automatically
861 handle changing dependencies with new versions of packages. As this may change
862 the install status of (or even remove) installed packages, it is potentially
863 dangerous to use dist-upgrade; invoked by sudo, if necessary.
865 : **ag** (//apt-get upgrade//)
866 Downloads and installs the newest versions of all packages currently installed
867 on the system. Under no circumstances are currently installed packages removed,
868 or packages not already installed retrieved and installed. New versions of
869 currently installed packages that cannot be upgraded without changing the install
870 status of another package will be left at their current version. An update must
871 be performed first (see au below); run by sudo, if necessary.
873 : **agi** (//apt-get install//)
874 Downloads and installs or upgrades the packages given on the command line.
875 If a hyphen is appended to the package name, the identified package will be
876 removed if it is installed. Similarly a plus sign can be used to designate a
877 package to install. This may be useful to override decisions made by apt-get's
878 conflict resolution system.
879 A specific version of a package can be selected for installation by following
880 the package name with an equals and the version of the package to select. This
881 will cause that version to be located and selected for install. Alternatively a
882 specific distribution can be selected by following the package name with a slash
883 and the version of the distribution or the Archive name (stable, testing, unstable).
884 Gets invoked by sudo, if user id is not 0.
886 : **ati** (//aptitude install//)
887 Aptitude is a terminal-based package manager with a command line mode similar to
888 apt-get (see agi above); invoked by sudo, if necessary.
890 : **au** (//apt-get update//)
891 Resynchronizes the package index files from their sources. The indexes of
892 available packages are fetched from the location(s) specified in
893 /etc/apt/sources.list. An update should always be performed before an
894 upgrade or dist-upgrade; run by sudo, if necessary.
896 : **da** (//du -sch//)
897 Prints the summarized disk usage of the arguments as well as a grand total
898 in human readable format.
900 : **dbp** (//dpkg-buildpackage//)
901 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
903 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
904 Prints installed Packages sorted by size (descending).
906 : **dir** (//ls -lSrah//)
907 Lists files (including dot files) sorted by size (biggest last) in long and
908 human readable output format.
910 : **ge** (//grep-excuses//)
911 Searches the testing excuses files for a specific maintainer (See:
914 : **grep** (//grep --color=auto//)
915 Shows grep output in nice colors, if available.
917 : **grml-version** (//cat /etc/grml_version//)
918 Prints version of running grml.
920 : **hbp** (//hg-buildpackage//)
921 Helper program to maintain Debian packages with mercurial.
923 : **http** (//python -m SimpleHTTPServer//)
924 Basic HTTP server implemented in python. Listens on port 8000/tcp and
925 serves current directory. Implements GET and HEAD methods.
927 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
928 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
929 host key changes frequently, for example on virtualized test- or development-systems.
930 To be used only inside trusted networks, of course.
932 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
933 ssh with possible man-in-the-middle attack enabled
934 (for an explanation see insecscp above).
936 : **help-zshglob** (//H-Glob()//)
937 Runs the function H-Glob() to expand or explain wildcards.
939 : **j** (//jobs -l//)
940 Prints status of jobs in the current shell session in long format.
942 : **l** (//ls -l --color=auto//)
943 Lists files in long output format with indicator for filetype appended
944 to filename. If the terminal supports it, with colored output.
946 : **la** (//ls -la --color=auto//)
947 Lists files in long colored output format. Including file names
950 : **lad** (//ls -d .*(/)//)
951 Lists the dot directories (not their contents) in current directory.
953 : **lh** (//ls -hAl --color=auto//)
954 Lists files in long and human readable output format in nice colors,
955 if available. Includes file names starting with "." except "." and
958 : **ll** (//ls -l --color=auto//)
959 Lists files in long colored output format.
961 : **llog** (//$PAGER /var/log/syslog//)
962 Opens syslog in pager.
964 : **ls** (//ls -C --color=auto//)
965 Lists directory, entries are listed by columns and an indicator for
966 file type is appended to each file name. Additionally the output is
967 colored, if the terminal supports it.
969 : **lsa** (//ls -a .*(.)//)
970 Lists dot files in current working directory.
972 : **lsbig** (//ls -flh *(.OL[1,10])//)
973 Displays the ten biggest files (long and human readable output format).
975 : **lsd** (//ls -d *(/)//)
978 : **lse** (//ls -d *(/^F)//)
979 Shows empty directories.
981 : **lsl** (//ls -l *(@)//)
982 Lists symbolic links in current directory.
984 : **lsnew** (//ls -rl *(D.om[1,10])//)
985 Displays the ten newest files (long output format).
987 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
988 Displays the ten newest directories and ten newest .directories.
990 : **lsold** (//ls -rtlh *(D.om[1,10])//)
991 Displays the ten oldest files (long output format).
993 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
994 Displays the ten oldest directories and ten oldest .directories.
996 : **lss** (//ls -l *(s,S,t)//)
997 Lists files in current directory that have the setuid, setgid or sticky bit
1000 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1001 Displays the ten smallest files (long output format).
1003 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1004 Displays all files which are world readable and/or world writable and/or
1005 world executable (long output format).
1007 : **lsx** (//ls -l *(*)//)
1008 Lists only executable files.
1010 : **mdstat** (//cat /proc/mdstat//)
1011 Lists all active md (i.e. linux software raid) devices with some information
1014 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1015 Executes the commands on the versioned patch queue from current repository.
1017 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1018 rmdir current working directory
1020 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1021 If invoking user is root, starts screen session with /etc/grml/screenrc
1022 as config file. If invoked by a regular user, start a screen session
1023 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1026 : **su** (//sudo su//)
1027 If user is running a Grml live system, don't ask for any password, if she
1030 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1031 Sets mode from UTF-8 to ISO 2022 (See:
1032 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1034 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1035 Sets mode from ISO 2022 to UTF-8 (See:
1036 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1038 : **tlog** (//tail -f /var/log/syslog//)
1039 Prints syslog continuously (See tail(1)).
1041 : **up** (//aptitude update ; aptitude safe-upgrade//)
1042 Performs a system update followed by a system upgrade using aptitude; run
1043 by sudo, if necessary. See au and ag above.
1045 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1046 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1047 protect them from the shell.
1049 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1050 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1052 : **...** (//cd ../..///)
1053 Changes current directory two levels higher.
1057 This is a set of files, that - if they exist - can be used to customize the
1058 behaviour of //grmlzshrc//.
1061 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1062 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1065 # show battery status in RPROMPT
1066 GRML_DISPLAY_BATTERY=1
1067 # always load the complete setup, even for root
1068 GRML_ALWAYS_LOAD_ALL=1
1072 Sourced right before loading //grmlzshrc// is finished. There is a global
1073 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1077 Directory listing for persistent dirstack (see above).
1079 : **.important_commands**
1080 List of commands, used by persistent history (see above).
1083 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1084 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1085 (http://www.ubuntu.com) and similar systems - it is very easy to get
1086 //grmlzshrc// via grml's .deb repositories.
1088 On non-debian systems, that is not an option, but all is not lost:
1091 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1094 If you would also like to get separate function files (which you can put into
1095 your **$fpath**), you can browse and download them at:
1097 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1099 = ZSH REFCARD TAGS =
1100 If you read //grmlzshrc//'s code you may notice strange looking comments in
1101 it. These are there for a purpose. grml's zsh-refcard is automatically
1102 generated from the contents of the actual configuration file. However, we need
1103 a little extra information on which comments and what lines of code to take
1104 into account (and for what purpose).
1106 Here is what they mean:
1108 List of tags (comment types) used:
1110 Next line contains an important alias, that should be included in the
1111 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1114 Next line contains the beginning of an important function. (placement
1115 tag: @@INSERT-functions@@)
1118 Next line contains an important variable. (placement tag:
1119 @@INSERT-variables@@)
1122 Next line contains an important keybinding. (placement tag:
1123 @@INSERT-keybindings@@)
1126 Hashed directories list generation: //start//: denotes the start of a list of
1127 'hash -d' definitions. //end//: denotes its end. (placement tag:
1128 @@INSERT-hasheddirs@@)
1131 Abbreviation expansion list generation: //start//: denotes the beginning of
1132 abbreviations. //end//: denotes their end.
1134 Lines within this section that end in '#d .*' provide extra documentation to
1135 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1138 This tag allows you to manually generate refcard entries for code lines that
1139 are hard/impossible to parse.
1143 #m# k ESC-h Call the run-help function
1146 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1149 So the syntax is: #m# <section> <argument> <comment>
1152 This tag lets you insert entries to the 'other' hash. Generally, this should
1153 not be used. It is there for things that cannot be done easily in another way.
1154 (placement tag: @@INSERT-other-foobar@@)
1157 All of these tags (except for m and o) take two arguments, the first
1158 within the tag, the other after the tag:
1160 #<tag><section># <comment>
1162 Where <section> is really just a number, which are defined by the @secmap
1163 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1164 that for the reader, the tag should not differ much from a regular comment.
1165 For zsh, it is a regular comment indeed. The numbers have got the following
1190 So, the following will add an entry to the 'functions' table in the 'system'
1191 section, with a (hopefully) descriptive comment:
1194 #f1# Edit an alias via zle
1198 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1199 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1200 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1201 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1202 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1206 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1207 repository from git.grml.org:
1209 ``` % git clone git://git.grml.org/grml-etc-core.git
1211 Make your changes, commit them; use '**git format-patch**' to create a series
1212 of patches and send those to the following address via '**git send-email**':
1214 ``` grml-etc-core@grml.org
1216 Doing so makes sure the right people get your patches for review and
1221 This manual page is the **reference** manual for //grmlzshrc//.
1223 That means that in contrast to the existing refcard it should document **every**
1224 aspect of the setup.
1226 This manual is currently not complete. If you want to help improving it, visit
1227 the following pages:
1229 http://wiki.grml.org/doku.php?id=zshrcmanual
1231 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1233 Contributions are highly welcome.
1237 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1238 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1239 Beckert <abe@deuxchevaux.org>.
1243 Copyright (c) 2009-2013 Grml project <http://grml.org>
1245 This manpage is distributed under the terms of the GPL version 2.
1247 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1248 except for **accept-line()** which are distributed under the same conditions
1249 as zsh itself (which is BSD-like).