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
29 VARIABLE (see below). Also the umask(1) for the root user is set to 022,
30 while for regular users it is set to 002. So read/write permissions
31 for the regular user and her group are set for new files (keep that
32 in mind on systems, where regular users share a common group).
35 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
36 variables. These may be set temporarily when starting zsh like this:
40 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
43 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
44 put the battery status into the right hand side interactive prompt.
46 : **COMMAND_NOT_FOUND**
47 A non zero value activates a handler, which is called when a command can not
48 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
50 : **GRML_ALWAYS_LOAD_ALL**
51 Enables the whole grml setup for root, if set to a non zero value.
53 : **GRML_ZSH_CNF_HANDLER**
54 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
55 and defaults to "/usr/share/command-not-found/command-not-found".
57 : **GRMLSMALL_SPECIFIC**
58 Set this to zero to remove items in zsh config, which do not work in
62 Where zsh saves the history. Default: ${HOME}/.zsh_history.
65 Number of commands to be kept in the history. On a grml-CD this defaults to
66 500, on a hard disk installation to 5000.
69 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
70 A value of zero turns off checking.
73 Non zero values deactivate automatic correction of commands.
76 If set to zero (default), allows selection from a menu, if there are at least
77 five possible options of completion.
80 A non zero value disables precmd and preexec commands. These are functions
81 that are run before every command (setting xterm/screen titles etc.).
84 Show time (user, system and cpu) used by external commands, if they run longer
85 than the defined number of seconds (default: 5).
88 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a grml-CD
89 and to 10000 on an installation on hard disk.
92 As in tcsh(1) an array of login/logout events to be reported by the shell
93 builtin "log". For details see zshparam(1). Defaults to (notme root).
95 : **ZSH_NO_DEFAULT_LOCALE**
96 Import "/etc/default/locale", if set to zero (default).
99 A non zero value causes shell functions to be profiled. The results can be
100 obtained with the zprof builtin command (see zshmodules(1) for details).
103 = FEATURE DESCRIPTION =
104 This is an in depth description of non-standard features implemented by
107 == DIRSTACK HANDLING ==
108 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
109 file each time zsh's working directory is changed. That file can be configured
110 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
111 **DIRSTACKSIZE** variable defaults to **20** in this setup.
113 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
114 zshs inherit the dirstack of the zsh that most recently updated
117 == DIRECTORY BASED PROFILES ==
118 If you want certain settings to be active in certain directories (and
119 automatically switch back and forth between them), this is what you want.
122 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
123 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
126 When that's done and you enter a directory that matches the pattern
127 in the third part of the context, a function called chpwd_profile_grml,
128 for example, is called (if it exists).
130 If no pattern matches (read: no profile is detected) the profile is
131 set to 'default', which means chpwd_profile_default is attempted to
134 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
135 command) which is used: The third part in the context is matched against
136 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
137 Because that way the profile is detected for all these values of **$PWD**:
145 So, if you want to make double damn sure a profile works in /foo/bar
146 and everywhere deeper in that tree, just use (|/|/*) and be happy.
148 The name of the detected profile will be available in a variable called
149 'profile' in your functions. You don't need to do anything, it'll just
152 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
153 that was active up to now. That way you can avoid running code for a
154 profile that is already active, by running code such as the following
155 at the start of your function:
158 function chpwd_profile_grml() {
159 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
164 The initial value for **$CHPWD_PROFILE** is 'default'.
166 === Signaling availabily/profile changes ===
168 If you use this feature and need to know whether it is active in your
169 current shell, there are several ways to do that. Here are two simple
172 a) If knowing if the profiles feature is active when zsh starts is
173 good enough for you, you can put the following snippet into your
177 (( ${+functions[chpwd_profiles]} )) &&
178 print "directory profiles active"
181 b) If that is not good enough, and you would prefer to be notified
182 whenever a profile changes, you can solve that by making sure you
183 start **every** profile function you create like this:
186 function chpwd_profile_myprofilename() {
187 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
188 print "chpwd(): Switching to profile: $profile"
193 That makes sure you only get notified if a profile is **changed**,
194 not everytime you change directory.
196 === Version requirement ===
197 This feature requires zsh //4.3.3// or newer.
200 == ACCEPTLINE WRAPPER ==
201 The //accept-line// wiget is the one that is taking action when the **return**
202 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
205 This wrapper is configured via styles. That means, you issue commands, that look
209 zstyle 'context' style value
212 The context namespace, that we are using is 'acceptline'. That means, the actual
213 context for your commands look like: **':acceptline:<subcontext>'**.
215 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
219 === Recognized Contexts ===
221 This is the value, the context is initialized with.
222 The //compwarnfmt and //rehash// styles are looked up in this context.
225 If the first word in the command line is either a command, alias, function,
226 builtin or reserved word, you are in this context.
229 This is the context, that is used if you hit enter again, after being warned
230 about the existence of a _completion for the non-existing command you
234 This is the context, you are in if the command line is empty or only
235 consists of whitespace.
238 This context is in effect, if you entered something that does not match any
239 of the above. (e.g.: variable assignments).
242 === Available Styles ===
244 If you set this style to true, the warning about non existent commands,
245 for which completions exist will not be issued. (Default: **false**)
248 The message, that is displayed to warn about the _completion issue.
249 (default: **'%c will not execute and completion %f exists.'**)
250 '%c' is replaced by the command name, '%f' by the completion's name.
253 If this is set, we'll force rehashing, if appropriate. (Defaults to
254 **true** in //grmlzshrc//).
257 This can be a list of wigdets to call in a given context. If you need a
258 specific order for these to be called, name them accordingly. The default value
259 is an **empty list**.
262 The name of a widget, that is called after the widgets from 'actions'.
263 By default, this will be '.accept-line' (which is the built-in accept-line
267 If true in the current context, call the widget in the 'default_action'
268 style. (The default is **true** in all contexts.)
274 == GNU/SCREEN STATUS SETTING ==
275 //grmlzshrc// sets screen's hardstatus lines to the currently running command
276 or **'zsh'** if the shell is idling at its prompt. If the current working
277 directory is inside a repository unter version control, screen status is set
278 to: **'zsh: <repository name>'** via zsh's vcs_info.
281 == PERSISTENT HISTORY ==
282 If you got commands you consider important enough to be included in every
283 shell's history, you can put them into ~/.important_commands and they will be
284 available via the usual history lookup widgets.
288 == ENVIRONMENT VARIABLES ==
289 //grmlzshrc// sets some environment variables, which influence the
290 behaviour of applications.
293 If X is running this is set to "firefox", otherwise to "w3m".
296 Set to "yes". Some applications read this to learn about properties
297 of the terminal they are running in.
300 If not already set, sets the default editor. Falls back to vi(1),
301 if vim(1) is not available.
304 Some environment variables that add colour support to less(1) for viewing
305 man pages. See termcap(5) for details.
308 The mailbox file for the current user is set to /var/mail/$USER, if not
309 already set otherwise.
312 Set less(1) as default pager, if not already set to something different.
315 Holds the path to shared files for the C++ application framework QT
319 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
320 default to /bin/sh or /bin/bash.
324 Apart from zsh's default options, //grmlzshrc// sets some options
325 that change the behaviour of zsh. Options that change Z-shell's default
326 settings are marked by <grml>. But note, that zsh's defaults vary depending
327 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
330 Zsh sessions, that use //grmlzshrc//, will append their history list to the
331 history file, rather than replace it. Thus, multiple parallel zsh sessions
332 will all have the new entries from their history lists added to the history
333 file, in the order that they exit. The file will still be periodically
334 re-written to trim it when the number of lines grows 20% beyond the value
335 specified by $SAVEHIST.
338 If a command is issued that can't be executed as a normal command, and the
339 command is the name of a directory, perform the cd command to that directory.
341 : **auto_pushd** <grml>
342 Make cd push the old directory onto the directory stack.
344 : **completeinword** <grml>
345 If the cursor is inside a word, completion is done from both ends;
346 instead of moving the cursor to the end of the word first and starting
349 : **extended_glob** <grml>
350 Treat the '#', '~' and '^' characters as active globbing pattern characters.
352 : **extended_history** <grml>
353 Save each command's beginning timestamp (in seconds since the epoch) and the
354 duration (in seconds) to the history file.
357 Whenever a command completion is attempted, make sure the entire command
358 path is hashed first. This makes the first completion slower.
360 : **histignorealldups** <grml>
361 If a new command line being added to the history list duplicates an
362 older one, the older command is removed from the list, even if it is
363 not the previous event.
365 : **histignorespace** <grml>
366 Remove command lines from the history list when the first character on
367 the line is a space, or when one of the expanded aliases contains a
368 leading space. Note that the command lingers in the internal history
369 until the next command is entered before it vanishes.
371 : **longlistjobs** <grml>
372 List jobs in long format by default.
375 Avoid to beep on errors in zsh command line editing (zle).
378 A wildcard character never matches a leading '.'.
381 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
383 : **nonomatch** <grml>
384 If a pattern for filename generation has no matches, do not print an error
385 and leave it unchanged in the argument list. This also applies to file
386 expansion of an initial `~' or `='.
389 Report the status of background jobs immediately, rather than waiting until
390 just before printing a prompt.
392 : **pushd_ignore_dups** <grml>
393 Don't push multiple copies of the same directory onto the directory stack.
395 : **share_history** <grml>
396 As each line is added to the history file, it is checked to see if anything
397 else was written out by another shell, and if so it is included in the
398 history of the current shell too. Using !-style history, the commands from
399 the other sessions will not appear in the history list unless you explicitly
400 type the "history" command. This option is activated for zsh versions >= 4,
405 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
406 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
410 Edit the current command buffer in your favourite editor.
413 Deletes a word left of the cursor; seeing '/' as additional word separator.
416 Jump right after the first word.
419 Searches the last occurence of string before the cursor in the command history.
422 Brings a job, which got suspended with CTRL-z back to foreground.
425 == SHELL FUNCTIONS ==
426 //grmlzshrc// comes with a wide array of defined shell functions to ease the
430 Converts plaintext files to HTML using vim. The output is written to
433 : **855resolution()**
434 If 915resolution is available, issues a warning to the user to run it instead
435 to modify the resolution on intel graphics chipsets.
438 Lists files in current directory, which have been accessed within the
439 last N days. N is an integer to be passed as first and only argument.
440 If no argument is specified N is set to 1.
443 Searches for USENET postings from authors using google groups.
446 Sets all ulimit values to "unlimited".
449 Prints a colored table of available ansi color codes (to be used in escape
450 sequences) and the colors they represent.
453 Lists processes matching given pattern.
455 : **aoeu(), asdf(), uiae()**
456 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
459 : **apache2-ssl-certificate()**
460 Advices the user how to create self signed certificates.
463 Login on the host provided as argument using autossh. Then reattach a GNU screen
464 session if a detached session is around or detach a currently attached screen or
465 else start a new screen. This is especially useful for roadwarriors using GNU
469 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
470 Then prompts the user if she wants to remove that directory. You might need
471 to tell audioburn which cdrom device to use like:
472 "DEVICE=/dev/cdrom audioburn"
475 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
476 it. Then prompts the user if she wants to burn a audio CD with audioburn()
477 (see above). You might need to tell audiorip which cdrom device to use like:
478 "DEVICE=/dev/cdrom audioburn"
481 Simple backup of a file or directory using cp(1). The target file name is the
482 original name plus a time stamp attached. Symlinks and file attributes like mode,
483 ownership and timestamps are preserved.
486 The brltty(1) program provides a braille display, so a blind person can access
487 the console screen. This wrapper function works around problems with some
488 environments (f. e. utf8).
491 Runs a recursive diff(1) over two given directories trying to find the
492 smallest set of changes. Three lines of context will be printed and binary
496 If the original cdrecord is not installed, issues a warning to the user to
497 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
501 Lists files in current directory, which have been changed within the
502 last N days. N is an integer to be passed as first and only argument.
503 If no argument is specified N is set to 1.
506 Returns true if given command exists either as program, function, alias,
507 builtin or reserved word. If the option -c is given, only returns true,
508 if command is a program.
511 Changes directory to $HOME on first invocation of zsh. This is neccessary on
512 grml systems with autologin.
515 Changes current directory to the one supplied by argument and lists the files
516 in it, including file names starting with ".".
519 Adds and commits the given files using cvs(1). The commit message will be
523 Shows a cvs diff of the arguments in $PAGER.
526 Shows the cvs log in $PAGER.
532 Generates a changelog using rcs2log and shows it in $PAGER.
535 Shows cvs status of given files.
538 Shows the changelog of given package in $PAGER.
541 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
542 email addresses of submitters or any string given on the command line.
545 Shows bug report for debian given by number in mailbox format.
548 Tells the user to use grml-debootstrap, if she wants to install debian to
552 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
553 back interactive responsiveness after suspend, when the system is swapping
557 Shows the disk usage of the directories given in human readable format;
561 Translates C source code to assembly and ouputs both.
564 Searches for the first argument (optional) in the Open Directory Project
565 (See http://www.dmoz.org/docs/en/about.html).
568 Shows the NEWS file for the given package in $PAGER.
571 Takes packagename as argument. Sets current working directory to
572 /usr/share/doc/<packagename> and prints out a directory listing.
575 Looks up the first argument (optional) in the german Wiktionary
576 which is an online dictionary (See: http://de.wiktionary.org/).
582 Edit given shell function.
585 Looks up the first argument (optional in the english Wiktionary
586 which is an online dictionary (See: http://en.wiktionary.org/).
589 Renames image files based on date/time informations in their exif headers.
592 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
593 instance of firefox running, attaches to the first window found and opens the
594 URL in a new tab (this even works across an ssh session).
596 : **fluxkey-change()**
597 Switches the key combinations for changing current workspace under fluxbox(1)
598 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
599 Requires the window manager to reread configuration to take effect.
602 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
605 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
606 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
607 filename>". Creates an index.html with title "Images" showing the
608 thumbnails as clickable links to the respective original file.
609 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
610 and all files and/or directories beginning with "thumb-" in current directory!
613 Fetches 3ware RAID controller software using get_3ware(1).
616 Performs an exact (i. e. quoted) web search using Google.
619 Searches the arguments on Google Groups, a web to USENET gateway.
622 Searches the search engine Google using arguments as search string.
625 Searches the zsh command history for a regular expression.
628 Prints the hexadecimal representation of the number supplied as argument
632 Use GNU diff with options -ubwd for mercurial.
635 Displays diffstat between the revision given as argument and tip (no
636 argument means last revision).
639 Outputs highlighted diff; needs highstring(1).
642 Shows source files in less(1) with syntax highlighting. Run "hl -h"
643 for detailed usage information.
646 Queries IMAP server (first parameter) for its capabilities. Takes
647 port number as optional second argument.
650 Sets up an IPv6 tunnel on interface sit1. Needs one argument -
651 either "start", "stop" or "status".
654 Returns true, if zsh version is equal or greater than 4, else false.
657 Returns true, if zsh version is equal or greater than 4.1, else false.
660 Returns true, if zsh version is equal or greater than 4.2, else false.
663 Returns true, if zsh version is equal or greater than 4.2.5, else false.
666 Returns true, if zsh version is equal or greater than 4.3, else false.
669 Returns true, if zsh version is equal or greater than 4.3.3, else false.
672 Returns true, if running on darwin, else false.
675 Returns true, if running on a grml system, else false.
678 Returns true, if running on a grml system from a live cd, else false.
681 Returns true, if run on grml-small, else false.
684 Changes every occurrence of the string iso885915 or ISO885915 in
685 environment variables to UTF-8.
688 Returns true, if run within an utf environment, else false.
691 Searches a wireless interface and runs dhclient(8) on it.
694 Lists libraries that define the symbol containing the string given as
698 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
702 Prints specified range of (numbered) lines of a file.
703 Usage: linenr <start>[,<end>] <file>
706 Creates a PostScript and a PDF file (basename as first argument) from
710 Displays manpage in a streched style.
713 Shows the zshall manpage and jumps to the first match of the regular
714 expression optionally given as argument (Needs qma(1)).
717 Creates directory including parent directories, if necessary. Then changes
718 current working directory to it.
721 Diffs the two arguments recursively and writes the
722 output (unified format) to a timestamped file.
725 Prints the summarized memory usage in bytes.
728 Searches Google Groups for a USENET message-ID.
730 : **minimal-shell()**
731 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
732 so that file system can be unmounted.
735 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
736 replaces spaces in file names with underscores. Then mkaudiocd()
737 normalizes the files and recodes them to WAV.
740 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
741 enabled using mkisofs(8). Prompts the user for volume name, filename and
745 Creates a directory with first parameter as name inside $MAILDIR_ROOT
746 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
749 Runs "make install" and logs the output under ~/.errorlogs/; useful for
750 a clean deinstall later.
753 Lists files in current directory, which have been modified within the
754 last N days. N is an integer to be passed as first and only argument.
755 If no argument is specified N is set to 1.
758 Asks netcraft.com for informations about the site given as argument.
761 A helper function for the "e" glob qualifier to list all files newer
762 than a reference file.
766 % NTREF=/reference/file
769 % ls -l *(e:'nt /reference/file':)
773 Recodes an ogg file to mp3 with a bitrate of 192.
776 Translates the given word using the english - german online
777 dictionary dict.leo.org.
780 Evaluates a perl expression; useful as command line
781 calculator, therefore also available as "calc".
784 Lists all occurrences of the string given as argument in current $PATH.
787 Runs a command in $SHELL with profiling enabled (See startup variable
788 ZSH_PROFILE_RC above).
791 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
792 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
793 Asks for confirmation.
796 Opens all README-like files in current working directory with the program
797 defined in the $PAGER environment variable.
800 Reloads functions given as parameters.
803 Checks whether a regular expression (first parameter) matches a string
804 (second parameter) using perl.
807 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
808 for details. See also xunfunction() below.
811 Greps the history for the string provided as parameter and shows the numbered
812 findings in default pager. On exit of the pager the user is prompted for a
813 number. The shells readline buffer is then filled with the corresponding
817 Reimplementation of the csh(1) builtin setenv.
820 Lists the contents of a (compressed) archive with the appropriate programs.
821 The choice is made along the filename extension.
824 Lists the content of a gzipped tar archive in default pager.
827 Shows the content of a zip archive in default pager.
829 : **simple-extract()**
830 Tries to uncompress/unpack given file with the appropriate programs. The
831 choice is made along the filename ending.
834 Prints details of symlinks given as arguments.
837 Prints the arguments slowly by sleeping 0.08 seconds between each character.
839 : **smartcompress()**
840 Compresses/archives the file given as first parameter. Takes an optional
841 second argument, which denotes the compression/archive type as typical
842 filename extension; defaults to "tar.gz".
845 Indents C source code files given; uses Kernighan & Ritchie style.
848 Creates directory named shots in user's home directory, if it does not yet
849 exist and changes current working directory to it. Then sleeps 5 seconds,
850 so you have plenty of time to switch desktops/windows. Then makes a screenshot
851 of the current desktop. The result is stored in ~/shots to a timestamped
854 : **ssl-cert-fingerprints**
855 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
856 First and only parameter must be a file containing a certificate. Use
857 /dev/stdin as file if you want to pipe a certificate to these
861 Prints all information of a x509 certificate including the SHA512,
862 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
863 containing a certificate. Use /dev/stdin as file if you want to pipe a
864 certificate to this function.
866 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
867 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
868 certificate. First and only parameter must be a file containing a
869 certificate. Use /dev/stdin as file if you want to pipe a certificate
872 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
873 Functions for controlling daemons.
880 Shows some information about current system status.
883 Searches articles in the german Wikipedia for the term given as argument.
886 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
887 swspeak must be set for this to work.
890 Translates a word from german to english (-D) or vice versa (-E).
893 Shows upstreams changelog of a given package in $PAGER.
896 Makes a unified diff of the command line arguments trying hard to find a
897 smaller set of changes. Descends recursively into subdirectories. Ignores
898 hows some information about current status.
901 Downloads and displays a file using a suitable program for its
905 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
908 Takes a string as its first argument and prints it RFC 2396 URL encoded to
912 Changes every occurrence of the string UTF-8 or utf-8 in environment
913 variables to iso885915.
919 Wrapper for vim(1). It tries to set the title and hands vim the environment
920 variable VIM_OPTIONS on the command line. So the user may define command
921 line options, she always wants, in her .zshrc.local.
924 Use vim(1) as manpage reader.
927 Searches the history for a given pattern and lists the results by date.
928 The first argument is the search pattern. The second and third ones are
929 optional and denote a search range (default: -100).
932 Retrieves and prints weather information from "http://weather.noaa.gov".
933 The first and only argument is the ICAO code for the desired station.
934 For a list of ICAO codes see
935 "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
938 Looks up the argument on Wikipedia (german).
941 Looks up the argument on Wikipedia (english).
944 Searches the list of official debian packages for the term given as
945 first argument. The optional second argument denotes the distribution
946 (stable, testing or unstable) and defaults to unstable.
949 Tries to cat(1) file(s) given as parameter(s). Always returns true.
950 See also xunfunction() below.
953 Tries to source the file(s) given as parameter(s). Always returns true.
954 See zshbuiltins(1) for a detailed description of the source command.
955 See also xunfunction() below.
958 Changes the title of xterm window from within screen(1). Run without
959 arguments for details.
962 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
965 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
966 option plus a non empty pattern. Run zg without any arguments for a listing
967 of available command line switches. For a zshrc not in /etc/zsh, set the
968 GRML_ZSHRC environment variable.
971 Wrapper around the autoload builtin. Loads the definitions of functions
972 from the file given as argument. Searches $fpath for the file. See also
976 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
977 where own modifications should go. See also zshbuiltins(1) for a description
978 of the source command.
982 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
983 life. A few aliases (like those involving //grep// or //ls//) use the option
984 //--color=auto// for colourizing output. That option is part of **GNU**
985 implementations of these tools, and will only be used if such an implementation
988 : **acp** (//apt-cache policy//)
989 With no arguments prints out the priorities of each source. If a package name
990 is given, it displays detailed information about the priority selection of the
993 : **acs** (//apt-cache search//)
994 Searches debian package lists for the regular expression provided as argument.
995 The search includes package names and descriptions. Prints out name and short
996 description of matching packages.
998 : **acsh** (//apt-cache show//)
999 Shows the package records for the packages provided as arguments.
1001 : **adg** (//apt-get dist-upgrade//)
1002 Performs an upgrade of all installed packages. Also tries to automatically
1003 handle changing dependencies with new versions of packages. As this may change
1004 the install status of (or even remove) installed packages, it is potentially
1005 dangerous to use dist-upgrade; invoked by sudo, if necessary.
1007 : **ag** (//apt-get upgrade//)
1008 Downloads and installs the newest versions of all packages currently installed
1009 on the system. Under no circumstances are currently installed packages removed,
1010 or packages not already installed retrieved and installed. New versions of
1011 currently installed packages that cannot be upgraded without changing the install
1012 status of another package will be left at their current version. An update must
1013 be performed first (see au below); run by sudo, if necessary.
1015 : **agi** (//apt-get install//)
1016 Downloads and installs or upgrades the packages given on the command line.
1017 If a hyphen is appended to the package name, the identified package will be
1018 removed if it is installed. Similarly a plus sign can be used to designate a
1019 package to install. This may be useful to override decisions made by apt-get's
1020 conflict resolution system.
1021 A specific version of a package can be selected for installation by following
1022 the package name with an equals and the version of the package to select. This
1023 will cause that version to be located and selected for install. Alternatively a
1024 specific distribution can be selected by following the package name with a slash
1025 and the version of the distribution or the Archive name (stable, testing, unstable).
1026 Gets invoked by sudo, if user id is not 0.
1028 : **ati** (//aptitude install//)
1029 Aptitude is a terminal-based package manager with a command line mode similar to
1030 apt-get (see agi above); invoked by sudo, if necessary.
1032 : **au** (//apt-get update//)
1033 Resynchronizes the package index files from their sources. The indexes of
1034 available packages are fetched from the location(s) specified in
1035 /etc/apt/sources.list. An update should always be performed before an
1036 upgrade or dist-upgrade; run by sudo, if necessary.
1038 : **calc** (//peval//)
1039 Evaluates a perl expression (see peval() above); useful as a command line
1042 : **CH** (//./configure --help//)
1043 Lists available compilation options for building program from source.
1045 : **cmplayer** (//mplayer -vo fbdev//)
1046 Video player with framebuffer as video output device, so you can watch
1047 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
1048 while watching a movie.
1050 : **CO** (//./configure//)
1051 Prepares compilation for building program from source.
1053 : **cp** (//nocorrect cp//)
1054 cp(1) without spelling correction.
1056 : **da** (//du -sch//)
1057 Prints the summarized disk usage of the arguments as well as a grand total
1058 in human readable format.
1060 : **dbp** (//dpkg-buildpackage//)
1061 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
1063 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
1064 Prints installed Packages sorted by size (descending).
1066 : **default** (//echo -en [ escape sequence ]//)
1067 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
1068 using escape sequence.
1070 : **dir** (//ls -lSrah//)
1071 Lists files (including dot files) sorted by size (biggest last) in long and
1072 human readable output format.
1074 : **fblinks** (//links2 -driver fb//)
1075 A Web browser on the framebuffer device. So you can browse images and click
1076 links on the virtual tty.
1078 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
1079 Fullscreen Video player with the framebuffer as video output device. So you
1080 can watch videos on a virtual tty.
1083 Revision control system by Linus Torvalds.
1085 : **ge** (//grep-excuses//)
1086 Searches the testing excuses files for a specific maintainer (See:
1089 : **grep** (//grep --color=auto//)
1090 Shows grep output in nice colors, if available.
1092 : **GREP** (//grep -i --color=auto//)
1093 Case insensitive grep with colored output.
1095 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
1096 Scans for new devices and updates /etc/fstab according to the findings.
1098 : **grml-version** (//cat /etc/grml_version//)
1099 Prints version of running grml.
1101 : **hbp** (//hg-buildpackage//)
1102 Helper program to maintain Debian packages with mercurial.
1104 : **http** (//python -m SimpleHTTPServer//)
1105 Basic HTTP server implemented in python. Listens on port 8000/tcp and
1106 serves current directory. Implements GET and HEAD methods.
1108 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1109 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
1110 host key changes frequently, for example on virtualized test- or development-systems.
1111 To be used only inside trusted networks, of course.
1113 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1114 ssh with possible man-in-the-middle attack enabled
1115 (for an explanation see insecscp above).
1117 : **help-zshglob** (//H-Glob()//)
1118 Runs the function H-Glob() to expand or explain wildcards.
1120 : **hide** (//echo -en [ escape sequence ]//)
1121 Tries to hide xterm window using escape sequence.
1123 : **hidiff** (//histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'//)
1124 If histring(1) is installed, highlight important stuff in diff(1) output.
1126 : **huge** (//echo -en [ escape sequence ]//)
1127 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
1128 using escape sequence.
1130 : **j** (//jobs -l//)
1131 Prints status of jobs in the current shell session in long format.
1133 : **l** (//ls -lF --color=auto//)
1134 Lists files in long output format with indicator for filetype appended
1135 to filename. If the terminal supports it, with colored output.
1137 : **la** (//ls -la --color=auto//)
1138 Lists files in long colored output format. Including file names
1141 : **lad** (//ls -d .*(/)//)
1142 Lists the dot directories (not their contents) in current directory.
1144 : **large** (//echo -en [ escape sequence ]//)
1145 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
1146 using escape sequence.
1148 : **lh** (//ls -hAl --color=auto//)
1149 Lists files in long and human readable output format in nice colors,
1150 if available. Includes file names starting with "." except "." and
1153 : **ll** (//ls -l --color=auto//)
1154 Lists files in long colored output format.
1156 : **llog** (//$PAGER /var/log/syslog//)
1157 Opens syslog in pager.
1159 : **ls** (//ls -b -CF --color=auto//)
1160 Lists directory printing octal escapes for nongraphic characters.
1161 Entries are listed by columns and an indicator for file type is appended
1162 to each file name. Additionally the output is colored, if the terminal
1165 : **lsa** (//ls -a .*(.)//)
1166 Lists dot files in current working directory.
1168 : **lsbig** (//ls -flh *(.OL[1,10])//)
1169 Displays the ten biggest files (long and human readable output format).
1171 : **lsd** (//ls -d *(/)//)
1174 : **lse** (//ls -d *(/^F)//)
1175 Shows empty directories.
1177 : **lsl** (//ls -l *(@)//)
1178 Lists symbolic links in current directory.
1180 : **lsnew** (//ls -rl *(D.om[1,10])//)
1181 Displays the ten newest files (long output format).
1183 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1184 Displays the ten oldest files (long output format).
1186 : **lss** (//ls -l *(s,S,t)//)
1187 Lists files in current directory that have the setuid, setgid or sticky bit
1190 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1191 Displays the ten smallest files (long output format).
1193 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1194 Displays all files which are world readable and/or world writable and/or
1195 world executable (long output format).
1197 : **lsx** (//ls -l *(*)//)
1198 Lists only executable files.
1200 : **md** (//mkdir -p//)
1201 Creates directory including parent directories, if necessary
1203 : **mdstat** (//cat /proc/mdstat//)
1204 Lists all active md (i.e. linux software raid) devices with some information
1207 : **medium** (//echo -en [ escape sequence ]//)
1208 Sets medium sized font
1209 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1210 using escape sequence.
1212 : **mkdir** (//nocorrect mkdir//)
1213 mkdir(1) without spelling correction.
1215 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1216 Executes the commands on the versioned patch queue from current repository.
1218 : **mv** (//nocorrect mv//)
1219 mv(1) without spelling correction.
1221 : **rd** (//rmdir//)
1222 Short rmdir(1) (remove directory).
1224 : **rm** (//nocorrect rm//)
1225 rm(1) without spelling correction.
1227 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1228 If invoking user is root, starts screen session with /etc/grml/screenrc
1229 as config file. If invoked by a regular user, start a screen session
1230 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1233 : **rw-** (//chmod 600//)
1234 Grants read and write permission of a file to the owner and nobody else.
1236 : **rwx** (//chmod 700//)
1237 Grants read, write and execute permission of a file to the owner and nobody
1240 : **r--** (//chmod 644//)
1241 Grants read and write permission of a file to the owner and read-only to
1244 : **r-x** (//chmod 755//)
1245 Grants read, write and execute permission of a file to the owner and
1246 read-only plus execute permission to anybody else.
1248 : **S** (//screen//)
1249 Short for screen(1).
1254 : **semifont** (//echo -en [ escape sequence ]//)
1255 Sets font of xterm to
1256 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1259 : **small** (//echo -en [ escape sequence ]//)
1260 Sets small xterm font ("6x10") using escape sequence.
1262 : **smartfont** (//echo -en [ escape sequence ]//)
1263 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1266 : **su** (//sudo su//)
1267 If user is running a grml live-CD, dont ask for any password, if she
1270 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1271 Sets mode from UTF-8 to ISO 2022 (See:
1272 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1274 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1275 Sets mode from ISO 2022 to UTF-8 (See:
1276 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1278 : **tiny** (//echo -en [ escape sequence ]//)
1279 Sets tiny xterm font
1280 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1283 : **tlog** (//tail -f /var/log/syslog//)
1284 Prints syslog continuously (See tail(1)).
1286 : **top10** (//print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10//)
1287 Prints the ten most used shell commands.
1289 : **truec** (//truecrypt [ mount options ]//)
1290 Mount a truecrypt volume with some reasonable mount options
1291 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1294 : **up** (//aptitude update ; aptitude safe-upgrade//)
1295 Performs a system update followed by a system upgrade using aptitude; run
1296 by sudo, if necessary. See au and ag above.
1298 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1299 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1300 protect them from the shell.
1302 : **0** (//return 0//)
1303 Gives a clean prompt (i.e. without $?).
1305 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1306 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1308 : **...** (//cd ../..///)
1309 Changes current directory two levels higher.
1311 : **?** (//qma zshall//)
1312 Runs the grml script qma (quick manual access) to build the collected man
1313 pages for the z-shell. This compressed file is kept at
1314 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1315 fast. See "man qma" for further information.
1319 This is a set of files, that - if they exist - can be used to customize the
1320 behaviour of //grmlzshrc//.
1323 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1324 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1327 # show battery status in RPROMPT
1329 # always load the complete setup, even for root
1330 GRML_ALWAYS_LOAD_ALL=1
1334 Sourced right before loading //grmlzshrc// is finished. There is a global
1335 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1339 Directory listing for persistent dirstack (see above).
1341 : **.important_commands**
1342 List of commands, used by persistent history (see above).
1345 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1346 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1347 (http://www.ubuntu.com) and similar systems - it is very easy to get
1348 //grmlzshrc// via grml's .deb repositories.
1350 On non-debian systems, that is not an option, but all is not lost:
1353 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1356 If you would also like to get seperate function files (which you can put into
1357 your **$fpath**), you can browse and download them at:
1359 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1361 = ZSH REFCARD TAGS =
1362 If you read //grmlzshrc//'s code you may notice strange looking comments in
1363 it. These are there for a purpose. grml's zsh-refcard is automatically
1364 generated from the contents of the actual configuration file. However, we need
1365 a little extra information on which comments and what lines of code to take
1366 into account (and for what purpose).
1368 Here is what they mean:
1370 List of tags (comment types) used:
1372 Next line contains an important alias, that should be included in the
1373 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1376 Next line contains the beginning of an important function. (placement
1377 tag: @@INSERT-functions@@)
1380 Next line contains an important variable. (placement tag:
1381 @@INSERT-variables@@)
1384 Next line contains an important keybinding. (placement tag:
1385 @@INSERT-keybindings@@)
1388 Hashed directories list generation: //start//: denotes the start of a list of
1389 'hash -d' definitions. //end//: denotes its end. (placement tag:
1390 @@INSERT-hasheddirs@@)
1393 Abbreviation expansion list generation: //start//: denotes the beginning of
1394 abbreviations. //end//: denotes their end.
1396 Lines within this section that end in '#d .*' provide extra documentation to
1397 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1400 This tag allows you to manually generate refcard entries for code lines that
1401 are hard/impossible to parse.
1405 #m# k ESC-h Call the run-help function
1408 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1411 So the syntax is: #m# <section> <argument> <comment>
1414 This tag lets you insert entries to the 'other' hash. Generally, this should
1415 not be used. It is there for things that cannot be done easily in another way.
1416 (placement tag: @@INSERT-other-foobar@@)
1419 All of these tags (except for m and o) take two arguments, the first
1420 within the tag, the other after the tag:
1422 #<tag><section># <comment>
1424 Where <section> is really just a number, which are defined by the @secmap
1425 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1426 that for the reader, the tag should not differ much from a regular comment.
1427 For zsh, it is a regular comment indeed. The numbers have got the following
1452 So, the following will add an entry to the 'functions' table in the 'system'
1453 section, with a (hopefully) descriptive comment:
1456 #f1# Edit an alias via zle
1460 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1461 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1462 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1463 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1464 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1468 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1469 repository from git.grml.org:
1471 ``` % git clone git://git.grml.org/grml-etc-core.git
1473 Make your changes, commit them; use '**git format-patch**' to create a series
1474 of patches and send those to the following address via '**git send-email**':
1476 ``` grml-etc-core@grml.org
1478 Doing so makes sure the right people get your patches for review and
1483 This manual page is the **reference** manual for //grmlzshrc//.
1485 That means that in contrast to the existing refcard it should document **every**
1486 aspect of the setup.
1488 This manual is currently not complete. If you want to help improving it, visit
1489 the following pages:
1491 http://wiki.grml.org/doku.php?id=zshrcmanual
1493 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1495 Contributions are highly welcome.
1499 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1500 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1501 Beckert <abe@deuxchevaux.org>.
1505 Copyright (c) 2009-2010 grml project <http://grml.org>
1507 This manpage is distributed under the terms of the GPL version 2.
1509 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1510 except for **accept-line()** and **vcs_info()**, which are distributed under
1511 the same conditions as zsh itself (which is BSD-like).