6 %!postproc(man): "^(\.TH.*) 1 " "\1 5 "
10 grmlzshrc - grml's zsh setup
14 //zsh// [**options**]...
18 The grml project provides a fairly exhaustive interactive setup (referred to
19 as //grmlzshrc// throughout this document) for the amazing unix shell zsh
20 (http://zsh.sourceforge.net). This is the reference manual for that
23 To use //grmlzshrc//, you need at least version 3.1.7 of zsh (although not all
24 features are enabled in every version).
26 //grmlzshrc// behaves differently depending on which user loads it. For the
27 root user (**EUID** == 0) only a subset of features is loaded by default. This
28 behaviour can be altered by setting the **GRML_ALWAYS_LOAD_ALL** STARTUP
32 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
33 variables. These may be set temporarily when starting zsh like this:
37 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
40 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
41 put the battery status into the right hand side interactive prompt.
44 = FEATURE DESCRIPTION =
45 This is an in depth description of non-standard features implemented by
48 == DIRSTACK HANDLING ==
49 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
50 file each time zsh's working directory is changed. That file can be configured
51 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
52 **DIRSTACKSIZE** variable defaults to **20** in this setup.
54 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
55 zshs inherit the dirstack of the zsh that most recently updated
58 == DIRECTORY BASED PROFILES ==
59 If you want certain settings to be active in certain directories (and
60 automatically switch back and forth between them), this is what you want.
63 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
64 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
67 When that's done and you enter a directory that matches the pattern
68 in the third part of the context, a function called chpwd_profile_grml,
69 for example, is called (if it exists).
71 If no pattern matches (read: no profile is detected) the profile is
72 set to 'default', which means chpwd_profile_default is attempted to
75 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
76 command) which is used: The third part in the context is matched against
77 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
78 Because that way the profile is detected for all these values of **$PWD**:
86 So, if you want to make double damn sure a profile works in /foo/bar
87 and everywhere deeper in that tree, just use (|/|/*) and be happy.
89 The name of the detected profile will be available in a variable called
90 'profile' in your functions. You don't need to do anything, it'll just
93 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
94 that was active up to now. That way you can avoid running code for a
95 profile that is already active, by running code such as the following
96 at the start of your function:
99 function chpwd_profile_grml() {
100 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
105 The initial value for **$CHPWD_PROFILE** is 'default'.
107 === Signaling availabily/profile changes ===
109 If you use this feature and need to know whether it is active in your
110 current shell, there are several ways to do that. Here are two simple
113 a) If knowing if the profiles feature is active when zsh starts is
114 good enough for you, you can put the following snippet into your
118 (( ${+functions[chpwd_profiles]} )) &&
119 print "directory profiles active"
122 b) If that is not good enough, and you would prefer to be notified
123 whenever a profile changes, you can solve that by making sure you
124 start **every** profile function you create like this:
127 function chpwd_profile_myprofilename() {
128 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
129 print "chpwd(): Switching to profile: $profile"
134 That makes sure you only get notified if a profile is **changed**,
135 not everytime you change directory.
137 === Version requirement ===
138 This feature requires zsh //4.3.3// or newer.
141 == ACCEPTLINE WRAPPER ==
142 The //accept-line// wiget is the one that is taking action when the **return**
143 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
146 This wrapper is configured via styles. That means, you issue commands, that look
150 zstyle 'context' style value
153 The context namespace, that we are using is 'acceptline'. That means, the actual
154 context for your commands look like: **':acceptline:<subcontext>'**.
156 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
160 === Recognized Contexts ===
162 This is the value, the context is initialized with.
163 The //compwarnfmt and //rehash// styles are looked up in this context.
166 If the first word in the command line is either a command, alias, function,
167 builtin or reserved word, you are in this context.
170 This is the context, that is used if you hit enter again, after being warned
171 about the existence of a _completion for the non-existing command you
175 This is the context, you are in if the command line is empty or only
176 consists of whitespace.
179 This context is in effect, if you entered something that does not match any
180 of the above. (e.g.: variable assignments).
183 === Available Styles ===
185 If you set this style to true, the warning about non existent commands,
186 for which completions exist will not be issued. (Default: **false**)
189 The message, that is displayed to warn about the _completion issue.
190 (default: **'%c will not execute and completion %f exists.'**)
191 '%c' is replaced by the command name, '%f' by the completion's name.
194 If this is set, we'll force rehashing, if appropriate. (Defaults to
195 **true** in //grmlzshrc//).
198 This can be a list of wigdets to call in a given context. If you need a
199 specific order for these to be called, name them accordingly. The default value
200 is an **empty list**.
203 The name of a widget, that is called after the widgets from 'actions'.
204 By default, this will be '.accept-line' (which is the built-in accept-line
208 If true in the current context, call the widget in the 'default_action'
209 style. (The default is **true** in all contexts.)
215 == GNU/SCREEN STATUS SETTING ==
216 //grmlzshrc// sets screen's hardstatus lines to the currently running command
217 or **'zsh'** if the shell is idling at its prompt. If the current working
218 directory is inside a repository unter version control, screen status is set
219 to: **'zsh: <repository name>'** via zsh's vcs_info.
222 == PERSISTENT HISTORY ==
223 If you got commands you consider important enough to be included in every
224 shell's history, you can put them into ~/.important_commands and they will be
225 available via the usual history lookup widgets.
230 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
231 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
235 Edit the current command buffer in your favourite editor.
238 == SHELL FUNCTIONS ==
239 //grmlzshrc// comes with a wide array of defined shell functions to ease the
243 Converts plaintext files to HTML using vim. The output is written to
247 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
248 Then prompts the user if she wants to remove that directory. You might need
249 to tell audioburn which cdrom device to use like:
250 "DEVICE=/dev/cdrom audioburn"
253 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
254 it. Then prompts the user if she wants to burn a audio CD with audioburn()
255 (see above). You might need to tell audiorip which cdrom device to use like:
256 "DEVICE=/dev/cdrom audioburn"
259 Changes current directory to the one supplied by argument and lists the files
260 in it, including file names starting with ".".
263 Takes packagename as argument. Sets current working directory to
264 /usr/share/doc/<packagename> and prints out a directory listing.
266 : **fluxkey-change()**
267 Switches the key combinations for changing current workspace under fluxbox(1)
268 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
269 Requires the window manager to reread configuration to take effect.
272 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
273 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
274 filename>". Creates an index.html with title "Images" showing the
275 thumbnails as clickable links to the respective original file.
276 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
277 and all files and/or directories beginning with "thumb-" in current directory!
280 Searches the zsh command history for a regular expression.
283 Prints the hexadecimal representation of the number supplied as argument
287 Returns true, if zsh version is equal or greater than 4, else false.
290 Returns true, if zsh version is equal or greater than 4.1, else false.
293 Returns true, if zsh version is equal or greater than 4.2, else false.
296 Returns true, if zsh version is equal or greater than 4.2.5, else false.
299 Returns true, if zsh version is equal or greater than 4.3, else false.
302 Returns true, if zsh version is equal or greater than 4.3.3, else false.
305 Returns true, if running on darwin, else false.
308 Returns true, if running on a grml system, else false.
311 Returns true, if running on a grml system from a live cd, else false.
314 Returns true, if run on grml-small, else false.
317 Returns true, if run within an utf environment, else false.
320 Lists libraries that define the symbol containing the string given as
324 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
328 Creates directory including parent directories, if necessary. Then changes
329 current working directory to it.
332 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
333 enabled using mkisofs(8). Prompts the user for volume name, filename and
337 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
338 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
339 Asks for confirmation.
342 Opens all README-like files in current working directory with the program
343 defined in the $PAGER environment variable.
346 Checks whether a regular expression (first parameter) matches a string
347 (second parameter) using perl.
350 Lists the content of a gzipped tar archive in default pager.
353 Shows the content of a zip archive in default pager.
356 Prints the arguments slowly by sleeping 0.08 seconds between each character.
359 Creates directory named shots in user's home directory, if it does not yet
360 exist and changes current working directory to it. Then sleeps 5 seconds,
361 so you have plenty of time to switch desktops/windows. Then makes a screenshot
362 of the current desktop. The result is stored in ~/shots to a timestamped
366 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
367 issues a Warning to use the grml-x(1) script. Can be overridden by using
368 /usr/bin/startx directly.
371 Shows some information about current system status.
374 Makes a unified diff of the command line arguments trying hard to find a
375 smaller set of changes. Descends recursively into subdirectories. Ignores
376 hows some information about current status.
379 Takes a string as its first argument and prints it RFC 2396 URL encoded to
386 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
387 issues a Warning to use the grml-x(1) script. Can be overridden by using
388 /usr/bin/xinit directly.
392 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
393 life. A few aliases (like those involving //grep// or //ls//) use the option
394 //--color=auto// for colourizing output. That option is part of **GNU**
395 implementations of these tools, and will only be used if such an implementation
398 : **cmplayer** (//mplayer -vo fbdev//)
399 Video player with framebuffer as video output device, so you can watch
400 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
401 while watching a movie.
403 : **da** (//du -sch//)
404 Prints the summarized disk usage of the arguments as well as a grand total
405 in human readable format.
407 : **fblinks** (//links2 -driver fb//)
408 A Web browser on the framebuffer device. So you can browse images and click
409 links on the virtual tty.
411 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
412 Fullscreen Video player with the framebuffer as video output device. So you
413 can watch videos on a virtual tty.
416 Revision control system by Linus Torvalds.
418 : **grep** (//grep --color=auto//)
419 Shows grep output in nice colors, if available.
421 : **GREP** (//grep -i --color=auto//)
422 Case insensitive grep with colored output.
424 : **http** (//python -m SimpleHTTPServer//)
425 Basic HTTP server implemented in python. Listens on port 8000/tcp and
426 serves current directory. Implements GET and HEAD methods.
428 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
429 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
430 host key changes frequently, for example on virtualized test- or development-systems.
431 To be used only inside trusted networks, of course.
433 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
434 ssh with possible man-in-the-middle attack enabled
435 (for an explanation see insecscp above).
437 : **l** (//ls -lF --color=auto//)
438 Lists files in long output format with indicator for filetype appended
439 to filename. If the terminal supports it, with colored output.
441 : **la** (//ls -la --color=auto//)
442 Lists files in long colored output format. Including file names
445 : **lh** (//ls -hAl --color=auto//)
446 Lists files in long and human readable output format in nice colors,
447 if available. Includes file names starting with "." except "." and
450 : **ll** (//ls -l --color=auto//)
451 Lists files in long colored output format.
453 : **j** (//jobs -l//)
454 Prints status of jobs in the current shell session in long format.
456 : **ls** (//ls -b -CF --color=auto//)
457 Lists directory printing octal escapes for nongraphic characters.
458 Entries are listed by columns and an indicator for file type is appended
459 to each file name. Additionally the output is colored, if the terminal
462 : **lsbig** (//ls -flh *(.OL[1,10])//)
463 Displays the ten biggest files (long and human readable output format).
465 : **lsd** (//ls -d *(/)//)
468 : **lse** (//ls -d *(/^F)//)
469 Shows empty directories.
471 : **lsnew** (//ls -rl *(D.om[1,10])//)
472 Displays the ten newest files (long output format).
474 : **lsold** (//ls -rtlh *(D.om[1,10])//)
475 Displays the ten oldest files (long output format).
477 : **lssmall** (//ls -Srl *(.oL[1,10])//)
478 Displays the ten smallest files (long output format).
480 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
481 Displays all files which are world readable and/or world writable and/or
482 world executable (long output format).
484 : **lsx** (//ls -l *(*)//)
485 Lists only executable files.
487 : **md** (//mkdir -p//)
488 Creates directory including parent directories, if necessary
490 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
491 If invoking user is root, starts screen session with /etc/grml/screenrc
492 as config file. If invoked by a regular user, start a screen session
493 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
496 : **rw-** (//chmod 600//)
497 Grants read and write permission of a file to the owner and nobody else.
499 : **rwx** (//chmod 700//)
500 Grants read, write and execute permission of a file to the owner and nobody
503 : **r--** (//chmod 644//)
504 Grants read and write permission of a file to the owner and read-only to
507 : **r-x** (//chmod 755//)
508 Grants read, write and execute permission of a file to the owner and
509 read-only plus execute permission to anybody else.
513 This is a set of files, that - if they exist - can be used to customize the
514 behaviour of //grmlzshrc//.
517 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
518 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
521 # show battery status in RPROMPT
523 # always load the complete setup, even for root
524 GRML_ALWAYS_LOAD_ALL=1
528 Sourced right before loading //grmlzshrc// is finished. There is a global
529 version of this file (/etc/zsh/zshrc.local) which is sourced before the
533 Directory listing for persistent dirstack (see above).
535 : **.important_commands**
536 List of commands, used by persistent history (see above).
539 = INSTALLATION ON NON-DEBIAN SYSTEMS =
540 On Debian systems (http://www.debian.org) - and possibly Ubuntu
541 (http://www.ubuntu.com) and similar systems - it is very easy to get
542 //grmlzshrc// via grml's .deb repositories.
544 On non-debian systems, that is not an option, but all is not lost:
547 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
550 If you would also like to get seperate function files (which you can put into
551 your **$fpath**), you can browse and download them at:
553 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
556 If you read //grmlzshrc//'s code you may notice strange looking comments in
557 it. These are there for a purpose. grml's zsh-refcard is automatically
558 generated from the contents of the actual configuration file. However, we need
559 a little extra information on which comments and what lines of code to take
560 into account (and for what purpose).
562 Here is what they mean:
564 List of tags (comment types) used:
566 Next line contains an important alias, that should be included in the
567 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
570 Next line contains the beginning of an important function. (placement
571 tag: @@INSERT-functions@@)
574 Next line contains an important variable. (placement tag:
575 @@INSERT-variables@@)
578 Next line contains an important keybinding. (placement tag:
579 @@INSERT-keybindings@@)
582 Hashed directories list generation: //start//: denotes the start of a list of
583 'hash -d' definitions. //end//: denotes its end. (placement tag:
584 @@INSERT-hasheddirs@@)
587 Abbreviation expansion list generation: //start//: denotes the beginning of
588 abbreviations. //end//: denotes their end.
590 Lines within this section that end in '#d .*' provide extra documentation to
591 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
594 This tag allows you to manually generate refcard entries for code lines that
595 are hard/impossible to parse.
599 #m# k ESC-h Call the run-help function
602 That would add a refcard entry in the keybindings table for 'ESC-h' with the
605 So the syntax is: #m# <section> <argument> <comment>
608 This tag lets you insert entries to the 'other' hash. Generally, this should
609 not be used. It is there for things that cannot be done easily in another way.
610 (placement tag: @@INSERT-other-foobar@@)
613 All of these tags (except for m and o) take two arguments, the first
614 within the tag, the other after the tag:
616 #<tag><section># <comment>
618 Where <section> is really just a number, which are defined by the @secmap
619 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
620 that for the reader, the tag should not differ much from a regular comment.
621 For zsh, it is a regular comment indeed. The numbers have got the following
646 So, the following will add an entry to the 'functions' table in the 'system'
647 section, with a (hopefully) descriptive comment:
650 #f1# Edit an alias via zle
654 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
655 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
656 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
657 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
658 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
662 If you want to help to improve grml's zsh setup, clone the grml-etc-core
663 repository from git.grml.org:
665 ``` % git clone git://git.grml.org/grml-etc-core.git
667 Make your changes, commit them; use '**git format-patch**' to create a series
668 of patches and send those to the following address via '**git send-email**':
670 ``` grml-etc-core@grml.org
672 Doing so makes sure the right people get your patches for review and
677 This manual page is supposed to be a **reference** manual for //grmlzshrc//.
678 That means that in contrast to the existing refcard it should document **every**
679 aspect of the setup. That is currently **not** the case. Not for a long time
680 yet. Contributions are highly welcome.
684 This manpage was written by Frank Terbeck <ft@grml.org> and Joerg Woelke
689 Copyright (c) 2009, grml project <http://grml.org>
691 This manpage is distributed under the terms of the GPL version 2.
693 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
694 except for **accept-line()** and **vcs_info()**, which are distributed under
695 the same conditions as zsh itself (which is BSD-like).