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.
47 = FEATURE DESCRIPTION =
48 This is an in depth description of non-standard features implemented by
51 == DIRSTACK HANDLING ==
52 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
53 file each time zsh's working directory is changed. That file can be configured
54 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
55 **DIRSTACKSIZE** variable defaults to **20** in this setup.
57 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
58 zshs inherit the dirstack of the zsh that most recently updated
61 == DIRECTORY BASED PROFILES ==
62 If you want certain settings to be active in certain directories (and
63 automatically switch back and forth between them), this is what you want.
66 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
67 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
70 When that's done and you enter a directory that matches the pattern
71 in the third part of the context, a function called chpwd_profile_grml,
72 for example, is called (if it exists).
74 If no pattern matches (read: no profile is detected) the profile is
75 set to 'default', which means chpwd_profile_default is attempted to
78 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
79 command) which is used: The third part in the context is matched against
80 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
81 Because that way the profile is detected for all these values of **$PWD**:
89 So, if you want to make double damn sure a profile works in /foo/bar
90 and everywhere deeper in that tree, just use (|/|/*) and be happy.
92 The name of the detected profile will be available in a variable called
93 'profile' in your functions. You don't need to do anything, it'll just
96 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
97 that was active up to now. That way you can avoid running code for a
98 profile that is already active, by running code such as the following
99 at the start of your function:
102 function chpwd_profile_grml() {
103 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
108 The initial value for **$CHPWD_PROFILE** is 'default'.
110 === Signaling availabily/profile changes ===
112 If you use this feature and need to know whether it is active in your
113 current shell, there are several ways to do that. Here are two simple
116 a) If knowing if the profiles feature is active when zsh starts is
117 good enough for you, you can put the following snippet into your
121 (( ${+functions[chpwd_profiles]} )) &&
122 print "directory profiles active"
125 b) If that is not good enough, and you would prefer to be notified
126 whenever a profile changes, you can solve that by making sure you
127 start **every** profile function you create like this:
130 function chpwd_profile_myprofilename() {
131 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
132 print "chpwd(): Switching to profile: $profile"
137 That makes sure you only get notified if a profile is **changed**,
138 not everytime you change directory.
140 === Version requirement ===
141 This feature requires zsh //4.3.3// or newer.
144 == ACCEPTLINE WRAPPER ==
145 The //accept-line// wiget is the one that is taking action when the **return**
146 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
149 This wrapper is configured via styles. That means, you issue commands, that look
153 zstyle 'context' style value
156 The context namespace, that we are using is 'acceptline'. That means, the actual
157 context for your commands look like: **':acceptline:<subcontext>'**.
159 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
163 === Recognized Contexts ===
165 This is the value, the context is initialized with.
166 The //compwarnfmt and //rehash// styles are looked up in this context.
169 If the first word in the command line is either a command, alias, function,
170 builtin or reserved word, you are in this context.
173 This is the context, that is used if you hit enter again, after being warned
174 about the existence of a _completion for the non-existing command you
178 This is the context, you are in if the command line is empty or only
179 consists of whitespace.
182 This context is in effect, if you entered something that does not match any
183 of the above. (e.g.: variable assignments).
186 === Available Styles ===
188 If you set this style to true, the warning about non existent commands,
189 for which completions exist will not be issued. (Default: **false**)
192 The message, that is displayed to warn about the _completion issue.
193 (default: **'%c will not execute and completion %f exists.'**)
194 '%c' is replaced by the command name, '%f' by the completion's name.
197 If this is set, we'll force rehashing, if appropriate. (Defaults to
198 **true** in //grmlzshrc//).
201 This can be a list of wigdets to call in a given context. If you need a
202 specific order for these to be called, name them accordingly. The default value
203 is an **empty list**.
206 The name of a widget, that is called after the widgets from 'actions'.
207 By default, this will be '.accept-line' (which is the built-in accept-line
211 If true in the current context, call the widget in the 'default_action'
212 style. (The default is **true** in all contexts.)
218 == GNU/SCREEN STATUS SETTING ==
219 //grmlzshrc// sets screen's hardstatus lines to the currently running command
220 or **'zsh'** if the shell is idling at its prompt. If the current working
221 directory is inside a repository unter version control, screen status is set
222 to: **'zsh: <repository name>'** via zsh's vcs_info.
225 == PERSISTENT HISTORY ==
226 If you got commands you consider important enough to be included in every
227 shell's history, you can put them into ~/.important_commands and they will be
228 available via the usual history lookup widgets.
233 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
234 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
238 Edit the current command buffer in your favourite editor.
241 Deletes a word left of the cursor; seeing '/' as additional word separator.
244 Jump right after the first word.
247 Searches the last occurence of string before the cursor in the command history.
250 Brings a job, which got suspended with CTRL-z back to foreground.
253 == SHELL FUNCTIONS ==
254 //grmlzshrc// comes with a wide array of defined shell functions to ease the
258 Converts plaintext files to HTML using vim. The output is written to
261 : **855resolution()**
262 If 915resolution is available, issues a warning to the user to run it instead
263 to modify the resolution on intel graphics chipsets.
266 Searches for USENET postings from authors using google groups.
269 Sets all ulimit values to "unlimited".
272 Prints a colored table of available ansi color codes (to be used in escape
273 sequences) and the colors they represent.
275 : **aoeu(), asdf(), uiae()**
276 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
280 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
281 Then prompts the user if she wants to remove that directory. You might need
282 to tell audioburn which cdrom device to use like:
283 "DEVICE=/dev/cdrom audioburn"
286 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
287 it. Then prompts the user if she wants to burn a audio CD with audioburn()
288 (see above). You might need to tell audiorip which cdrom device to use like:
289 "DEVICE=/dev/cdrom audioburn"
292 Simple backup of a file or directory using cp(1). The target file name is the
293 original name plus a time stamp attached. Symlinks and file attributes like mode,
294 ownership and timestamps are preserved.
297 The brltty(1) program provides a braille display, so a blind person can access
298 the console screen. This wrapper function works around problems with some
299 environments (f. e. utf8).
302 If the original cdrecord is not installed, issues a warning to the user to
303 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
307 Changes current directory to the one supplied by argument and lists the files
308 in it, including file names starting with ".".
311 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
312 email addresses of submitters or any string given on the command line.
315 Shows bug report for debian given by number in mailbox format.
318 Tells the user to use grml-debootstrap, if she wants to install debian to
322 Shows the disk usage of the directories given in human readable format;
326 Translates C source code to assembly and ouputs both.
329 Takes packagename as argument. Sets current working directory to
330 /usr/share/doc/<packagename> and prints out a directory listing.
333 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
334 instance of firefox running, attaches to the first window found and opens the
335 URL in a new tab (this even works across an ssh session).
337 : **fluxkey-change()**
338 Switches the key combinations for changing current workspace under fluxbox(1)
339 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
340 Requires the window manager to reread configuration to take effect.
343 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
344 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
345 filename>". Creates an index.html with title "Images" showing the
346 thumbnails as clickable links to the respective original file.
347 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
348 and all files and/or directories beginning with "thumb-" in current directory!
351 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
354 Tries to download and install Gizmo (VoIP software) for Debian.
357 Tries to download and install Skype (VoIP software) for Debian.
360 Downloads and installs newer version of Skype.
363 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
367 Opens a specific git commitdiff from kernel.org in default browser. Tree is
368 chosen by the environment variable GITTREE which defaults to Linus Torvalds'
371 : **git-get-commit()**
372 Opens a specific git commit from kernel.org in default browser. The tree to
373 fetch from is controlled by the environment variable GITTREE which defaults
374 to Linus Torvalds' kernel tree.
376 : **git-get-plaindiff()**
377 Fetches specific git diff from kernel.org. The tree is controlled by the
378 environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
381 Searches the zsh command history for a regular expression.
384 Prints the hexadecimal representation of the number supplied as argument
388 Outputs highlighted diff; needs highstring(1).
391 Returns true, if zsh version is equal or greater than 4, else false.
394 Returns true, if zsh version is equal or greater than 4.1, else false.
397 Returns true, if zsh version is equal or greater than 4.2, else false.
400 Returns true, if zsh version is equal or greater than 4.2.5, else false.
403 Returns true, if zsh version is equal or greater than 4.3, else false.
406 Returns true, if zsh version is equal or greater than 4.3.3, else false.
409 Returns true, if running on darwin, else false.
412 Returns true, if running on a grml system, else false.
415 Returns true, if running on a grml system from a live cd, else false.
418 Returns true, if run on grml-small, else false.
421 Returns true, if run within an utf environment, else false.
424 Lists libraries that define the symbol containing the string given as
428 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
432 Creates directory including parent directories, if necessary. Then changes
433 current working directory to it.
435 : **minimal-shell()**
436 Spawns a absolute minimal Korn shell. It references no files in /usr, so
437 that file system can be unmounted.
440 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
441 replaces spaces in file names with underscores. Then mkaudiocd()
442 normalizes the files and recodes them to WAV.
445 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
446 enabled using mkisofs(8). Prompts the user for volume name, filename and
450 Runs "make install" and logs the output under ~/.errorlogs/; useful for
451 a clean deinstall later.
454 Recodes an ogg file to mp3 with a bitrate of 192.
457 Evaluates a perl expression; useful as command line
458 calculator, therefore also available as "calc".
461 Lists all occurrences of the string given as argument in current $PATH.
464 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
465 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
466 Asks for confirmation.
469 Opens all README-like files in current working directory with the program
470 defined in the $PAGER environment variable.
473 Reloads functions given as parameters.
476 Checks whether a regular expression (first parameter) matches a string
477 (second parameter) using perl.
480 Greps the history for the string provided as parameter and shows the numbered
481 findings in default pager. On exit of the pager the user is prompted for a
482 number. The shells readline buffer is then filled with the corresponding
486 Lists the contents of a (compressed) archive with the appropriate programs.
487 The choice is made along the filename extension.
490 Lists the content of a gzipped tar archive in default pager.
493 Shows the content of a zip archive in default pager.
495 : **simple-extract()**
496 Tries to uncompress/unpack given file with the appropriate programs. The
497 choice is made along the filename ending.
500 Prints the arguments slowly by sleeping 0.08 seconds between each character.
502 : **smartcompress()**
503 Compresses/archives the file given as first parameter. Takes an optional
504 second argument, which denotes the compression/archive type as typical
505 filename extension; defaults to "tar.gz".
508 Indents C source code files given; uses Kernighan & Ritchie style.
511 Creates directory named shots in user's home directory, if it does not yet
512 exist and changes current working directory to it. Then sleeps 5 seconds,
513 so you have plenty of time to switch desktops/windows. Then makes a screenshot
514 of the current desktop. The result is stored in ~/shots to a timestamped
518 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
519 issues a Warning to use the grml-x(1) script. Can be overridden by using
520 /usr/bin/startx directly.
523 Shows some information about current system status.
526 Makes a unified diff of the command line arguments trying hard to find a
527 smaller set of changes. Descends recursively into subdirectories. Ignores
528 hows some information about current status.
531 Takes a string as its first argument and prints it RFC 2396 URL encoded to
538 Wrapper for vim(1). It tries to set the title and hands vim the environment
539 variable VIM_OPTIONS on the command line. So the user may define command
540 line options, she always wants, in her .zshrc.local.
543 Use vim(1) as manpage reader.
546 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
547 issues a Warning to use the grml-x(1) script. Can be overridden by using
548 /usr/bin/xinit directly.
551 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
552 option plus a non empty pattern. Run zg without any arguments for a listing
553 of available command line switches. For a zshrc not in /etc/zsh, set the
554 GRML_ZSHRC environment variable.
558 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
559 life. A few aliases (like those involving //grep// or //ls//) use the option
560 //--color=auto// for colourizing output. That option is part of **GNU**
561 implementations of these tools, and will only be used if such an implementation
564 : **acp** (//apt-cache policy//)
565 With no arguments prints out the priorities of each source. If a package name
566 is given, it displays detailed information about the priority selection of the
569 : **acs** (//apt-cache search//)
570 Searches debian package lists for the regular expression provided as argument.
571 The search includes package names and descriptions. Prints out name and short
572 description of matching packages.
574 : **acsh** (//apt-cache show//)
575 Shows the package records for the packages provided as arguments.
577 : **adg** (//apt-get dist-upgrade//)
578 Performs an upgrade of all installed packages. Also tries to automatically
579 handle changing dependencies with new versions of packages. As this may change
580 the install status of (or even remove) installed packages, it is potentially
581 dangerous to use dist-upgrade; invoked by sudo, if necessary.
583 : **ag** (//apt-get upgrade//)
584 Downloads and installs the newest versions of all packages currently installed
585 on the system. Under no circumstances are currently installed packages removed,
586 or packages not already installed retrieved and installed. New versions of
587 currently installed packages that cannot be upgraded without changing the install
588 status of another package will be left at their current version. An update must
589 be performed first (see au below); run by sudo, if necessary.
591 : **agi** (//apt-get install//)
592 Downloads and installs or upgrades the packages given on the command line.
593 If a hyphen is appended to the package name, the identified package will be
594 removed if it is installed. Similarly a plus sign can be used to designate a
595 package to install. This may be useful to override decisions made by apt-get's
596 conflict resolution system.
597 A specific version of a package can be selected for installation by following
598 the package name with an equals and the version of the package to select. This
599 will cause that version to be located and selected for install. Alternatively a
600 specific distribution can be selected by following the package name with a slash
601 and the version of the distribution or the Archive name (stable, testing, unstable).
602 Gets invoked by sudo, if user id is not 0.
604 : **ati** (//aptitude install//)
605 Aptitude is a terminal-based package manager with a command line mode similar to
606 apt-get (see agi above); invoked by sudo, if necessary.
608 : **au** (//apt-get update//)
609 Resynchronizes the package index files from their sources. The indexes of
610 available packages are fetched from the location(s) specified in
611 /etc/apt/sources.list. An update should always be performed before an
612 upgrade or dist-upgrade; run by sudo, if necessary.
614 : **calc** (//peval//)
615 Evaluates a perl expression (see peval() above); useful as a command line
618 : **CH** (//./configure --help//)
619 Lists available compilation options for building program from source.
621 : **cmplayer** (//mplayer -vo fbdev//)
622 Video player with framebuffer as video output device, so you can watch
623 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
624 while watching a movie.
626 : **CO** (//./configure//)
627 Prepares compilation for building program from source.
629 : **da** (//du -sch//)
630 Prints the summarized disk usage of the arguments as well as a grand total
631 in human readable format.
633 : **default** (//echo -en [ escape sequence ]//)
634 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
635 using escape sequence.
637 : **dir** (//ls -lSrah//)
638 Lists files (including dot files) sorted by size (biggest last) in long and
639 human readable output format.
641 : **fblinks** (//links2 -driver fb//)
642 A Web browser on the framebuffer device. So you can browse images and click
643 links on the virtual tty.
645 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
646 Fullscreen Video player with the framebuffer as video output device. So you
647 can watch videos on a virtual tty.
650 Revision control system by Linus Torvalds.
652 : **grep** (//grep --color=auto//)
653 Shows grep output in nice colors, if available.
655 : **GREP** (//grep -i --color=auto//)
656 Case insensitive grep with colored output.
658 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
659 Scans for new devices and updates /etc/fstab according to the findings.
661 : **grml-version** (//cat /etc/grml_version//)
662 Prints version of running grml.
664 : **http** (//python -m SimpleHTTPServer//)
665 Basic HTTP server implemented in python. Listens on port 8000/tcp and
666 serves current directory. Implements GET and HEAD methods.
668 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
669 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
670 host key changes frequently, for example on virtualized test- or development-systems.
671 To be used only inside trusted networks, of course.
673 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
674 ssh with possible man-in-the-middle attack enabled
675 (for an explanation see insecscp above).
677 : **help-zshglob** (//H-Glob()//)
678 Runs the function H-Glob() to expand or explain wildcards.
680 : **hide** (//echo -en [ escape sequence ]//)
681 Tries to hide xterm window using escape sequence.
683 : **huge** (//echo -en [ escape sequence ]//)
684 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
685 using escape sequence.
687 : **j** (//jobs -l//)
688 Prints status of jobs in the current shell session in long format.
690 : **l** (//ls -lF --color=auto//)
691 Lists files in long output format with indicator for filetype appended
692 to filename. If the terminal supports it, with colored output.
694 : **la** (//ls -la --color=auto//)
695 Lists files in long colored output format. Including file names
698 : **lad** (//ls -d .*(/)//)
699 Lists the dot directories (not their contents) in current directory.
701 : **large** (//echo -en [ escape sequence ]//)
702 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
703 using escape sequence.
705 : **lh** (//ls -hAl --color=auto//)
706 Lists files in long and human readable output format in nice colors,
707 if available. Includes file names starting with "." except "." and
710 : **ll** (//ls -l --color=auto//)
711 Lists files in long colored output format.
713 : **ls** (//ls -b -CF --color=auto//)
714 Lists directory printing octal escapes for nongraphic characters.
715 Entries are listed by columns and an indicator for file type is appended
716 to each file name. Additionally the output is colored, if the terminal
719 : **lsa** (//ls -a .*(.)//)
720 Lists dot files in current working directory.
722 : **lsbig** (//ls -flh *(.OL[1,10])//)
723 Displays the ten biggest files (long and human readable output format).
725 : **lsd** (//ls -d *(/)//)
728 : **lse** (//ls -d *(/^F)//)
729 Shows empty directories.
731 : **lsl** (//ls -l *(@)//)
732 Lists symbolic links in current directory.
734 : **lsnew** (//ls -rl *(D.om[1,10])//)
735 Displays the ten newest files (long output format).
737 : **lsold** (//ls -rtlh *(D.om[1,10])//)
738 Displays the ten oldest files (long output format).
740 : **lss** (//ls -l *(s,S,t)//)
741 Lists files in current directory that have the setuid, setgid or sticky bit
744 : **lssmall** (//ls -Srl *(.oL[1,10])//)
745 Displays the ten smallest files (long output format).
747 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
748 Displays all files which are world readable and/or world writable and/or
749 world executable (long output format).
751 : **lsx** (//ls -l *(*)//)
752 Lists only executable files.
754 : **md** (//mkdir -p//)
755 Creates directory including parent directories, if necessary
757 : **medium** (//echo -en [ escape sequence ]//)
758 Sets medium sized font
759 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
760 using escape sequence.
762 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
763 If invoking user is root, starts screen session with /etc/grml/screenrc
764 as config file. If invoked by a regular user, start a screen session
765 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
768 : **rw-** (//chmod 600//)
769 Grants read and write permission of a file to the owner and nobody else.
771 : **rwx** (//chmod 700//)
772 Grants read, write and execute permission of a file to the owner and nobody
775 : **r--** (//chmod 644//)
776 Grants read and write permission of a file to the owner and read-only to
779 : **r-x** (//chmod 755//)
780 Grants read, write and execute permission of a file to the owner and
781 read-only plus execute permission to anybody else.
783 : **semifont** (//echo -en [ escape sequence ]//)
784 Sets font of xterm to
785 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
788 : **small** (//echo -en [ escape sequence ]//)
789 Sets small xterm font ("6x10") using escape sequence.
791 : **smartfont** (//echo -en [ escape sequence ]//)
792 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
795 : **su** (//sudo su//)
796 If user is running a grml live-CD, dont ask for any password, if she
799 : **tiny** (//echo -en [ escape sequence ]//)
801 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
804 : **truec** (//truecrypt [ mount options ]//)
805 Mount a truecrypt volume with some reasonable mount options
806 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
809 : **up** (//aptitude update ; aptitude safe-upgrade//)
810 Performs a system update followed by a system upgrade using aptitude; run
811 by sudo, if necessary. See au and ag above.
813 : **?** (//qma zshall//)
814 Runs the grml script qma (quick manual access) to build the collected man
815 pages for the z-shell. This compressed file is kept at
816 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
817 fast. See "man qma" for further information.
821 This is a set of files, that - if they exist - can be used to customize the
822 behaviour of //grmlzshrc//.
825 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
826 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
829 # show battery status in RPROMPT
831 # always load the complete setup, even for root
832 GRML_ALWAYS_LOAD_ALL=1
836 Sourced right before loading //grmlzshrc// is finished. There is a global
837 version of this file (/etc/zsh/zshrc.local) which is sourced before the
841 Directory listing for persistent dirstack (see above).
843 : **.important_commands**
844 List of commands, used by persistent history (see above).
847 = INSTALLATION ON NON-DEBIAN SYSTEMS =
848 On Debian systems (http://www.debian.org) - and possibly Ubuntu
849 (http://www.ubuntu.com) and similar systems - it is very easy to get
850 //grmlzshrc// via grml's .deb repositories.
852 On non-debian systems, that is not an option, but all is not lost:
855 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
858 If you would also like to get seperate function files (which you can put into
859 your **$fpath**), you can browse and download them at:
861 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
864 If you read //grmlzshrc//'s code you may notice strange looking comments in
865 it. These are there for a purpose. grml's zsh-refcard is automatically
866 generated from the contents of the actual configuration file. However, we need
867 a little extra information on which comments and what lines of code to take
868 into account (and for what purpose).
870 Here is what they mean:
872 List of tags (comment types) used:
874 Next line contains an important alias, that should be included in the
875 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
878 Next line contains the beginning of an important function. (placement
879 tag: @@INSERT-functions@@)
882 Next line contains an important variable. (placement tag:
883 @@INSERT-variables@@)
886 Next line contains an important keybinding. (placement tag:
887 @@INSERT-keybindings@@)
890 Hashed directories list generation: //start//: denotes the start of a list of
891 'hash -d' definitions. //end//: denotes its end. (placement tag:
892 @@INSERT-hasheddirs@@)
895 Abbreviation expansion list generation: //start//: denotes the beginning of
896 abbreviations. //end//: denotes their end.
898 Lines within this section that end in '#d .*' provide extra documentation to
899 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
902 This tag allows you to manually generate refcard entries for code lines that
903 are hard/impossible to parse.
907 #m# k ESC-h Call the run-help function
910 That would add a refcard entry in the keybindings table for 'ESC-h' with the
913 So the syntax is: #m# <section> <argument> <comment>
916 This tag lets you insert entries to the 'other' hash. Generally, this should
917 not be used. It is there for things that cannot be done easily in another way.
918 (placement tag: @@INSERT-other-foobar@@)
921 All of these tags (except for m and o) take two arguments, the first
922 within the tag, the other after the tag:
924 #<tag><section># <comment>
926 Where <section> is really just a number, which are defined by the @secmap
927 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
928 that for the reader, the tag should not differ much from a regular comment.
929 For zsh, it is a regular comment indeed. The numbers have got the following
954 So, the following will add an entry to the 'functions' table in the 'system'
955 section, with a (hopefully) descriptive comment:
958 #f1# Edit an alias via zle
962 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
963 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
964 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
965 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
966 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
970 If you want to help to improve grml's zsh setup, clone the grml-etc-core
971 repository from git.grml.org:
973 ``` % git clone git://git.grml.org/grml-etc-core.git
975 Make your changes, commit them; use '**git format-patch**' to create a series
976 of patches and send those to the following address via '**git send-email**':
978 ``` grml-etc-core@grml.org
980 Doing so makes sure the right people get your patches for review and
985 This manual page is supposed to be a **reference** manual for //grmlzshrc//.
986 That means that in contrast to the existing refcard it should document **every**
987 aspect of the setup. That is currently **not** the case. Not for a long time
988 yet. Contributions are highly welcome.
992 This manpage was written by Frank Terbeck <ft@grml.org> and Joerg Woelke
997 Copyright (c) 2009, grml project <http://grml.org>
999 This manpage is distributed under the terms of the GPL version 2.
1001 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1002 except for **accept-line()** and **vcs_info()**, which are distributed under
1003 the same conditions as zsh itself (which is BSD-like).