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