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 Deletes a word left of the cursor; seeing '/' as additional word separator.
241 Jump right after the first word.
244 Searches the last occurence of string before the cursor in the command history.
247 Brings a job, which got suspended with CTRL-z back to foreground.
250 == SHELL FUNCTIONS ==
251 //grmlzshrc// comes with a wide array of defined shell functions to ease the
255 Converts plaintext files to HTML using vim. The output is written to
258 : **855resolution()**
259 If 915resolution is available, issues a warning to the user to run it instead
260 to modify the resolution on intel graphics chipsets.
263 Searches for USENET postings from authors using google groups.
266 Sets all ulimit values to "unlimited".
269 Prints a colored table of available ansi color codes (to be used in escape
270 sequences) and the colors they represent.
272 : **aoeu(), asdf(), uiae()**
273 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
277 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
278 Then prompts the user if she wants to remove that directory. You might need
279 to tell audioburn which cdrom device to use like:
280 "DEVICE=/dev/cdrom audioburn"
283 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
284 it. Then prompts the user if she wants to burn a audio CD with audioburn()
285 (see above). You might need to tell audiorip which cdrom device to use like:
286 "DEVICE=/dev/cdrom audioburn"
289 Simple backup of a file or directory using cp(1). The target file name is the
290 original name plus a time stamp attached. Symlinks and file attributes like mode,
291 ownership and timestamps are preserved.
294 The brltty(1) program provides a braille display, so a blind person can access
295 the console screen. This wrapper function works around problems with some
296 environments (f. e. utf8).
299 If the original cdrecord is not installed, issues a warning to the user to
300 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
304 Changes current directory to the one supplied by argument and lists the files
305 in it, including file names starting with ".".
308 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
309 email addresses of submitters or any string given on the command line.
312 Shows bug report for debian given by number in mailbox format.
315 Tells the user to use grml-debootstrap, if she wants to install debian to
319 Shows the disk usage of the directories given in human readable format;
323 Translates C source code to assembly and ouputs both.
326 Takes packagename as argument. Sets current working directory to
327 /usr/share/doc/<packagename> and prints out a directory listing.
330 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
331 instance of firefox running, attaches to the first window found and opens the
332 URL in a new tab (this even works across an ssh session).
334 : **fluxkey-change()**
335 Switches the key combinations for changing current workspace under fluxbox(1)
336 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
337 Requires the window manager to reread configuration to take effect.
340 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
341 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
342 filename>". Creates an index.html with title "Images" showing the
343 thumbnails as clickable links to the respective original file.
344 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
345 and all files and/or directories beginning with "thumb-" in current directory!
348 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
351 Tries to download and install Gizmo (VoIP software) for Debian.
354 Tries to download and install Skype (VoIP software) for Debian.
357 Downloads and installs newer version of Skype.
360 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
364 Opens a specific git commitdiff from kernel.org in default browser. Tree is
365 chosen by the environment variable GITTREE which defaults to Linus Torvalds'
368 : **git-get-commit()**
369 Opens a specific git commit from kernel.org in default browser. The tree to
370 fetch from is controlled by the environment variable GITTREE which defaults
371 to Linus Torvalds' kernel tree.
373 : **git-get-plaindiff()**
374 Fetches specific git diff from kernel.org. The tree is controlled by the
375 environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
378 Searches the zsh command history for a regular expression.
381 Prints the hexadecimal representation of the number supplied as argument
385 Outputs highlighted diff; needs highstring(1).
388 Returns true, if zsh version is equal or greater than 4, else false.
391 Returns true, if zsh version is equal or greater than 4.1, else false.
394 Returns true, if zsh version is equal or greater than 4.2, else false.
397 Returns true, if zsh version is equal or greater than 4.2.5, else false.
400 Returns true, if zsh version is equal or greater than 4.3, else false.
403 Returns true, if zsh version is equal or greater than 4.3.3, else false.
406 Returns true, if running on darwin, else false.
409 Returns true, if running on a grml system, else false.
412 Returns true, if running on a grml system from a live cd, else false.
415 Returns true, if run on grml-small, else false.
418 Returns true, if run within an utf environment, else false.
421 Lists libraries that define the symbol containing the string given as
425 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
429 Creates directory including parent directories, if necessary. Then changes
430 current working directory to it.
432 : **minimal-shell()**
433 Spawns a absolute minimal Korn shell. It references no files in /usr, so
434 that file system can be unmounted.
437 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
438 replaces spaces in file names with underscores. Then mkaudiocd()
439 normalizes the files and recodes them to WAV.
442 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
443 enabled using mkisofs(8). Prompts the user for volume name, filename and
447 Runs "make install" and logs the output under ~/.errorlogs/; useful for
448 a clean deinstall later.
451 Recodes an ogg file to mp3 with a bitrate of 192.
454 Evaluates a perl expression; useful as command line
455 calculator, therefore also available as "calc".
458 Lists all occurrences of the string given as argument in current $PATH.
461 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
462 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
463 Asks for confirmation.
466 Opens all README-like files in current working directory with the program
467 defined in the $PAGER environment variable.
470 Reloads functions given as parameters.
473 Checks whether a regular expression (first parameter) matches a string
474 (second parameter) using perl.
477 Greps the history for the string provided as parameter and shows the numbered
478 findings in default pager. On exit of the pager the user is prompted for a
479 number. The shells readline buffer is then filled with the corresponding
483 Lists the contents of a (compressed) archive with the appropriate programs.
484 The choice is made along the filename extension.
487 Lists the content of a gzipped tar archive in default pager.
490 Shows the content of a zip archive in default pager.
492 : **simple-extract()**
493 Tries to uncompress/unpack given file with the appropriate programs. The
494 choice is made along the filename ending.
497 Prints the arguments slowly by sleeping 0.08 seconds between each character.
499 : **smartcompress()**
500 Compresses/archives the file given as first parameter. Takes an optional
501 second argument, which denotes the compression/archive type as typical
502 filename extension; defaults to "tar.gz".
505 Indents C source code files given; uses Kernighan & Ritchie style.
508 Creates directory named shots in user's home directory, if it does not yet
509 exist and changes current working directory to it. Then sleeps 5 seconds,
510 so you have plenty of time to switch desktops/windows. Then makes a screenshot
511 of the current desktop. The result is stored in ~/shots to a timestamped
515 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
516 issues a Warning to use the grml-x(1) script. Can be overridden by using
517 /usr/bin/startx directly.
520 Shows some information about current system status.
523 Makes a unified diff of the command line arguments trying hard to find a
524 smaller set of changes. Descends recursively into subdirectories. Ignores
525 hows some information about current status.
528 Takes a string as its first argument and prints it RFC 2396 URL encoded to
535 Wrapper for vim(1). It tries to set the title and hands vim the environment
536 variable VIM_OPTIONS on the command line. So the user may define command
537 line options, she always wants, in her .zshrc.local.
540 Use vim(1) as manpage reader.
543 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
544 issues a Warning to use the grml-x(1) script. Can be overridden by using
545 /usr/bin/xinit directly.
548 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
549 option plus a non empty pattern. Run zg without any arguments for a listing
550 of available command line switches. For a zshrc not in /etc/zsh, set the
551 GRML_ZSHRC environment variable.
555 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
556 life. A few aliases (like those involving //grep// or //ls//) use the option
557 //--color=auto// for colourizing output. That option is part of **GNU**
558 implementations of these tools, and will only be used if such an implementation
561 : **acp** (//apt-cache policy//)
562 With no arguments prints out the priorities of each source. If a package name
563 is given, it displays detailed information about the priority selection of the
566 : **acs** (//apt-cache search//)
567 Searches debian package lists for the regular expression provided as argument.
568 The search includes package names and descriptions. Prints out name and short
569 description of matching packages.
571 : **acsh** (//apt-cache show//)
572 Shows the package records for the packages provided as arguments.
574 : **adg** (//apt-get dist-upgrade//)
575 Performs an upgrade of all installed packages. Also tries to automatically
576 handle changing dependencies with new versions of packages. As this may change
577 the install status of (or even remove) installed packages, it is potentially
578 dangerous to use dist-upgrade; invoked by sudo, if necessary.
580 : **ag** (//apt-get upgrade//)
581 Downloads and installs the newest versions of all packages currently installed
582 on the system. Under no circumstances are currently installed packages removed,
583 or packages not already installed retrieved and installed. New versions of
584 currently installed packages that cannot be upgraded without changing the install
585 status of another package will be left at their current version. An update must
586 be performed first (see au below); run by sudo, if necessary.
588 : **agi** (//apt-get install//)
589 Downloads and installs or upgrades the packages given on the command line.
590 If a hyphen is appended to the package name, the identified package will be
591 removed if it is installed. Similarly a plus sign can be used to designate a
592 package to install. This may be useful to override decisions made by apt-get's
593 conflict resolution system.
594 A specific version of a package can be selected for installation by following
595 the package name with an equals and the version of the package to select. This
596 will cause that version to be located and selected for install. Alternatively a
597 specific distribution can be selected by following the package name with a slash
598 and the version of the distribution or the Archive name (stable, testing, unstable).
599 Gets invoked by sudo, if user id is not 0.
601 : **ati** (//aptitude install//)
602 Aptitude is a terminal-based package manager with a command line mode similar to
603 apt-get (see agi above); invoked by sudo, if necessary.
605 : **au** (//apt-get update//)
606 Resynchronizes the package index files from their sources. The indexes of
607 available packages are fetched from the location(s) specified in
608 /etc/apt/sources.list. An update should always be performed before an
609 upgrade or dist-upgrade; run by sudo, if necessary.
611 : **calc** (//peval//)
612 Evaluates a perl expression (see peval() above); useful as a command line
615 : **CH** (//./configure --help//)
616 Lists available compilation options for building program from source.
618 : **cmplayer** (//mplayer -vo fbdev//)
619 Video player with framebuffer as video output device, so you can watch
620 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
621 while watching a movie.
623 : **CO** (//./configure//)
624 Prepares compilation for building program from source.
626 : **da** (//du -sch//)
627 Prints the summarized disk usage of the arguments as well as a grand total
628 in human readable format.
630 : **default** (//echo -en [ escape sequence ]//)
631 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
632 using escape sequence.
634 : **dir** (//ls -lSrah//)
635 Lists files (including dot files) sorted by size (biggest last) in long and
636 human readable output format.
638 : **fblinks** (//links2 -driver fb//)
639 A Web browser on the framebuffer device. So you can browse images and click
640 links on the virtual tty.
642 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
643 Fullscreen Video player with the framebuffer as video output device. So you
644 can watch videos on a virtual tty.
647 Revision control system by Linus Torvalds.
649 : **grep** (//grep --color=auto//)
650 Shows grep output in nice colors, if available.
652 : **GREP** (//grep -i --color=auto//)
653 Case insensitive grep with colored output.
655 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
656 Scans for new devices and updates /etc/fstab according to the findings.
658 : **grml-version** (//cat /etc/grml_version//)
659 Prints version of running grml.
661 : **http** (//python -m SimpleHTTPServer//)
662 Basic HTTP server implemented in python. Listens on port 8000/tcp and
663 serves current directory. Implements GET and HEAD methods.
665 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
666 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
667 host key changes frequently, for example on virtualized test- or development-systems.
668 To be used only inside trusted networks, of course.
670 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
671 ssh with possible man-in-the-middle attack enabled
672 (for an explanation see insecscp above).
674 : **help-zshglob** (//H-Glob()//)
675 Runs the function H-Glob() to expand or explain wildcards.
677 : **hide** (//echo -en [ escape sequence ]//)
678 Tries to hide xterm window using escape sequence.
680 : **huge** (//echo -en [ escape sequence ]//)
681 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
682 using escape sequence.
684 : **j** (//jobs -l//)
685 Prints status of jobs in the current shell session in long format.
687 : **l** (//ls -lF --color=auto//)
688 Lists files in long output format with indicator for filetype appended
689 to filename. If the terminal supports it, with colored output.
691 : **la** (//ls -la --color=auto//)
692 Lists files in long colored output format. Including file names
695 : **lad** (//ls -d .*(/)//)
696 Lists the dot directories (not their contents) in current directory.
698 : **large** (//echo -en [ escape sequence ]//)
699 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
700 using escape sequence.
702 : **lh** (//ls -hAl --color=auto//)
703 Lists files in long and human readable output format in nice colors,
704 if available. Includes file names starting with "." except "." and
707 : **ll** (//ls -l --color=auto//)
708 Lists files in long colored output format.
710 : **ls** (//ls -b -CF --color=auto//)
711 Lists directory printing octal escapes for nongraphic characters.
712 Entries are listed by columns and an indicator for file type is appended
713 to each file name. Additionally the output is colored, if the terminal
716 : **lsa** (//ls -a .*(.)//)
717 Lists dot files in current working directory.
719 : **lsbig** (//ls -flh *(.OL[1,10])//)
720 Displays the ten biggest files (long and human readable output format).
722 : **lsd** (//ls -d *(/)//)
725 : **lse** (//ls -d *(/^F)//)
726 Shows empty directories.
728 : **lsl** (//ls -l *(@)//)
729 Lists symbolic links in current directory.
731 : **lsnew** (//ls -rl *(D.om[1,10])//)
732 Displays the ten newest files (long output format).
734 : **lsold** (//ls -rtlh *(D.om[1,10])//)
735 Displays the ten oldest files (long output format).
737 : **lss** (//ls -l *(s,S,t)//)
738 Lists files in current directory that have the setuid, setgid or sticky bit
741 : **lssmall** (//ls -Srl *(.oL[1,10])//)
742 Displays the ten smallest files (long output format).
744 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
745 Displays all files which are world readable and/or world writable and/or
746 world executable (long output format).
748 : **lsx** (//ls -l *(*)//)
749 Lists only executable files.
751 : **md** (//mkdir -p//)
752 Creates directory including parent directories, if necessary
754 : **medium** (//echo -en [ escape sequence ]//)
755 Sets medium sized font
756 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
757 using escape sequence.
759 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
760 If invoking user is root, starts screen session with /etc/grml/screenrc
761 as config file. If invoked by a regular user, start a screen session
762 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
765 : **rw-** (//chmod 600//)
766 Grants read and write permission of a file to the owner and nobody else.
768 : **rwx** (//chmod 700//)
769 Grants read, write and execute permission of a file to the owner and nobody
772 : **r--** (//chmod 644//)
773 Grants read and write permission of a file to the owner and read-only to
776 : **r-x** (//chmod 755//)
777 Grants read, write and execute permission of a file to the owner and
778 read-only plus execute permission to anybody else.
780 : **semifont** (//echo -en [ escape sequence ]//)
781 Sets font of xterm to
782 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
785 : **small** (//echo -en [ escape sequence ]//)
786 Sets small xterm font ("6x10") using escape sequence.
788 : **smartfont** (//echo -en [ escape sequence ]//)
789 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
792 : **su** (//sudo su//)
793 If user is running a grml live-CD, dont ask for any password, if she
796 : **tiny** (//echo -en [ escape sequence ]//)
798 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
801 : **truec** (//truecrypt [ mount options ]//)
802 Mount a truecrypt volume with some reasonable mount options
803 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
806 : **up** (//aptitude update ; aptitude safe-upgrade//)
807 Performs a system update followed by a system upgrade using aptitude; run
808 by sudo, if necessary. See au and ag above.
810 : **?** (//qma zshall//)
811 Runs the grml script qma (quick manual access) to build the collected man
812 pages for the z-shell. This compressed file is kept at
813 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
814 fast. See "man qma" for further information.
818 This is a set of files, that - if they exist - can be used to customize the
819 behaviour of //grmlzshrc//.
822 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
823 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
826 # show battery status in RPROMPT
828 # always load the complete setup, even for root
829 GRML_ALWAYS_LOAD_ALL=1
833 Sourced right before loading //grmlzshrc// is finished. There is a global
834 version of this file (/etc/zsh/zshrc.local) which is sourced before the
838 Directory listing for persistent dirstack (see above).
840 : **.important_commands**
841 List of commands, used by persistent history (see above).
844 = INSTALLATION ON NON-DEBIAN SYSTEMS =
845 On Debian systems (http://www.debian.org) - and possibly Ubuntu
846 (http://www.ubuntu.com) and similar systems - it is very easy to get
847 //grmlzshrc// via grml's .deb repositories.
849 On non-debian systems, that is not an option, but all is not lost:
852 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
855 If you would also like to get seperate function files (which you can put into
856 your **$fpath**), you can browse and download them at:
858 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
861 If you read //grmlzshrc//'s code you may notice strange looking comments in
862 it. These are there for a purpose. grml's zsh-refcard is automatically
863 generated from the contents of the actual configuration file. However, we need
864 a little extra information on which comments and what lines of code to take
865 into account (and for what purpose).
867 Here is what they mean:
869 List of tags (comment types) used:
871 Next line contains an important alias, that should be included in the
872 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
875 Next line contains the beginning of an important function. (placement
876 tag: @@INSERT-functions@@)
879 Next line contains an important variable. (placement tag:
880 @@INSERT-variables@@)
883 Next line contains an important keybinding. (placement tag:
884 @@INSERT-keybindings@@)
887 Hashed directories list generation: //start//: denotes the start of a list of
888 'hash -d' definitions. //end//: denotes its end. (placement tag:
889 @@INSERT-hasheddirs@@)
892 Abbreviation expansion list generation: //start//: denotes the beginning of
893 abbreviations. //end//: denotes their end.
895 Lines within this section that end in '#d .*' provide extra documentation to
896 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
899 This tag allows you to manually generate refcard entries for code lines that
900 are hard/impossible to parse.
904 #m# k ESC-h Call the run-help function
907 That would add a refcard entry in the keybindings table for 'ESC-h' with the
910 So the syntax is: #m# <section> <argument> <comment>
913 This tag lets you insert entries to the 'other' hash. Generally, this should
914 not be used. It is there for things that cannot be done easily in another way.
915 (placement tag: @@INSERT-other-foobar@@)
918 All of these tags (except for m and o) take two arguments, the first
919 within the tag, the other after the tag:
921 #<tag><section># <comment>
923 Where <section> is really just a number, which are defined by the @secmap
924 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
925 that for the reader, the tag should not differ much from a regular comment.
926 For zsh, it is a regular comment indeed. The numbers have got the following
951 So, the following will add an entry to the 'functions' table in the 'system'
952 section, with a (hopefully) descriptive comment:
955 #f1# Edit an alias via zle
959 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
960 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
961 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
962 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
963 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
967 If you want to help to improve grml's zsh setup, clone the grml-etc-core
968 repository from git.grml.org:
970 ``` % git clone git://git.grml.org/grml-etc-core.git
972 Make your changes, commit them; use '**git format-patch**' to create a series
973 of patches and send those to the following address via '**git send-email**':
975 ``` grml-etc-core@grml.org
977 Doing so makes sure the right people get your patches for review and
982 This manual page is supposed to be a **reference** manual for //grmlzshrc//.
983 That means that in contrast to the existing refcard it should document **every**
984 aspect of the setup. That is currently **not** the case. Not for a long time
985 yet. Contributions are highly welcome.
989 This manpage was written by Frank Terbeck <ft@grml.org> and Joerg Woelke
994 Copyright (c) 2009, grml project <http://grml.org>
996 This manpage is distributed under the terms of the GPL version 2.
998 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
999 except for **accept-line()** and **vcs_info()**, which are distributed under
1000 the same conditions as zsh itself (which is BSD-like).