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 If X is running this is set to "firefox", otherwise to "w3m".
305 Set to "yes". Some applications read this to learn about properties
306 of the terminal they are running in.
309 If not already set, sets the default editor. Falls back to vi(1),
310 if vim(1) is not available.
313 Some environment variables that add colour support to less(1) for viewing
314 man pages. See termcap(5) for details.
317 The mailbox file for the current user is set to /var/mail/$USER, if not
318 already set otherwise.
321 Set less(1) as default pager, if not already set to something different.
324 Holds the path to shared files for the C++ application framework QT
328 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
329 default to /bin/sh or /bin/bash.
333 Apart from zsh's default options, //grmlzshrc// sets some options
334 that change the behaviour of zsh. Options that change Z-shell's default
335 settings are marked by <grml>. But note, that zsh's defaults vary depending
336 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
339 Zsh sessions, that use //grmlzshrc//, will append their history list to the
340 history file, rather than replace it. Thus, multiple parallel zsh sessions
341 will all have the new entries from their history lists added to the history
342 file, in the order that they exit. The file will still be periodically
343 re-written to trim it when the number of lines grows 20% beyond the value
344 specified by $SAVEHIST.
347 If a command is issued that can't be executed as a normal command, and the
348 command is the name of a directory, perform the cd command to that directory.
350 : **auto_pushd** <grml>
351 Make cd push the old directory onto the directory stack.
353 : **completeinword** <grml>
354 If the cursor is inside a word, completion is done from both ends;
355 instead of moving the cursor to the end of the word first and starting
358 : **extended_glob** <grml>
359 Treat the '#', '~' and '^' characters as active globbing pattern characters.
361 : **extended_history** <grml>
362 Save each command's beginning timestamp (in seconds since the epoch) and the
363 duration (in seconds) to the history file.
366 Whenever a command completion is attempted, make sure the entire command
367 path is hashed first. This makes the first completion slower.
369 : **histignorealldups** <grml>
370 If a new command line being added to the history list duplicates an
371 older one, the older command is removed from the list, even if it is
372 not the previous event.
374 : **histignorespace** <grml>
375 Remove command lines from the history list when the first character on
376 the line is a space, or when one of the expanded aliases contains a
377 leading space. Note that the command lingers in the internal history
378 until the next command is entered before it vanishes.
380 : **longlistjobs** <grml>
381 List jobs in long format by default.
384 Avoid to beep on errors in zsh command line editing (zle).
387 A wildcard character never matches a leading '.'.
390 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
392 : **nonomatch** <grml>
393 If a pattern for filename generation has no matches, do not print an error
394 and leave it unchanged in the argument list. This also applies to file
395 expansion of an initial `~' or `='.
398 Report the status of background jobs immediately, rather than waiting until
399 just before printing a prompt.
401 : **pushd_ignore_dups** <grml>
402 Don't push multiple copies of the same directory onto the directory stack.
404 : **share_history** <grml>
405 As each line is added to the history file, it is checked to see if anything
406 else was written out by another shell, and if so it is included in the
407 history of the current shell too. Using !-style history, the commands from
408 the other sessions will not appear in the history list unless you explicitly
409 type the "history" command. This option is activated for zsh versions >= 4,
414 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
415 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
419 Edit the current command buffer in your favourite editor.
422 Deletes a word left of the cursor; seeing '/' as additional word separator.
425 Jump right after the first word.
428 Create directory under cursor or the selected area.
429 To select an area press ctrl-@ and use the cursor.
430 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
431 directory does not exist yet -> press **CTRL-xM** and problem solved.
434 Searches the last occurence of string before the cursor in the command history.
437 Display help on keybindings and zsh line editor. Press consecutively to page through content.
440 Brings a job, which got suspended with CTRL-z back to foreground.
443 == SHELL FUNCTIONS ==
444 //grmlzshrc// comes with a wide array of defined shell functions to ease the
448 Converts plaintext files to HTML using vim. The output is written to
451 : **855resolution()**
452 If 915resolution is available, issues a warning to the user to run it instead
453 to modify the resolution on intel graphics chipsets.
456 Lists files in current directory, which have been accessed within the
457 last N days. N is an integer to be passed as first and only argument.
458 If no argument is specified N is set to 1.
461 Searches for USENET postings from authors using google groups.
464 Sets all ulimit values to "unlimited".
467 Prints a colored table of available ansi color codes (to be used in escape
468 sequences) and the colors they represent.
471 Lists processes matching given pattern.
473 : **aoeu(), asdf(), uiae()**
474 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
477 : **apache2-ssl-certificate()**
478 Advices the user how to create self signed certificates.
481 Login on the host provided as argument using autossh. Then reattach a GNU screen
482 session if a detached session is around or detach a currently attached screen or
483 else start a new screen. This is especially useful for roadwarriors using GNU
487 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
488 Then prompts the user if she wants to remove that directory. You might need
489 to tell audioburn which cdrom device to use like:
490 "DEVICE=/dev/cdrom audioburn"
493 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
494 it. Then prompts the user if she wants to burn a audio CD with audioburn()
495 (see above). You might need to tell audiorip which cdrom device to use like:
496 "DEVICE=/dev/cdrom audioburn"
499 Simple backup of a file or directory using cp(1). The target file name is the
500 original name plus a time stamp attached. Symlinks and file attributes like mode,
501 ownership and timestamps are preserved.
504 Runs a recursive diff(1) over two given directories trying to find the
505 smallest set of changes. Three lines of context will be printed and binary
509 If the original cdrecord is not installed, issues a warning to the user to
510 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
514 Creates a temporary directory using mktemp. Then changes current
515 working directory to it.
518 Lists files in current directory, which have been changed within the
519 last N days. N is an integer to be passed as first and only argument.
520 If no argument is specified N is set to 1.
523 Returns true if given command exists either as program, function, alias,
524 builtin or reserved word. If the option -c is given, only returns true,
525 if command is a program.
528 Changes directory to $HOME on first invocation of zsh. This is neccessary on
529 grml systems with autologin.
532 Changes current directory to the one supplied by argument and lists the files
533 in it, including file names starting with ".".
536 Adds and commits the given files using cvs(1). The commit message will be
540 Shows a cvs diff of the arguments in $PAGER.
543 Shows the cvs log in $PAGER.
549 Generates a changelog using rcs2log and shows it in $PAGER.
552 Shows cvs status of given files.
555 Shows the changelog of given package in $PAGER.
558 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
559 email addresses of submitters or any string given on the command line.
562 Shows bug report for debian given by number in mailbox format.
565 Tells the user to use grml-debootstrap, if she wants to install debian to
569 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
570 back interactive responsiveness after suspend, when the system is swapping
574 Shows the disk usage of the directories given in human readable format;
578 Translates C source code to assembly and ouputs both.
581 Searches for the first argument (optional) in the Open Directory Project
582 (See http://www.dmoz.org/docs/en/about.html).
585 Shows the NEWS file for the given package in $PAGER.
588 Takes packagename as argument. Sets current working directory to
589 /usr/share/doc/<packagename> and prints out a directory listing.
592 Looks up the first argument (optional) in the german Wiktionary
593 which is an online dictionary (See: http://de.wiktionary.org/).
599 Edit given shell function.
602 Looks up the first argument (optional in the english Wiktionary
603 which is an online dictionary (See: http://en.wiktionary.org/).
606 Renames image files based on date/time informations in their exif headers.
609 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
610 instance of firefox running, attaches to the first window found and opens the
611 URL in a new tab (this even works across an ssh session).
613 : **fluxkey-change()**
614 Switches the key combinations for changing current workspace under fluxbox(1)
615 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
616 Requires the window manager to reread configuration to take effect.
619 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
622 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
623 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
624 filename>". Creates an index.html with title "Images" showing the
625 thumbnails as clickable links to the respective original file.
626 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
627 and all files and/or directories beginning with "thumb-" in current directory!
630 Fetches 3ware RAID controller software using get_3ware(1).
633 Performs an exact (i. e. quoted) web search using Google.
636 Searches the arguments on Google Groups, a web to USENET gateway.
639 Searches the search engine Google using arguments as search string.
642 Searches the zsh command history for a regular expression.
645 Prints the hexadecimal representation of the number supplied as argument
649 Use GNU diff with options -ubwd for mercurial.
652 Displays diffstat between the revision given as argument and tip (no
653 argument means last revision).
656 Outputs highlighted diff; needs highstring(1).
659 Shows source files in less(1) with syntax highlighting. Run "hl -h"
660 for detailed usage information.
663 Queries IMAP server (first parameter) for its capabilities. Takes
664 port number as optional second argument.
667 Sets up an IPv6 tunnel on interface sit1. Needs one argument -
668 either "start", "stop" or "status".
671 Returns true, if zsh version is equal or greater than 4, else false.
674 Returns true, if zsh version is equal or greater than 4.1, else false.
677 Returns true, if zsh version is equal or greater than 4.2, else false.
680 Returns true, if zsh version is equal or greater than 4.2.5, else false.
683 Returns true, if zsh version is equal or greater than 4.3, else false.
686 Returns true, if zsh version is equal or greater than 4.3.3, else false.
689 Returns true, if running on darwin, else false.
692 Returns true, if running on a grml system, else false.
695 Returns true, if running on a grml system from a live cd, else false.
698 Returns true, if run on grml-small, else false.
701 Changes every occurrence of the string iso885915 or ISO885915 in
702 environment variables to UTF-8.
705 Returns true, if run within an utf environment, else false.
708 Searches a wireless interface and runs dhclient(8) on it.
711 Lists libraries that define the symbol containing the string given as
715 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
719 Prints specified range of (numbered) lines of a file.
720 Usage: linenr <start>[,<end>] <file>
723 Uses udev's /dev/disk to list block devices with their LABEL, UUID and IDs.
726 Creates a PostScript and a PDF file (basename as first argument) from
730 Displays manpage in a streched style.
733 Shows the zshall manpage and jumps to the first match of the regular
734 expression optionally given as argument (Needs qma(1)).
737 Creates directory including parent directories, if necessary. Then changes
738 current working directory to it.
741 Diffs the two arguments recursively and writes the
742 output (unified format) to a timestamped file.
745 Prints the summarized memory usage in bytes.
748 Searches Google Groups for a USENET message-ID.
750 : **minimal-shell()**
751 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
752 so that file system can be unmounted.
755 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
756 replaces spaces in file names with underscores. Then mkaudiocd()
757 normalizes the files and recodes them to WAV.
760 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
761 enabled using mkisofs(8). Prompts the user for volume name, filename and
765 Creates a directory with first parameter as name inside $MAILDIR_ROOT
766 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
769 Runs "make install" and logs the output under ~/.errorlogs/; useful for
770 a clean deinstall later.
773 Lists files in current directory, which have been modified within the
774 last N days. N is an integer to be passed as first and only argument.
775 If no argument is specified N is set to 1.
778 Asks netcraft.com for informations about the site given as argument.
781 A helper function for the "e" glob qualifier to list all files newer
782 than a reference file.
786 % NTREF=/reference/file
789 % ls -l *(e:'nt /reference/file':)
793 Translates the given word using the english - german online
794 dictionary dict.leo.org.
797 Evaluates a perl expression; useful as command line
798 calculator, therefore also available as "calc".
801 Lists all occurrences of the string given as argument in current $PATH.
804 Runs a command in $SHELL with profiling enabled (See startup variable
805 ZSH_PROFILE_RC above).
808 Removes temporary files from current directory. Asks for confirmation. Uses sudo if necessary.
810 - common temp files like "*~", ".*~", "#*#", "*.o", "a.out", "*.orig", "*.rej", "*.cmo", "*.cmi" and ".*.swp"
812 - debconf backup files: "*.dpkg-old", "*.dkpg-new", "*.dpkg-dist"
813 - gentoo dispatch-conf backups: ".cfg0000_*", ".mrg0000_*"
814 - precompiled python code ("*.pyc", "*.pyo") as long as matching "*.py" source is also present
815 - 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"
816 - ghc temp files, as long as matching "*.hs" or "*.lhs" is also present
817 - "*.mood(D)" Files which are missing their corresponding audio file
820 Opens all README-like files in current working directory with the program
821 defined in the $PAGER environment variable.
824 Reloads functions given as parameters.
827 Checks whether a regular expression (first parameter) matches a string
828 (second parameter) using perl.
831 Takes as first parameter a quoted string containing an exectuable command or function with arguments.
832 Following that it takes a bunch of directories, which will then be traversed, executing the
833 first argument in each one. E.g.: rundirs purge . **/*(/-/)
836 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
837 for details. See also xunfunction() below.
840 Greps the history for the string provided as parameter and shows the numbered
841 findings in default pager. On exit of the pager the user is prompted for a
842 number. The shells readline buffer is then filled with the corresponding
846 Reimplementation of the csh(1) builtin setenv.
849 Lists the contents of a (compressed) archive with the appropriate programs.
850 The choice is made along the filename extension.
853 Lists the content of a gzipped tar archive in default pager.
856 Shows the content of a zip archive in default pager.
858 : **simple-extract()**
859 Tries to uncompress/unpack given files with the appropriate programs. If an URI
860 starting with https, http or ftp is provided simple-extract tries to download
861 and then uncompress/unpack the file. The choice is made along the filename
862 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
863 .xz) unless you use the '-d' option.
866 Prints details of symlinks given as arguments.
869 Prints the arguments slowly by sleeping 0.08 seconds between each character.
871 : **smartcompress()**
872 Compresses/archives the file given as first parameter. Takes an optional
873 second argument, which denotes the compression/archive type as typical
874 filename extension; defaults to "tar.gz".
877 Indents C source code files given; uses Kernighan & Ritchie style.
880 Creates directory named shots in user's home directory, if it does not yet
881 exist and changes current working directory to it. Then sleeps 5 seconds,
882 so you have plenty of time to switch desktops/windows. Then makes a screenshot
883 of the current desktop. The result is stored in ~/shots to a timestamped
886 : **ssl-cert-fingerprints**
887 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
888 First and only parameter must be a file containing a certificate. Use
889 /dev/stdin as file if you want to pipe a certificate to these
893 Prints all information of a x509 certificate including the SHA512,
894 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
895 containing a certificate. Use /dev/stdin as file if you want to pipe a
896 certificate to this function.
898 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
899 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
900 certificate. First and only parameter must be a file containing a
901 certificate. Use /dev/stdin as file if you want to pipe a certificate
904 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
905 Functions for controlling daemons.
912 Shows some information about current system status.
915 Searches articles in the german Wikipedia for the term given as argument.
918 Translates a word from german to english (-D) or vice versa (-E).
921 Shows upstreams changelog of a given package in $PAGER.
924 Makes a unified diff of the command line arguments trying hard to find a
925 smaller set of changes. Descends recursively into subdirectories. Ignores
926 hows some information about current status.
929 Downloads and displays a file using a suitable program for its
933 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
936 Takes a string as its first argument and prints it RFC 2396 URL encoded to
940 Changes every occurrence of the string UTF-8 or utf-8 in environment
941 variables to iso885915.
947 Wrapper for vim(1). It tries to set the title and hands vim the environment
948 variable VIM_OPTIONS on the command line. So the user may define command
949 line options, she always wants, in her .zshrc.local.
952 Use vim(1) as manpage reader.
955 Searches the history for a given pattern and lists the results by date.
956 The first argument is the search pattern. The second and third ones are
957 optional and denote a search range (default: -100).
960 Retrieves and prints weather information from "http://weather.noaa.gov".
961 The first and only argument is the ICAO code for the desired station.
962 For a list of ICAO codes see
963 "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
966 Looks up the argument on Wikipedia (german).
969 Looks up the argument on Wikipedia (english).
972 Searches the list of official debian packages for the term given as
973 first argument. The optional second argument denotes the distribution
974 (stable, testing or unstable) and defaults to unstable.
977 Tries to cat(1) file(s) given as parameter(s). Always returns true.
978 See also xunfunction() below.
981 Tries to source the file(s) given as parameter(s). Always returns true.
982 See zshbuiltins(1) for a detailed description of the source command.
983 See also xunfunction() below.
986 Changes the title of xterm window from within screen(1). Run without
987 arguments for details.
990 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
993 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
994 option plus a non empty pattern. Run zg without any arguments for a listing
995 of available command line switches. For a zshrc not in /etc/zsh, set the
996 GRML_ZSHRC environment variable.
999 Wrapper around the autoload builtin. Loads the definitions of functions
1000 from the file given as argument. Searches $fpath for the file. See also
1001 xunfunction() above.
1004 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
1005 where own modifications should go. See also zshbuiltins(1) for a description
1006 of the source command.
1010 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
1011 life. A few aliases (like those involving //grep// or //ls//) use the option
1012 //--color=auto// for colourizing output. That option is part of **GNU**
1013 implementations of these tools, and will only be used if such an implementation
1016 : **acp** (//apt-cache policy//)
1017 With no arguments prints out the priorities of each source. If a package name
1018 is given, it displays detailed information about the priority selection of the
1021 : **acs** (//apt-cache search//)
1022 Searches debian package lists for the regular expression provided as argument.
1023 The search includes package names and descriptions. Prints out name and short
1024 description of matching packages.
1026 : **acsh** (//apt-cache show//)
1027 Shows the package records for the packages provided as arguments.
1029 : **adg** (//apt-get dist-upgrade//)
1030 Performs an upgrade of all installed packages. Also tries to automatically
1031 handle changing dependencies with new versions of packages. As this may change
1032 the install status of (or even remove) installed packages, it is potentially
1033 dangerous to use dist-upgrade; invoked by sudo, if necessary.
1035 : **ag** (//apt-get upgrade//)
1036 Downloads and installs the newest versions of all packages currently installed
1037 on the system. Under no circumstances are currently installed packages removed,
1038 or packages not already installed retrieved and installed. New versions of
1039 currently installed packages that cannot be upgraded without changing the install
1040 status of another package will be left at their current version. An update must
1041 be performed first (see au below); run by sudo, if necessary.
1043 : **agi** (//apt-get install//)
1044 Downloads and installs or upgrades the packages given on the command line.
1045 If a hyphen is appended to the package name, the identified package will be
1046 removed if it is installed. Similarly a plus sign can be used to designate a
1047 package to install. This may be useful to override decisions made by apt-get's
1048 conflict resolution system.
1049 A specific version of a package can be selected for installation by following
1050 the package name with an equals and the version of the package to select. This
1051 will cause that version to be located and selected for install. Alternatively a
1052 specific distribution can be selected by following the package name with a slash
1053 and the version of the distribution or the Archive name (stable, testing, unstable).
1054 Gets invoked by sudo, if user id is not 0.
1056 : **ati** (//aptitude install//)
1057 Aptitude is a terminal-based package manager with a command line mode similar to
1058 apt-get (see agi above); invoked by sudo, if necessary.
1060 : **au** (//apt-get update//)
1061 Resynchronizes the package index files from their sources. The indexes of
1062 available packages are fetched from the location(s) specified in
1063 /etc/apt/sources.list. An update should always be performed before an
1064 upgrade or dist-upgrade; run by sudo, if necessary.
1066 : **calc** (//peval//)
1067 Evaluates a perl expression (see peval() above); useful as a command line
1070 : **CH** (//./configure --help//)
1071 Lists available compilation options for building program from source.
1073 : **cmplayer** (//mplayer -vo fbdev//)
1074 Video player with framebuffer as video output device, so you can watch
1075 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
1076 while watching a movie.
1078 : **CO** (//./configure//)
1079 Prepares compilation for building program from source.
1081 : **cp** (//nocorrect cp//)
1082 cp(1) without spelling correction.
1084 : **da** (//du -sch//)
1085 Prints the summarized disk usage of the arguments as well as a grand total
1086 in human readable format.
1088 : **dbp** (//dpkg-buildpackage//)
1089 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
1091 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
1092 Prints installed Packages sorted by size (descending).
1094 : **default** (//echo -en [ escape sequence ]//)
1095 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
1096 using escape sequence.
1098 : **dir** (//ls -lSrah//)
1099 Lists files (including dot files) sorted by size (biggest last) in long and
1100 human readable output format.
1102 : **fblinks** (//links2 -driver fb//)
1103 A Web browser on the framebuffer device. So you can browse images and click
1104 links on the virtual tty.
1106 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
1107 Fullscreen Video player with the framebuffer as video output device. So you
1108 can watch videos on a virtual tty.
1111 Revision control system by Linus Torvalds.
1113 : **ge** (//grep-excuses//)
1114 Searches the testing excuses files for a specific maintainer (See:
1117 : **grep** (//grep --color=auto//)
1118 Shows grep output in nice colors, if available.
1120 : **GREP** (//grep -i --color=auto//)
1121 Case insensitive grep with colored output.
1123 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
1124 Scans for new devices and updates /etc/fstab according to the findings.
1126 : **grml-version** (//cat /etc/grml_version//)
1127 Prints version of running grml.
1129 : **hbp** (//hg-buildpackage//)
1130 Helper program to maintain Debian packages with mercurial.
1132 : **http** (//python -m SimpleHTTPServer//)
1133 Basic HTTP server implemented in python. Listens on port 8000/tcp and
1134 serves current directory. Implements GET and HEAD methods.
1136 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1137 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
1138 host key changes frequently, for example on virtualized test- or development-systems.
1139 To be used only inside trusted networks, of course.
1141 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1142 ssh with possible man-in-the-middle attack enabled
1143 (for an explanation see insecscp above).
1145 : **help-zshglob** (//H-Glob()//)
1146 Runs the function H-Glob() to expand or explain wildcards.
1148 : **hide** (//echo -en [ escape sequence ]//)
1149 Tries to hide xterm window using escape sequence.
1151 : **hidiff** (//histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'//)
1152 If histring(1) is installed, highlight important stuff in diff(1) output.
1154 : **huge** (//echo -en [ escape sequence ]//)
1155 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
1156 using escape sequence.
1158 : **j** (//jobs -l//)
1159 Prints status of jobs in the current shell session in long format.
1161 : **l** (//ls -lF --color=auto//)
1162 Lists files in long output format with indicator for filetype appended
1163 to filename. If the terminal supports it, with colored output.
1165 : **la** (//ls -la --color=auto//)
1166 Lists files in long colored output format. Including file names
1169 : **lad** (//ls -d .*(/)//)
1170 Lists the dot directories (not their contents) in current directory.
1172 : **large** (//echo -en [ escape sequence ]//)
1173 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
1174 using escape sequence.
1176 : **lh** (//ls -hAl --color=auto//)
1177 Lists files in long and human readable output format in nice colors,
1178 if available. Includes file names starting with "." except "." and
1181 : **ll** (//ls -l --color=auto//)
1182 Lists files in long colored output format.
1184 : **llog** (//$PAGER /var/log/syslog//)
1185 Opens syslog in pager.
1187 : **ls** (//ls -b -CF --color=auto//)
1188 Lists directory printing octal escapes for nongraphic characters.
1189 Entries are listed by columns and an indicator for file type is appended
1190 to each file name. Additionally the output is colored, if the terminal
1193 : **lsa** (//ls -a .*(.)//)
1194 Lists dot files in current working directory.
1196 : **lsbig** (//ls -flh *(.OL[1,10])//)
1197 Displays the ten biggest files (long and human readable output format).
1199 : **lsd** (//ls -d *(/)//)
1202 : **lse** (//ls -d *(/^F)//)
1203 Shows empty directories.
1205 : **lsl** (//ls -l *(@)//)
1206 Lists symbolic links in current directory.
1208 : **lsnew** (//ls -rl *(D.om[1,10])//)
1209 Displays the ten newest files (long output format).
1211 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1212 Displays the ten oldest files (long output format).
1214 : **lss** (//ls -l *(s,S,t)//)
1215 Lists files in current directory that have the setuid, setgid or sticky bit
1218 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1219 Displays the ten smallest files (long output format).
1221 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1222 Displays all files which are world readable and/or world writable and/or
1223 world executable (long output format).
1225 : **lsx** (//ls -l *(*)//)
1226 Lists only executable files.
1228 : **md** (//mkdir -p//)
1229 Creates directory including parent directories, if necessary
1231 : **mdstat** (//cat /proc/mdstat//)
1232 Lists all active md (i.e. linux software raid) devices with some information
1235 : **medium** (//echo -en [ escape sequence ]//)
1236 Sets medium sized font
1237 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1238 using escape sequence.
1240 : **mkdir** (//nocorrect mkdir//)
1241 mkdir(1) without spelling correction.
1243 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1244 Executes the commands on the versioned patch queue from current repository.
1246 : **mv** (//nocorrect mv//)
1247 mv(1) without spelling correction.
1249 : **rd** (//rmdir//)
1250 Short rmdir(1) (remove directory).
1252 : **rm** (//nocorrect rm//)
1253 rm(1) without spelling correction.
1255 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1256 rmdir current working directory
1258 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1259 If invoking user is root, starts screen session with /etc/grml/screenrc
1260 as config file. If invoked by a regular user, start a screen session
1261 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1264 : **rw-** (//chmod 600//)
1265 Grants read and write permission of a file to the owner and nobody else.
1267 : **rwx** (//chmod 700//)
1268 Grants read, write and execute permission of a file to the owner and nobody
1271 : **r--** (//chmod 644//)
1272 Grants read and write permission of a file to the owner and read-only to
1275 : **r-x** (//chmod 755//)
1276 Grants read, write and execute permission of a file to the owner and
1277 read-only plus execute permission to anybody else.
1279 : **S** (//screen//)
1280 Short for screen(1).
1285 : **semifont** (//echo -en [ escape sequence ]//)
1286 Sets font of xterm to
1287 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1290 : **small** (//echo -en [ escape sequence ]//)
1291 Sets small xterm font ("6x10") using escape sequence.
1293 : **smartfont** (//echo -en [ escape sequence ]//)
1294 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1297 : **su** (//sudo su//)
1298 If user is running a grml live-CD, dont ask for any password, if she
1301 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1302 Sets mode from UTF-8 to ISO 2022 (See:
1303 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1305 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1306 Sets mode from ISO 2022 to UTF-8 (See:
1307 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1309 : **tiny** (//echo -en [ escape sequence ]//)
1310 Sets tiny xterm font
1311 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1314 : **tlog** (//tail -f /var/log/syslog//)
1315 Prints syslog continuously (See tail(1)).
1317 : **top10** (//print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10//)
1318 Prints the ten most used shell commands.
1320 : **truec** (//truecrypt [ mount options ]//)
1321 Mount a truecrypt volume with some reasonable mount options
1322 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1325 : **up** (//aptitude update ; aptitude safe-upgrade//)
1326 Performs a system update followed by a system upgrade using aptitude; run
1327 by sudo, if necessary. See au and ag above.
1329 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1330 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1331 protect them from the shell.
1333 : **0** (//return 0//)
1334 Gives a clean prompt (i.e. without $?).
1336 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1337 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1339 : **...** (//cd ../..///)
1340 Changes current directory two levels higher.
1342 : **?** (//qma zshall//)
1343 Runs the grml script qma (quick manual access) to build the collected man
1344 pages for the z-shell. This compressed file is kept at
1345 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1346 fast. See "man qma" for further information.
1350 This is a set of files, that - if they exist - can be used to customize the
1351 behaviour of //grmlzshrc//.
1354 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1355 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1358 # show battery status in RPROMPT
1360 # always load the complete setup, even for root
1361 GRML_ALWAYS_LOAD_ALL=1
1365 Sourced right before loading //grmlzshrc// is finished. There is a global
1366 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1370 Directory listing for persistent dirstack (see above).
1372 : **.important_commands**
1373 List of commands, used by persistent history (see above).
1376 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1377 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1378 (http://www.ubuntu.com) and similar systems - it is very easy to get
1379 //grmlzshrc// via grml's .deb repositories.
1381 On non-debian systems, that is not an option, but all is not lost:
1384 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1387 If you would also like to get seperate function files (which you can put into
1388 your **$fpath**), you can browse and download them at:
1390 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1392 = ZSH REFCARD TAGS =
1393 If you read //grmlzshrc//'s code you may notice strange looking comments in
1394 it. These are there for a purpose. grml's zsh-refcard is automatically
1395 generated from the contents of the actual configuration file. However, we need
1396 a little extra information on which comments and what lines of code to take
1397 into account (and for what purpose).
1399 Here is what they mean:
1401 List of tags (comment types) used:
1403 Next line contains an important alias, that should be included in the
1404 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1407 Next line contains the beginning of an important function. (placement
1408 tag: @@INSERT-functions@@)
1411 Next line contains an important variable. (placement tag:
1412 @@INSERT-variables@@)
1415 Next line contains an important keybinding. (placement tag:
1416 @@INSERT-keybindings@@)
1419 Hashed directories list generation: //start//: denotes the start of a list of
1420 'hash -d' definitions. //end//: denotes its end. (placement tag:
1421 @@INSERT-hasheddirs@@)
1424 Abbreviation expansion list generation: //start//: denotes the beginning of
1425 abbreviations. //end//: denotes their end.
1427 Lines within this section that end in '#d .*' provide extra documentation to
1428 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1431 This tag allows you to manually generate refcard entries for code lines that
1432 are hard/impossible to parse.
1436 #m# k ESC-h Call the run-help function
1439 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1442 So the syntax is: #m# <section> <argument> <comment>
1445 This tag lets you insert entries to the 'other' hash. Generally, this should
1446 not be used. It is there for things that cannot be done easily in another way.
1447 (placement tag: @@INSERT-other-foobar@@)
1450 All of these tags (except for m and o) take two arguments, the first
1451 within the tag, the other after the tag:
1453 #<tag><section># <comment>
1455 Where <section> is really just a number, which are defined by the @secmap
1456 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1457 that for the reader, the tag should not differ much from a regular comment.
1458 For zsh, it is a regular comment indeed. The numbers have got the following
1483 So, the following will add an entry to the 'functions' table in the 'system'
1484 section, with a (hopefully) descriptive comment:
1487 #f1# Edit an alias via zle
1491 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1492 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1493 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1494 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1495 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1499 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1500 repository from git.grml.org:
1502 ``` % git clone git://git.grml.org/grml-etc-core.git
1504 Make your changes, commit them; use '**git format-patch**' to create a series
1505 of patches and send those to the following address via '**git send-email**':
1507 ``` grml-etc-core@grml.org
1509 Doing so makes sure the right people get your patches for review and
1514 This manual page is the **reference** manual for //grmlzshrc//.
1516 That means that in contrast to the existing refcard it should document **every**
1517 aspect of the setup.
1519 This manual is currently not complete. If you want to help improving it, visit
1520 the following pages:
1522 http://wiki.grml.org/doku.php?id=zshrcmanual
1524 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1526 Contributions are highly welcome.
1530 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1531 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1532 Beckert <abe@deuxchevaux.org>.
1536 Copyright (c) 2009-2011 Grml project <http://grml.org>
1538 This manpage is distributed under the terms of the GPL version 2.
1540 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1541 except for **accept-line()** which are distributed under the same conditions
1542 as zsh itself (which is BSD-like).