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 options, //grmlzshrc// sets some options
234 that change the behaviour of zsh. Options that change Z-shell's default
235 settings are marked by <grml>. But note, that zsh's defaults vary depending
236 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
239 Zsh sessions, that use //grmlzshrc//, will append their history list to the
240 history file, rather than replace it. Thus, multiple parallel zsh sessions
241 will all have the new entries from their history lists added to the history
242 file, in the order that they exit. The file will still be periodically
243 re-written to trim it when the number of lines grows 20% beyond the value
244 specified by $SAVEHIST.
247 If a command is issued that can't be executed as a normal command, and the
248 command is the name of a directory, perform the cd command to that directory.
250 : **auto_pushd** <grml>
251 Make cd push the old directory onto the directory stack.
253 : **completeinword** <grml>
254 If the cursor is inside a word, completion is done from both ends;
255 instead of moving the cursor to the end of the word first and starting
258 : **extended_glob** <grml>
259 Treat the '#', '~' and '^' characters as active globbing pattern characters.
261 : **extended_history** <grml>
262 Save each command's beginning timestamp (in seconds since the epoch) and the
263 duration (in seconds) to the history file.
266 Whenever a command completion is attempted, make sure the entire command
267 path is hashed first. This makes the first completion slower.
269 : **histignorealldups** <grml>
270 If a new command line being added to the history list duplicates an
271 older one, the older command is removed from the list, even if it is
272 not the previous event.
274 : **histignorespace** <grml>
275 Remove command lines from the history list when the first character on
276 the line is a space, or when one of the expanded aliases contains a
277 leading space. Note that the command lingers in the internal history
278 until the next command is entered before it vanishes.
280 : **longlistjobs** <grml>
281 List jobs in long format by default.
284 Avoid to beep on errors in zsh command line editing (zle).
287 A wildcard character never matches a leading '.'.
290 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
292 : **nonomatch** <grml>
293 If a pattern for filename generation has no matches, do not print an error
294 and leave it unchanged in the argument list. This also applies to file
295 expansion of an initial `~' or `='.
298 Report the status of background jobs immediately, rather than waiting until
299 just before printing a prompt.
301 : **pushd_ignore_dups** <grml>
302 Don't push multiple copies of the same directory onto the directory stack.
304 : **share_history** <grml>
305 As each line is added to the history file, it is checked to see if anything
306 else was written out by another shell, and if so it is included in the
307 history of the current shell too. Using !-style history, the commands from
308 the other sessions will not appear in the history list unless you explicitly
309 type the "history" command. This option is activated for zsh versions >= 4,
314 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
315 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
319 Edit the current command buffer in your favourite editor.
322 Deletes a word left of the cursor; seeing '/' as additional word separator.
325 Jump right after the first word.
328 Searches the last occurence of string before the cursor in the command history.
331 Brings a job, which got suspended with CTRL-z back to foreground.
334 == SHELL FUNCTIONS ==
335 //grmlzshrc// comes with a wide array of defined shell functions to ease the
339 Converts plaintext files to HTML using vim. The output is written to
342 : **855resolution()**
343 If 915resolution is available, issues a warning to the user to run it instead
344 to modify the resolution on intel graphics chipsets.
347 Searches for USENET postings from authors using google groups.
350 Sets all ulimit values to "unlimited".
353 Prints a colored table of available ansi color codes (to be used in escape
354 sequences) and the colors they represent.
356 : **aoeu(), asdf(), uiae()**
357 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
361 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
362 Then prompts the user if she wants to remove that directory. You might need
363 to tell audioburn which cdrom device to use like:
364 "DEVICE=/dev/cdrom audioburn"
367 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
368 it. Then prompts the user if she wants to burn a audio CD with audioburn()
369 (see above). You might need to tell audiorip which cdrom device to use like:
370 "DEVICE=/dev/cdrom audioburn"
373 Simple backup of a file or directory using cp(1). The target file name is the
374 original name plus a time stamp attached. Symlinks and file attributes like mode,
375 ownership and timestamps are preserved.
378 The brltty(1) program provides a braille display, so a blind person can access
379 the console screen. This wrapper function works around problems with some
380 environments (f. e. utf8).
383 If the original cdrecord is not installed, issues a warning to the user to
384 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
388 Returns true if given command exists either as program, function, alias,
389 builtin or reserved word. If the option -c is given, only returns true,
390 if command is a program.
393 Changes directory to $HOME on first invocation of zsh. This is neccessary on
394 grml systems with autologin.
397 Changes current directory to the one supplied by argument and lists the files
398 in it, including file names starting with ".".
401 Presents a numbered listing of the directory stack. Then changes current
402 working directory to the one chosen by the user.
405 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
406 email addresses of submitters or any string given on the command line.
409 Shows bug report for debian given by number in mailbox format.
412 Tells the user to use grml-debootstrap, if she wants to install debian to
416 Shows the disk usage of the directories given in human readable format;
420 Translates C source code to assembly and ouputs both.
423 Takes packagename as argument. Sets current working directory to
424 /usr/share/doc/<packagename> and prints out a directory listing.
427 Renames image files based on date/time informations in their exif headers.
430 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
431 instance of firefox running, attaches to the first window found and opens the
432 URL in a new tab (this even works across an ssh session).
434 : **fluxkey-change()**
435 Switches the key combinations for changing current workspace under fluxbox(1)
436 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
437 Requires the window manager to reread configuration to take effect.
440 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
441 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
442 filename>". Creates an index.html with title "Images" showing the
443 thumbnails as clickable links to the respective original file.
444 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
445 and all files and/or directories beginning with "thumb-" in current directory!
448 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
451 Tries to download and install Gizmo (VoIP software) for Debian.
454 Tries to download and install Skype (VoIP software) for Debian.
457 Downloads and installs newer version of Skype.
460 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
464 Opens a specific git commitdiff from kernel.org in default browser. Tree is
465 chosen by the environment variable GITTREE which defaults to Linus Torvalds'
468 : **git-get-commit()**
469 Opens a specific git commit from kernel.org in default browser. The tree to
470 fetch from is controlled by the environment variable GITTREE which defaults
471 to Linus Torvalds' kernel tree.
473 : **git-get-plaindiff()**
474 Fetches specific git diff from kernel.org. The tree is controlled by the
475 environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
478 Searches the zsh command history for a regular expression.
481 Prints the hexadecimal representation of the number supplied as argument
485 Outputs highlighted diff; needs highstring(1).
488 Shows source files in less(1) with syntax highlighting. Run "hl -h"
489 for detailed usage information.
492 Queries IMAP server (first parameter) for its capabilities. Takes
493 port number as optional second argument.
496 Returns true, if zsh version is equal or greater than 4, else false.
499 Returns true, if zsh version is equal or greater than 4.1, else false.
502 Returns true, if zsh version is equal or greater than 4.2, else false.
505 Returns true, if zsh version is equal or greater than 4.2.5, else false.
508 Returns true, if zsh version is equal or greater than 4.3, else false.
511 Returns true, if zsh version is equal or greater than 4.3.3, else false.
514 Returns true, if running on darwin, else false.
517 Returns true, if running on a grml system, else false.
520 Returns true, if running on a grml system from a live cd, else false.
523 Returns true, if run on grml-small, else false.
526 Changes every occurrence of the string iso885915 or ISO885915 in
527 environment variables to UTF-8.
530 Returns true, if run within an utf environment, else false.
533 Lists libraries that define the symbol containing the string given as
537 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
541 Creates a PostScript and a PDF file (basename as first argument) from
545 Displays manpage in a streched style.
548 Creates directory including parent directories, if necessary. Then changes
549 current working directory to it.
552 Diffs the two arguments recursively and writes the
553 output (unified format) to a timestamped file.
556 Prints the summarized memory usage in bytes.
558 : **minimal-shell()**
559 Spawns a absolute minimal Korn shell. It references no files in /usr, so
560 that file system can be unmounted.
563 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
564 replaces spaces in file names with underscores. Then mkaudiocd()
565 normalizes the files and recodes them to WAV.
568 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
569 enabled using mkisofs(8). Prompts the user for volume name, filename and
573 Creates a directory with first parameter as name inside $MAILDIR_ROOT
574 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
577 Runs "make install" and logs the output under ~/.errorlogs/; useful for
578 a clean deinstall later.
581 Lists files in current directory, which have been modified within the
582 last N days. N is an integer required as first and only argument.
585 Recodes an ogg file to mp3 with a bitrate of 192.
588 Evaluates a perl expression; useful as command line
589 calculator, therefore also available as "calc".
592 Lists all occurrences of the string given as argument in current $PATH.
595 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
596 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
597 Asks for confirmation.
600 Opens all README-like files in current working directory with the program
601 defined in the $PAGER environment variable.
604 Reloads functions given as parameters.
607 Checks whether a regular expression (first parameter) matches a string
608 (second parameter) using perl.
611 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
612 for details. See also xunfunction() below.
615 Greps the history for the string provided as parameter and shows the numbered
616 findings in default pager. On exit of the pager the user is prompted for a
617 number. The shells readline buffer is then filled with the corresponding
621 Lists the contents of a (compressed) archive with the appropriate programs.
622 The choice is made along the filename extension.
625 Lists the content of a gzipped tar archive in default pager.
628 Shows the content of a zip archive in default pager.
630 : **simple-extract()**
631 Tries to uncompress/unpack given file with the appropriate programs. The
632 choice is made along the filename ending.
635 Prints the arguments slowly by sleeping 0.08 seconds between each character.
637 : **smartcompress()**
638 Compresses/archives the file given as first parameter. Takes an optional
639 second argument, which denotes the compression/archive type as typical
640 filename extension; defaults to "tar.gz".
643 Indents C source code files given; uses Kernighan & Ritchie style.
646 Creates directory named shots in user's home directory, if it does not yet
647 exist and changes current working directory to it. Then sleeps 5 seconds,
648 so you have plenty of time to switch desktops/windows. Then makes a screenshot
649 of the current desktop. The result is stored in ~/shots to a timestamped
653 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
654 issues a Warning to use the grml-x(1) script. Can be overridden by using
655 /usr/bin/startx directly.
658 Shows some information about current system status.
661 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
662 swspeak must be set for this to work.
665 Translates a word from german to english (-D) or vice versa (-E).
668 Makes a unified diff of the command line arguments trying hard to find a
669 smaller set of changes. Descends recursively into subdirectories. Ignores
670 hows some information about current status.
673 Downloads and displays a file using a suitable program for its
677 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
680 Takes a string as its first argument and prints it RFC 2396 URL encoded to
684 Changes every occurrence of the string UTF-8 or utf-8 in environment
685 variables to iso885915.
691 Wrapper for vim(1). It tries to set the title and hands vim the environment
692 variable VIM_OPTIONS on the command line. So the user may define command
693 line options, she always wants, in her .zshrc.local.
696 Use vim(1) as manpage reader.
699 Tries to cat(1) file(s) given as parameter(s). Always returns true.
700 See also xunfunction() below.
703 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
704 issues a Warning to use the grml-x(1) script. Can be overridden by using
705 /usr/bin/xinit directly.
708 Tries to source the file(s) given as parameter(s). Always returns true.
709 See zshbuiltins(1) for a detailed description of the source command.
710 See also xunfunction() below.
713 Changes the title of xterm window from within screen(1). Run without
714 arguments for details.
717 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
720 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
721 option plus a non empty pattern. Run zg without any arguments for a listing
722 of available command line switches. For a zshrc not in /etc/zsh, set the
723 GRML_ZSHRC environment variable.
726 Wrapper around the autoload builtin. Loads the definitions of functions
727 from the file given as argument. Searches $fpath for the file. See also
731 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
732 where own modifications should go. See also zshbuiltins(1) for a description
733 of the source command.
737 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
738 life. A few aliases (like those involving //grep// or //ls//) use the option
739 //--color=auto// for colourizing output. That option is part of **GNU**
740 implementations of these tools, and will only be used if such an implementation
743 : **acp** (//apt-cache policy//)
744 With no arguments prints out the priorities of each source. If a package name
745 is given, it displays detailed information about the priority selection of the
748 : **acs** (//apt-cache search//)
749 Searches debian package lists for the regular expression provided as argument.
750 The search includes package names and descriptions. Prints out name and short
751 description of matching packages.
753 : **acsh** (//apt-cache show//)
754 Shows the package records for the packages provided as arguments.
756 : **adg** (//apt-get dist-upgrade//)
757 Performs an upgrade of all installed packages. Also tries to automatically
758 handle changing dependencies with new versions of packages. As this may change
759 the install status of (or even remove) installed packages, it is potentially
760 dangerous to use dist-upgrade; invoked by sudo, if necessary.
762 : **ag** (//apt-get upgrade//)
763 Downloads and installs the newest versions of all packages currently installed
764 on the system. Under no circumstances are currently installed packages removed,
765 or packages not already installed retrieved and installed. New versions of
766 currently installed packages that cannot be upgraded without changing the install
767 status of another package will be left at their current version. An update must
768 be performed first (see au below); run by sudo, if necessary.
770 : **agi** (//apt-get install//)
771 Downloads and installs or upgrades the packages given on the command line.
772 If a hyphen is appended to the package name, the identified package will be
773 removed if it is installed. Similarly a plus sign can be used to designate a
774 package to install. This may be useful to override decisions made by apt-get's
775 conflict resolution system.
776 A specific version of a package can be selected for installation by following
777 the package name with an equals and the version of the package to select. This
778 will cause that version to be located and selected for install. Alternatively a
779 specific distribution can be selected by following the package name with a slash
780 and the version of the distribution or the Archive name (stable, testing, unstable).
781 Gets invoked by sudo, if user id is not 0.
783 : **ati** (//aptitude install//)
784 Aptitude is a terminal-based package manager with a command line mode similar to
785 apt-get (see agi above); invoked by sudo, if necessary.
787 : **au** (//apt-get update//)
788 Resynchronizes the package index files from their sources. The indexes of
789 available packages are fetched from the location(s) specified in
790 /etc/apt/sources.list. An update should always be performed before an
791 upgrade or dist-upgrade; run by sudo, if necessary.
793 : **calc** (//peval//)
794 Evaluates a perl expression (see peval() above); useful as a command line
797 : **CH** (//./configure --help//)
798 Lists available compilation options for building program from source.
800 : **cmplayer** (//mplayer -vo fbdev//)
801 Video player with framebuffer as video output device, so you can watch
802 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
803 while watching a movie.
805 : **CO** (//./configure//)
806 Prepares compilation for building program from source.
808 : **da** (//du -sch//)
809 Prints the summarized disk usage of the arguments as well as a grand total
810 in human readable format.
812 : **default** (//echo -en [ escape sequence ]//)
813 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
814 using escape sequence.
816 : **dir** (//ls -lSrah//)
817 Lists files (including dot files) sorted by size (biggest last) in long and
818 human readable output format.
820 : **fblinks** (//links2 -driver fb//)
821 A Web browser on the framebuffer device. So you can browse images and click
822 links on the virtual tty.
824 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
825 Fullscreen Video player with the framebuffer as video output device. So you
826 can watch videos on a virtual tty.
829 Revision control system by Linus Torvalds.
831 : **grep** (//grep --color=auto//)
832 Shows grep output in nice colors, if available.
834 : **GREP** (//grep -i --color=auto//)
835 Case insensitive grep with colored output.
837 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
838 Scans for new devices and updates /etc/fstab according to the findings.
840 : **grml-version** (//cat /etc/grml_version//)
841 Prints version of running grml.
843 : **http** (//python -m SimpleHTTPServer//)
844 Basic HTTP server implemented in python. Listens on port 8000/tcp and
845 serves current directory. Implements GET and HEAD methods.
847 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
848 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
849 host key changes frequently, for example on virtualized test- or development-systems.
850 To be used only inside trusted networks, of course.
852 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
853 ssh with possible man-in-the-middle attack enabled
854 (for an explanation see insecscp above).
856 : **help-zshglob** (//H-Glob()//)
857 Runs the function H-Glob() to expand or explain wildcards.
859 : **hide** (//echo -en [ escape sequence ]//)
860 Tries to hide xterm window using escape sequence.
862 : **huge** (//echo -en [ escape sequence ]//)
863 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
864 using escape sequence.
866 : **j** (//jobs -l//)
867 Prints status of jobs in the current shell session in long format.
869 : **l** (//ls -lF --color=auto//)
870 Lists files in long output format with indicator for filetype appended
871 to filename. If the terminal supports it, with colored output.
873 : **la** (//ls -la --color=auto//)
874 Lists files in long colored output format. Including file names
877 : **lad** (//ls -d .*(/)//)
878 Lists the dot directories (not their contents) in current directory.
880 : **large** (//echo -en [ escape sequence ]//)
881 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
882 using escape sequence.
884 : **lh** (//ls -hAl --color=auto//)
885 Lists files in long and human readable output format in nice colors,
886 if available. Includes file names starting with "." except "." and
889 : **ll** (//ls -l --color=auto//)
890 Lists files in long colored output format.
892 : **ls** (//ls -b -CF --color=auto//)
893 Lists directory printing octal escapes for nongraphic characters.
894 Entries are listed by columns and an indicator for file type is appended
895 to each file name. Additionally the output is colored, if the terminal
898 : **lsa** (//ls -a .*(.)//)
899 Lists dot files in current working directory.
901 : **lsbig** (//ls -flh *(.OL[1,10])//)
902 Displays the ten biggest files (long and human readable output format).
904 : **lsd** (//ls -d *(/)//)
907 : **lse** (//ls -d *(/^F)//)
908 Shows empty directories.
910 : **lsl** (//ls -l *(@)//)
911 Lists symbolic links in current directory.
913 : **lsnew** (//ls -rl *(D.om[1,10])//)
914 Displays the ten newest files (long output format).
916 : **lsold** (//ls -rtlh *(D.om[1,10])//)
917 Displays the ten oldest files (long output format).
919 : **lss** (//ls -l *(s,S,t)//)
920 Lists files in current directory that have the setuid, setgid or sticky bit
923 : **lssmall** (//ls -Srl *(.oL[1,10])//)
924 Displays the ten smallest files (long output format).
926 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
927 Displays all files which are world readable and/or world writable and/or
928 world executable (long output format).
930 : **lsx** (//ls -l *(*)//)
931 Lists only executable files.
933 : **md** (//mkdir -p//)
934 Creates directory including parent directories, if necessary
936 : **medium** (//echo -en [ escape sequence ]//)
937 Sets medium sized font
938 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
939 using escape sequence.
941 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
942 If invoking user is root, starts screen session with /etc/grml/screenrc
943 as config file. If invoked by a regular user, start a screen session
944 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
947 : **rw-** (//chmod 600//)
948 Grants read and write permission of a file to the owner and nobody else.
950 : **rwx** (//chmod 700//)
951 Grants read, write and execute permission of a file to the owner and nobody
954 : **r--** (//chmod 644//)
955 Grants read and write permission of a file to the owner and read-only to
958 : **r-x** (//chmod 755//)
959 Grants read, write and execute permission of a file to the owner and
960 read-only plus execute permission to anybody else.
962 : **semifont** (//echo -en [ escape sequence ]//)
963 Sets font of xterm to
964 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
967 : **small** (//echo -en [ escape sequence ]//)
968 Sets small xterm font ("6x10") using escape sequence.
970 : **smartfont** (//echo -en [ escape sequence ]//)
971 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
974 : **su** (//sudo su//)
975 If user is running a grml live-CD, dont ask for any password, if she
978 : **tiny** (//echo -en [ escape sequence ]//)
980 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
983 : **truec** (//truecrypt [ mount options ]//)
984 Mount a truecrypt volume with some reasonable mount options
985 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
988 : **up** (//aptitude update ; aptitude safe-upgrade//)
989 Performs a system update followed by a system upgrade using aptitude; run
990 by sudo, if necessary. See au and ag above.
992 : **?** (//qma zshall//)
993 Runs the grml script qma (quick manual access) to build the collected man
994 pages for the z-shell. This compressed file is kept at
995 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
996 fast. See "man qma" for further information.
1000 This is a set of files, that - if they exist - can be used to customize the
1001 behaviour of //grmlzshrc//.
1004 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1005 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1008 # show battery status in RPROMPT
1010 # always load the complete setup, even for root
1011 GRML_ALWAYS_LOAD_ALL=1
1015 Sourced right before loading //grmlzshrc// is finished. There is a global
1016 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1020 Directory listing for persistent dirstack (see above).
1022 : **.important_commands**
1023 List of commands, used by persistent history (see above).
1026 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1027 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1028 (http://www.ubuntu.com) and similar systems - it is very easy to get
1029 //grmlzshrc// via grml's .deb repositories.
1031 On non-debian systems, that is not an option, but all is not lost:
1034 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1037 If you would also like to get seperate function files (which you can put into
1038 your **$fpath**), you can browse and download them at:
1040 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1042 = ZSH REFCARD TAGS =
1043 If you read //grmlzshrc//'s code you may notice strange looking comments in
1044 it. These are there for a purpose. grml's zsh-refcard is automatically
1045 generated from the contents of the actual configuration file. However, we need
1046 a little extra information on which comments and what lines of code to take
1047 into account (and for what purpose).
1049 Here is what they mean:
1051 List of tags (comment types) used:
1053 Next line contains an important alias, that should be included in the
1054 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1057 Next line contains the beginning of an important function. (placement
1058 tag: @@INSERT-functions@@)
1061 Next line contains an important variable. (placement tag:
1062 @@INSERT-variables@@)
1065 Next line contains an important keybinding. (placement tag:
1066 @@INSERT-keybindings@@)
1069 Hashed directories list generation: //start//: denotes the start of a list of
1070 'hash -d' definitions. //end//: denotes its end. (placement tag:
1071 @@INSERT-hasheddirs@@)
1074 Abbreviation expansion list generation: //start//: denotes the beginning of
1075 abbreviations. //end//: denotes their end.
1077 Lines within this section that end in '#d .*' provide extra documentation to
1078 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1081 This tag allows you to manually generate refcard entries for code lines that
1082 are hard/impossible to parse.
1086 #m# k ESC-h Call the run-help function
1089 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1092 So the syntax is: #m# <section> <argument> <comment>
1095 This tag lets you insert entries to the 'other' hash. Generally, this should
1096 not be used. It is there for things that cannot be done easily in another way.
1097 (placement tag: @@INSERT-other-foobar@@)
1100 All of these tags (except for m and o) take two arguments, the first
1101 within the tag, the other after the tag:
1103 #<tag><section># <comment>
1105 Where <section> is really just a number, which are defined by the @secmap
1106 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1107 that for the reader, the tag should not differ much from a regular comment.
1108 For zsh, it is a regular comment indeed. The numbers have got the following
1133 So, the following will add an entry to the 'functions' table in the 'system'
1134 section, with a (hopefully) descriptive comment:
1137 #f1# Edit an alias via zle
1141 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1142 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1143 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1144 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1145 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1149 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1150 repository from git.grml.org:
1152 ``` % git clone git://git.grml.org/grml-etc-core.git
1154 Make your changes, commit them; use '**git format-patch**' to create a series
1155 of patches and send those to the following address via '**git send-email**':
1157 ``` grml-etc-core@grml.org
1159 Doing so makes sure the right people get your patches for review and
1164 This manual page is supposed to be a **reference** manual for //grmlzshrc//.
1165 That means that in contrast to the existing refcard it should document **every**
1166 aspect of the setup. That is currently **not** the case. Not for a long time
1167 yet. Contributions are highly welcome.
1171 This manpage was written by Frank Terbeck <ft@grml.org> and Joerg Woelke
1176 Copyright (c) 2009, grml project <http://grml.org>
1178 This manpage is distributed under the terms of the GPL version 2.
1180 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1181 except for **accept-line()** and **vcs_info()**, which are distributed under
1182 the same conditions as zsh itself (which is BSD-like).