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 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
402 email addresses of submitters or any string given on the command line.
405 Shows bug report for debian given by number in mailbox format.
408 Tells the user to use grml-debootstrap, if she wants to install debian to
412 Shows the disk usage of the directories given in human readable format;
416 Translates C source code to assembly and ouputs both.
419 Takes packagename as argument. Sets current working directory to
420 /usr/share/doc/<packagename> and prints out a directory listing.
423 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
424 instance of firefox running, attaches to the first window found and opens the
425 URL in a new tab (this even works across an ssh session).
427 : **fluxkey-change()**
428 Switches the key combinations for changing current workspace under fluxbox(1)
429 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
430 Requires the window manager to reread configuration to take effect.
433 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
434 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
435 filename>". Creates an index.html with title "Images" showing the
436 thumbnails as clickable links to the respective original file.
437 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
438 and all files and/or directories beginning with "thumb-" in current directory!
441 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
444 Tries to download and install Gizmo (VoIP software) for Debian.
447 Tries to download and install Skype (VoIP software) for Debian.
450 Downloads and installs newer version of Skype.
453 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
457 Opens a specific git commitdiff from kernel.org in default browser. Tree is
458 chosen by the environment variable GITTREE which defaults to Linus Torvalds'
461 : **git-get-commit()**
462 Opens a specific git commit from kernel.org in default browser. The tree to
463 fetch from is controlled by the environment variable GITTREE which defaults
464 to Linus Torvalds' kernel tree.
466 : **git-get-plaindiff()**
467 Fetches specific git diff from kernel.org. The tree is controlled by the
468 environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
471 Searches the zsh command history for a regular expression.
474 Prints the hexadecimal representation of the number supplied as argument
478 Outputs highlighted diff; needs highstring(1).
481 Returns true, if zsh version is equal or greater than 4, else false.
484 Returns true, if zsh version is equal or greater than 4.1, else false.
487 Returns true, if zsh version is equal or greater than 4.2, else false.
490 Returns true, if zsh version is equal or greater than 4.2.5, else false.
493 Returns true, if zsh version is equal or greater than 4.3, else false.
496 Returns true, if zsh version is equal or greater than 4.3.3, else false.
499 Returns true, if running on darwin, else false.
502 Returns true, if running on a grml system, else false.
505 Returns true, if running on a grml system from a live cd, else false.
508 Returns true, if run on grml-small, else false.
511 Changes every occurrence of the string iso885915 or ISO885915 in
512 environment variables to UTF-8.
515 Returns true, if run within an utf environment, else false.
518 Lists libraries that define the symbol containing the string given as
522 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
526 Creates directory including parent directories, if necessary. Then changes
527 current working directory to it.
529 : **minimal-shell()**
530 Spawns a absolute minimal Korn shell. It references no files in /usr, so
531 that file system can be unmounted.
534 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
535 replaces spaces in file names with underscores. Then mkaudiocd()
536 normalizes the files and recodes them to WAV.
539 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
540 enabled using mkisofs(8). Prompts the user for volume name, filename and
544 Runs "make install" and logs the output under ~/.errorlogs/; useful for
545 a clean deinstall later.
548 Recodes an ogg file to mp3 with a bitrate of 192.
551 Evaluates a perl expression; useful as command line
552 calculator, therefore also available as "calc".
555 Lists all occurrences of the string given as argument in current $PATH.
558 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
559 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
560 Asks for confirmation.
563 Opens all README-like files in current working directory with the program
564 defined in the $PAGER environment variable.
567 Reloads functions given as parameters.
570 Checks whether a regular expression (first parameter) matches a string
571 (second parameter) using perl.
574 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
575 for details. See also xunfunction() below.
578 Greps the history for the string provided as parameter and shows the numbered
579 findings in default pager. On exit of the pager the user is prompted for a
580 number. The shells readline buffer is then filled with the corresponding
584 Lists the contents of a (compressed) archive with the appropriate programs.
585 The choice is made along the filename extension.
588 Lists the content of a gzipped tar archive in default pager.
591 Shows the content of a zip archive in default pager.
593 : **simple-extract()**
594 Tries to uncompress/unpack given file with the appropriate programs. The
595 choice is made along the filename ending.
598 Prints the arguments slowly by sleeping 0.08 seconds between each character.
600 : **smartcompress()**
601 Compresses/archives the file given as first parameter. Takes an optional
602 second argument, which denotes the compression/archive type as typical
603 filename extension; defaults to "tar.gz".
606 Indents C source code files given; uses Kernighan & Ritchie style.
609 Creates directory named shots in user's home directory, if it does not yet
610 exist and changes current working directory to it. Then sleeps 5 seconds,
611 so you have plenty of time to switch desktops/windows. Then makes a screenshot
612 of the current desktop. The result is stored in ~/shots to a timestamped
616 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
617 issues a Warning to use the grml-x(1) script. Can be overridden by using
618 /usr/bin/startx directly.
621 Shows some information about current system status.
624 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
625 swspeak must be set for this to work.
628 Makes a unified diff of the command line arguments trying hard to find a
629 smaller set of changes. Descends recursively into subdirectories. Ignores
630 hows some information about current status.
633 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
636 Takes a string as its first argument and prints it RFC 2396 URL encoded to
640 Changes every occurrence of the string UTF-8 or utf-8 in environment
641 variables to iso885915.
647 Wrapper for vim(1). It tries to set the title and hands vim the environment
648 variable VIM_OPTIONS on the command line. So the user may define command
649 line options, she always wants, in her .zshrc.local.
652 Use vim(1) as manpage reader.
655 Tries to cat(1) file(s) given as parameter(s). Always returns true.
656 See also xunfunction() below.
659 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
660 issues a Warning to use the grml-x(1) script. Can be overridden by using
661 /usr/bin/xinit directly.
664 Tries to source the file(s) given as parameter(s). Always returns true.
665 See zshbuiltins(1) for a detailed description of the source command.
666 See also xunfunction() below.
669 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
672 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
673 option plus a non empty pattern. Run zg without any arguments for a listing
674 of available command line switches. For a zshrc not in /etc/zsh, set the
675 GRML_ZSHRC environment variable.
678 Wrapper around the autoload builtin. Loads the definitions of functions
679 from the file given as argument. Searches $fpath for the file. See also
683 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
684 where own modifications should go. See also zshbuiltins(1) for a description
685 of the source command.
689 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
690 life. A few aliases (like those involving //grep// or //ls//) use the option
691 //--color=auto// for colourizing output. That option is part of **GNU**
692 implementations of these tools, and will only be used if such an implementation
695 : **acp** (//apt-cache policy//)
696 With no arguments prints out the priorities of each source. If a package name
697 is given, it displays detailed information about the priority selection of the
700 : **acs** (//apt-cache search//)
701 Searches debian package lists for the regular expression provided as argument.
702 The search includes package names and descriptions. Prints out name and short
703 description of matching packages.
705 : **acsh** (//apt-cache show//)
706 Shows the package records for the packages provided as arguments.
708 : **adg** (//apt-get dist-upgrade//)
709 Performs an upgrade of all installed packages. Also tries to automatically
710 handle changing dependencies with new versions of packages. As this may change
711 the install status of (or even remove) installed packages, it is potentially
712 dangerous to use dist-upgrade; invoked by sudo, if necessary.
714 : **ag** (//apt-get upgrade//)
715 Downloads and installs the newest versions of all packages currently installed
716 on the system. Under no circumstances are currently installed packages removed,
717 or packages not already installed retrieved and installed. New versions of
718 currently installed packages that cannot be upgraded without changing the install
719 status of another package will be left at their current version. An update must
720 be performed first (see au below); run by sudo, if necessary.
722 : **agi** (//apt-get install//)
723 Downloads and installs or upgrades the packages given on the command line.
724 If a hyphen is appended to the package name, the identified package will be
725 removed if it is installed. Similarly a plus sign can be used to designate a
726 package to install. This may be useful to override decisions made by apt-get's
727 conflict resolution system.
728 A specific version of a package can be selected for installation by following
729 the package name with an equals and the version of the package to select. This
730 will cause that version to be located and selected for install. Alternatively a
731 specific distribution can be selected by following the package name with a slash
732 and the version of the distribution or the Archive name (stable, testing, unstable).
733 Gets invoked by sudo, if user id is not 0.
735 : **ati** (//aptitude install//)
736 Aptitude is a terminal-based package manager with a command line mode similar to
737 apt-get (see agi above); invoked by sudo, if necessary.
739 : **au** (//apt-get update//)
740 Resynchronizes the package index files from their sources. The indexes of
741 available packages are fetched from the location(s) specified in
742 /etc/apt/sources.list. An update should always be performed before an
743 upgrade or dist-upgrade; run by sudo, if necessary.
745 : **calc** (//peval//)
746 Evaluates a perl expression (see peval() above); useful as a command line
749 : **CH** (//./configure --help//)
750 Lists available compilation options for building program from source.
752 : **cmplayer** (//mplayer -vo fbdev//)
753 Video player with framebuffer as video output device, so you can watch
754 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
755 while watching a movie.
757 : **CO** (//./configure//)
758 Prepares compilation for building program from source.
760 : **da** (//du -sch//)
761 Prints the summarized disk usage of the arguments as well as a grand total
762 in human readable format.
764 : **default** (//echo -en [ escape sequence ]//)
765 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
766 using escape sequence.
768 : **dir** (//ls -lSrah//)
769 Lists files (including dot files) sorted by size (biggest last) in long and
770 human readable output format.
772 : **fblinks** (//links2 -driver fb//)
773 A Web browser on the framebuffer device. So you can browse images and click
774 links on the virtual tty.
776 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
777 Fullscreen Video player with the framebuffer as video output device. So you
778 can watch videos on a virtual tty.
781 Revision control system by Linus Torvalds.
783 : **grep** (//grep --color=auto//)
784 Shows grep output in nice colors, if available.
786 : **GREP** (//grep -i --color=auto//)
787 Case insensitive grep with colored output.
789 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
790 Scans for new devices and updates /etc/fstab according to the findings.
792 : **grml-version** (//cat /etc/grml_version//)
793 Prints version of running grml.
795 : **http** (//python -m SimpleHTTPServer//)
796 Basic HTTP server implemented in python. Listens on port 8000/tcp and
797 serves current directory. Implements GET and HEAD methods.
799 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
800 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
801 host key changes frequently, for example on virtualized test- or development-systems.
802 To be used only inside trusted networks, of course.
804 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
805 ssh with possible man-in-the-middle attack enabled
806 (for an explanation see insecscp above).
808 : **help-zshglob** (//H-Glob()//)
809 Runs the function H-Glob() to expand or explain wildcards.
811 : **hide** (//echo -en [ escape sequence ]//)
812 Tries to hide xterm window using escape sequence.
814 : **huge** (//echo -en [ escape sequence ]//)
815 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
816 using escape sequence.
818 : **j** (//jobs -l//)
819 Prints status of jobs in the current shell session in long format.
821 : **l** (//ls -lF --color=auto//)
822 Lists files in long output format with indicator for filetype appended
823 to filename. If the terminal supports it, with colored output.
825 : **la** (//ls -la --color=auto//)
826 Lists files in long colored output format. Including file names
829 : **lad** (//ls -d .*(/)//)
830 Lists the dot directories (not their contents) in current directory.
832 : **large** (//echo -en [ escape sequence ]//)
833 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
834 using escape sequence.
836 : **lh** (//ls -hAl --color=auto//)
837 Lists files in long and human readable output format in nice colors,
838 if available. Includes file names starting with "." except "." and
841 : **ll** (//ls -l --color=auto//)
842 Lists files in long colored output format.
844 : **ls** (//ls -b -CF --color=auto//)
845 Lists directory printing octal escapes for nongraphic characters.
846 Entries are listed by columns and an indicator for file type is appended
847 to each file name. Additionally the output is colored, if the terminal
850 : **lsa** (//ls -a .*(.)//)
851 Lists dot files in current working directory.
853 : **lsbig** (//ls -flh *(.OL[1,10])//)
854 Displays the ten biggest files (long and human readable output format).
856 : **lsd** (//ls -d *(/)//)
859 : **lse** (//ls -d *(/^F)//)
860 Shows empty directories.
862 : **lsl** (//ls -l *(@)//)
863 Lists symbolic links in current directory.
865 : **lsnew** (//ls -rl *(D.om[1,10])//)
866 Displays the ten newest files (long output format).
868 : **lsold** (//ls -rtlh *(D.om[1,10])//)
869 Displays the ten oldest files (long output format).
871 : **lss** (//ls -l *(s,S,t)//)
872 Lists files in current directory that have the setuid, setgid or sticky bit
875 : **lssmall** (//ls -Srl *(.oL[1,10])//)
876 Displays the ten smallest files (long output format).
878 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
879 Displays all files which are world readable and/or world writable and/or
880 world executable (long output format).
882 : **lsx** (//ls -l *(*)//)
883 Lists only executable files.
885 : **md** (//mkdir -p//)
886 Creates directory including parent directories, if necessary
888 : **medium** (//echo -en [ escape sequence ]//)
889 Sets medium sized font
890 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
891 using escape sequence.
893 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
894 If invoking user is root, starts screen session with /etc/grml/screenrc
895 as config file. If invoked by a regular user, start a screen session
896 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
899 : **rw-** (//chmod 600//)
900 Grants read and write permission of a file to the owner and nobody else.
902 : **rwx** (//chmod 700//)
903 Grants read, write and execute permission of a file to the owner and nobody
906 : **r--** (//chmod 644//)
907 Grants read and write permission of a file to the owner and read-only to
910 : **r-x** (//chmod 755//)
911 Grants read, write and execute permission of a file to the owner and
912 read-only plus execute permission to anybody else.
914 : **semifont** (//echo -en [ escape sequence ]//)
915 Sets font of xterm to
916 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
919 : **small** (//echo -en [ escape sequence ]//)
920 Sets small xterm font ("6x10") using escape sequence.
922 : **smartfont** (//echo -en [ escape sequence ]//)
923 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
926 : **su** (//sudo su//)
927 If user is running a grml live-CD, dont ask for any password, if she
930 : **tiny** (//echo -en [ escape sequence ]//)
932 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
935 : **truec** (//truecrypt [ mount options ]//)
936 Mount a truecrypt volume with some reasonable mount options
937 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
940 : **up** (//aptitude update ; aptitude safe-upgrade//)
941 Performs a system update followed by a system upgrade using aptitude; run
942 by sudo, if necessary. See au and ag above.
944 : **?** (//qma zshall//)
945 Runs the grml script qma (quick manual access) to build the collected man
946 pages for the z-shell. This compressed file is kept at
947 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
948 fast. See "man qma" for further information.
952 This is a set of files, that - if they exist - can be used to customize the
953 behaviour of //grmlzshrc//.
956 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
957 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
960 # show battery status in RPROMPT
962 # always load the complete setup, even for root
963 GRML_ALWAYS_LOAD_ALL=1
967 Sourced right before loading //grmlzshrc// is finished. There is a global
968 version of this file (/etc/zsh/zshrc.local) which is sourced before the
972 Directory listing for persistent dirstack (see above).
974 : **.important_commands**
975 List of commands, used by persistent history (see above).
978 = INSTALLATION ON NON-DEBIAN SYSTEMS =
979 On Debian systems (http://www.debian.org) - and possibly Ubuntu
980 (http://www.ubuntu.com) and similar systems - it is very easy to get
981 //grmlzshrc// via grml's .deb repositories.
983 On non-debian systems, that is not an option, but all is not lost:
986 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
989 If you would also like to get seperate function files (which you can put into
990 your **$fpath**), you can browse and download them at:
992 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
995 If you read //grmlzshrc//'s code you may notice strange looking comments in
996 it. These are there for a purpose. grml's zsh-refcard is automatically
997 generated from the contents of the actual configuration file. However, we need
998 a little extra information on which comments and what lines of code to take
999 into account (and for what purpose).
1001 Here is what they mean:
1003 List of tags (comment types) used:
1005 Next line contains an important alias, that should be included in the
1006 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1009 Next line contains the beginning of an important function. (placement
1010 tag: @@INSERT-functions@@)
1013 Next line contains an important variable. (placement tag:
1014 @@INSERT-variables@@)
1017 Next line contains an important keybinding. (placement tag:
1018 @@INSERT-keybindings@@)
1021 Hashed directories list generation: //start//: denotes the start of a list of
1022 'hash -d' definitions. //end//: denotes its end. (placement tag:
1023 @@INSERT-hasheddirs@@)
1026 Abbreviation expansion list generation: //start//: denotes the beginning of
1027 abbreviations. //end//: denotes their end.
1029 Lines within this section that end in '#d .*' provide extra documentation to
1030 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1033 This tag allows you to manually generate refcard entries for code lines that
1034 are hard/impossible to parse.
1038 #m# k ESC-h Call the run-help function
1041 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1044 So the syntax is: #m# <section> <argument> <comment>
1047 This tag lets you insert entries to the 'other' hash. Generally, this should
1048 not be used. It is there for things that cannot be done easily in another way.
1049 (placement tag: @@INSERT-other-foobar@@)
1052 All of these tags (except for m and o) take two arguments, the first
1053 within the tag, the other after the tag:
1055 #<tag><section># <comment>
1057 Where <section> is really just a number, which are defined by the @secmap
1058 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1059 that for the reader, the tag should not differ much from a regular comment.
1060 For zsh, it is a regular comment indeed. The numbers have got the following
1085 So, the following will add an entry to the 'functions' table in the 'system'
1086 section, with a (hopefully) descriptive comment:
1089 #f1# Edit an alias via zle
1093 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1094 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1095 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1096 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1097 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1101 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1102 repository from git.grml.org:
1104 ``` % git clone git://git.grml.org/grml-etc-core.git
1106 Make your changes, commit them; use '**git format-patch**' to create a series
1107 of patches and send those to the following address via '**git send-email**':
1109 ``` grml-etc-core@grml.org
1111 Doing so makes sure the right people get your patches for review and
1116 This manual page is supposed to be a **reference** manual for //grmlzshrc//.
1117 That means that in contrast to the existing refcard it should document **every**
1118 aspect of the setup. That is currently **not** the case. Not for a long time
1119 yet. Contributions are highly welcome.
1123 This manpage was written by Frank Terbeck <ft@grml.org> and Joerg Woelke
1128 Copyright (c) 2009, grml project <http://grml.org>
1130 This manpage is distributed under the terms of the GPL version 2.
1132 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1133 except for **accept-line()** and **vcs_info()**, which are distributed under
1134 the same conditions as zsh itself (which is BSD-like).