6 %!postproc(man): "^(\.TH.*) 1 " "\1 5 "
10 grmlzshrc - Grml's zsh setup
14 //zsh// [**options**]...
18 The Grml project provides a fairly exhaustive interactive setup (referred to
19 as //grmlzshrc// throughout this document) for the amazing unix shell zsh
20 (http://zsh.sourceforge.net). This is the reference manual for that
23 To use //grmlzshrc//, you need at least version 3.1.7 of zsh (although not all
24 features are enabled in every version).
26 //grmlzshrc// behaves differently depending on which user loads it. For the
27 root user (**EUID** == 0) only a subset of features is loaded by default. This
28 behaviour can be altered by setting the **GRML_ALWAYS_LOAD_ALL** STARTUP
31 Users may want to keep an up-to-date version of the setup (possibly from the
32 git-sources) in //~/.zshrc//. If that happens on a system where the global
33 zshrc is also a //grmlzshrc// (but possibly an older one), you can inhibit
34 loading the global version by doing:
37 echo setopt no_global_rcs >> ~/.zshenv
40 Note, that this will disable //ANY// global files, except for the global
44 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
45 variables. These may be set temporarily when starting zsh like this:
49 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
52 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
53 put the battery status into the right hand side interactive prompt.
55 : **COMMAND_NOT_FOUND**
56 A non zero value activates a handler, which is called when a command can not
57 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
59 : **GRML_ALWAYS_LOAD_ALL**
60 Enables the whole Grml setup for root, if set to a non zero value.
62 : **GRML_ZSH_CNF_HANDLER**
63 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
64 and defaults to "/usr/share/command-not-found/command-not-found".
66 : **GRMLSMALL_SPECIFIC**
67 Set this to zero to remove items in zsh config, which do not work in
71 Where zsh saves the history. Default: ${HOME}/.zsh_history.
74 Number of commands to be kept in the history. On a Grml-CD this defaults to
75 500, on a hard disk installation to 5000.
78 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
79 A value of zero turns off checking.
82 Non zero values deactivate automatic correction of commands.
85 If set to zero (default), allows selection from a menu, if there are at least
86 five possible options of completion.
89 A non zero value disables precmd and preexec commands. These are functions
90 that are run before every command (setting xterm/screen titles etc.).
93 Show time (user, system and cpu) used by external commands, if they run longer
94 than the defined number of seconds (default: 5).
97 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
98 and to 10000 on an installation on hard disk.
101 As in tcsh(1) an array of login/logout events to be reported by the shell
102 builtin "log". For details see zshparam(1). Defaults to (notme root).
104 : **ZSH_NO_DEFAULT_LOCALE**
105 Import "/etc/default/locale", if set to zero (default).
108 A non zero value causes shell functions to be profiled. The results can be
109 obtained with the zprof builtin command (see zshmodules(1) for details).
112 = FEATURE DESCRIPTION =
113 This is an in depth description of non-standard features implemented by
116 == DIRSTACK HANDLING ==
117 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
118 file each time zsh's working directory is changed. That file can be configured
119 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
120 **DIRSTACKSIZE** variable defaults to **20** in this setup.
122 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
123 zshs inherit the dirstack of the zsh that most recently updated
126 == DIRECTORY BASED PROFILES ==
127 If you want certain settings to be active in certain directories (and
128 automatically switch back and forth between them), this is what you want.
131 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
132 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
135 When that's done and you enter a directory that matches the pattern
136 in the third part of the context, a function called chpwd_profile_grml,
137 for example, is called (if it exists).
139 If no pattern matches (read: no profile is detected) the profile is
140 set to 'default', which means chpwd_profile_default is attempted to
143 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
144 command) which is used: The third part in the context is matched against
145 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
146 Because that way the profile is detected for all these values of **$PWD**:
154 So, if you want to make double damn sure a profile works in /foo/bar
155 and everywhere deeper in that tree, just use (|/|/*) and be happy.
157 The name of the detected profile will be available in a variable called
158 'profile' in your functions. You don't need to do anything, it'll just
161 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
162 that was active up to now. That way you can avoid running code for a
163 profile that is already active, by running code such as the following
164 at the start of your function:
167 function chpwd_profile_grml() {
168 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
173 The initial value for **$CHPWD_PROFILE** is 'default'.
175 === Signaling availabily/profile changes ===
177 If you use this feature and need to know whether it is active in your
178 current shell, there are several ways to do that. Here are two simple
181 a) If knowing if the profiles feature is active when zsh starts is
182 good enough for you, you can put the following snippet into your
186 (( ${+functions[chpwd_profiles]} )) &&
187 print "directory profiles active"
190 b) If that is not good enough, and you would prefer to be notified
191 whenever a profile changes, you can solve that by making sure you
192 start **every** profile function you create like this:
195 function chpwd_profile_myprofilename() {
196 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
197 print "chpwd(): Switching to profile: $profile"
202 That makes sure you only get notified if a profile is **changed**,
203 not everytime you change directory.
205 === Version requirement ===
206 This feature requires zsh //4.3.3// or newer.
209 == ACCEPTLINE WRAPPER ==
210 The //accept-line// wiget is the one that is taking action when the **return**
211 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
214 This wrapper is configured via styles. That means, you issue commands, that look
218 zstyle 'context' style value
221 The context namespace, that we are using is 'acceptline'. That means, the actual
222 context for your commands look like: **':acceptline:<subcontext>'**.
224 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
228 === Recognized Contexts ===
230 This is the value, the context is initialized with.
231 The //compwarnfmt and //rehash// styles are looked up in this context.
234 If the first word in the command line is either a command, alias, function,
235 builtin or reserved word, you are in this context.
238 This is the context, that is used if you hit enter again, after being warned
239 about the existence of a _completion for the non-existing command you
243 This is the context, you are in if the command line is empty or only
244 consists of whitespace.
247 This context is in effect, if you entered something that does not match any
248 of the above. (e.g.: variable assignments).
251 === Available Styles ===
253 If you set this style to true, the warning about non existent commands,
254 for which completions exist will not be issued. (Default: **false**)
257 The message, that is displayed to warn about the _completion issue.
258 (default: **'%c will not execute and completion %f exists.'**)
259 '%c' is replaced by the command name, '%f' by the completion's name.
262 If this is set, we'll force rehashing, if appropriate. (Defaults to
263 **true** in //grmlzshrc//).
266 This can be a list of wigdets to call in a given context. If you need a
267 specific order for these to be called, name them accordingly. The default value
268 is an **empty list**.
271 The name of a widget, that is called after the widgets from 'actions'.
272 By default, this will be '.accept-line' (which is the built-in accept-line
276 If true in the current context, call the widget in the 'default_action'
277 style. (The default is **true** in all contexts.)
283 == GNU/SCREEN STATUS SETTING ==
284 //grmlzshrc// sets screen's hardstatus lines to the currently running command
285 or **'zsh'** if the shell is idling at its prompt. If the current working
286 directory is inside a repository unter version control, screen status is set
287 to: **'zsh: <repository name>'** via zsh's vcs_info.
290 == PERSISTENT HISTORY ==
291 If you got commands you consider important enough to be included in every
292 shell's history, you can put them into ~/.important_commands and they will be
293 available via the usual history lookup widgets.
297 == ENVIRONMENT VARIABLES ==
298 //grmlzshrc// sets some environment variables, which influence the
299 behaviour of applications.
302 Set to "yes". Some applications read this to learn about properties
303 of the terminal they are running in.
306 If not already set, sets the default editor. Falls back to vi(1),
307 if vim(1) is not available.
310 Some environment variables that add colour support to less(1) for viewing
311 man pages. See termcap(5) for details.
314 The mailbox file for the current user is set to /var/mail/$USER, if not
315 already set otherwise.
318 Set less(1) as default pager, if not already set to something different.
321 Holds the path to shared files for the C++ application framework QT
325 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
326 default to /bin/sh or /bin/bash.
330 Apart from zsh's default options, //grmlzshrc// sets some options
331 that change the behaviour of zsh. Options that change Z-shell's default
332 settings are marked by <grml>. But note, that zsh's defaults vary depending
333 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
336 Zsh sessions, that use //grmlzshrc//, will append their history list to the
337 history file, rather than replace it. Thus, multiple parallel zsh sessions
338 will all have the new entries from their history lists added to the history
339 file, in the order that they exit. The file will still be periodically
340 re-written to trim it when the number of lines grows 20% beyond the value
341 specified by $SAVEHIST.
344 If a command is issued that can't be executed as a normal command, and the
345 command is the name of a directory, perform the cd command to that directory.
347 : **auto_pushd** <grml>
348 Make cd push the old directory onto the directory stack.
350 : **completeinword** <grml>
351 If the cursor is inside a word, completion is done from both ends;
352 instead of moving the cursor to the end of the word first and starting
355 : **extended_glob** <grml>
356 Treat the '#', '~' and '^' characters as active globbing pattern characters.
358 : **extended_history** <grml>
359 Save each command's beginning timestamp (in seconds since the epoch) and the
360 duration (in seconds) to the history file.
363 Whenever a command completion is attempted, make sure the entire command
364 path is hashed first. This makes the first completion slower.
366 : **histignorealldups** <grml>
367 If a new command line being added to the history list duplicates an
368 older one, the older command is removed from the list, even if it is
369 not the previous event.
371 : **histignorespace** <grml>
372 Remove command lines from the history list when the first character on
373 the line is a space, or when one of the expanded aliases contains a
374 leading space. Note that the command lingers in the internal history
375 until the next command is entered before it vanishes.
377 : **longlistjobs** <grml>
378 List jobs in long format by default.
381 Avoid to beep on errors in zsh command line editing (zle).
384 A wildcard character never matches a leading '.'.
387 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
389 : **nonomatch** <grml>
390 If a pattern for filename generation has no matches, do not print an error
391 and leave it unchanged in the argument list. This also applies to file
392 expansion of an initial `~' or `='.
395 Report the status of background jobs immediately, rather than waiting until
396 just before printing a prompt.
398 : **pushd_ignore_dups** <grml>
399 Don't push multiple copies of the same directory onto the directory stack.
401 : **share_history** <grml>
402 As each line is added to the history file, it is checked to see if anything
403 else was written out by another shell, and if so it is included in the
404 history of the current shell too. Using !-style history, the commands from
405 the other sessions will not appear in the history list unless you explicitly
406 type the "history" command. This option is activated for zsh versions >= 4,
411 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
412 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
416 Edit the current command buffer in your favourite editor.
419 Deletes a word left of the cursor; seeing '/' as additional word separator.
422 Jump right after the first word.
425 Create directory under cursor or the selected area.
426 To select an area press ctrl-@ and use the cursor.
427 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
428 directory does not exist yet -> press **CTRL-xM** and problem solved.
431 Searches the last occurence of string before the cursor in the command history.
434 Display help on keybindings and zsh line editor. Press consecutively to page through content.
437 Brings a job, which got suspended with CTRL-z back to foreground.
440 == SHELL FUNCTIONS ==
441 //grmlzshrc// comes with a wide array of defined shell functions to ease the
445 Converts plaintext files to HTML using vim. The output is written to
448 : **855resolution()**
449 If 915resolution is available, issues a warning to the user to run it instead
450 to modify the resolution on intel graphics chipsets.
453 Lists files in current directory, which have been accessed within the
454 last N days. N is an integer to be passed as first and only argument.
455 If no argument is specified N is set to 1.
458 Searches for USENET postings from authors using google groups.
461 Sets all ulimit values to "unlimited".
464 Prints a colored table of available ansi color codes (to be used in escape
465 sequences) and the colors they represent.
468 Lists processes matching given pattern.
470 : **aoeu(), asdf(), uiae()**
471 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
474 : **apache2-ssl-certificate()**
475 Advices the user how to create self signed certificates.
478 Login on the host provided as argument using autossh. Then reattach a GNU screen
479 session if a detached session is around or detach a currently attached screen or
480 else start a new screen. This is especially useful for roadwarriors using GNU
484 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
485 Then prompts the user if she wants to remove that directory. You might need
486 to tell audioburn which cdrom device to use like:
487 "DEVICE=/dev/cdrom audioburn"
490 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
491 it. Then prompts the user if she wants to burn a audio CD with audioburn()
492 (see above). You might need to tell audiorip which cdrom device to use like:
493 "DEVICE=/dev/cdrom audioburn"
496 Simple backup of a file or directory using cp(1). The target file name is the
497 original name plus a time stamp attached. Symlinks and file attributes like mode,
498 ownership and timestamps are preserved.
501 Runs a recursive diff(1) over two given directories trying to find the
502 smallest set of changes. Three lines of context will be printed and binary
506 If the original cdrecord is not installed, issues a warning to the user to
507 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
511 Creates a temporary directory using mktemp. Then changes current
512 working directory to it.
515 Lists files in current directory, which have been changed within the
516 last N days. N is an integer to be passed as first and only argument.
517 If no argument is specified N is set to 1.
520 Returns true if given command exists either as program, function, alias,
521 builtin or reserved word. If the option -c is given, only returns true,
522 if command is a program.
525 Changes directory to $HOME on first invocation of zsh. This is neccessary on
526 grml systems with autologin.
529 Changes current directory to the one supplied by argument and lists the files
530 in it, including file names starting with ".".
533 Adds and commits the given files using cvs(1). The commit message will be
537 Shows a cvs diff of the arguments in $PAGER.
540 Shows the cvs log in $PAGER.
546 Generates a changelog using rcs2log and shows it in $PAGER.
549 Shows cvs status of given files.
552 Shows the changelog of given package in $PAGER.
555 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
556 email addresses of submitters or any string given on the command line.
559 Shows bug report for debian given by number in mailbox format.
562 Tells the user to use grml-debootstrap, if she wants to install debian to
566 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
567 back interactive responsiveness after suspend, when the system is swapping
571 Shows the disk usage of the directories given in human readable format;
575 Translates C source code to assembly and ouputs both.
578 Searches for the first argument (optional) in the Open Directory Project
579 (See http://www.dmoz.org/docs/en/about.html).
582 Shows the NEWS file for the given package in $PAGER.
585 Takes packagename as argument. Sets current working directory to
586 /usr/share/doc/<packagename> and prints out a directory listing.
589 Looks up the first argument (optional) in the german Wiktionary
590 which is an online dictionary (See: http://de.wiktionary.org/).
596 Edit given shell function.
599 Looks up the first argument (optional in the english Wiktionary
600 which is an online dictionary (See: http://en.wiktionary.org/).
603 Renames image files based on date/time informations in their exif headers.
606 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
607 instance of firefox running, attaches to the first window found and opens the
608 URL in a new tab (this even works across an ssh session).
610 : **fluxkey-change()**
611 Switches the key combinations for changing current workspace under fluxbox(1)
612 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
613 Requires the window manager to reread configuration to take effect.
616 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
619 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
620 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
621 filename>". Creates an index.html with title "Images" showing the
622 thumbnails as clickable links to the respective original file.
623 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
624 and all files and/or directories beginning with "thumb-" in current directory!
627 Fetches 3ware RAID controller software using get_3ware(1).
630 Performs an exact (i. e. quoted) web search using Google.
633 Searches the arguments on Google Groups, a web to USENET gateway.
636 Searches the search engine Google using arguments as search string.
639 Searches the zsh command history for a regular expression.
642 Prints the hexadecimal representation of the number supplied as argument
646 Use GNU diff with options -ubwd for mercurial.
649 Displays diffstat between the revision given as argument and tip (no
650 argument means last revision).
653 Outputs highlighted diff; needs highstring(1).
656 Shows source files in less(1) with syntax highlighting. Run "hl -h"
657 for detailed usage information.
660 Queries IMAP server (first parameter) for its capabilities. Takes
661 port number as optional second argument.
664 Sets up an IPv6 tunnel on interface sit1. Needs one argument -
665 either "start", "stop" or "status".
668 Returns true, if zsh version is equal or greater than 4, else false.
671 Returns true, if zsh version is equal or greater than 4.1, else false.
674 Returns true, if zsh version is equal or greater than 4.2, else false.
677 Returns true, if zsh version is equal or greater than 4.2.5, else false.
680 Returns true, if zsh version is equal or greater than 4.3, else false.
683 Returns true, if zsh version is equal or greater than 4.3.3, else false.
686 Returns true, if running on darwin, else false.
689 Returns true, if running on a grml system, else false.
692 Returns true, if running on a grml system from a live cd, else false.
695 Returns true, if run on grml-small, else false.
698 Changes every occurrence of the string iso885915 or ISO885915 in
699 environment variables to UTF-8.
702 Returns true, if run within an utf environment, else false.
705 Searches a wireless interface and runs dhclient(8) on it.
708 Lists libraries that define the symbol containing the string given as
712 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
716 Prints specified range of (numbered) lines of a file.
717 Usage: linenr <start>[,<end>] <file>
720 Uses udev's /dev/disk to list block devices with their LABEL, UUID and IDs.
723 Creates a PostScript and a PDF file (basename as first argument) from
727 Displays manpage in a streched style.
730 Shows the zshall manpage and jumps to the first match of the regular
731 expression optionally given as argument (Needs qma(1)).
734 Creates directory including parent directories, if necessary. Then changes
735 current working directory to it.
738 Diffs the two arguments recursively and writes the
739 output (unified format) to a timestamped file.
742 Prints the summarized memory usage in bytes.
745 Searches Google Groups for a USENET message-ID.
747 : **minimal-shell()**
748 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
749 so that file system can be unmounted.
752 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
753 replaces spaces in file names with underscores. Then mkaudiocd()
754 normalizes the files and recodes them to WAV.
757 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
758 enabled using mkisofs(8). Prompts the user for volume name, filename and
762 Creates a directory with first parameter as name inside $MAILDIR_ROOT
763 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
766 Runs "make install" and logs the output under ~/.errorlogs/; useful for
767 a clean deinstall later.
770 Lists files in current directory, which have been modified within the
771 last N days. N is an integer to be passed as first and only argument.
772 If no argument is specified N is set to 1.
775 Asks netcraft.com for informations about the site given as argument.
778 A helper function for the "e" glob qualifier to list all files newer
779 than a reference file.
783 % NTREF=/reference/file
786 % ls -l *(e:'nt /reference/file':)
790 Translates the given word using the english - german online
791 dictionary dict.leo.org.
794 Evaluates a perl expression; useful as command line
795 calculator, therefore also available as "calc".
798 Lists all occurrences of the string given as argument in current $PATH.
801 Runs a command in $SHELL with profiling enabled (See startup variable
802 ZSH_PROFILE_RC above).
805 Removes temporary files from current directory. Asks for confirmation. Uses sudo if necessary.
807 - common temp files like "*~", ".*~", "#*#", "*.o", "a.out", "*.orig", "*.rej", "*.cmo", "*.cmi" and ".*.swp"
809 - debconf backup files: "*.dpkg-old", "*.dkpg-new", "*.dpkg-dist"
810 - gentoo dispatch-conf backups: ".cfg0000_*", ".mrg0000_*"
811 - precompiled python code ("*.pyc", "*.pyo") as long as matching "*.py" source is also present
812 - LaTeX temp files i.e. "*.(log|toc|aux|nav|snm|out|tex.backup|bbl|blg|bib.backup|vrb|lof|lot|hd|idx)" for any present "*.tex"
813 - ghc temp files, as long as matching "*.hs" or "*.lhs" is also present
814 - "*.mood(D)" Files which are missing their corresponding audio file
817 Opens all README-like files in current working directory with the program
818 defined in the $PAGER environment variable.
821 Reloads functions given as parameters.
824 Checks whether a regular expression (first parameter) matches a string
825 (second parameter) using perl.
828 Takes as first parameter a quoted string containing an exectuable command or function with arguments.
829 Following that it takes a bunch of directories, which will then be traversed, executing the
830 first argument in each one. E.g.: rundirs purge . **/*(/-/)
833 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
834 for details. See also xunfunction() below.
837 Greps the history for the string provided as parameter and shows the numbered
838 findings in default pager. On exit of the pager the user is prompted for a
839 number. The shells readline buffer is then filled with the corresponding
843 Reimplementation of the csh(1) builtin setenv.
846 Lists the contents of a (compressed) archive with the appropriate programs.
847 The choice is made along the filename extension.
850 Lists the content of a gzipped tar archive in default pager.
853 Shows the content of a zip archive in default pager.
855 : **simple-extract()**
856 Tries to uncompress/unpack given files with the appropriate programs. If an URI
857 starting with https, http or ftp is provided simple-extract tries to download
858 and then uncompress/unpack the file. The choice is made along the filename
859 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
860 .xz) unless you use the '-d' option.
863 Prints details of symlinks given as arguments.
866 Prints the arguments slowly by sleeping 0.08 seconds between each character.
868 : **smartcompress()**
869 Compresses/archives the file given as first parameter. Takes an optional
870 second argument, which denotes the compression/archive type as typical
871 filename extension; defaults to "tar.gz".
874 Indents C source code files given; uses Kernighan & Ritchie style.
877 Creates directory named shots in user's home directory, if it does not yet
878 exist and changes current working directory to it. Then sleeps 5 seconds,
879 so you have plenty of time to switch desktops/windows. Then makes a screenshot
880 of the current desktop. The result is stored in ~/shots to a timestamped
883 : **ssl-cert-fingerprints**
884 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
885 First and only parameter must be a file containing a certificate. Use
886 /dev/stdin as file if you want to pipe a certificate to these
890 Prints all information of a x509 certificate including the SHA512,
891 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
892 containing a certificate. Use /dev/stdin as file if you want to pipe a
893 certificate to this function.
895 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
896 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
897 certificate. First and only parameter must be a file containing a
898 certificate. Use /dev/stdin as file if you want to pipe a certificate
901 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
902 Functions for controlling daemons.
909 Shows some information about current system status.
912 Searches articles in the german Wikipedia for the term given as argument.
915 Translates a word from german to english (-D) or vice versa (-E).
918 Shows upstreams changelog of a given package in $PAGER.
921 Makes a unified diff of the command line arguments trying hard to find a
922 smaller set of changes. Descends recursively into subdirectories. Ignores
923 hows some information about current status.
926 Downloads and displays a file using a suitable program for its
930 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
933 Takes a string as its first argument and prints it RFC 2396 URL encoded to
937 Changes every occurrence of the string UTF-8 or utf-8 in environment
938 variables to iso885915.
944 Wrapper for vim(1). It tries to set the title and hands vim the environment
945 variable VIM_OPTIONS on the command line. So the user may define command
946 line options, she always wants, in her .zshrc.local.
949 Use vim(1) as manpage reader.
952 Searches the history for a given pattern and lists the results by date.
953 The first argument is the search pattern. The second and third ones are
954 optional and denote a search range (default: -100).
957 Retrieves and prints weather information from "http://weather.noaa.gov".
958 The first and only argument is the ICAO code for the desired station.
959 For a list of ICAO codes see
960 "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
963 Looks up the argument on Wikipedia (german).
966 Looks up the argument on Wikipedia (english).
969 Searches the list of official debian packages for the term given as
970 first argument. The optional second argument denotes the distribution
971 (stable, testing or unstable) and defaults to unstable.
974 Tries to cat(1) file(s) given as parameter(s). Always returns true.
975 See also xunfunction() below.
978 Tries to source the file(s) given as parameter(s). Always returns true.
979 See zshbuiltins(1) for a detailed description of the source command.
980 See also xunfunction() below.
983 Changes the title of xterm window from within screen(1). Run without
984 arguments for details.
987 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
990 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
991 option plus a non empty pattern. Run zg without any arguments for a listing
992 of available command line switches. For a zshrc not in /etc/zsh, set the
993 GRML_ZSHRC environment variable.
996 Wrapper around the autoload builtin. Loads the definitions of functions
997 from the file given as argument. Searches $fpath for the file. See also
1001 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
1002 where own modifications should go. See also zshbuiltins(1) for a description
1003 of the source command.
1007 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
1008 life. A few aliases (like those involving //grep// or //ls//) use the option
1009 //--color=auto// for colourizing output. That option is part of **GNU**
1010 implementations of these tools, and will only be used if such an implementation
1013 : **acp** (//apt-cache policy//)
1014 With no arguments prints out the priorities of each source. If a package name
1015 is given, it displays detailed information about the priority selection of the
1018 : **acs** (//apt-cache search//)
1019 Searches debian package lists for the regular expression provided as argument.
1020 The search includes package names and descriptions. Prints out name and short
1021 description of matching packages.
1023 : **acsh** (//apt-cache show//)
1024 Shows the package records for the packages provided as arguments.
1026 : **adg** (//apt-get dist-upgrade//)
1027 Performs an upgrade of all installed packages. Also tries to automatically
1028 handle changing dependencies with new versions of packages. As this may change
1029 the install status of (or even remove) installed packages, it is potentially
1030 dangerous to use dist-upgrade; invoked by sudo, if necessary.
1032 : **ag** (//apt-get upgrade//)
1033 Downloads and installs the newest versions of all packages currently installed
1034 on the system. Under no circumstances are currently installed packages removed,
1035 or packages not already installed retrieved and installed. New versions of
1036 currently installed packages that cannot be upgraded without changing the install
1037 status of another package will be left at their current version. An update must
1038 be performed first (see au below); run by sudo, if necessary.
1040 : **agi** (//apt-get install//)
1041 Downloads and installs or upgrades the packages given on the command line.
1042 If a hyphen is appended to the package name, the identified package will be
1043 removed if it is installed. Similarly a plus sign can be used to designate a
1044 package to install. This may be useful to override decisions made by apt-get's
1045 conflict resolution system.
1046 A specific version of a package can be selected for installation by following
1047 the package name with an equals and the version of the package to select. This
1048 will cause that version to be located and selected for install. Alternatively a
1049 specific distribution can be selected by following the package name with a slash
1050 and the version of the distribution or the Archive name (stable, testing, unstable).
1051 Gets invoked by sudo, if user id is not 0.
1053 : **ati** (//aptitude install//)
1054 Aptitude is a terminal-based package manager with a command line mode similar to
1055 apt-get (see agi above); invoked by sudo, if necessary.
1057 : **au** (//apt-get update//)
1058 Resynchronizes the package index files from their sources. The indexes of
1059 available packages are fetched from the location(s) specified in
1060 /etc/apt/sources.list. An update should always be performed before an
1061 upgrade or dist-upgrade; run by sudo, if necessary.
1063 : **calc** (//peval//)
1064 Evaluates a perl expression (see peval() above); useful as a command line
1067 : **CH** (//./configure --help//)
1068 Lists available compilation options for building program from source.
1070 : **cmplayer** (//mplayer -vo fbdev//)
1071 Video player with framebuffer as video output device, so you can watch
1072 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
1073 while watching a movie.
1075 : **CO** (//./configure//)
1076 Prepares compilation for building program from source.
1078 : **cp** (//nocorrect cp//)
1079 cp(1) without spelling correction.
1081 : **da** (//du -sch//)
1082 Prints the summarized disk usage of the arguments as well as a grand total
1083 in human readable format.
1085 : **dbp** (//dpkg-buildpackage//)
1086 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
1088 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
1089 Prints installed Packages sorted by size (descending).
1091 : **default** (//echo -en [ escape sequence ]//)
1092 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
1093 using escape sequence.
1095 : **dir** (//ls -lSrah//)
1096 Lists files (including dot files) sorted by size (biggest last) in long and
1097 human readable output format.
1099 : **fblinks** (//links2 -driver fb//)
1100 A Web browser on the framebuffer device. So you can browse images and click
1101 links on the virtual tty.
1103 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
1104 Fullscreen Video player with the framebuffer as video output device. So you
1105 can watch videos on a virtual tty.
1108 Revision control system by Linus Torvalds.
1110 : **ge** (//grep-excuses//)
1111 Searches the testing excuses files for a specific maintainer (See:
1114 : **grep** (//grep --color=auto//)
1115 Shows grep output in nice colors, if available.
1117 : **GREP** (//grep -i --color=auto//)
1118 Case insensitive grep with colored output.
1120 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
1121 Scans for new devices and updates /etc/fstab according to the findings.
1123 : **grml-version** (//cat /etc/grml_version//)
1124 Prints version of running grml.
1126 : **hbp** (//hg-buildpackage//)
1127 Helper program to maintain Debian packages with mercurial.
1129 : **http** (//python -m SimpleHTTPServer//)
1130 Basic HTTP server implemented in python. Listens on port 8000/tcp and
1131 serves current directory. Implements GET and HEAD methods.
1133 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1134 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
1135 host key changes frequently, for example on virtualized test- or development-systems.
1136 To be used only inside trusted networks, of course.
1138 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1139 ssh with possible man-in-the-middle attack enabled
1140 (for an explanation see insecscp above).
1142 : **help-zshglob** (//H-Glob()//)
1143 Runs the function H-Glob() to expand or explain wildcards.
1145 : **hide** (//echo -en [ escape sequence ]//)
1146 Tries to hide xterm window using escape sequence.
1148 : **hidiff** (//histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'//)
1149 If histring(1) is installed, highlight important stuff in diff(1) output.
1151 : **huge** (//echo -en [ escape sequence ]//)
1152 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
1153 using escape sequence.
1155 : **j** (//jobs -l//)
1156 Prints status of jobs in the current shell session in long format.
1158 : **l** (//ls -lF --color=auto//)
1159 Lists files in long output format with indicator for filetype appended
1160 to filename. If the terminal supports it, with colored output.
1162 : **la** (//ls -la --color=auto//)
1163 Lists files in long colored output format. Including file names
1166 : **lad** (//ls -d .*(/)//)
1167 Lists the dot directories (not their contents) in current directory.
1169 : **large** (//echo -en [ escape sequence ]//)
1170 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
1171 using escape sequence.
1173 : **lh** (//ls -hAl --color=auto//)
1174 Lists files in long and human readable output format in nice colors,
1175 if available. Includes file names starting with "." except "." and
1178 : **ll** (//ls -l --color=auto//)
1179 Lists files in long colored output format.
1181 : **llog** (//$PAGER /var/log/syslog//)
1182 Opens syslog in pager.
1184 : **ls** (//ls -b -CF --color=auto//)
1185 Lists directory printing octal escapes for nongraphic characters.
1186 Entries are listed by columns and an indicator for file type is appended
1187 to each file name. Additionally the output is colored, if the terminal
1190 : **lsa** (//ls -a .*(.)//)
1191 Lists dot files in current working directory.
1193 : **lsbig** (//ls -flh *(.OL[1,10])//)
1194 Displays the ten biggest files (long and human readable output format).
1196 : **lsd** (//ls -d *(/)//)
1199 : **lse** (//ls -d *(/^F)//)
1200 Shows empty directories.
1202 : **lsl** (//ls -l *(@)//)
1203 Lists symbolic links in current directory.
1205 : **lsnew** (//ls -rl *(D.om[1,10])//)
1206 Displays the ten newest files (long output format).
1208 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1209 Displays the ten oldest files (long output format).
1211 : **lss** (//ls -l *(s,S,t)//)
1212 Lists files in current directory that have the setuid, setgid or sticky bit
1215 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1216 Displays the ten smallest files (long output format).
1218 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1219 Displays all files which are world readable and/or world writable and/or
1220 world executable (long output format).
1222 : **lsx** (//ls -l *(*)//)
1223 Lists only executable files.
1225 : **md** (//mkdir -p//)
1226 Creates directory including parent directories, if necessary
1228 : **mdstat** (//cat /proc/mdstat//)
1229 Lists all active md (i.e. linux software raid) devices with some information
1232 : **medium** (//echo -en [ escape sequence ]//)
1233 Sets medium sized font
1234 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1235 using escape sequence.
1237 : **mkdir** (//nocorrect mkdir//)
1238 mkdir(1) without spelling correction.
1240 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1241 Executes the commands on the versioned patch queue from current repository.
1243 : **mv** (//nocorrect mv//)
1244 mv(1) without spelling correction.
1246 : **rd** (//rmdir//)
1247 Short rmdir(1) (remove directory).
1249 : **rm** (//nocorrect rm//)
1250 rm(1) without spelling correction.
1252 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1253 rmdir current working directory
1255 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1256 If invoking user is root, starts screen session with /etc/grml/screenrc
1257 as config file. If invoked by a regular user, start a screen session
1258 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1261 : **rw-** (//chmod 600//)
1262 Grants read and write permission of a file to the owner and nobody else.
1264 : **rwx** (//chmod 700//)
1265 Grants read, write and execute permission of a file to the owner and nobody
1268 : **r--** (//chmod 644//)
1269 Grants read and write permission of a file to the owner and read-only to
1272 : **r-x** (//chmod 755//)
1273 Grants read, write and execute permission of a file to the owner and
1274 read-only plus execute permission to anybody else.
1276 : **S** (//screen//)
1277 Short for screen(1).
1282 : **semifont** (//echo -en [ escape sequence ]//)
1283 Sets font of xterm to
1284 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1287 : **small** (//echo -en [ escape sequence ]//)
1288 Sets small xterm font ("6x10") using escape sequence.
1290 : **smartfont** (//echo -en [ escape sequence ]//)
1291 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1294 : **su** (//sudo su//)
1295 If user is running a grml live-CD, dont ask for any password, if she
1298 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1299 Sets mode from UTF-8 to ISO 2022 (See:
1300 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1302 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1303 Sets mode from ISO 2022 to UTF-8 (See:
1304 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1306 : **tiny** (//echo -en [ escape sequence ]//)
1307 Sets tiny xterm font
1308 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1311 : **tlog** (//tail -f /var/log/syslog//)
1312 Prints syslog continuously (See tail(1)).
1314 : **top10** (//print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10//)
1315 Prints the ten most used shell commands.
1317 : **truec** (//truecrypt [ mount options ]//)
1318 Mount a truecrypt volume with some reasonable mount options
1319 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1322 : **up** (//aptitude update ; aptitude safe-upgrade//)
1323 Performs a system update followed by a system upgrade using aptitude; run
1324 by sudo, if necessary. See au and ag above.
1326 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1327 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1328 protect them from the shell.
1330 : **0** (//return 0//)
1331 Gives a clean prompt (i.e. without $?).
1333 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1334 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1336 : **...** (//cd ../..///)
1337 Changes current directory two levels higher.
1339 : **?** (//qma zshall//)
1340 Runs the grml script qma (quick manual access) to build the collected man
1341 pages for the z-shell. This compressed file is kept at
1342 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1343 fast. See "man qma" for further information.
1347 This is a set of files, that - if they exist - can be used to customize the
1348 behaviour of //grmlzshrc//.
1351 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1352 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1355 # show battery status in RPROMPT
1357 # always load the complete setup, even for root
1358 GRML_ALWAYS_LOAD_ALL=1
1362 Sourced right before loading //grmlzshrc// is finished. There is a global
1363 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1367 Directory listing for persistent dirstack (see above).
1369 : **.important_commands**
1370 List of commands, used by persistent history (see above).
1373 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1374 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1375 (http://www.ubuntu.com) and similar systems - it is very easy to get
1376 //grmlzshrc// via grml's .deb repositories.
1378 On non-debian systems, that is not an option, but all is not lost:
1381 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1384 If you would also like to get seperate function files (which you can put into
1385 your **$fpath**), you can browse and download them at:
1387 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1389 = ZSH REFCARD TAGS =
1390 If you read //grmlzshrc//'s code you may notice strange looking comments in
1391 it. These are there for a purpose. grml's zsh-refcard is automatically
1392 generated from the contents of the actual configuration file. However, we need
1393 a little extra information on which comments and what lines of code to take
1394 into account (and for what purpose).
1396 Here is what they mean:
1398 List of tags (comment types) used:
1400 Next line contains an important alias, that should be included in the
1401 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1404 Next line contains the beginning of an important function. (placement
1405 tag: @@INSERT-functions@@)
1408 Next line contains an important variable. (placement tag:
1409 @@INSERT-variables@@)
1412 Next line contains an important keybinding. (placement tag:
1413 @@INSERT-keybindings@@)
1416 Hashed directories list generation: //start//: denotes the start of a list of
1417 'hash -d' definitions. //end//: denotes its end. (placement tag:
1418 @@INSERT-hasheddirs@@)
1421 Abbreviation expansion list generation: //start//: denotes the beginning of
1422 abbreviations. //end//: denotes their end.
1424 Lines within this section that end in '#d .*' provide extra documentation to
1425 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1428 This tag allows you to manually generate refcard entries for code lines that
1429 are hard/impossible to parse.
1433 #m# k ESC-h Call the run-help function
1436 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1439 So the syntax is: #m# <section> <argument> <comment>
1442 This tag lets you insert entries to the 'other' hash. Generally, this should
1443 not be used. It is there for things that cannot be done easily in another way.
1444 (placement tag: @@INSERT-other-foobar@@)
1447 All of these tags (except for m and o) take two arguments, the first
1448 within the tag, the other after the tag:
1450 #<tag><section># <comment>
1452 Where <section> is really just a number, which are defined by the @secmap
1453 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1454 that for the reader, the tag should not differ much from a regular comment.
1455 For zsh, it is a regular comment indeed. The numbers have got the following
1480 So, the following will add an entry to the 'functions' table in the 'system'
1481 section, with a (hopefully) descriptive comment:
1484 #f1# Edit an alias via zle
1488 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1489 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1490 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1491 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1492 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1496 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1497 repository from git.grml.org:
1499 ``` % git clone git://git.grml.org/grml-etc-core.git
1501 Make your changes, commit them; use '**git format-patch**' to create a series
1502 of patches and send those to the following address via '**git send-email**':
1504 ``` grml-etc-core@grml.org
1506 Doing so makes sure the right people get your patches for review and
1511 This manual page is the **reference** manual for //grmlzshrc//.
1513 That means that in contrast to the existing refcard it should document **every**
1514 aspect of the setup.
1516 This manual is currently not complete. If you want to help improving it, visit
1517 the following pages:
1519 http://wiki.grml.org/doku.php?id=zshrcmanual
1521 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1523 Contributions are highly welcome.
1527 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1528 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1529 Beckert <abe@deuxchevaux.org>.
1533 Copyright (c) 2009-2011 Grml project <http://grml.org>
1535 This manpage is distributed under the terms of the GPL version 2.
1537 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1538 except for **accept-line()** which are distributed under the same conditions
1539 as zsh itself (which is BSD-like).