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 Searches for USENET postings from authors using google groups.
249 : **aoeu(), asdf(), uiae()**
250 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
254 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
255 Then prompts the user if she wants to remove that directory. You might need
256 to tell audioburn which cdrom device to use like:
257 "DEVICE=/dev/cdrom audioburn"
260 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
261 it. Then prompts the user if she wants to burn a audio CD with audioburn()
262 (see above). You might need to tell audiorip which cdrom device to use like:
263 "DEVICE=/dev/cdrom audioburn"
266 Simple backup of a file or directory using cp(1). The target file name is the
267 original name plus a time stamp attached. Symlinks and file attributes like mode,
268 ownership and timestamps are preserved.
271 The brltty(1) program provides a braille display, so a blind person can access
272 the console screen. This wrapper function works around problems with some
273 environments (f. e. utf8).
276 Changes current directory to the one supplied by argument and lists the files
277 in it, including file names starting with ".".
280 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
281 email addresses of submitters or any string given on the command line.
284 Shows bug report for debian given by number in mailbox format.
287 Takes packagename as argument. Sets current working directory to
288 /usr/share/doc/<packagename> and prints out a directory listing.
290 : **fluxkey-change()**
291 Switches the key combinations for changing current workspace under fluxbox(1)
292 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
293 Requires the window manager to reread configuration to take effect.
296 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
297 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
298 filename>". Creates an index.html with title "Images" showing the
299 thumbnails as clickable links to the respective original file.
300 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
301 and all files and/or directories beginning with "thumb-" in current directory!
304 Searches the zsh command history for a regular expression.
307 Prints the hexadecimal representation of the number supplied as argument
311 Returns true, if zsh version is equal or greater than 4, else false.
314 Returns true, if zsh version is equal or greater than 4.1, else false.
317 Returns true, if zsh version is equal or greater than 4.2, else false.
320 Returns true, if zsh version is equal or greater than 4.2.5, else false.
323 Returns true, if zsh version is equal or greater than 4.3, else false.
326 Returns true, if zsh version is equal or greater than 4.3.3, else false.
329 Returns true, if running on darwin, else false.
332 Returns true, if running on a grml system, else false.
335 Returns true, if running on a grml system from a live cd, else false.
338 Returns true, if run on grml-small, else false.
341 Returns true, if run within an utf environment, else false.
344 Lists libraries that define the symbol containing the string given as
348 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
352 Creates directory including parent directories, if necessary. Then changes
353 current working directory to it.
355 : **minimal-shell()**
356 Spawns a absolute minimal Korn shell. It references no files in /usr, so
357 that file system can be unmounted.
360 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
361 enabled using mkisofs(8). Prompts the user for volume name, filename and
365 Evaluates a perl expression; useful as command line
366 calculator, therefore also available as "calc".
369 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
370 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
371 Asks for confirmation.
374 Opens all README-like files in current working directory with the program
375 defined in the $PAGER environment variable.
378 Checks whether a regular expression (first parameter) matches a string
379 (second parameter) using perl.
382 Lists the content of a gzipped tar archive in default pager.
385 Shows the content of a zip archive in default pager.
388 Prints the arguments slowly by sleeping 0.08 seconds between each character.
391 Creates directory named shots in user's home directory, if it does not yet
392 exist and changes current working directory to it. Then sleeps 5 seconds,
393 so you have plenty of time to switch desktops/windows. Then makes a screenshot
394 of the current desktop. The result is stored in ~/shots to a timestamped
398 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
399 issues a Warning to use the grml-x(1) script. Can be overridden by using
400 /usr/bin/startx directly.
403 Shows some information about current system status.
406 Makes a unified diff of the command line arguments trying hard to find a
407 smaller set of changes. Descends recursively into subdirectories. Ignores
408 hows some information about current status.
411 Takes a string as its first argument and prints it RFC 2396 URL encoded to
418 Wrapper for vim(1). It tries to set the title and hands vim the environment
419 variable VIM_OPTIONS on the command line. So the user may define command
420 line options, she always wants, in her .zshrc.local.
423 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
424 issues a Warning to use the grml-x(1) script. Can be overridden by using
425 /usr/bin/xinit directly.
428 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
429 option plus a non empty pattern. Run zg without any arguments for a listing
430 of available command line switches. For a zshrc not in /etc/zsh, set the
431 GRML_ZSHRC environment variable.
435 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
436 life. A few aliases (like those involving //grep// or //ls//) use the option
437 //--color=auto// for colourizing output. That option is part of **GNU**
438 implementations of these tools, and will only be used if such an implementation
441 : **acp** (//apt-cache policy//)
442 With no arguments prints out the priorities of each source. If a package name
443 is given, it displays detailed information about the priority selection of the
446 : **acs** (//apt-cache search//)
447 Searches debian package lists for the regular expression provided as argument.
448 The search includes package names and descriptions. Prints out name and short
449 description of matching packages.
451 : **acsh** (//apt-cache show//)
452 Shows the package records for the packages provided as arguments.
454 : **adg** (//apt-get dist-upgrade//)
455 Performs an upgrade of all installed packages. Also tries to automatically
456 handle changing dependencies with new versions of packages. As this may change
457 the install status of (or even remove) installed packages, it is potentially
458 dangerous to use dist-upgrade; invoked by sudo, if necessary.
460 : **ag** (//apt-get upgrade//)
461 Downloads and installs the newest versions of all packages currently installed
462 on the system. Under no circumstances are currently installed packages removed,
463 or packages not already installed retrieved and installed. New versions of
464 currently installed packages that cannot be upgraded without changing the install
465 status of another package will be left at their current version. An update must
466 be performed first (see au below); run by sudo, if necessary.
468 : **agi** (//apt-get install//)
469 Downloads and installs or upgrades the packages given on the command line.
470 If a hyphen is appended to the package name, the identified package will be
471 removed if it is installed. Similarly a plus sign can be used to designate a
472 package to install. This may be useful to override decisions made by apt-get's
473 conflict resolution system.
474 A specific version of a package can be selected for installation by following
475 the package name with an equals and the version of the package to select. This
476 will cause that version to be located and selected for install. Alternatively a
477 specific distribution can be selected by following the package name with a slash
478 and the version of the distribution or the Archive name (stable, testing, unstable).
479 Gets invoked by sudo, if user id is not 0.
481 : **ati** (//aptitude install//)
482 Aptitude is a terminal-based package manager with a command line mode similar to
483 apt-get (see agi above); invoked by sudo, if necessary.
485 : **au** (//apt-get update//)
486 Resynchronizes the package index files from their sources. The indexes of
487 available packages are fetched from the location(s) specified in
488 /etc/apt/sources.list. An update should always be performed before an
489 upgrade or dist-upgrade; run by sudo, if necessary.
491 : **calc** (//peval//)
492 Evaluates a perl expression (see peval() above); useful as a command line
495 : **CH** (//./configure --help//)
496 Lists available compilation options for building program from source.
498 : **cmplayer** (//mplayer -vo fbdev//)
499 Video player with framebuffer as video output device, so you can watch
500 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
501 while watching a movie.
503 : **CO** (//./configure//)
504 Prepares compilation for building program from source.
506 : **da** (//du -sch//)
507 Prints the summarized disk usage of the arguments as well as a grand total
508 in human readable format.
510 : **default** (//echo -en [ escape sequence ]//)
511 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
512 using escape sequence.
514 : **dir** (//ls -lSrah//)
515 Lists files (including dot files) sorted by size (biggest last) in long and
516 human readable output format.
518 : **fblinks** (//links2 -driver fb//)
519 A Web browser on the framebuffer device. So you can browse images and click
520 links on the virtual tty.
522 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
523 Fullscreen Video player with the framebuffer as video output device. So you
524 can watch videos on a virtual tty.
527 Revision control system by Linus Torvalds.
529 : **grep** (//grep --color=auto//)
530 Shows grep output in nice colors, if available.
532 : **GREP** (//grep -i --color=auto//)
533 Case insensitive grep with colored output.
535 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
536 Scans for new devices and updates /etc/fstab according to the findings.
538 : **grml-version** (//cat /etc/grml_version//)
539 Prints version of running grml.
541 : **http** (//python -m SimpleHTTPServer//)
542 Basic HTTP server implemented in python. Listens on port 8000/tcp and
543 serves current directory. Implements GET and HEAD methods.
545 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
546 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
547 host key changes frequently, for example on virtualized test- or development-systems.
548 To be used only inside trusted networks, of course.
550 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
551 ssh with possible man-in-the-middle attack enabled
552 (for an explanation see insecscp above).
554 : **help-zshglob** (//H-Glob()//)
555 Runs the function H-Glob() to expand or explain wildcards.
557 : **hide** (//echo -en [ escape sequence ]//)
558 Tries to hide xterm window using escape sequence.
560 : **huge** (//echo -en [ escape sequence ]//)
561 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
562 using escape sequence.
564 : **j** (//jobs -l//)
565 Prints status of jobs in the current shell session in long format.
567 : **l** (//ls -lF --color=auto//)
568 Lists files in long output format with indicator for filetype appended
569 to filename. If the terminal supports it, with colored output.
571 : **la** (//ls -la --color=auto//)
572 Lists files in long colored output format. Including file names
575 : **lad** (//ls -d .*(/)//)
576 Lists the dot directories (not their contents) in current directory.
578 : **large** (//echo -en [ escape sequence ]//)
579 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
580 using escape sequence.
582 : **lh** (//ls -hAl --color=auto//)
583 Lists files in long and human readable output format in nice colors,
584 if available. Includes file names starting with "." except "." and
587 : **ll** (//ls -l --color=auto//)
588 Lists files in long colored output format.
590 : **ls** (//ls -b -CF --color=auto//)
591 Lists directory printing octal escapes for nongraphic characters.
592 Entries are listed by columns and an indicator for file type is appended
593 to each file name. Additionally the output is colored, if the terminal
596 : **lsa** (//ls -a .*(.)//)
597 Lists dot files in current working directory.
599 : **lsbig** (//ls -flh *(.OL[1,10])//)
600 Displays the ten biggest files (long and human readable output format).
602 : **lsd** (//ls -d *(/)//)
605 : **lse** (//ls -d *(/^F)//)
606 Shows empty directories.
608 : **lsl** (//ls -l *(@)//)
609 Lists symbolic links in current directory.
611 : **lsnew** (//ls -rl *(D.om[1,10])//)
612 Displays the ten newest files (long output format).
614 : **lsold** (//ls -rtlh *(D.om[1,10])//)
615 Displays the ten oldest files (long output format).
617 : **lss** (//ls -l *(s,S,t)//)
618 Lists files in current directory that have the setuid, setgid or sticky bit
621 : **lssmall** (//ls -Srl *(.oL[1,10])//)
622 Displays the ten smallest files (long output format).
624 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
625 Displays all files which are world readable and/or world writable and/or
626 world executable (long output format).
628 : **lsx** (//ls -l *(*)//)
629 Lists only executable files.
631 : **md** (//mkdir -p//)
632 Creates directory including parent directories, if necessary
634 : **medium** (//echo -en [ escape sequence ]//)
635 Sets medium sized font
636 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
637 using escape sequence.
639 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
640 If invoking user is root, starts screen session with /etc/grml/screenrc
641 as config file. If invoked by a regular user, start a screen session
642 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
645 : **rw-** (//chmod 600//)
646 Grants read and write permission of a file to the owner and nobody else.
648 : **rwx** (//chmod 700//)
649 Grants read, write and execute permission of a file to the owner and nobody
652 : **r--** (//chmod 644//)
653 Grants read and write permission of a file to the owner and read-only to
656 : **r-x** (//chmod 755//)
657 Grants read, write and execute permission of a file to the owner and
658 read-only plus execute permission to anybody else.
660 : **semifont** (//echo -en [ escape sequence ]//)
661 Sets font of xterm to
662 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
665 : **small** (//echo -en [ escape sequence ]//)
666 Sets small xterm font ("6x10") using escape sequence.
668 : **smartfont** (//echo -en [ escape sequence ]//)
669 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
672 : **su** (//sudo su//)
673 If user is running a grml live-CD, dont ask for any password, if she
676 : **tiny** (//echo -en [ escape sequence ]//)
678 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
681 : **truec** (//truecrypt [ mount options ]//)
682 Mount a truecrypt volume with some reasonable mount options
683 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
686 : **up** (//aptitude update ; aptitude safe-upgrade//)
687 Performs a system update followed by a system upgrade using aptitude; run
688 by sudo, if necessary. See au and ag above.
690 : **?** (//qma zshall//)
691 Runs the grml script qma (quick manual access) to build the collected man
692 pages for the z-shell. This compressed file is kept at
693 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
694 fast. See "man qma" for further information.
698 This is a set of files, that - if they exist - can be used to customize the
699 behaviour of //grmlzshrc//.
702 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
703 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
706 # show battery status in RPROMPT
708 # always load the complete setup, even for root
709 GRML_ALWAYS_LOAD_ALL=1
713 Sourced right before loading //grmlzshrc// is finished. There is a global
714 version of this file (/etc/zsh/zshrc.local) which is sourced before the
718 Directory listing for persistent dirstack (see above).
720 : **.important_commands**
721 List of commands, used by persistent history (see above).
724 = INSTALLATION ON NON-DEBIAN SYSTEMS =
725 On Debian systems (http://www.debian.org) - and possibly Ubuntu
726 (http://www.ubuntu.com) and similar systems - it is very easy to get
727 //grmlzshrc// via grml's .deb repositories.
729 On non-debian systems, that is not an option, but all is not lost:
732 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
735 If you would also like to get seperate function files (which you can put into
736 your **$fpath**), you can browse and download them at:
738 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
741 If you read //grmlzshrc//'s code you may notice strange looking comments in
742 it. These are there for a purpose. grml's zsh-refcard is automatically
743 generated from the contents of the actual configuration file. However, we need
744 a little extra information on which comments and what lines of code to take
745 into account (and for what purpose).
747 Here is what they mean:
749 List of tags (comment types) used:
751 Next line contains an important alias, that should be included in the
752 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
755 Next line contains the beginning of an important function. (placement
756 tag: @@INSERT-functions@@)
759 Next line contains an important variable. (placement tag:
760 @@INSERT-variables@@)
763 Next line contains an important keybinding. (placement tag:
764 @@INSERT-keybindings@@)
767 Hashed directories list generation: //start//: denotes the start of a list of
768 'hash -d' definitions. //end//: denotes its end. (placement tag:
769 @@INSERT-hasheddirs@@)
772 Abbreviation expansion list generation: //start//: denotes the beginning of
773 abbreviations. //end//: denotes their end.
775 Lines within this section that end in '#d .*' provide extra documentation to
776 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
779 This tag allows you to manually generate refcard entries for code lines that
780 are hard/impossible to parse.
784 #m# k ESC-h Call the run-help function
787 That would add a refcard entry in the keybindings table for 'ESC-h' with the
790 So the syntax is: #m# <section> <argument> <comment>
793 This tag lets you insert entries to the 'other' hash. Generally, this should
794 not be used. It is there for things that cannot be done easily in another way.
795 (placement tag: @@INSERT-other-foobar@@)
798 All of these tags (except for m and o) take two arguments, the first
799 within the tag, the other after the tag:
801 #<tag><section># <comment>
803 Where <section> is really just a number, which are defined by the @secmap
804 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
805 that for the reader, the tag should not differ much from a regular comment.
806 For zsh, it is a regular comment indeed. The numbers have got the following
831 So, the following will add an entry to the 'functions' table in the 'system'
832 section, with a (hopefully) descriptive comment:
835 #f1# Edit an alias via zle
839 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
840 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
841 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
842 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
843 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
847 If you want to help to improve grml's zsh setup, clone the grml-etc-core
848 repository from git.grml.org:
850 ``` % git clone git://git.grml.org/grml-etc-core.git
852 Make your changes, commit them; use '**git format-patch**' to create a series
853 of patches and send those to the following address via '**git send-email**':
855 ``` grml-etc-core@grml.org
857 Doing so makes sure the right people get your patches for review and
862 This manual page is supposed to be a **reference** manual for //grmlzshrc//.
863 That means that in contrast to the existing refcard it should document **every**
864 aspect of the setup. That is currently **not** the case. Not for a long time
865 yet. Contributions are highly welcome.
869 This manpage was written by Frank Terbeck <ft@grml.org> and Joerg Woelke
874 Copyright (c) 2009, grml project <http://grml.org>
876 This manpage is distributed under the terms of the GPL version 2.
878 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
879 except for **accept-line()** and **vcs_info()**, which are distributed under
880 the same conditions as zsh itself (which is BSD-like).