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
31 Users may want to keep an up-to-date version of the setup (possibly from the
32 git-sources) in //~/.zshrc//. If that happens on a system where the global
33 zshrc is also a //grmlzshrc// (but possibly an older one), you can inhibit
34 loading the global version by doing:
37 echo setopt no_global_rcs >> ~/.zshenv
40 Note, that this will disable //ANY// global files, except for the global
44 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
45 variables. These may be set temporarily when starting zsh like this:
49 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
52 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
53 put the battery status into the right hand side interactive prompt.
55 : **COMMAND_NOT_FOUND**
56 A non zero value activates a handler, which is called when a command can not
57 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
59 : **GRML_ZSH_CNF_HANDLER**
60 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
61 and defaults to "/usr/share/command-not-found/command-not-found".
63 : **GRMLSMALL_SPECIFIC**
64 Set this to zero to remove items in zsh config, which do not work in
68 Where zsh saves the history. Default: ${HOME}/.zsh_history.
71 Number of commands to be kept in the history. On a Grml-CD this defaults to
72 500, on a hard disk installation to 5000.
75 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
76 A value of zero turns off checking.
79 Non zero values deactivate automatic correction of commands.
82 If set to zero (default), allows selection from a menu, if there are at least
83 five possible options of completion.
86 A non zero value disables precmd and preexec commands. These are functions
87 that are run before every command (setting xterm/screen titles etc.).
90 Show time (user, system and cpu) used by external commands, if they run longer
91 than the defined number of seconds (default: 5).
94 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
95 and to 10000 on an installation on hard disk.
98 As in tcsh(1) an array of login/logout events to be reported by the shell
99 builtin "log". For details see zshparam(1). Defaults to (notme root).
101 : **ZSH_NO_DEFAULT_LOCALE**
102 Import "/etc/default/locale", if set to zero (default).
105 A non zero value causes shell functions to be profiled. The results can be
106 obtained with the zprof builtin command (see zshmodules(1) for details).
109 = FEATURE DESCRIPTION =
110 This is an in depth description of non-standard features implemented by
113 == DIRSTACK HANDLING ==
114 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
115 file each time zsh's working directory is changed. That file can be configured
116 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
117 **DIRSTACKSIZE** variable defaults to **20** in this setup.
119 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
120 zshs inherit the dirstack of the zsh that most recently updated
123 == DIRECTORY BASED PROFILES ==
125 If you need to perform certain actions each time you enter certain
126 directory-trees, this is the feature you are looking for.
129 === Initialisation ===
130 To initialise the system, you need to call the function `chpwd_profiles' at
131 some point in your `zshrc.local'; preferably **after** you configured the
132 system. The configuration of the system is described further below.
134 If you need to do initialisations the first time `chpwd_profiles' is called
135 (which should be in your configuration file), you can do that in a function
136 called "chpwd_profiles_init". That function needs to be defined **before**
137 `chpwd_profiles' is called for this to work.
139 During the **first** call of `chpwd_profiles' (and therefore all its profile
140 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
141 all other cases, the parameter does not exist at all.
144 === Styles and Profile-names ===
145 To store its configuration, the system uses **functions** and **styles**
146 (zsh's context sensitive configuration system), such as this:
150 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
151 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
154 When that's done and you enter a directory that matches the pattern in the
155 third part of the context, a function called chpwd_profile_grml, for example,
156 is called (if it exists).
158 If no pattern matches (read: no profile is detected) the profile is set to
159 'default', which means chpwd_profile_default is attempted to be called.
161 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
162 which is used: The third part in the context is matched against ${PWD}. That's
163 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
164 profile is detected for all these values of ${PWD}:
171 So, if you want to make double damn sure a profile works in /foo/bar and
172 everywhere deeper in that tree, just use (|/|/*) and be happy.
174 The name of the detected profile will be available in a variable called
175 'profile' in your functions. You don't need to do anything, it'll just be
179 === Controlling Profile Execution ===
181 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
182 which is set to the profile that was is currently active (the default value is
183 "default"). That way you can avoid running code for a profile that is already
184 active, by running code such as the following at the start of your function:
187 function chpwd_profile_grml() {
188 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
193 If you know you are going to do that all the time for each and every
194 directory-profile function you are ever going to write, you may also set the
195 `re-execute' style to `false' (which only defaults to `true' for backwards
196 compatibility), like this:
199 zstyle ':chpwd:profiles:*' re-execute false
203 === Signaling availabily/profile changes ===
205 If you use this feature and need to know whether it is active in your current
206 shell, there are several ways to do that. Here are two simple ways:
208 a) If knowing if the profiles feature is active when zsh starts is good
209 enough for you, you can use the following snippet:
211 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
213 b) If that is not good enough, and you would prefer to be notified whenever a
214 profile changes, you can solve that by making sure you start **every**
215 profile function you create like this:
217 function chpwd_profile_myprofilename() {
218 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
219 print "chpwd(): Switching to profile: $profile"
223 That makes sure you only get notified if a profile is **changed**, not
224 everytime you change directory. (To avoid this, you may also set the newer
225 `re-execute' style like described further above instead of the test on top of
229 === Leaving Profiles ===
231 When the system switches from one profile to another, it executes a function
232 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
233 profile-function for the new profile.
236 === Version requirement ===
237 This feature requires zsh //4.3.3// or newer.
240 == ACCEPTLINE WRAPPER ==
241 The //accept-line// wiget is the one that is taking action when the **return**
242 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
245 This wrapper is configured via styles. That means, you issue commands, that look
249 zstyle 'context' style value
252 The context namespace, that we are using is 'acceptline'. That means, the actual
253 context for your commands look like: **':acceptline:<subcontext>'**.
255 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
259 === Recognized Contexts ===
261 This is the value, the context is initialized with.
262 The //compwarnfmt and //rehash// styles are looked up in this context.
265 If the first word in the command line is either a command, alias, function,
266 builtin or reserved word, you are in this context.
269 This is the context, that is used if you hit enter again, after being warned
270 about the existence of a _completion for the non-existing command you
274 This is the context, you are in if the command line is empty or only
275 consists of whitespace.
278 This context is in effect, if you entered something that does not match any
279 of the above. (e.g.: variable assignments).
282 === Available Styles ===
284 If you set this style to true, the warning about non existent commands,
285 for which completions exist will not be issued. (Default: **false**)
288 The message, that is displayed to warn about the _completion issue.
289 (default: **'%c will not execute and completion %f exists.'**)
290 '%c' is replaced by the command name, '%f' by the completion's name.
293 If this is set, we'll force rehashing, if appropriate. (Defaults to
294 **true** in //grmlzshrc//).
297 This can be a list of wigdets to call in a given context. If you need a
298 specific order for these to be called, name them accordingly. The default value
299 is an **empty list**.
302 The name of a widget, that is called after the widgets from 'actions'.
303 By default, this will be '.accept-line' (which is the built-in accept-line
307 If true in the current context, call the widget in the 'default_action'
308 style. (The default is **true** in all contexts.)
314 == GNU/SCREEN STATUS SETTING ==
315 //grmlzshrc// sets screen's hardstatus lines to the currently running command
316 or **'zsh'** if the shell is idling at its prompt. If the current working
317 directory is inside a repository unter version control, screen status is set
318 to: **'zsh: <repository name>'** via zsh's vcs_info.
321 == PERSISTENT HISTORY ==
322 If you got commands you consider important enough to be included in every
323 shell's history, you can put them into ~/.important_commands and they will be
324 available via the usual history lookup widgets.
328 == ENVIRONMENT VARIABLES ==
329 //grmlzshrc// sets some environment variables, which influence the
330 behaviour of applications.
333 Set to "yes". Some applications read this to learn about properties
334 of the terminal they are running in.
337 If not already set, sets the default editor. Falls back to vi(1),
338 if vim(1) is not available.
341 Some environment variables that add colour support to less(1) for viewing
342 man pages. See termcap(5) for details.
345 The mailbox file for the current user is set to /var/mail/$USER, if not
346 already set otherwise.
349 Set less(1) as default pager, if not already set to something different.
352 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
353 default to /bin/sh or /bin/bash.
357 Apart from zsh's default options, //grmlzshrc// sets some options
358 that change the behaviour of zsh. Options that change Z-shell's default
359 settings are marked by <grml>. But note, that zsh's defaults vary depending
360 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
363 Zsh sessions, that use //grmlzshrc//, will append their history list to the
364 history file, rather than replace it. Thus, multiple parallel zsh sessions
365 will all have the new entries from their history lists added to the history
366 file, in the order that they exit. The file will still be periodically
367 re-written to trim it when the number of lines grows 20% beyond the value
368 specified by $SAVEHIST.
371 If a command is issued that can't be executed as a normal command, and the
372 command is the name of a directory, perform the cd command to that directory.
374 : **auto_pushd** <grml>
375 Make cd push the old directory onto the directory stack.
377 : **completeinword** <grml>
378 If the cursor is inside a word, completion is done from both ends;
379 instead of moving the cursor to the end of the word first and starting
382 : **extended_glob** <grml>
383 Treat the '#', '~' and '^' characters as active globbing pattern characters.
385 : **extended_history** <grml>
386 Save each command's beginning timestamp (in seconds since the epoch) and the
387 duration (in seconds) to the history file.
390 Whenever a command completion is attempted, make sure the entire command
391 path is hashed first. This makes the first completion slower.
393 : **histignorealldups** <grml>
394 If a new command line being added to the history list duplicates an
395 older one, the older command is removed from the list, even if it is
396 not the previous event.
398 : **histignorespace** <grml>
399 Remove command lines from the history list when the first character on
400 the line is a space, or when one of the expanded aliases contains a
401 leading space. Note that the command lingers in the internal history
402 until the next command is entered before it vanishes.
404 : **longlistjobs** <grml>
405 List jobs in long format by default.
408 Avoid to beep on errors in zsh command line editing (zle).
411 A wildcard character never matches a leading '.'.
414 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
416 : **nonomatch** <grml>
417 If a pattern for filename generation has no matches, do not print an error
418 and leave it unchanged in the argument list. This also applies to file
419 expansion of an initial `~' or `='.
422 Report the status of background jobs immediately, rather than waiting until
423 just before printing a prompt.
425 : **pushd_ignore_dups** <grml>
426 Don't push multiple copies of the same directory onto the directory stack.
428 : **share_history** <grml>
429 As each line is added to the history file, it is checked to see if anything
430 else was written out by another shell, and if so it is included in the
431 history of the current shell too. Using !-style history, the commands from
432 the other sessions will not appear in the history list unless you explicitly
433 type the "history" command. This option is activated for zsh versions >= 4,
438 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
439 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
443 Edit the current command buffer in your favourite editor.
446 Deletes a word left of the cursor; seeing '/' as additional word separator.
449 Jump right after the first word.
452 Create directory under cursor or the selected area.
453 To select an area press ctrl-@ and use the cursor.
454 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
455 directory does not exist yet -> press **CTRL-xM** and problem solved.
458 Searches the last occurence of string before the cursor in the command history.
461 Display help on keybindings and zsh line editor. Press consecutively to page through content.
464 Brings a job, which got suspended with CTRL-z back to foreground.
467 == SHELL FUNCTIONS ==
468 //grmlzshrc// comes with a wide array of defined shell functions to ease the
471 : **855resolution()**
472 If 915resolution is available, issues a warning to the user to run it instead
473 to modify the resolution on intel graphics chipsets.
476 Lists files in current directory, which have been accessed within the
477 last N days. N is an integer to be passed as first and only argument.
478 If no argument is specified N is set to 1.
481 Sets all ulimit values to "unlimited".
484 Lists processes matching given pattern.
487 Login on the host provided as argument using autossh. Then reattach a GNU screen
488 session if a detached session is around or detach a currently attached screen or
489 else start a new screen. This is especially useful for roadwarriors using GNU
493 Simple backup of a file or directory using cp(1). The target file name is the
494 original name plus a time stamp attached. Symlinks and file attributes like mode,
495 ownership and timestamps are preserved.
498 If the original cdrecord is not installed, issues a warning to the user to
499 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
503 Creates a temporary directory using mktemp. Then changes current
504 working directory to it.
507 Lists files in current directory, which have been changed within the
508 last N days. N is an integer to be passed as first and only argument.
509 If no argument is specified N is set to 1.
512 Returns true if given command exists either as program, function, alias,
513 builtin or reserved word. If the option -c is given, only returns true,
514 if command is a program.
517 Changes directory to $HOME on first invocation of zsh. This is neccessary on
518 grml systems with autologin.
521 Changes current directory to the one supplied by argument and lists the files
522 in it, including file names starting with ".".
525 Shows the changelog of given package in $PAGER.
528 Tells the user to use grml-debootstrap, if she wants to install debian to
532 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
533 back interactive responsiveness after suspend, when the system is swapping
537 Shows the NEWS file for the given package in $PAGER.
543 Edit given shell function.
546 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
549 Use GNU diff with options -ubwd for mercurial.
552 Displays diffstat between the revision given as argument and tip (no
553 argument means last revision).
556 Outputs highlighted diff; needs highstring(1).
559 Returns true, if zsh version is equal or greater than 4, else false.
562 Returns true, if zsh version is equal or greater than 4.1, else false.
565 Returns true, if zsh version is equal or greater than 4.2, else false.
568 Returns true, if zsh version is equal or greater than 4.2.5, else false.
571 Returns true, if zsh version is equal or greater than 4.3, else false.
574 Returns true, if zsh version is equal or greater than 4.3.3, else false.
577 Returns true, if running on darwin, else false.
580 Returns true, if running on a grml system, else false.
583 Returns true, if running on a grml system from a live cd, else false.
586 Returns true, if run on grml-small, else false.
589 Changes every occurrence of the string iso885915 or ISO885915 in
590 environment variables to UTF-8.
593 Returns true, if run within an utf environment, else false.
596 Creates directory including parent directories, if necessary. Then changes
597 current working directory to it.
600 Lists files in current directory, which have been modified within the
601 last N days. N is an integer to be passed as first and only argument.
602 If no argument is specified N is set to 1.
605 A helper function for the "e" glob qualifier to list all files newer
606 than a reference file.
610 % NTREF=/reference/file
613 % ls -l *(e:'nt /reference/file':)
617 Runs a command in $SHELL with profiling enabled (See startup variable
618 ZSH_PROFILE_RC above).
621 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
622 for details. See also xunfunction() below.
624 : **simple-extract()**
625 Tries to uncompress/unpack given files with the appropriate programs. If an URI
626 starting with https, http or ftp is provided simple-extract tries to download
627 and then uncompress/unpack the file. The choice is made along the filename
628 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
629 .xz) unless you use the '-d' option.
632 Prints details of symlinks given as arguments.
634 : **ssl-cert-fingerprints**
635 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
636 First and only parameter must be a file containing a certificate. Use
637 /dev/stdin as file if you want to pipe a certificate to these
641 Prints all information of a x509 certificate including the SHA512,
642 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
643 containing a certificate. Use /dev/stdin as file if you want to pipe a
644 certificate to this function.
646 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
647 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
648 certificate. First and only parameter must be a file containing a
649 certificate. Use /dev/stdin as file if you want to pipe a certificate
652 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
653 Functions for controlling daemons.
660 Translates a word from german to english (-D) or vice versa (-E).
663 Shows upstreams changelog of a given package in $PAGER.
666 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
669 Changes every occurrence of the string UTF-8 or utf-8 in environment
670 variables to iso885915.
673 Wrapper for vim(1). It tries to set the title and hands vim the environment
674 variable VIM_OPTIONS on the command line. So the user may define command
675 line options, she always wants, in her .zshrc.local.
678 Searches the history for a given pattern and lists the results by date.
679 The first argument is the search pattern. The second and third ones are
680 optional and denote a search range (default: -100).
683 Tries to cat(1) file(s) given as parameter(s). Always returns true.
684 See also xunfunction() below.
687 Tries to source the file(s) given as parameter(s). Always returns true.
688 See zshbuiltins(1) for a detailed description of the source command.
689 See also xunfunction() below.
692 Changes the title of xterm window from within screen(1). Run without
693 arguments for details.
696 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
699 Wrapper around the autoload builtin. Loads the definitions of functions
700 from the file given as argument. Searches $fpath for the file. See also
704 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
705 where own modifications should go. See also zshbuiltins(1) for a description
706 of the source command.
710 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
711 life. A few aliases (like those involving //grep// or //ls//) use the option
712 //--color=auto// for colourizing output. That option is part of **GNU**
713 implementations of these tools, and will only be used if such an implementation
716 : **acp** (//apt-cache policy//)
717 With no arguments prints out the priorities of each source. If a package name
718 is given, it displays detailed information about the priority selection of the
721 : **acs** (//apt-cache search//)
722 Searches debian package lists for the regular expression provided as argument.
723 The search includes package names and descriptions. Prints out name and short
724 description of matching packages.
726 : **acsh** (//apt-cache show//)
727 Shows the package records for the packages provided as arguments.
729 : **adg** (//apt-get dist-upgrade//)
730 Performs an upgrade of all installed packages. Also tries to automatically
731 handle changing dependencies with new versions of packages. As this may change
732 the install status of (or even remove) installed packages, it is potentially
733 dangerous to use dist-upgrade; invoked by sudo, if necessary.
735 : **ag** (//apt-get upgrade//)
736 Downloads and installs the newest versions of all packages currently installed
737 on the system. Under no circumstances are currently installed packages removed,
738 or packages not already installed retrieved and installed. New versions of
739 currently installed packages that cannot be upgraded without changing the install
740 status of another package will be left at their current version. An update must
741 be performed first (see au below); run by sudo, if necessary.
743 : **agi** (//apt-get install//)
744 Downloads and installs or upgrades the packages given on the command line.
745 If a hyphen is appended to the package name, the identified package will be
746 removed if it is installed. Similarly a plus sign can be used to designate a
747 package to install. This may be useful to override decisions made by apt-get's
748 conflict resolution system.
749 A specific version of a package can be selected for installation by following
750 the package name with an equals and the version of the package to select. This
751 will cause that version to be located and selected for install. Alternatively a
752 specific distribution can be selected by following the package name with a slash
753 and the version of the distribution or the Archive name (stable, testing, unstable).
754 Gets invoked by sudo, if user id is not 0.
756 : **ati** (//aptitude install//)
757 Aptitude is a terminal-based package manager with a command line mode similar to
758 apt-get (see agi above); invoked by sudo, if necessary.
760 : **au** (//apt-get update//)
761 Resynchronizes the package index files from their sources. The indexes of
762 available packages are fetched from the location(s) specified in
763 /etc/apt/sources.list. An update should always be performed before an
764 upgrade or dist-upgrade; run by sudo, if necessary.
766 : **da** (//du -sch//)
767 Prints the summarized disk usage of the arguments as well as a grand total
768 in human readable format.
770 : **dbp** (//dpkg-buildpackage//)
771 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
773 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
774 Prints installed Packages sorted by size (descending).
776 : **dir** (//ls -lSrah//)
777 Lists files (including dot files) sorted by size (biggest last) in long and
778 human readable output format.
780 : **ge** (//grep-excuses//)
781 Searches the testing excuses files for a specific maintainer (See:
784 : **grep** (//grep --color=auto//)
785 Shows grep output in nice colors, if available.
787 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
788 Scans for new devices and updates /etc/fstab according to the findings.
790 : **grml-version** (//cat /etc/grml_version//)
791 Prints version of running grml.
793 : **hbp** (//hg-buildpackage//)
794 Helper program to maintain Debian packages with mercurial.
796 : **http** (//python -m SimpleHTTPServer//)
797 Basic HTTP server implemented in python. Listens on port 8000/tcp and
798 serves current directory. Implements GET and HEAD methods.
800 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
801 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
802 host key changes frequently, for example on virtualized test- or development-systems.
803 To be used only inside trusted networks, of course.
805 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
806 ssh with possible man-in-the-middle attack enabled
807 (for an explanation see insecscp above).
809 : **help-zshglob** (//H-Glob()//)
810 Runs the function H-Glob() to expand or explain wildcards.
812 : **j** (//jobs -l//)
813 Prints status of jobs in the current shell session in long format.
815 : **l** (//ls -lF --color=auto//)
816 Lists files in long output format with indicator for filetype appended
817 to filename. If the terminal supports it, with colored output.
819 : **la** (//ls -la --color=auto//)
820 Lists files in long colored output format. Including file names
823 : **lad** (//ls -d .*(/)//)
824 Lists the dot directories (not their contents) in current directory.
826 : **lh** (//ls -hAl --color=auto//)
827 Lists files in long and human readable output format in nice colors,
828 if available. Includes file names starting with "." except "." and
831 : **ll** (//ls -l --color=auto//)
832 Lists files in long colored output format.
834 : **llog** (//$PAGER /var/log/syslog//)
835 Opens syslog in pager.
837 : **ls** (//ls -b -CF --color=auto//)
838 Lists directory printing octal escapes for nongraphic characters.
839 Entries are listed by columns and an indicator for file type is appended
840 to each file name. Additionally the output is colored, if the terminal
843 : **lsa** (//ls -a .*(.)//)
844 Lists dot files in current working directory.
846 : **lsbig** (//ls -flh *(.OL[1,10])//)
847 Displays the ten biggest files (long and human readable output format).
849 : **lsd** (//ls -d *(/)//)
852 : **lse** (//ls -d *(/^F)//)
853 Shows empty directories.
855 : **lsl** (//ls -l *(@)//)
856 Lists symbolic links in current directory.
858 : **lsnew** (//ls -rl *(D.om[1,10])//)
859 Displays the ten newest files (long output format).
861 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
862 Displays the ten newest directories and ten newest .directories.
864 : **lsold** (//ls -rtlh *(D.om[1,10])//)
865 Displays the ten oldest files (long output format).
867 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
868 Displays the ten oldest directories and ten oldest .directories.
870 : **lss** (//ls -l *(s,S,t)//)
871 Lists files in current directory that have the setuid, setgid or sticky bit
874 : **lssmall** (//ls -Srl *(.oL[1,10])//)
875 Displays the ten smallest files (long output format).
877 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
878 Displays all files which are world readable and/or world writable and/or
879 world executable (long output format).
881 : **lsx** (//ls -l *(*)//)
882 Lists only executable files.
884 : **mdstat** (//cat /proc/mdstat//)
885 Lists all active md (i.e. linux software raid) devices with some information
888 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
889 Executes the commands on the versioned patch queue from current repository.
891 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
892 rmdir current working directory
894 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
895 If invoking user is root, starts screen session with /etc/grml/screenrc
896 as config file. If invoked by a regular user, start a screen session
897 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
900 : **su** (//sudo su//)
901 If user is running a grml live-CD, dont ask for any password, if she
904 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
905 Sets mode from UTF-8 to ISO 2022 (See:
906 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
908 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
909 Sets mode from ISO 2022 to UTF-8 (See:
910 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
912 : **tlog** (//tail -f /var/log/syslog//)
913 Prints syslog continuously (See tail(1)).
915 : **up** (//aptitude update ; aptitude safe-upgrade//)
916 Performs a system update followed by a system upgrade using aptitude; run
917 by sudo, if necessary. See au and ag above.
919 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
920 After calling, characters of URLs as typed get automatically escaped, if necessary, to
921 protect them from the shell.
923 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
924 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
926 : **...** (//cd ../..///)
927 Changes current directory two levels higher.
931 This is a set of files, that - if they exist - can be used to customize the
932 behaviour of //grmlzshrc//.
935 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
936 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
939 # show battery status in RPROMPT
941 # always load the complete setup, even for root
942 GRML_ALWAYS_LOAD_ALL=1
946 Sourced right before loading //grmlzshrc// is finished. There is a global
947 version of this file (/etc/zsh/zshrc.local) which is sourced before the
951 Directory listing for persistent dirstack (see above).
953 : **.important_commands**
954 List of commands, used by persistent history (see above).
957 = INSTALLATION ON NON-DEBIAN SYSTEMS =
958 On Debian systems (http://www.debian.org) - and possibly Ubuntu
959 (http://www.ubuntu.com) and similar systems - it is very easy to get
960 //grmlzshrc// via grml's .deb repositories.
962 On non-debian systems, that is not an option, but all is not lost:
965 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
968 If you would also like to get seperate function files (which you can put into
969 your **$fpath**), you can browse and download them at:
971 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
974 If you read //grmlzshrc//'s code you may notice strange looking comments in
975 it. These are there for a purpose. grml's zsh-refcard is automatically
976 generated from the contents of the actual configuration file. However, we need
977 a little extra information on which comments and what lines of code to take
978 into account (and for what purpose).
980 Here is what they mean:
982 List of tags (comment types) used:
984 Next line contains an important alias, that should be included in the
985 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
988 Next line contains the beginning of an important function. (placement
989 tag: @@INSERT-functions@@)
992 Next line contains an important variable. (placement tag:
993 @@INSERT-variables@@)
996 Next line contains an important keybinding. (placement tag:
997 @@INSERT-keybindings@@)
1000 Hashed directories list generation: //start//: denotes the start of a list of
1001 'hash -d' definitions. //end//: denotes its end. (placement tag:
1002 @@INSERT-hasheddirs@@)
1005 Abbreviation expansion list generation: //start//: denotes the beginning of
1006 abbreviations. //end//: denotes their end.
1008 Lines within this section that end in '#d .*' provide extra documentation to
1009 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1012 This tag allows you to manually generate refcard entries for code lines that
1013 are hard/impossible to parse.
1017 #m# k ESC-h Call the run-help function
1020 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1023 So the syntax is: #m# <section> <argument> <comment>
1026 This tag lets you insert entries to the 'other' hash. Generally, this should
1027 not be used. It is there for things that cannot be done easily in another way.
1028 (placement tag: @@INSERT-other-foobar@@)
1031 All of these tags (except for m and o) take two arguments, the first
1032 within the tag, the other after the tag:
1034 #<tag><section># <comment>
1036 Where <section> is really just a number, which are defined by the @secmap
1037 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1038 that for the reader, the tag should not differ much from a regular comment.
1039 For zsh, it is a regular comment indeed. The numbers have got the following
1064 So, the following will add an entry to the 'functions' table in the 'system'
1065 section, with a (hopefully) descriptive comment:
1068 #f1# Edit an alias via zle
1072 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1073 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1074 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1075 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1076 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1080 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1081 repository from git.grml.org:
1083 ``` % git clone git://git.grml.org/grml-etc-core.git
1085 Make your changes, commit them; use '**git format-patch**' to create a series
1086 of patches and send those to the following address via '**git send-email**':
1088 ``` grml-etc-core@grml.org
1090 Doing so makes sure the right people get your patches for review and
1095 This manual page is the **reference** manual for //grmlzshrc//.
1097 That means that in contrast to the existing refcard it should document **every**
1098 aspect of the setup.
1100 This manual is currently not complete. If you want to help improving it, visit
1101 the following pages:
1103 http://wiki.grml.org/doku.php?id=zshrcmanual
1105 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1107 Contributions are highly welcome.
1111 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1112 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1113 Beckert <abe@deuxchevaux.org>.
1117 Copyright (c) 2009-2011 Grml project <http://grml.org>
1119 This manpage is distributed under the terms of the GPL version 2.
1121 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1122 except for **accept-line()** which are distributed under the same conditions
1123 as zsh itself (which is BSD-like).