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.)
313 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
314 **promptinit** system. The three themes are called **grml**, **grml-large** and
317 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
318 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
319 non-empty, **grml-chroot** is used.
321 As usual, with promtinit themes, the user may switch to a different theme using
322 the //prompt// utility:
328 That will use the **grml-large** prompt theme.
330 The themes are highly customisable. The main source of documentation about
331 customisation is the main **grml** theme's doc-string, that is available via
332 the following command:
338 The other themes also come with doc-strings, but the main theme's is the
339 canonical reference about all of them.
341 This feature requires version //4.3.7// of the shell. Older versions will use
342 the classic grml prompt as a fallback.
344 A note to people who like customisation: If you are **not** using a prompt
345 theme for your customisation, but you're either statically setting $PS1 (or
346 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
347 function, make sure you are turning the zsh's prompt theme system **off**
348 before doing so. A correct example customisation could look like this:
351 # Turn the prompt system off:
353 # Customise the prompt yourself:
358 == GNU/SCREEN STATUS SETTING ==
359 //grmlzshrc// sets screen's hardstatus lines to the currently running command
360 or **'zsh'** if the shell is idling at its prompt. If the current working
361 directory is inside a repository unter version control, screen status is set
362 to: **'zsh: <repository name>'** via zsh's vcs_info.
365 == PERSISTENT HISTORY ==
366 If you got commands you consider important enough to be included in every
367 shell's history, you can put them into ~/.important_commands and they will be
368 available via the usual history lookup widgets.
372 == ENVIRONMENT VARIABLES ==
373 //grmlzshrc// sets some environment variables, which influence the
374 behaviour of applications.
377 Set to "yes". Some applications read this to learn about properties
378 of the terminal they are running in.
381 If not already set, sets the default editor. Falls back to vi(1),
382 if vim(1) is not available.
385 Some environment variables that add colour support to less(1) for viewing
386 man pages. See termcap(5) for details.
389 The mailbox file for the current user is set to /var/mail/$USER, if not
390 already set otherwise.
393 Set less(1) as default pager, if not already set to something different.
396 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
397 default to /bin/sh or /bin/bash.
401 Apart from zsh's default options, //grmlzshrc// sets some options
402 that change the behaviour of zsh. Options that change Z-shell's default
403 settings are marked by <grml>. But note, that zsh's defaults vary depending
404 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
407 Zsh sessions, that use //grmlzshrc//, will append their history list to the
408 history file, rather than replace it. Thus, multiple parallel zsh sessions
409 will all have the new entries from their history lists added to the history
410 file, in the order that they exit. The file will still be periodically
411 re-written to trim it when the number of lines grows 20% beyond the value
412 specified by $SAVEHIST.
415 If a command is issued that can't be executed as a normal command, and the
416 command is the name of a directory, perform the cd command to that directory.
418 : **auto_pushd** <grml>
419 Make cd push the old directory onto the directory stack.
421 : **completeinword** <grml>
422 If the cursor is inside a word, completion is done from both ends;
423 instead of moving the cursor to the end of the word first and starting
426 : **extended_glob** <grml>
427 Treat the '#', '~' and '^' characters as active globbing pattern characters.
429 : **extended_history** <grml>
430 Save each command's beginning timestamp (in seconds since the epoch) and the
431 duration (in seconds) to the history file.
434 Whenever a command completion is attempted, make sure the entire command
435 path is hashed first. This makes the first completion slower.
437 : **histignorealldups** <grml>
438 If a new command line being added to the history list duplicates an
439 older one, the older command is removed from the list, even if it is
440 not the previous event.
442 : **histignorespace** <grml>
443 Remove command lines from the history list when the first character on
444 the line is a space, or when one of the expanded aliases contains a
445 leading space. Note that the command lingers in the internal history
446 until the next command is entered before it vanishes.
448 : **longlistjobs** <grml>
449 List jobs in long format by default.
452 Avoid to beep on errors in zsh command line editing (zle).
455 A wildcard character never matches a leading '.'.
458 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
460 : **nonomatch** <grml>
461 If a pattern for filename generation has no matches, do not print an error
462 and leave it unchanged in the argument list. This also applies to file
463 expansion of an initial `~' or `='.
466 Report the status of background jobs immediately, rather than waiting until
467 just before printing a prompt.
469 : **pushd_ignore_dups** <grml>
470 Don't push multiple copies of the same directory onto the directory stack.
472 : **share_history** <grml>
473 As each line is added to the history file, it is checked to see if anything
474 else was written out by another shell, and if so it is included in the
475 history of the current shell too. Using !-style history, the commands from
476 the other sessions will not appear in the history list unless you explicitly
477 type the "history" command. This option is activated for zsh versions >= 4,
482 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
483 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
487 Edit the current command buffer in your favourite editor.
490 Deletes a word left of the cursor; seeing '/' as additional word separator.
493 Jump right after the first word.
496 Create directory under cursor or the selected area.
497 To select an area press ctrl-@ and use the cursor.
498 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
499 directory does not exist yet -> press **CTRL-xM** and problem solved.
502 Searches the last occurence of string before the cursor in the command history.
505 Display help on keybindings and zsh line editor. Press consecutively to page through content.
508 Brings a job, which got suspended with CTRL-z back to foreground.
511 === Customisation ===
513 To customise keybindings, you can just use zsh's bindkey utility. However, if
514 you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
515 yourself, make sure you call the following functions in the respective hook:
517 - **zle-line-init**: //zle-smkx//
518 - **zle-line-finish**: //zle-rmkx//
521 This is **required** so the keybindings set up by //grmlzshrc// work. The
522 reason for this is to turn the terminal into the right mode while zsh's line
523 editor (zle) is running. This enables us to query //terminfo// about escape
524 sequences for special keys and thus simplify and generalise our keybinding
528 == SHELL FUNCTIONS ==
529 //grmlzshrc// comes with a wide array of defined shell functions to ease the
532 : **855resolution()**
533 If 915resolution is available, issues a warning to the user to run it instead
534 to modify the resolution on intel graphics chipsets.
537 Lists files in current directory, which have been accessed within the
538 last N days. N is an integer to be passed as first and only argument.
539 If no argument is specified N is set to 1.
542 Sets all ulimit values to "unlimited".
545 Lists processes matching given pattern.
548 Login on the host provided as argument using autossh. Then reattach a GNU screen
549 session if a detached session is around or detach a currently attached screen or
550 else start a new screen. This is especially useful for roadwarriors using GNU
554 Simple backup of a file or directory using cp(1). The target file name is the
555 original name plus a time stamp attached. Symlinks and file attributes like mode,
556 ownership and timestamps are preserved.
559 If the original cdrecord is not installed, issues a warning to the user to
560 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
564 Creates a temporary directory using mktemp. Then changes current
565 working directory to it.
568 Lists files in current directory, which have been changed within the
569 last N days. N is an integer to be passed as first and only argument.
570 If no argument is specified N is set to 1.
573 Returns true if given command exists either as program, function, alias,
574 builtin or reserved word. If the option -c is given, only returns true,
575 if command is a program.
578 Changes directory to $HOME on first invocation of zsh. This is neccessary on
579 grml systems with autologin.
582 Changes current directory to the one supplied by argument and lists the files
583 in it, including file names starting with ".".
586 Shows the changelog of given package in $PAGER.
589 Shows the copyright of given package in $PAGER.
592 Tells the user to use grml-debootstrap, if she wants to install debian to
596 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
597 back interactive responsiveness after suspend, when the system is swapping
601 Shows the NEWS file for the given package in $PAGER.
607 Edit given shell function.
610 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
613 Use GNU diff with options -ubwd for mercurial.
616 Displays diffstat between the revision given as argument and tip (no
617 argument means last revision).
620 Outputs highlighted diff; needs highstring(1).
623 Returns true, if zsh version is equal or greater than 4, else false.
626 Returns true, if zsh version is equal or greater than 4.1, else false.
629 Returns true, if zsh version is equal or greater than 4.2, else false.
632 Returns true, if zsh version is equal or greater than 4.2.5, else false.
635 Returns true, if zsh version is equal or greater than 4.3, else false.
638 Returns true, if zsh version is equal or greater than 4.3.3, else false.
641 Returns true, if running on darwin, else false.
644 Returns true, if running on a grml system, else false.
647 Returns true, if running on a grml system from a live cd, else false.
650 Returns true, if run on grml-small, else false.
653 Changes every occurrence of the string iso885915 or ISO885915 in
654 environment variables to UTF-8.
657 Returns true, if run within an utf environment, else false.
660 Creates directory including parent directories, if necessary. Then changes
661 current working directory to it.
664 Lists files in current directory, which have been modified within the
665 last N days. N is an integer to be passed as first and only argument.
666 If no argument is specified N is set to 1.
669 A helper function for the "e" glob qualifier to list all files newer
670 than a reference file.
674 % NTREF=/reference/file
677 % ls -l *(e:'nt /reference/file':)
681 Runs a command in $SHELL with profiling enabled (See startup variable
682 ZSH_PROFILE_RC above).
685 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
686 for details. See also xunfunction() below.
688 : **simple-extract()**
689 Tries to uncompress/unpack given files with the appropriate programs. If an URI
690 starting with https, http or ftp is provided simple-extract tries to download
691 and then uncompress/unpack the file. The choice is made along the filename
692 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
693 .xz) unless you use the '-d' option.
696 Prints details of symlinks given as arguments.
698 : **ssl-cert-fingerprints**
699 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
700 First and only parameter must be a file containing a certificate. Use
701 /dev/stdin as file if you want to pipe a certificate to these
705 Prints all information of a x509 certificate including the SHA512,
706 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
707 containing a certificate. Use /dev/stdin as file if you want to pipe a
708 certificate to this function.
710 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
711 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
712 certificate. First and only parameter must be a file containing a
713 certificate. Use /dev/stdin as file if you want to pipe a certificate
716 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
717 Functions for controlling daemons.
724 Translates a word from german to english (-D) or vice versa (-E).
727 Shows upstreams changelog of a given package in $PAGER.
730 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
733 Changes every occurrence of the string UTF-8 or utf-8 in environment
734 variables to iso885915.
737 Wrapper for vim(1). It tries to set the title and hands vim the environment
738 variable VIM_OPTIONS on the command line. So the user may define command
739 line options, she always wants, in her .zshrc.local.
742 Searches the history for a given pattern and lists the results by date.
743 The first argument is the search pattern. The second and third ones are
744 optional and denote a search range (default: -100).
747 Tries to cat(1) file(s) given as parameter(s). Always returns true.
748 See also xunfunction() below.
751 Tries to source the file(s) given as parameter(s). Always returns true.
752 See zshbuiltins(1) for a detailed description of the source command.
753 See also xunfunction() below.
756 Changes the title of xterm window from within screen(1). Run without
757 arguments for details.
760 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
763 Wrapper around the autoload builtin. Loads the definitions of functions
764 from the file given as argument. Searches $fpath for the file. See also
768 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
769 where own modifications should go. See also zshbuiltins(1) for a description
770 of the source command.
774 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
775 life. A few aliases (like those involving //grep// or //ls//) use the option
776 //--color=auto// for colourizing output. That option is part of **GNU**
777 implementations of these tools, and will only be used if such an implementation
780 : **acp** (//apt-cache policy//)
781 With no arguments prints out the priorities of each source. If a package name
782 is given, it displays detailed information about the priority selection of the
785 : **acs** (//apt-cache search//)
786 Searches debian package lists for the regular expression provided as argument.
787 The search includes package names and descriptions. Prints out name and short
788 description of matching packages.
790 : **acsh** (//apt-cache show//)
791 Shows the package records for the packages provided as arguments.
793 : **adg** (//apt-get dist-upgrade//)
794 Performs an upgrade of all installed packages. Also tries to automatically
795 handle changing dependencies with new versions of packages. As this may change
796 the install status of (or even remove) installed packages, it is potentially
797 dangerous to use dist-upgrade; invoked by sudo, if necessary.
799 : **ag** (//apt-get upgrade//)
800 Downloads and installs the newest versions of all packages currently installed
801 on the system. Under no circumstances are currently installed packages removed,
802 or packages not already installed retrieved and installed. New versions of
803 currently installed packages that cannot be upgraded without changing the install
804 status of another package will be left at their current version. An update must
805 be performed first (see au below); run by sudo, if necessary.
807 : **agi** (//apt-get install//)
808 Downloads and installs or upgrades the packages given on the command line.
809 If a hyphen is appended to the package name, the identified package will be
810 removed if it is installed. Similarly a plus sign can be used to designate a
811 package to install. This may be useful to override decisions made by apt-get's
812 conflict resolution system.
813 A specific version of a package can be selected for installation by following
814 the package name with an equals and the version of the package to select. This
815 will cause that version to be located and selected for install. Alternatively a
816 specific distribution can be selected by following the package name with a slash
817 and the version of the distribution or the Archive name (stable, testing, unstable).
818 Gets invoked by sudo, if user id is not 0.
820 : **ati** (//aptitude install//)
821 Aptitude is a terminal-based package manager with a command line mode similar to
822 apt-get (see agi above); invoked by sudo, if necessary.
824 : **au** (//apt-get update//)
825 Resynchronizes the package index files from their sources. The indexes of
826 available packages are fetched from the location(s) specified in
827 /etc/apt/sources.list. An update should always be performed before an
828 upgrade or dist-upgrade; run by sudo, if necessary.
830 : **da** (//du -sch//)
831 Prints the summarized disk usage of the arguments as well as a grand total
832 in human readable format.
834 : **dbp** (//dpkg-buildpackage//)
835 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
837 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
838 Prints installed Packages sorted by size (descending).
840 : **dir** (//ls -lSrah//)
841 Lists files (including dot files) sorted by size (biggest last) in long and
842 human readable output format.
844 : **ge** (//grep-excuses//)
845 Searches the testing excuses files for a specific maintainer (See:
848 : **grep** (//grep --color=auto//)
849 Shows grep output in nice colors, if available.
851 : **grml-version** (//cat /etc/grml_version//)
852 Prints version of running grml.
854 : **hbp** (//hg-buildpackage//)
855 Helper program to maintain Debian packages with mercurial.
857 : **http** (//python -m SimpleHTTPServer//)
858 Basic HTTP server implemented in python. Listens on port 8000/tcp and
859 serves current directory. Implements GET and HEAD methods.
861 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
862 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
863 host key changes frequently, for example on virtualized test- or development-systems.
864 To be used only inside trusted networks, of course.
866 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
867 ssh with possible man-in-the-middle attack enabled
868 (for an explanation see insecscp above).
870 : **help-zshglob** (//H-Glob()//)
871 Runs the function H-Glob() to expand or explain wildcards.
873 : **j** (//jobs -l//)
874 Prints status of jobs in the current shell session in long format.
876 : **l** (//ls -lF --color=auto//)
877 Lists files in long output format with indicator for filetype appended
878 to filename. If the terminal supports it, with colored output.
880 : **la** (//ls -la --color=auto//)
881 Lists files in long colored output format. Including file names
884 : **lad** (//ls -d .*(/)//)
885 Lists the dot directories (not their contents) in current directory.
887 : **lh** (//ls -hAl --color=auto//)
888 Lists files in long and human readable output format in nice colors,
889 if available. Includes file names starting with "." except "." and
892 : **ll** (//ls -l --color=auto//)
893 Lists files in long colored output format.
895 : **llog** (//$PAGER /var/log/syslog//)
896 Opens syslog in pager.
898 : **ls** (//ls -b -CF --color=auto//)
899 Lists directory printing octal escapes for nongraphic characters.
900 Entries are listed by columns and an indicator for file type is appended
901 to each file name. Additionally the output is colored, if the terminal
904 : **lsa** (//ls -a .*(.)//)
905 Lists dot files in current working directory.
907 : **lsbig** (//ls -flh *(.OL[1,10])//)
908 Displays the ten biggest files (long and human readable output format).
910 : **lsd** (//ls -d *(/)//)
913 : **lse** (//ls -d *(/^F)//)
914 Shows empty directories.
916 : **lsl** (//ls -l *(@)//)
917 Lists symbolic links in current directory.
919 : **lsnew** (//ls -rl *(D.om[1,10])//)
920 Displays the ten newest files (long output format).
922 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
923 Displays the ten newest directories and ten newest .directories.
925 : **lsold** (//ls -rtlh *(D.om[1,10])//)
926 Displays the ten oldest files (long output format).
928 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
929 Displays the ten oldest directories and ten oldest .directories.
931 : **lss** (//ls -l *(s,S,t)//)
932 Lists files in current directory that have the setuid, setgid or sticky bit
935 : **lssmall** (//ls -Srl *(.oL[1,10])//)
936 Displays the ten smallest files (long output format).
938 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
939 Displays all files which are world readable and/or world writable and/or
940 world executable (long output format).
942 : **lsx** (//ls -l *(*)//)
943 Lists only executable files.
945 : **mdstat** (//cat /proc/mdstat//)
946 Lists all active md (i.e. linux software raid) devices with some information
949 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
950 Executes the commands on the versioned patch queue from current repository.
952 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
953 rmdir current working directory
955 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
956 If invoking user is root, starts screen session with /etc/grml/screenrc
957 as config file. If invoked by a regular user, start a screen session
958 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
961 : **su** (//sudo su//)
962 If user is running a grml live-CD, dont ask for any password, if she
965 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
966 Sets mode from UTF-8 to ISO 2022 (See:
967 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
969 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
970 Sets mode from ISO 2022 to UTF-8 (See:
971 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
973 : **tlog** (//tail -f /var/log/syslog//)
974 Prints syslog continuously (See tail(1)).
976 : **up** (//aptitude update ; aptitude safe-upgrade//)
977 Performs a system update followed by a system upgrade using aptitude; run
978 by sudo, if necessary. See au and ag above.
980 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
981 After calling, characters of URLs as typed get automatically escaped, if necessary, to
982 protect them from the shell.
984 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
985 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
987 : **...** (//cd ../..///)
988 Changes current directory two levels higher.
992 This is a set of files, that - if they exist - can be used to customize the
993 behaviour of //grmlzshrc//.
996 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
997 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1000 # show battery status in RPROMPT
1002 # always load the complete setup, even for root
1003 GRML_ALWAYS_LOAD_ALL=1
1007 Sourced right before loading //grmlzshrc// is finished. There is a global
1008 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1012 Directory listing for persistent dirstack (see above).
1014 : **.important_commands**
1015 List of commands, used by persistent history (see above).
1018 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1019 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1020 (http://www.ubuntu.com) and similar systems - it is very easy to get
1021 //grmlzshrc// via grml's .deb repositories.
1023 On non-debian systems, that is not an option, but all is not lost:
1026 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1029 If you would also like to get seperate function files (which you can put into
1030 your **$fpath**), you can browse and download them at:
1032 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1034 = ZSH REFCARD TAGS =
1035 If you read //grmlzshrc//'s code you may notice strange looking comments in
1036 it. These are there for a purpose. grml's zsh-refcard is automatically
1037 generated from the contents of the actual configuration file. However, we need
1038 a little extra information on which comments and what lines of code to take
1039 into account (and for what purpose).
1041 Here is what they mean:
1043 List of tags (comment types) used:
1045 Next line contains an important alias, that should be included in the
1046 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1049 Next line contains the beginning of an important function. (placement
1050 tag: @@INSERT-functions@@)
1053 Next line contains an important variable. (placement tag:
1054 @@INSERT-variables@@)
1057 Next line contains an important keybinding. (placement tag:
1058 @@INSERT-keybindings@@)
1061 Hashed directories list generation: //start//: denotes the start of a list of
1062 'hash -d' definitions. //end//: denotes its end. (placement tag:
1063 @@INSERT-hasheddirs@@)
1066 Abbreviation expansion list generation: //start//: denotes the beginning of
1067 abbreviations. //end//: denotes their end.
1069 Lines within this section that end in '#d .*' provide extra documentation to
1070 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1073 This tag allows you to manually generate refcard entries for code lines that
1074 are hard/impossible to parse.
1078 #m# k ESC-h Call the run-help function
1081 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1084 So the syntax is: #m# <section> <argument> <comment>
1087 This tag lets you insert entries to the 'other' hash. Generally, this should
1088 not be used. It is there for things that cannot be done easily in another way.
1089 (placement tag: @@INSERT-other-foobar@@)
1092 All of these tags (except for m and o) take two arguments, the first
1093 within the tag, the other after the tag:
1095 #<tag><section># <comment>
1097 Where <section> is really just a number, which are defined by the @secmap
1098 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1099 that for the reader, the tag should not differ much from a regular comment.
1100 For zsh, it is a regular comment indeed. The numbers have got the following
1125 So, the following will add an entry to the 'functions' table in the 'system'
1126 section, with a (hopefully) descriptive comment:
1129 #f1# Edit an alias via zle
1133 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1134 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1135 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1136 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1137 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1141 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1142 repository from git.grml.org:
1144 ``` % git clone git://git.grml.org/grml-etc-core.git
1146 Make your changes, commit them; use '**git format-patch**' to create a series
1147 of patches and send those to the following address via '**git send-email**':
1149 ``` grml-etc-core@grml.org
1151 Doing so makes sure the right people get your patches for review and
1156 This manual page is the **reference** manual for //grmlzshrc//.
1158 That means that in contrast to the existing refcard it should document **every**
1159 aspect of the setup.
1161 This manual is currently not complete. If you want to help improving it, visit
1162 the following pages:
1164 http://wiki.grml.org/doku.php?id=zshrcmanual
1166 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1168 Contributions are highly welcome.
1172 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1173 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1174 Beckert <abe@deuxchevaux.org>.
1178 Copyright (c) 2009-2013 Grml project <http://grml.org>
1180 This manpage is distributed under the terms of the GPL version 2.
1182 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1183 except for **accept-line()** which are distributed under the same conditions
1184 as zsh itself (which is BSD-like).