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
431 Useful if you own players lacking ogg/flac support.
432 Takes a list of "*.ogg" and "*.flac" files and transcodes them to mp3
433 with a variable bitrate of at least 192, while preserving basic id3 tags.
435 : **855resolution()**
436 If 915resolution is available, issues a warning to the user to run it instead
437 to modify the resolution on intel graphics chipsets.
440 Lists files in current directory, which have been accessed within the
441 last N days. N is an integer to be passed as first and only argument.
442 If no argument is specified N is set to 1.
445 Searches for USENET postings from authors using google groups.
448 Sets all ulimit values to "unlimited".
451 Prints a colored table of available ansi color codes (to be used in escape
452 sequences) and the colors they represent.
455 Lists processes matching given pattern.
457 : **aoeu(), asdf(), uiae()**
458 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
461 : **apache2-ssl-certificate()**
462 Advices the user how to create self signed certificates.
465 Login on the host provided as argument using autossh. Then reattach a GNU screen
466 session if a detached session is around or detach a currently attached screen or
467 else start a new screen. This is especially useful for roadwarriors using GNU
471 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
472 Then prompts the user if she wants to remove that directory. You might need
473 to tell audioburn which cdrom device to use like:
474 "DEVICE=/dev/cdrom audioburn"
477 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
478 it. Then prompts the user if she wants to burn a audio CD with audioburn()
479 (see above). You might need to tell audiorip which cdrom device to use like:
480 "DEVICE=/dev/cdrom audioburn"
483 Simple backup of a file or directory using cp(1). The target file name is the
484 original name plus a time stamp attached. Symlinks and file attributes like mode,
485 ownership and timestamps are preserved.
488 The brltty(1) program provides a braille display, so a blind person can access
489 the console screen. This wrapper function works around problems with some
490 environments (f. e. utf8).
493 Runs a recursive diff(1) over two given directories trying to find the
494 smallest set of changes. Three lines of context will be printed and binary
498 If the original cdrecord is not installed, issues a warning to the user to
499 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
503 Lists files in current directory, which have been changed within the
504 last N days. N is an integer to be passed as first and only argument.
505 If no argument is specified N is set to 1.
508 Returns true if given command exists either as program, function, alias,
509 builtin or reserved word. If the option -c is given, only returns true,
510 if command is a program.
513 Changes directory to $HOME on first invocation of zsh. This is neccessary on
514 grml systems with autologin.
517 Changes current directory to the one supplied by argument and lists the files
518 in it, including file names starting with ".".
521 Adds and commits the given files using cvs(1). The commit message will be
525 Shows a cvs diff of the arguments in $PAGER.
528 Shows the cvs log in $PAGER.
534 Generates a changelog using rcs2log and shows it in $PAGER.
537 Shows cvs status of given files.
540 Shows the changelog of given package in $PAGER.
543 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
544 email addresses of submitters or any string given on the command line.
547 Shows bug report for debian given by number in mailbox format.
550 Tells the user to use grml-debootstrap, if she wants to install debian to
554 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
555 back interactive responsiveness after suspend, when the system is swapping
559 Shows the disk usage of the directories given in human readable format;
563 Translates C source code to assembly and ouputs both.
566 Searches for the first argument (optional) in the Open Directory Project
567 (See http://www.dmoz.org/docs/en/about.html).
570 Shows the NEWS file for the given package in $PAGER.
573 Takes packagename as argument. Sets current working directory to
574 /usr/share/doc/<packagename> and prints out a directory listing.
577 Looks up the first argument (optional) in the german Wiktionary
578 which is an online dictionary (See: http://de.wiktionary.org/).
584 Edit given shell function.
587 Looks up the first argument (optional in the english Wiktionary
588 which is an online dictionary (See: http://en.wiktionary.org/).
591 Renames image files based on date/time informations in their exif headers.
594 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
595 instance of firefox running, attaches to the first window found and opens the
596 URL in a new tab (this even works across an ssh session).
598 : **fluxkey-change()**
599 Switches the key combinations for changing current workspace under fluxbox(1)
600 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
601 Requires the window manager to reread configuration to take effect.
604 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
607 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
608 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
609 filename>". Creates an index.html with title "Images" showing the
610 thumbnails as clickable links to the respective original file.
611 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
612 and all files and/or directories beginning with "thumb-" in current directory!
615 Fetches 3ware RAID controller software using get_3ware(1).
618 Performs an exact (i. e. quoted) web search using Google.
621 Searches the arguments on Google Groups, a web to USENET gateway.
624 Searches the search engine Google using arguments as search string.
627 Searches the zsh command history for a regular expression.
630 Prints the hexadecimal representation of the number supplied as argument
634 Use GNU diff with options -ubwd for mercurial.
637 Displays diffstat between the revision given as argument and tip (no
638 argument means last revision).
641 Outputs highlighted diff; needs highstring(1).
644 Shows source files in less(1) with syntax highlighting. Run "hl -h"
645 for detailed usage information.
648 Queries IMAP server (first parameter) for its capabilities. Takes
649 port number as optional second argument.
652 Sets up an IPv6 tunnel on interface sit1. Needs one argument -
653 either "start", "stop" or "status".
656 Returns true, if zsh version is equal or greater than 4, else false.
659 Returns true, if zsh version is equal or greater than 4.1, else false.
662 Returns true, if zsh version is equal or greater than 4.2, else false.
665 Returns true, if zsh version is equal or greater than 4.2.5, else false.
668 Returns true, if zsh version is equal or greater than 4.3, else false.
671 Returns true, if zsh version is equal or greater than 4.3.3, else false.
674 Returns true, if running on darwin, else false.
677 Returns true, if running on a grml system, else false.
680 Returns true, if running on a grml system from a live cd, else false.
683 Returns true, if run on grml-small, else false.
686 Changes every occurrence of the string iso885915 or ISO885915 in
687 environment variables to UTF-8.
690 Returns true, if run within an utf environment, else false.
693 Searches a wireless interface and runs dhclient(8) on it.
696 Lists libraries that define the symbol containing the string given as
700 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
704 Prints specified range of (numbered) lines of a file.
705 Usage: linenr <start>[,<end>] <file>
708 Uses udev's /dev/disk to list block devices with their LABEL, UUID and IDs.
711 Creates a PostScript and a PDF file (basename as first argument) from
715 Displays manpage in a streched style.
718 Shows the zshall manpage and jumps to the first match of the regular
719 expression optionally given as argument (Needs qma(1)).
722 Creates directory including parent directories, if necessary. Then changes
723 current working directory to it.
726 Diffs the two arguments recursively and writes the
727 output (unified format) to a timestamped file.
730 Prints the summarized memory usage in bytes.
733 Searches Google Groups for a USENET message-ID.
735 : **minimal-shell()**
736 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
737 so that file system can be unmounted.
740 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
741 replaces spaces in file names with underscores. Then mkaudiocd()
742 normalizes the files and recodes them to WAV.
745 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
746 enabled using mkisofs(8). Prompts the user for volume name, filename and
750 Creates a directory with first parameter as name inside $MAILDIR_ROOT
751 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
754 Runs "make install" and logs the output under ~/.errorlogs/; useful for
755 a clean deinstall later.
758 Lists files in current directory, which have been modified within the
759 last N days. N is an integer to be passed as first and only argument.
760 If no argument is specified N is set to 1.
763 Asks netcraft.com for informations about the site given as argument.
766 A helper function for the "e" glob qualifier to list all files newer
767 than a reference file.
771 % NTREF=/reference/file
774 % ls -l *(e:'nt /reference/file':)
778 Translates the given word using the english - german online
779 dictionary dict.leo.org.
782 Evaluates a perl expression; useful as command line
783 calculator, therefore also available as "calc".
786 Lists all occurrences of the string given as argument in current $PATH.
789 Runs a command in $SHELL with profiling enabled (See startup variable
790 ZSH_PROFILE_RC above).
793 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
794 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
795 Asks for confirmation.
798 Opens all README-like files in current working directory with the program
799 defined in the $PAGER environment variable.
802 Reloads functions given as parameters.
805 Checks whether a regular expression (first parameter) matches a string
806 (second parameter) using perl.
809 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
810 for details. See also xunfunction() below.
813 Greps the history for the string provided as parameter and shows the numbered
814 findings in default pager. On exit of the pager the user is prompted for a
815 number. The shells readline buffer is then filled with the corresponding
819 Reimplementation of the csh(1) builtin setenv.
822 Lists the contents of a (compressed) archive with the appropriate programs.
823 The choice is made along the filename extension.
826 Lists the content of a gzipped tar archive in default pager.
829 Shows the content of a zip archive in default pager.
831 : **simple-extract()**
832 Tries to uncompress/unpack given file with the appropriate programs. The
833 choice is made along the filename ending.
836 Prints details of symlinks given as arguments.
839 Prints the arguments slowly by sleeping 0.08 seconds between each character.
841 : **smartcompress()**
842 Compresses/archives the file given as first parameter. Takes an optional
843 second argument, which denotes the compression/archive type as typical
844 filename extension; defaults to "tar.gz".
847 Indents C source code files given; uses Kernighan & Ritchie style.
850 Creates directory named shots in user's home directory, if it does not yet
851 exist and changes current working directory to it. Then sleeps 5 seconds,
852 so you have plenty of time to switch desktops/windows. Then makes a screenshot
853 of the current desktop. The result is stored in ~/shots to a timestamped
856 : **ssl-cert-fingerprints**
857 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
858 First and only parameter must be a file containing a certificate. Use
859 /dev/stdin as file if you want to pipe a certificate to these
863 Prints all information of a x509 certificate including the SHA512,
864 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
865 containing a certificate. Use /dev/stdin as file if you want to pipe a
866 certificate to this function.
868 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
869 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
870 certificate. First and only parameter must be a file containing a
871 certificate. Use /dev/stdin as file if you want to pipe a certificate
874 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
875 Functions for controlling daemons.
882 Shows some information about current system status.
885 Searches articles in the german Wikipedia for the term given as argument.
888 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
889 swspeak must be set for this to work.
892 Translates a word from german to english (-D) or vice versa (-E).
895 Shows upstreams changelog of a given package in $PAGER.
898 Makes a unified diff of the command line arguments trying hard to find a
899 smaller set of changes. Descends recursively into subdirectories. Ignores
900 hows some information about current status.
903 Downloads and displays a file using a suitable program for its
907 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
910 Takes a string as its first argument and prints it RFC 2396 URL encoded to
914 Changes every occurrence of the string UTF-8 or utf-8 in environment
915 variables to iso885915.
921 Wrapper for vim(1). It tries to set the title and hands vim the environment
922 variable VIM_OPTIONS on the command line. So the user may define command
923 line options, she always wants, in her .zshrc.local.
926 Use vim(1) as manpage reader.
929 Searches the history for a given pattern and lists the results by date.
930 The first argument is the search pattern. The second and third ones are
931 optional and denote a search range (default: -100).
934 Retrieves and prints weather information from "http://weather.noaa.gov".
935 The first and only argument is the ICAO code for the desired station.
936 For a list of ICAO codes see
937 "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
940 Looks up the argument on Wikipedia (german).
943 Looks up the argument on Wikipedia (english).
946 Searches the list of official debian packages for the term given as
947 first argument. The optional second argument denotes the distribution
948 (stable, testing or unstable) and defaults to unstable.
951 Tries to cat(1) file(s) given as parameter(s). Always returns true.
952 See also xunfunction() below.
955 Tries to source the file(s) given as parameter(s). Always returns true.
956 See zshbuiltins(1) for a detailed description of the source command.
957 See also xunfunction() below.
960 Changes the title of xterm window from within screen(1). Run without
961 arguments for details.
964 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
967 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
968 option plus a non empty pattern. Run zg without any arguments for a listing
969 of available command line switches. For a zshrc not in /etc/zsh, set the
970 GRML_ZSHRC environment variable.
973 Wrapper around the autoload builtin. Loads the definitions of functions
974 from the file given as argument. Searches $fpath for the file. See also
978 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
979 where own modifications should go. See also zshbuiltins(1) for a description
980 of the source command.
984 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
985 life. A few aliases (like those involving //grep// or //ls//) use the option
986 //--color=auto// for colourizing output. That option is part of **GNU**
987 implementations of these tools, and will only be used if such an implementation
990 : **acp** (//apt-cache policy//)
991 With no arguments prints out the priorities of each source. If a package name
992 is given, it displays detailed information about the priority selection of the
995 : **acs** (//apt-cache search//)
996 Searches debian package lists for the regular expression provided as argument.
997 The search includes package names and descriptions. Prints out name and short
998 description of matching packages.
1000 : **acsh** (//apt-cache show//)
1001 Shows the package records for the packages provided as arguments.
1003 : **adg** (//apt-get dist-upgrade//)
1004 Performs an upgrade of all installed packages. Also tries to automatically
1005 handle changing dependencies with new versions of packages. As this may change
1006 the install status of (or even remove) installed packages, it is potentially
1007 dangerous to use dist-upgrade; invoked by sudo, if necessary.
1009 : **ag** (//apt-get upgrade//)
1010 Downloads and installs the newest versions of all packages currently installed
1011 on the system. Under no circumstances are currently installed packages removed,
1012 or packages not already installed retrieved and installed. New versions of
1013 currently installed packages that cannot be upgraded without changing the install
1014 status of another package will be left at their current version. An update must
1015 be performed first (see au below); run by sudo, if necessary.
1017 : **agi** (//apt-get install//)
1018 Downloads and installs or upgrades the packages given on the command line.
1019 If a hyphen is appended to the package name, the identified package will be
1020 removed if it is installed. Similarly a plus sign can be used to designate a
1021 package to install. This may be useful to override decisions made by apt-get's
1022 conflict resolution system.
1023 A specific version of a package can be selected for installation by following
1024 the package name with an equals and the version of the package to select. This
1025 will cause that version to be located and selected for install. Alternatively a
1026 specific distribution can be selected by following the package name with a slash
1027 and the version of the distribution or the Archive name (stable, testing, unstable).
1028 Gets invoked by sudo, if user id is not 0.
1030 : **ati** (//aptitude install//)
1031 Aptitude is a terminal-based package manager with a command line mode similar to
1032 apt-get (see agi above); invoked by sudo, if necessary.
1034 : **au** (//apt-get update//)
1035 Resynchronizes the package index files from their sources. The indexes of
1036 available packages are fetched from the location(s) specified in
1037 /etc/apt/sources.list. An update should always be performed before an
1038 upgrade or dist-upgrade; run by sudo, if necessary.
1040 : **calc** (//peval//)
1041 Evaluates a perl expression (see peval() above); useful as a command line
1044 : **CH** (//./configure --help//)
1045 Lists available compilation options for building program from source.
1047 : **cmplayer** (//mplayer -vo fbdev//)
1048 Video player with framebuffer as video output device, so you can watch
1049 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
1050 while watching a movie.
1052 : **CO** (//./configure//)
1053 Prepares compilation for building program from source.
1055 : **cp** (//nocorrect cp//)
1056 cp(1) without spelling correction.
1058 : **da** (//du -sch//)
1059 Prints the summarized disk usage of the arguments as well as a grand total
1060 in human readable format.
1062 : **dbp** (//dpkg-buildpackage//)
1063 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
1065 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
1066 Prints installed Packages sorted by size (descending).
1068 : **default** (//echo -en [ escape sequence ]//)
1069 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
1070 using escape sequence.
1072 : **dir** (//ls -lSrah//)
1073 Lists files (including dot files) sorted by size (biggest last) in long and
1074 human readable output format.
1076 : **fblinks** (//links2 -driver fb//)
1077 A Web browser on the framebuffer device. So you can browse images and click
1078 links on the virtual tty.
1080 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
1081 Fullscreen Video player with the framebuffer as video output device. So you
1082 can watch videos on a virtual tty.
1085 Revision control system by Linus Torvalds.
1087 : **ge** (//grep-excuses//)
1088 Searches the testing excuses files for a specific maintainer (See:
1091 : **grep** (//grep --color=auto//)
1092 Shows grep output in nice colors, if available.
1094 : **GREP** (//grep -i --color=auto//)
1095 Case insensitive grep with colored output.
1097 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
1098 Scans for new devices and updates /etc/fstab according to the findings.
1100 : **grml-version** (//cat /etc/grml_version//)
1101 Prints version of running grml.
1103 : **hbp** (//hg-buildpackage//)
1104 Helper program to maintain Debian packages with mercurial.
1106 : **http** (//python -m SimpleHTTPServer//)
1107 Basic HTTP server implemented in python. Listens on port 8000/tcp and
1108 serves current directory. Implements GET and HEAD methods.
1110 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1111 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
1112 host key changes frequently, for example on virtualized test- or development-systems.
1113 To be used only inside trusted networks, of course.
1115 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1116 ssh with possible man-in-the-middle attack enabled
1117 (for an explanation see insecscp above).
1119 : **help-zshglob** (//H-Glob()//)
1120 Runs the function H-Glob() to expand or explain wildcards.
1122 : **hide** (//echo -en [ escape sequence ]//)
1123 Tries to hide xterm window using escape sequence.
1125 : **hidiff** (//histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'//)
1126 If histring(1) is installed, highlight important stuff in diff(1) output.
1128 : **huge** (//echo -en [ escape sequence ]//)
1129 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
1130 using escape sequence.
1132 : **j** (//jobs -l//)
1133 Prints status of jobs in the current shell session in long format.
1135 : **l** (//ls -lF --color=auto//)
1136 Lists files in long output format with indicator for filetype appended
1137 to filename. If the terminal supports it, with colored output.
1139 : **la** (//ls -la --color=auto//)
1140 Lists files in long colored output format. Including file names
1143 : **lad** (//ls -d .*(/)//)
1144 Lists the dot directories (not their contents) in current directory.
1146 : **large** (//echo -en [ escape sequence ]//)
1147 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
1148 using escape sequence.
1150 : **lh** (//ls -hAl --color=auto//)
1151 Lists files in long and human readable output format in nice colors,
1152 if available. Includes file names starting with "." except "." and
1155 : **ll** (//ls -l --color=auto//)
1156 Lists files in long colored output format.
1158 : **llog** (//$PAGER /var/log/syslog//)
1159 Opens syslog in pager.
1161 : **ls** (//ls -b -CF --color=auto//)
1162 Lists directory printing octal escapes for nongraphic characters.
1163 Entries are listed by columns and an indicator for file type is appended
1164 to each file name. Additionally the output is colored, if the terminal
1167 : **lsa** (//ls -a .*(.)//)
1168 Lists dot files in current working directory.
1170 : **lsbig** (//ls -flh *(.OL[1,10])//)
1171 Displays the ten biggest files (long and human readable output format).
1173 : **lsd** (//ls -d *(/)//)
1176 : **lse** (//ls -d *(/^F)//)
1177 Shows empty directories.
1179 : **lsl** (//ls -l *(@)//)
1180 Lists symbolic links in current directory.
1182 : **lsnew** (//ls -rl *(D.om[1,10])//)
1183 Displays the ten newest files (long output format).
1185 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1186 Displays the ten oldest files (long output format).
1188 : **lss** (//ls -l *(s,S,t)//)
1189 Lists files in current directory that have the setuid, setgid or sticky bit
1192 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1193 Displays the ten smallest files (long output format).
1195 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1196 Displays all files which are world readable and/or world writable and/or
1197 world executable (long output format).
1199 : **lsx** (//ls -l *(*)//)
1200 Lists only executable files.
1202 : **md** (//mkdir -p//)
1203 Creates directory including parent directories, if necessary
1205 : **mdstat** (//cat /proc/mdstat//)
1206 Lists all active md (i.e. linux software raid) devices with some information
1209 : **medium** (//echo -en [ escape sequence ]//)
1210 Sets medium sized font
1211 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1212 using escape sequence.
1214 : **mkdir** (//nocorrect mkdir//)
1215 mkdir(1) without spelling correction.
1217 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1218 Executes the commands on the versioned patch queue from current repository.
1220 : **mv** (//nocorrect mv//)
1221 mv(1) without spelling correction.
1223 : **rd** (//rmdir//)
1224 Short rmdir(1) (remove directory).
1226 : **rm** (//nocorrect rm//)
1227 rm(1) without spelling correction.
1229 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1230 If invoking user is root, starts screen session with /etc/grml/screenrc
1231 as config file. If invoked by a regular user, start a screen session
1232 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1235 : **rw-** (//chmod 600//)
1236 Grants read and write permission of a file to the owner and nobody else.
1238 : **rwx** (//chmod 700//)
1239 Grants read, write and execute permission of a file to the owner and nobody
1242 : **r--** (//chmod 644//)
1243 Grants read and write permission of a file to the owner and read-only to
1246 : **r-x** (//chmod 755//)
1247 Grants read, write and execute permission of a file to the owner and
1248 read-only plus execute permission to anybody else.
1250 : **S** (//screen//)
1251 Short for screen(1).
1256 : **semifont** (//echo -en [ escape sequence ]//)
1257 Sets font of xterm to
1258 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1261 : **small** (//echo -en [ escape sequence ]//)
1262 Sets small xterm font ("6x10") using escape sequence.
1264 : **smartfont** (//echo -en [ escape sequence ]//)
1265 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1268 : **su** (//sudo su//)
1269 If user is running a grml live-CD, dont ask for any password, if she
1272 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1273 Sets mode from UTF-8 to ISO 2022 (See:
1274 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1276 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1277 Sets mode from ISO 2022 to UTF-8 (See:
1278 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1280 : **tiny** (//echo -en [ escape sequence ]//)
1281 Sets tiny xterm font
1282 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1285 : **tlog** (//tail -f /var/log/syslog//)
1286 Prints syslog continuously (See tail(1)).
1288 : **top10** (//print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10//)
1289 Prints the ten most used shell commands.
1291 : **truec** (//truecrypt [ mount options ]//)
1292 Mount a truecrypt volume with some reasonable mount options
1293 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1296 : **up** (//aptitude update ; aptitude safe-upgrade//)
1297 Performs a system update followed by a system upgrade using aptitude; run
1298 by sudo, if necessary. See au and ag above.
1300 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1301 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1302 protect them from the shell.
1304 : **0** (//return 0//)
1305 Gives a clean prompt (i.e. without $?).
1307 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1308 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1310 : **...** (//cd ../..///)
1311 Changes current directory two levels higher.
1313 : **?** (//qma zshall//)
1314 Runs the grml script qma (quick manual access) to build the collected man
1315 pages for the z-shell. This compressed file is kept at
1316 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1317 fast. See "man qma" for further information.
1321 This is a set of files, that - if they exist - can be used to customize the
1322 behaviour of //grmlzshrc//.
1325 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1326 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1329 # show battery status in RPROMPT
1331 # always load the complete setup, even for root
1332 GRML_ALWAYS_LOAD_ALL=1
1336 Sourced right before loading //grmlzshrc// is finished. There is a global
1337 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1341 Directory listing for persistent dirstack (see above).
1343 : **.important_commands**
1344 List of commands, used by persistent history (see above).
1347 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1348 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1349 (http://www.ubuntu.com) and similar systems - it is very easy to get
1350 //grmlzshrc// via grml's .deb repositories.
1352 On non-debian systems, that is not an option, but all is not lost:
1355 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1358 If you would also like to get seperate function files (which you can put into
1359 your **$fpath**), you can browse and download them at:
1361 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1363 = ZSH REFCARD TAGS =
1364 If you read //grmlzshrc//'s code you may notice strange looking comments in
1365 it. These are there for a purpose. grml's zsh-refcard is automatically
1366 generated from the contents of the actual configuration file. However, we need
1367 a little extra information on which comments and what lines of code to take
1368 into account (and for what purpose).
1370 Here is what they mean:
1372 List of tags (comment types) used:
1374 Next line contains an important alias, that should be included in the
1375 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1378 Next line contains the beginning of an important function. (placement
1379 tag: @@INSERT-functions@@)
1382 Next line contains an important variable. (placement tag:
1383 @@INSERT-variables@@)
1386 Next line contains an important keybinding. (placement tag:
1387 @@INSERT-keybindings@@)
1390 Hashed directories list generation: //start//: denotes the start of a list of
1391 'hash -d' definitions. //end//: denotes its end. (placement tag:
1392 @@INSERT-hasheddirs@@)
1395 Abbreviation expansion list generation: //start//: denotes the beginning of
1396 abbreviations. //end//: denotes their end.
1398 Lines within this section that end in '#d .*' provide extra documentation to
1399 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1402 This tag allows you to manually generate refcard entries for code lines that
1403 are hard/impossible to parse.
1407 #m# k ESC-h Call the run-help function
1410 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1413 So the syntax is: #m# <section> <argument> <comment>
1416 This tag lets you insert entries to the 'other' hash. Generally, this should
1417 not be used. It is there for things that cannot be done easily in another way.
1418 (placement tag: @@INSERT-other-foobar@@)
1421 All of these tags (except for m and o) take two arguments, the first
1422 within the tag, the other after the tag:
1424 #<tag><section># <comment>
1426 Where <section> is really just a number, which are defined by the @secmap
1427 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1428 that for the reader, the tag should not differ much from a regular comment.
1429 For zsh, it is a regular comment indeed. The numbers have got the following
1454 So, the following will add an entry to the 'functions' table in the 'system'
1455 section, with a (hopefully) descriptive comment:
1458 #f1# Edit an alias via zle
1462 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1463 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1464 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1465 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1466 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1470 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1471 repository from git.grml.org:
1473 ``` % git clone git://git.grml.org/grml-etc-core.git
1475 Make your changes, commit them; use '**git format-patch**' to create a series
1476 of patches and send those to the following address via '**git send-email**':
1478 ``` grml-etc-core@grml.org
1480 Doing so makes sure the right people get your patches for review and
1485 This manual page is the **reference** manual for //grmlzshrc//.
1487 That means that in contrast to the existing refcard it should document **every**
1488 aspect of the setup.
1490 This manual is currently not complete. If you want to help improving it, visit
1491 the following pages:
1493 http://wiki.grml.org/doku.php?id=zshrcmanual
1495 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1497 Contributions are highly welcome.
1501 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1502 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1503 Beckert <abe@deuxchevaux.org>.
1507 Copyright (c) 2009-2011 Grml project <http://grml.org>
1509 This manpage is distributed under the terms of the GPL version 2.
1511 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1512 except for **accept-line()** and **vcs_info()**, which are distributed under
1513 the same conditions as zsh itself (which is BSD-like).