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
32 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
33 variables. These may be set temporarily when starting zsh like this:
37 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
40 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
41 put the battery status into the right hand side interactive prompt.
43 : **COMMAND_NOT_FOUND**
44 A non zero value activates a handler, which is called when a command can not
45 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
47 : **GRML_ALWAYS_LOAD_ALL**
48 Enables the whole grml setup for root, if set to a non zero value.
50 : **GRML_ZSH_CNF_HANDLER**
51 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
52 and defaults to "/usr/share/command-not-found/command-not-found".
54 : **GRMLSMALL_SPECIFIC**
55 Set this to zero to remove items in zsh config, which do not work in
59 Where zsh saves the history. Default: ${HOME}/.zsh_history.
62 Number of commands to be kept in the history. On a grml-CD this defaults to
63 500, on a hard disk installation to 5000.
66 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
67 A value of zero turns off checking.
70 Non zero values deactivate automatic correction of commands.
73 If set to zero (default), allows selection from a menu, if there are at least
74 five possible options of completion.
77 A non zero value disables precmd and preexec commands. These are functions
78 that are run before every command (setting xterm/screen titles etc.).
81 Show time (user, system and cpu) used by external commands, if they run longer
82 than the defined number of seconds (default: 5).
85 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a grml-CD
86 and to 10000 on an installation on hard disk.
89 As in tcsh(1) an array of login/logout events to be reported by the shell
90 builtin "log". For details see zshparam(1). Defaults to (notme root).
92 : **ZSH_NO_DEFAULT_LOCALE**
93 Import "/etc/default/locale", if set to zero (default).
96 A non zero value causes shell functions to be profiled. The results can be
97 obtained with the zprof builtin command (see zshmodules(1) for details).
100 = FEATURE DESCRIPTION =
101 This is an in depth description of non-standard features implemented by
104 == DIRSTACK HANDLING ==
105 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
106 file each time zsh's working directory is changed. That file can be configured
107 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
108 **DIRSTACKSIZE** variable defaults to **20** in this setup.
110 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
111 zshs inherit the dirstack of the zsh that most recently updated
114 == DIRECTORY BASED PROFILES ==
115 If you want certain settings to be active in certain directories (and
116 automatically switch back and forth between them), this is what you want.
119 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
120 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
123 When that's done and you enter a directory that matches the pattern
124 in the third part of the context, a function called chpwd_profile_grml,
125 for example, is called (if it exists).
127 If no pattern matches (read: no profile is detected) the profile is
128 set to 'default', which means chpwd_profile_default is attempted to
131 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
132 command) which is used: The third part in the context is matched against
133 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
134 Because that way the profile is detected for all these values of **$PWD**:
142 So, if you want to make double damn sure a profile works in /foo/bar
143 and everywhere deeper in that tree, just use (|/|/*) and be happy.
145 The name of the detected profile will be available in a variable called
146 'profile' in your functions. You don't need to do anything, it'll just
149 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
150 that was active up to now. That way you can avoid running code for a
151 profile that is already active, by running code such as the following
152 at the start of your function:
155 function chpwd_profile_grml() {
156 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
161 The initial value for **$CHPWD_PROFILE** is 'default'.
163 === Signaling availabily/profile changes ===
165 If you use this feature and need to know whether it is active in your
166 current shell, there are several ways to do that. Here are two simple
169 a) If knowing if the profiles feature is active when zsh starts is
170 good enough for you, you can put the following snippet into your
174 (( ${+functions[chpwd_profiles]} )) &&
175 print "directory profiles active"
178 b) If that is not good enough, and you would prefer to be notified
179 whenever a profile changes, you can solve that by making sure you
180 start **every** profile function you create like this:
183 function chpwd_profile_myprofilename() {
184 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
185 print "chpwd(): Switching to profile: $profile"
190 That makes sure you only get notified if a profile is **changed**,
191 not everytime you change directory.
193 === Version requirement ===
194 This feature requires zsh //4.3.3// or newer.
197 == ACCEPTLINE WRAPPER ==
198 The //accept-line// wiget is the one that is taking action when the **return**
199 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
202 This wrapper is configured via styles. That means, you issue commands, that look
206 zstyle 'context' style value
209 The context namespace, that we are using is 'acceptline'. That means, the actual
210 context for your commands look like: **':acceptline:<subcontext>'**.
212 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
216 === Recognized Contexts ===
218 This is the value, the context is initialized with.
219 The //compwarnfmt and //rehash// styles are looked up in this context.
222 If the first word in the command line is either a command, alias, function,
223 builtin or reserved word, you are in this context.
226 This is the context, that is used if you hit enter again, after being warned
227 about the existence of a _completion for the non-existing command you
231 This is the context, you are in if the command line is empty or only
232 consists of whitespace.
235 This context is in effect, if you entered something that does not match any
236 of the above. (e.g.: variable assignments).
239 === Available Styles ===
241 If you set this style to true, the warning about non existent commands,
242 for which completions exist will not be issued. (Default: **false**)
245 The message, that is displayed to warn about the _completion issue.
246 (default: **'%c will not execute and completion %f exists.'**)
247 '%c' is replaced by the command name, '%f' by the completion's name.
250 If this is set, we'll force rehashing, if appropriate. (Defaults to
251 **true** in //grmlzshrc//).
254 This can be a list of wigdets to call in a given context. If you need a
255 specific order for these to be called, name them accordingly. The default value
256 is an **empty list**.
259 The name of a widget, that is called after the widgets from 'actions'.
260 By default, this will be '.accept-line' (which is the built-in accept-line
264 If true in the current context, call the widget in the 'default_action'
265 style. (The default is **true** in all contexts.)
271 == GNU/SCREEN STATUS SETTING ==
272 //grmlzshrc// sets screen's hardstatus lines to the currently running command
273 or **'zsh'** if the shell is idling at its prompt. If the current working
274 directory is inside a repository unter version control, screen status is set
275 to: **'zsh: <repository name>'** via zsh's vcs_info.
278 == PERSISTENT HISTORY ==
279 If you got commands you consider important enough to be included in every
280 shell's history, you can put them into ~/.important_commands and they will be
281 available via the usual history lookup widgets.
285 == ENVIRONMENT VARIABLES ==
286 //grmlzshrc// sets some environment variables, which influence the
287 behaviour of applications.
290 If X is running this is set to "firefox", otherwise to "w3m".
293 Set to "yes". Some applications read this to learn about properties
294 of the terminal they are running in.
297 If not already set, sets the default editor. Falls back to vi(1),
298 if vim(1) is not available.
301 Some environment variables that add colour support to less(1) for viewing
302 man pages. See termcap(5) for details.
305 The mailbox file for the current user is set to /var/mail/$USER, if not
306 already set otherwise.
309 Set less(1) as default pager, if not already set to something different.
312 Holds the path to shared files for the C++ application framework QT
316 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
317 default to /bin/sh or /bin/bash.
321 Apart from zsh's default options, //grmlzshrc// sets some options
322 that change the behaviour of zsh. Options that change Z-shell's default
323 settings are marked by <grml>. But note, that zsh's defaults vary depending
324 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
327 Zsh sessions, that use //grmlzshrc//, will append their history list to the
328 history file, rather than replace it. Thus, multiple parallel zsh sessions
329 will all have the new entries from their history lists added to the history
330 file, in the order that they exit. The file will still be periodically
331 re-written to trim it when the number of lines grows 20% beyond the value
332 specified by $SAVEHIST.
335 If a command is issued that can't be executed as a normal command, and the
336 command is the name of a directory, perform the cd command to that directory.
338 : **auto_pushd** <grml>
339 Make cd push the old directory onto the directory stack.
341 : **completeinword** <grml>
342 If the cursor is inside a word, completion is done from both ends;
343 instead of moving the cursor to the end of the word first and starting
346 : **extended_glob** <grml>
347 Treat the '#', '~' and '^' characters as active globbing pattern characters.
349 : **extended_history** <grml>
350 Save each command's beginning timestamp (in seconds since the epoch) and the
351 duration (in seconds) to the history file.
354 Whenever a command completion is attempted, make sure the entire command
355 path is hashed first. This makes the first completion slower.
357 : **histignorealldups** <grml>
358 If a new command line being added to the history list duplicates an
359 older one, the older command is removed from the list, even if it is
360 not the previous event.
362 : **histignorespace** <grml>
363 Remove command lines from the history list when the first character on
364 the line is a space, or when one of the expanded aliases contains a
365 leading space. Note that the command lingers in the internal history
366 until the next command is entered before it vanishes.
368 : **longlistjobs** <grml>
369 List jobs in long format by default.
372 Avoid to beep on errors in zsh command line editing (zle).
375 A wildcard character never matches a leading '.'.
378 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
380 : **nonomatch** <grml>
381 If a pattern for filename generation has no matches, do not print an error
382 and leave it unchanged in the argument list. This also applies to file
383 expansion of an initial `~' or `='.
386 Report the status of background jobs immediately, rather than waiting until
387 just before printing a prompt.
389 : **pushd_ignore_dups** <grml>
390 Don't push multiple copies of the same directory onto the directory stack.
392 : **share_history** <grml>
393 As each line is added to the history file, it is checked to see if anything
394 else was written out by another shell, and if so it is included in the
395 history of the current shell too. Using !-style history, the commands from
396 the other sessions will not appear in the history list unless you explicitly
397 type the "history" command. This option is activated for zsh versions >= 4,
402 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
403 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
407 Edit the current command buffer in your favourite editor.
410 Deletes a word left of the cursor; seeing '/' as additional word separator.
413 Jump right after the first word.
416 Searches the last occurence of string before the cursor in the command history.
419 Brings a job, which got suspended with CTRL-z back to foreground.
422 == SHELL FUNCTIONS ==
423 //grmlzshrc// comes with a wide array of defined shell functions to ease the
427 Converts plaintext files to HTML using vim. The output is written to
430 : **855resolution()**
431 If 915resolution is available, issues a warning to the user to run it instead
432 to modify the resolution on intel graphics chipsets.
435 Lists files in current directory, which have been accessed within the
436 last N days. N is an integer to be passed as first and only argument.
437 If no argument is specified N is set to 1.
440 Searches for USENET postings from authors using google groups.
443 Sets all ulimit values to "unlimited".
446 Prints a colored table of available ansi color codes (to be used in escape
447 sequences) and the colors they represent.
450 Lists processes matching given pattern.
452 : **aoeu(), asdf(), uiae()**
453 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
456 : **apache2-ssl-certificate()**
457 Advices the user how to create self signed certificates.
460 Login on the host provided as argument using autossh. Then reattach a GNU screen
461 session if a detached session is around or detach a currently attached screen or
462 else start a new screen. This is especially useful for roadwarriors using GNU
466 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
467 Then prompts the user if she wants to remove that directory. You might need
468 to tell audioburn which cdrom device to use like:
469 "DEVICE=/dev/cdrom audioburn"
472 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
473 it. Then prompts the user if she wants to burn a audio CD with audioburn()
474 (see above). You might need to tell audiorip which cdrom device to use like:
475 "DEVICE=/dev/cdrom audioburn"
478 Simple backup of a file or directory using cp(1). The target file name is the
479 original name plus a time stamp attached. Symlinks and file attributes like mode,
480 ownership and timestamps are preserved.
483 The brltty(1) program provides a braille display, so a blind person can access
484 the console screen. This wrapper function works around problems with some
485 environments (f. e. utf8).
488 Runs a recursive diff(1) over two given directories trying to find the
489 smallest set of changes. Three lines of context will be printed and binary
493 If the original cdrecord is not installed, issues a warning to the user to
494 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
498 Lists files in current directory, which have been changed within the
499 last N days. N is an integer to be passed as first and only argument.
500 If no argument is specified N is set to 1.
503 Returns true if given command exists either as program, function, alias,
504 builtin or reserved word. If the option -c is given, only returns true,
505 if command is a program.
508 Changes directory to $HOME on first invocation of zsh. This is neccessary on
509 grml systems with autologin.
512 Changes current directory to the one supplied by argument and lists the files
513 in it, including file names starting with ".".
516 Adds and commits the given files using cvs(1). The commit message will be
520 Shows a cvs diff of the arguments in $PAGER.
523 Shows the cvs log in $PAGER.
529 Generates a changelog using rcs2log and shows it in $PAGER.
532 Shows cvs status of given files.
535 Shows the changelog of given package in $PAGER.
538 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
539 email addresses of submitters or any string given on the command line.
542 Shows bug report for debian given by number in mailbox format.
545 Tells the user to use grml-debootstrap, if she wants to install debian to
549 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
550 back interactive responsiveness after suspend, when the system is swapping
554 Shows the disk usage of the directories given in human readable format;
558 Translates C source code to assembly and ouputs both.
561 Searches for the first argument (optional) in the Open Directory Project
562 (See http://www.dmoz.org/docs/en/about.html).
565 Shows the NEWS file for the given package in $PAGER.
568 Takes packagename as argument. Sets current working directory to
569 /usr/share/doc/<packagename> and prints out a directory listing.
572 Looks up the first argument (optional) in the german Wiktionary
573 which is an online dictionary (See: http://de.wiktionary.org/).
579 Edit given shell function.
582 Looks up the first argument (optional in the english Wiktionary
583 which is an online dictionary (See: http://en.wiktionary.org/).
586 Renames image files based on date/time informations in their exif headers.
589 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
590 instance of firefox running, attaches to the first window found and opens the
591 URL in a new tab (this even works across an ssh session).
593 : **fluxkey-change()**
594 Switches the key combinations for changing current workspace under fluxbox(1)
595 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
596 Requires the window manager to reread configuration to take effect.
599 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
602 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
603 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
604 filename>". Creates an index.html with title "Images" showing the
605 thumbnails as clickable links to the respective original file.
606 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
607 and all files and/or directories beginning with "thumb-" in current directory!
610 Fetches 3ware RAID controller software using get_3ware(1).
613 Performs an exact (i. e. quoted) web search using Google.
616 Searches the arguments on Google Groups, a web to USENET gateway.
619 Searches the search engine Google using arguments as search string.
622 Searches the zsh command history for a regular expression.
625 Prints the hexadecimal representation of the number supplied as argument
629 Use GNU diff with options -ubwd for mercurial.
632 Displays diffstat between the revision given as argument and tip (no
633 argument means last revision).
636 Outputs highlighted diff; needs highstring(1).
639 Shows source files in less(1) with syntax highlighting. Run "hl -h"
640 for detailed usage information.
643 Queries IMAP server (first parameter) for its capabilities. Takes
644 port number as optional second argument.
647 Sets up an IPv6 tunnel on interface sit1. Needs one argument -
648 either "start", "stop" or "status".
651 Returns true, if zsh version is equal or greater than 4, else false.
654 Returns true, if zsh version is equal or greater than 4.1, else false.
657 Returns true, if zsh version is equal or greater than 4.2, else false.
660 Returns true, if zsh version is equal or greater than 4.2.5, else false.
663 Returns true, if zsh version is equal or greater than 4.3, else false.
666 Returns true, if zsh version is equal or greater than 4.3.3, else false.
669 Returns true, if running on darwin, else false.
672 Returns true, if running on a grml system, else false.
675 Returns true, if running on a grml system from a live cd, else false.
678 Returns true, if run on grml-small, else false.
681 Changes every occurrence of the string iso885915 or ISO885915 in
682 environment variables to UTF-8.
685 Returns true, if run within an utf environment, else false.
688 Searches a wireless interface and runs dhclient(8) on it.
691 Lists libraries that define the symbol containing the string given as
695 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
699 Prints specified range of (numbered) lines of a file.
700 Usage: linenr <start>[,<end>] <file>
703 Creates a PostScript and a PDF file (basename as first argument) from
707 Displays manpage in a streched style.
710 Shows the zshall manpage and jumps to the first match of the regular
711 expression optionally given as argument (Needs qma(1)).
714 Creates directory including parent directories, if necessary. Then changes
715 current working directory to it.
718 Diffs the two arguments recursively and writes the
719 output (unified format) to a timestamped file.
722 Prints the summarized memory usage in bytes.
725 Searches Google Groups for a USENET message-ID.
727 : **minimal-shell()**
728 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
729 so that file system can be unmounted.
732 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
733 replaces spaces in file names with underscores. Then mkaudiocd()
734 normalizes the files and recodes them to WAV.
737 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
738 enabled using mkisofs(8). Prompts the user for volume name, filename and
742 Creates a directory with first parameter as name inside $MAILDIR_ROOT
743 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
746 Runs "make install" and logs the output under ~/.errorlogs/; useful for
747 a clean deinstall later.
750 Lists files in current directory, which have been modified within the
751 last N days. N is an integer to be passed as first and only argument.
752 If no argument is specified N is set to 1.
755 Asks netcraft.com for informations about the site given as argument.
758 A helper function for the "e" glob qualifier to list all files newer
759 than a reference file.
763 % NTREF=/reference/file
766 % ls -l *(e:'nt /reference/file':)
770 Recodes an ogg file to mp3 with a bitrate of 192.
773 Translates the given word using the english - german online
774 dictionary dict.leo.org.
777 Evaluates a perl expression; useful as command line
778 calculator, therefore also available as "calc".
781 Lists all occurrences of the string given as argument in current $PATH.
784 Runs a command in $SHELL with profiling enabled (See startup variable
785 ZSH_PROFILE_RC above).
788 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
789 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
790 Asks for confirmation.
793 Opens all README-like files in current working directory with the program
794 defined in the $PAGER environment variable.
797 Reloads functions given as parameters.
800 Checks whether a regular expression (first parameter) matches a string
801 (second parameter) using perl.
804 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
805 for details. See also xunfunction() below.
808 Greps the history for the string provided as parameter and shows the numbered
809 findings in default pager. On exit of the pager the user is prompted for a
810 number. The shells readline buffer is then filled with the corresponding
814 Reimplementation of the csh(1) builtin setenv.
817 Lists the contents of a (compressed) archive with the appropriate programs.
818 The choice is made along the filename extension.
821 Lists the content of a gzipped tar archive in default pager.
824 Shows the content of a zip archive in default pager.
826 : **simple-extract()**
827 Tries to uncompress/unpack given file with the appropriate programs. The
828 choice is made along the filename ending.
831 Prints details of symlinks given as arguments.
834 Prints the arguments slowly by sleeping 0.08 seconds between each character.
836 : **smartcompress()**
837 Compresses/archives the file given as first parameter. Takes an optional
838 second argument, which denotes the compression/archive type as typical
839 filename extension; defaults to "tar.gz".
842 Indents C source code files given; uses Kernighan & Ritchie style.
845 Creates directory named shots in user's home directory, if it does not yet
846 exist and changes current working directory to it. Then sleeps 5 seconds,
847 so you have plenty of time to switch desktops/windows. Then makes a screenshot
848 of the current desktop. The result is stored in ~/shots to a timestamped
851 : **ssl-cert-fingerprints**
852 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
853 First and only parameter must be a file containing a certificate. Use
854 /dev/stdin as file if you want to pipe a certificate to these
858 Prints all information of a x509 certificate including the SHA512,
859 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
860 containing a certificate. Use /dev/stdin as file if you want to pipe a
861 certificate to this function.
863 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
864 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
865 certificate. First and only parameter must be a file containing a
866 certificate. Use /dev/stdin as file if you want to pipe a certificate
869 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
870 Functions for controlling daemons.
877 Shows some information about current system status.
880 Searches articles in the german Wikipedia for the term given as argument.
883 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
884 swspeak must be set for this to work.
887 Translates a word from german to english (-D) or vice versa (-E).
890 Shows upstreams changelog of a given package in $PAGER.
893 Makes a unified diff of the command line arguments trying hard to find a
894 smaller set of changes. Descends recursively into subdirectories. Ignores
895 hows some information about current status.
898 Downloads and displays a file using a suitable program for its
902 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
905 Takes a string as its first argument and prints it RFC 2396 URL encoded to
909 Changes every occurrence of the string UTF-8 or utf-8 in environment
910 variables to iso885915.
916 Wrapper for vim(1). It tries to set the title and hands vim the environment
917 variable VIM_OPTIONS on the command line. So the user may define command
918 line options, she always wants, in her .zshrc.local.
921 Use vim(1) as manpage reader.
924 Searches the history for a given pattern and lists the results by date.
925 The first argument is the search pattern. The second and third ones are
926 optional and denote a search range (default: -100).
929 Retrieves and prints weather information from "http://weather.noaa.gov".
930 The first and only argument is the ICAO code for the desired station.
931 For a list of ICAO codes see
932 "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
935 Looks up the argument on Wikipedia (german).
938 Looks up the argument on Wikipedia (english).
941 Searches the list of official debian packages for the term given as
942 first argument. The optional second argument denotes the distribution
943 (stable, testing or unstable) and defaults to unstable.
946 Tries to cat(1) file(s) given as parameter(s). Always returns true.
947 See also xunfunction() below.
950 Tries to source the file(s) given as parameter(s). Always returns true.
951 See zshbuiltins(1) for a detailed description of the source command.
952 See also xunfunction() below.
955 Changes the title of xterm window from within screen(1). Run without
956 arguments for details.
959 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
962 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
963 option plus a non empty pattern. Run zg without any arguments for a listing
964 of available command line switches. For a zshrc not in /etc/zsh, set the
965 GRML_ZSHRC environment variable.
968 Wrapper around the autoload builtin. Loads the definitions of functions
969 from the file given as argument. Searches $fpath for the file. See also
973 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
974 where own modifications should go. See also zshbuiltins(1) for a description
975 of the source command.
979 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
980 life. A few aliases (like those involving //grep// or //ls//) use the option
981 //--color=auto// for colourizing output. That option is part of **GNU**
982 implementations of these tools, and will only be used if such an implementation
985 : **acp** (//apt-cache policy//)
986 With no arguments prints out the priorities of each source. If a package name
987 is given, it displays detailed information about the priority selection of the
990 : **acs** (//apt-cache search//)
991 Searches debian package lists for the regular expression provided as argument.
992 The search includes package names and descriptions. Prints out name and short
993 description of matching packages.
995 : **acsh** (//apt-cache show//)
996 Shows the package records for the packages provided as arguments.
998 : **adg** (//apt-get dist-upgrade//)
999 Performs an upgrade of all installed packages. Also tries to automatically
1000 handle changing dependencies with new versions of packages. As this may change
1001 the install status of (or even remove) installed packages, it is potentially
1002 dangerous to use dist-upgrade; invoked by sudo, if necessary.
1004 : **ag** (//apt-get upgrade//)
1005 Downloads and installs the newest versions of all packages currently installed
1006 on the system. Under no circumstances are currently installed packages removed,
1007 or packages not already installed retrieved and installed. New versions of
1008 currently installed packages that cannot be upgraded without changing the install
1009 status of another package will be left at their current version. An update must
1010 be performed first (see au below); run by sudo, if necessary.
1012 : **agi** (//apt-get install//)
1013 Downloads and installs or upgrades the packages given on the command line.
1014 If a hyphen is appended to the package name, the identified package will be
1015 removed if it is installed. Similarly a plus sign can be used to designate a
1016 package to install. This may be useful to override decisions made by apt-get's
1017 conflict resolution system.
1018 A specific version of a package can be selected for installation by following
1019 the package name with an equals and the version of the package to select. This
1020 will cause that version to be located and selected for install. Alternatively a
1021 specific distribution can be selected by following the package name with a slash
1022 and the version of the distribution or the Archive name (stable, testing, unstable).
1023 Gets invoked by sudo, if user id is not 0.
1025 : **ati** (//aptitude install//)
1026 Aptitude is a terminal-based package manager with a command line mode similar to
1027 apt-get (see agi above); invoked by sudo, if necessary.
1029 : **au** (//apt-get update//)
1030 Resynchronizes the package index files from their sources. The indexes of
1031 available packages are fetched from the location(s) specified in
1032 /etc/apt/sources.list. An update should always be performed before an
1033 upgrade or dist-upgrade; run by sudo, if necessary.
1035 : **calc** (//peval//)
1036 Evaluates a perl expression (see peval() above); useful as a command line
1039 : **CH** (//./configure --help//)
1040 Lists available compilation options for building program from source.
1042 : **cmplayer** (//mplayer -vo fbdev//)
1043 Video player with framebuffer as video output device, so you can watch
1044 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
1045 while watching a movie.
1047 : **CO** (//./configure//)
1048 Prepares compilation for building program from source.
1050 : **cp** (//nocorrect cp//)
1051 cp(1) without spelling correction.
1053 : **da** (//du -sch//)
1054 Prints the summarized disk usage of the arguments as well as a grand total
1055 in human readable format.
1057 : **dbp** (//dpkg-buildpackage//)
1058 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
1060 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
1061 Prints installed Packages sorted by size (descending).
1063 : **default** (//echo -en [ escape sequence ]//)
1064 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
1065 using escape sequence.
1067 : **dir** (//ls -lSrah//)
1068 Lists files (including dot files) sorted by size (biggest last) in long and
1069 human readable output format.
1071 : **fblinks** (//links2 -driver fb//)
1072 A Web browser on the framebuffer device. So you can browse images and click
1073 links on the virtual tty.
1075 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
1076 Fullscreen Video player with the framebuffer as video output device. So you
1077 can watch videos on a virtual tty.
1080 Revision control system by Linus Torvalds.
1082 : **ge** (//grep-excuses//)
1083 Searches the testing excuses files for a specific maintainer (See:
1086 : **grep** (//grep --color=auto//)
1087 Shows grep output in nice colors, if available.
1089 : **GREP** (//grep -i --color=auto//)
1090 Case insensitive grep with colored output.
1092 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
1093 Scans for new devices and updates /etc/fstab according to the findings.
1095 : **grml-version** (//cat /etc/grml_version//)
1096 Prints version of running grml.
1098 : **hbp** (//hg-buildpackage//)
1099 Helper program to maintain Debian packages with mercurial.
1101 : **http** (//python -m SimpleHTTPServer//)
1102 Basic HTTP server implemented in python. Listens on port 8000/tcp and
1103 serves current directory. Implements GET and HEAD methods.
1105 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1106 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
1107 host key changes frequently, for example on virtualized test- or development-systems.
1108 To be used only inside trusted networks, of course.
1110 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1111 ssh with possible man-in-the-middle attack enabled
1112 (for an explanation see insecscp above).
1114 : **help-zshglob** (//H-Glob()//)
1115 Runs the function H-Glob() to expand or explain wildcards.
1117 : **hide** (//echo -en [ escape sequence ]//)
1118 Tries to hide xterm window using escape sequence.
1120 : **hidiff** (//histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'//)
1121 If histring(1) is installed, highlight important stuff in diff(1) output.
1123 : **huge** (//echo -en [ escape sequence ]//)
1124 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
1125 using escape sequence.
1127 : **j** (//jobs -l//)
1128 Prints status of jobs in the current shell session in long format.
1130 : **l** (//ls -lF --color=auto//)
1131 Lists files in long output format with indicator for filetype appended
1132 to filename. If the terminal supports it, with colored output.
1134 : **la** (//ls -la --color=auto//)
1135 Lists files in long colored output format. Including file names
1138 : **lad** (//ls -d .*(/)//)
1139 Lists the dot directories (not their contents) in current directory.
1141 : **large** (//echo -en [ escape sequence ]//)
1142 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
1143 using escape sequence.
1145 : **lh** (//ls -hAl --color=auto//)
1146 Lists files in long and human readable output format in nice colors,
1147 if available. Includes file names starting with "." except "." and
1150 : **ll** (//ls -l --color=auto//)
1151 Lists files in long colored output format.
1153 : **llog** (//$PAGER /var/log/syslog//)
1154 Opens syslog in pager.
1156 : **ls** (//ls -b -CF --color=auto//)
1157 Lists directory printing octal escapes for nongraphic characters.
1158 Entries are listed by columns and an indicator for file type is appended
1159 to each file name. Additionally the output is colored, if the terminal
1162 : **lsa** (//ls -a .*(.)//)
1163 Lists dot files in current working directory.
1165 : **lsbig** (//ls -flh *(.OL[1,10])//)
1166 Displays the ten biggest files (long and human readable output format).
1168 : **lsd** (//ls -d *(/)//)
1171 : **lse** (//ls -d *(/^F)//)
1172 Shows empty directories.
1174 : **lsl** (//ls -l *(@)//)
1175 Lists symbolic links in current directory.
1177 : **lsnew** (//ls -rl *(D.om[1,10])//)
1178 Displays the ten newest files (long output format).
1180 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1181 Displays the ten oldest files (long output format).
1183 : **lss** (//ls -l *(s,S,t)//)
1184 Lists files in current directory that have the setuid, setgid or sticky bit
1187 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1188 Displays the ten smallest files (long output format).
1190 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1191 Displays all files which are world readable and/or world writable and/or
1192 world executable (long output format).
1194 : **lsx** (//ls -l *(*)//)
1195 Lists only executable files.
1197 : **md** (//mkdir -p//)
1198 Creates directory including parent directories, if necessary
1200 : **mdstat** (//cat /proc/mdstat//)
1201 Lists all active md (i.e. linux software raid) devices with some information
1204 : **medium** (//echo -en [ escape sequence ]//)
1205 Sets medium sized font
1206 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1207 using escape sequence.
1209 : **mkdir** (//nocorrect mkdir//)
1210 mkdir(1) without spelling correction.
1212 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1213 Executes the commands on the versioned patch queue from current repository.
1215 : **mv** (//nocorrect mv//)
1216 mv(1) without spelling correction.
1218 : **rd** (//rmdir//)
1219 Short rmdir(1) (remove directory).
1221 : **rm** (//nocorrect rm//)
1222 rm(1) without spelling correction.
1224 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1225 If invoking user is root, starts screen session with /etc/grml/screenrc
1226 as config file. If invoked by a regular user, start a screen session
1227 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1230 : **rw-** (//chmod 600//)
1231 Grants read and write permission of a file to the owner and nobody else.
1233 : **rwx** (//chmod 700//)
1234 Grants read, write and execute permission of a file to the owner and nobody
1237 : **r--** (//chmod 644//)
1238 Grants read and write permission of a file to the owner and read-only to
1241 : **r-x** (//chmod 755//)
1242 Grants read, write and execute permission of a file to the owner and
1243 read-only plus execute permission to anybody else.
1245 : **S** (//screen//)
1246 Short for screen(1).
1251 : **semifont** (//echo -en [ escape sequence ]//)
1252 Sets font of xterm to
1253 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1256 : **small** (//echo -en [ escape sequence ]//)
1257 Sets small xterm font ("6x10") using escape sequence.
1259 : **smartfont** (//echo -en [ escape sequence ]//)
1260 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1263 : **su** (//sudo su//)
1264 If user is running a grml live-CD, dont ask for any password, if she
1267 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1268 Sets mode from UTF-8 to ISO 2022 (See:
1269 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1271 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1272 Sets mode from ISO 2022 to UTF-8 (See:
1273 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1275 : **tiny** (//echo -en [ escape sequence ]//)
1276 Sets tiny xterm font
1277 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1280 : **tlog** (//tail -f /var/log/syslog//)
1281 Prints syslog continuously (See tail(1)).
1283 : **top10** (//print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10//)
1284 Prints the ten most used shell commands.
1286 : **truec** (//truecrypt [ mount options ]//)
1287 Mount a truecrypt volume with some reasonable mount options
1288 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1291 : **up** (//aptitude update ; aptitude safe-upgrade//)
1292 Performs a system update followed by a system upgrade using aptitude; run
1293 by sudo, if necessary. See au and ag above.
1295 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1296 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1297 protect them from the shell.
1299 : **0** (//return 0//)
1300 Gives a clean prompt (i.e. without $?).
1302 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1303 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1305 : **...** (//cd ../..///)
1306 Changes current directory two levels higher.
1308 : **?** (//qma zshall//)
1309 Runs the grml script qma (quick manual access) to build the collected man
1310 pages for the z-shell. This compressed file is kept at
1311 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1312 fast. See "man qma" for further information.
1316 This is a set of files, that - if they exist - can be used to customize the
1317 behaviour of //grmlzshrc//.
1320 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1321 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1324 # show battery status in RPROMPT
1326 # always load the complete setup, even for root
1327 GRML_ALWAYS_LOAD_ALL=1
1331 Sourced right before loading //grmlzshrc// is finished. There is a global
1332 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1336 Directory listing for persistent dirstack (see above).
1338 : **.important_commands**
1339 List of commands, used by persistent history (see above).
1342 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1343 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1344 (http://www.ubuntu.com) and similar systems - it is very easy to get
1345 //grmlzshrc// via grml's .deb repositories.
1347 On non-debian systems, that is not an option, but all is not lost:
1350 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1353 If you would also like to get seperate function files (which you can put into
1354 your **$fpath**), you can browse and download them at:
1356 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1358 = ZSH REFCARD TAGS =
1359 If you read //grmlzshrc//'s code you may notice strange looking comments in
1360 it. These are there for a purpose. grml's zsh-refcard is automatically
1361 generated from the contents of the actual configuration file. However, we need
1362 a little extra information on which comments and what lines of code to take
1363 into account (and for what purpose).
1365 Here is what they mean:
1367 List of tags (comment types) used:
1369 Next line contains an important alias, that should be included in the
1370 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1373 Next line contains the beginning of an important function. (placement
1374 tag: @@INSERT-functions@@)
1377 Next line contains an important variable. (placement tag:
1378 @@INSERT-variables@@)
1381 Next line contains an important keybinding. (placement tag:
1382 @@INSERT-keybindings@@)
1385 Hashed directories list generation: //start//: denotes the start of a list of
1386 'hash -d' definitions. //end//: denotes its end. (placement tag:
1387 @@INSERT-hasheddirs@@)
1390 Abbreviation expansion list generation: //start//: denotes the beginning of
1391 abbreviations. //end//: denotes their end.
1393 Lines within this section that end in '#d .*' provide extra documentation to
1394 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1397 This tag allows you to manually generate refcard entries for code lines that
1398 are hard/impossible to parse.
1402 #m# k ESC-h Call the run-help function
1405 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1408 So the syntax is: #m# <section> <argument> <comment>
1411 This tag lets you insert entries to the 'other' hash. Generally, this should
1412 not be used. It is there for things that cannot be done easily in another way.
1413 (placement tag: @@INSERT-other-foobar@@)
1416 All of these tags (except for m and o) take two arguments, the first
1417 within the tag, the other after the tag:
1419 #<tag><section># <comment>
1421 Where <section> is really just a number, which are defined by the @secmap
1422 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1423 that for the reader, the tag should not differ much from a regular comment.
1424 For zsh, it is a regular comment indeed. The numbers have got the following
1449 So, the following will add an entry to the 'functions' table in the 'system'
1450 section, with a (hopefully) descriptive comment:
1453 #f1# Edit an alias via zle
1457 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1458 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1459 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1460 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1461 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1465 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1466 repository from git.grml.org:
1468 ``` % git clone git://git.grml.org/grml-etc-core.git
1470 Make your changes, commit them; use '**git format-patch**' to create a series
1471 of patches and send those to the following address via '**git send-email**':
1473 ``` grml-etc-core@grml.org
1475 Doing so makes sure the right people get your patches for review and
1480 This manual page is the **reference** manual for //grmlzshrc//.
1482 That means that in contrast to the existing refcard it should document **every**
1483 aspect of the setup.
1485 This manual is currently not complete. If you want to help improving it, visit
1486 the following pages:
1488 http://wiki.grml.org/doku.php?id=zshrcmanual
1490 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1492 Contributions are highly welcome.
1496 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1497 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1498 Beckert <abe@deuxchevaux.org>.
1502 Copyright (c) 2009-2010 grml project <http://grml.org>
1504 This manpage is distributed under the terms of the GPL version 2.
1506 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1507 except for **accept-line()** and **vcs_info()**, which are distributed under
1508 the same conditions as zsh itself (which is BSD-like).