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:
47 ``` % GRML_DISPLAY_BATTERY=1 zsh
49 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
52 Deprecated. Use **GRML_DISPLAY_BATTERY** instead.
54 : **COMMAND_NOT_FOUND**
55 A non zero value activates a handler, which is called when a command can not
56 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
58 : **GRML_DISPLAY_BATTERY**
59 If set to a value greater than zero, //grmlzshrc// will put the battery status
60 into the right hand side interactive prompt. Supported OSes are //GNU/Linux//,
61 //FreeBSD//, //OpenBSD// and //Darwin//.
63 : **GRML_ZSH_CNF_HANDLER**
64 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
65 and defaults to "/usr/share/command-not-found/command-not-found".
67 : **GRMLSMALL_SPECIFIC**
68 Set this to zero to remove items in zsh config, which do not work in
72 Where zsh saves the history. Default: ${HOME}/.zsh_history.
75 Number of commands to be kept in the history. On a Grml-CD this defaults to
76 500, on a hard disk installation to 5000.
79 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
80 A value of zero turns off checking.
83 Non zero values deactivate automatic correction of commands.
86 If set to zero (default), allows selection from a menu, if there are at least
87 five possible options of completion.
90 A non zero value disables precmd and preexec commands. These are functions
91 that are run before every command (setting xterm/screen titles etc.).
94 Show time (user, system and cpu) used by external commands, if they run longer
95 than the defined number of seconds (default: 5).
98 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
99 and to 10000 on an installation on hard disk.
102 As in tcsh(1) an array of login/logout events to be reported by the shell
103 builtin "log". For details see zshparam(1). Defaults to (notme root).
105 : **ZSH_NO_DEFAULT_LOCALE**
106 Import "/etc/default/locale", if set to zero (default).
109 A non zero value causes shell functions to be profiled. The results can be
110 obtained with the zprof builtin command (see zshmodules(1) for details).
113 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
116 = FEATURE DESCRIPTION =
117 This is an in depth description of non-standard features implemented by
120 == DIRSTACK HANDLING ==
121 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
122 file each time zsh's working directory is changed. That file can be configured
123 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
124 **DIRSTACKSIZE** variable defaults to **20** in this setup.
126 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
127 zshs inherit the dirstack of the zsh that most recently updated
130 == DIRECTORY BASED PROFILES ==
132 If you need to perform certain actions each time you enter certain
133 directory-trees, this is the feature you are looking for.
136 === Initialisation ===
137 To initialise the system, you need to call the function `chpwd_profiles' at
138 some point in your `zshrc.local'; preferably **after** you configured the
139 system. The configuration of the system is described further below.
141 If you need to do initialisations the first time `chpwd_profiles' is called
142 (which should be in your configuration file), you can do that in a function
143 called "chpwd_profiles_init". That function needs to be defined **before**
144 `chpwd_profiles' is called for this to work.
146 During the **first** call of `chpwd_profiles' (and therefore all its profile
147 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
148 all other cases, the parameter does not exist at all.
151 === Styles and Profile-names ===
152 To store its configuration, the system uses **functions** and **styles**
153 (zsh's context sensitive configuration system), such as this:
157 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
158 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
161 When that's done and you enter a directory that matches the pattern in the
162 third part of the context, a function called chpwd_profile_grml, for example,
163 is called (if it exists).
165 If no pattern matches (read: no profile is detected) the profile is set to
166 'default', which means chpwd_profile_default is attempted to be called.
168 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
169 which is used: The third part in the context is matched against ${PWD}. That's
170 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
171 profile is detected for all these values of ${PWD}:
178 So, if you want to make double damn sure a profile works in /foo/bar and
179 everywhere deeper in that tree, just use (|/|/*) and be happy.
181 The name of the detected profile will be available in a variable called
182 'profile' in your functions. You don't need to do anything, it'll just be
186 === Controlling Profile Execution ===
188 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
189 which is set to the profile that was is currently active (the default value is
190 "default"). That way you can avoid running code for a profile that is already
191 active, by running code such as the following at the start of your function:
194 function chpwd_profile_grml() {
195 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
200 If you know you are going to do that all the time for each and every
201 directory-profile function you are ever going to write, you may also set the
202 `re-execute' style to `false' (which only defaults to `true' for backwards
203 compatibility), like this:
206 zstyle ':chpwd:profiles:*' re-execute false
210 === Signaling availabily/profile changes ===
212 If you use this feature and need to know whether it is active in your current
213 shell, there are several ways to do that. Here are two simple ways:
215 a) If knowing if the profiles feature is active when zsh starts is good
216 enough for you, you can use the following snippet:
218 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
220 b) If that is not good enough, and you would prefer to be notified whenever a
221 profile changes, you can solve that by making sure you start **every**
222 profile function you create like this:
224 function chpwd_profile_myprofilename() {
225 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
226 print "chpwd(): Switching to profile: $profile"
230 That makes sure you only get notified if a profile is **changed**, not
231 everytime you change directory. (To avoid this, you may also set the newer
232 `re-execute' style like described further above instead of the test on top of
236 === Leaving Profiles ===
238 When the system switches from one profile to another, it executes a function
239 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
240 profile-function for the new profile.
243 === Version requirement ===
244 This feature requires zsh //4.3.3// or newer.
247 == ACCEPTLINE WRAPPER ==
248 The //accept-line// wiget is the one that is taking action when the **return**
249 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
252 This wrapper is configured via styles. That means, you issue commands, that look
256 zstyle 'context' style value
259 The context namespace, that we are using is 'acceptline'. That means, the actual
260 context for your commands look like: **':acceptline:<subcontext>'**.
262 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
266 === Recognized Contexts ===
268 This is the value, the context is initialized with.
269 The //compwarnfmt and //rehash// styles are looked up in this context.
272 If the first word in the command line is either a command, alias, function,
273 builtin or reserved word, you are in this context.
276 This is the context, that is used if you hit enter again, after being warned
277 about the existence of a _completion for the non-existing command you
281 This is the context, you are in if the command line is empty or only
282 consists of whitespace.
285 This context is in effect, if you entered something that does not match any
286 of the above. (e.g.: variable assignments).
289 === Available Styles ===
291 If you set this style to true, the warning about non existent commands,
292 for which completions exist will not be issued. (Default: **false**)
295 The message, that is displayed to warn about the _completion issue.
296 (default: **'%c will not execute and completion %f exists.'**)
297 '%c' is replaced by the command name, '%f' by the completion's name.
300 If this is set, we'll force rehashing, if appropriate. (Defaults to
301 **true** in //grmlzshrc//).
304 This can be a list of wigdets to call in a given context. If you need a
305 specific order for these to be called, name them accordingly. The default value
306 is an **empty list**.
309 The name of a widget, that is called after the widgets from 'actions'.
310 By default, this will be '.accept-line' (which is the built-in accept-line
314 If true in the current context, call the widget in the 'default_action'
315 style. (The default is **true** in all contexts.)
320 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
321 **promptinit** system. The three themes are called **grml**, **grml-large** and
324 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
325 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
326 non-empty, **grml-chroot** is used.
328 As usual, with promtinit themes, the user may switch to a different theme using
329 the //prompt// utility:
335 That will use the **grml-large** prompt theme.
337 The themes are highly customisable. The main source of documentation about
338 customisation is the main **grml** theme's doc-string, that is available via
339 the following command:
345 The other themes also come with doc-strings, but the main theme's is the
346 canonical reference about all of them.
348 This feature requires version //4.3.7// of the shell. Older versions will use
349 the classic grml prompt as a fallback.
351 A note to people who like customisation: If you are **not** using a prompt
352 theme for your customisation, but you're either statically setting $PS1 (or
353 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
354 function, make sure you are turning the zsh's prompt theme system **off**
355 before doing so. A correct example customisation could look like this:
358 # Turn the prompt system off:
360 # Customise the prompt yourself:
364 You also add your own tokens by using the \`grml_theme_add_token()' function.
365 Call the function without arguments for detailed documentation about that
368 == GNU/SCREEN STATUS SETTING ==
369 //grmlzshrc// sets screen's hardstatus lines to the currently running command
370 or **'zsh'** if the shell is idling at its prompt. If the current working
371 directory is inside a repository unter version control, screen status is set
372 to: **'zsh: <repository name>'** via zsh's vcs_info.
375 == PERSISTENT HISTORY ==
376 If you got commands you consider important enough to be included in every
377 shell's history, you can put them into ~/.important_commands and they will be
378 available via the usual history lookup widgets.
382 == ENVIRONMENT VARIABLES ==
383 //grmlzshrc// sets some environment variables, which influence the
384 behaviour of applications.
387 Set to "yes". Some applications read this to learn about properties
388 of the terminal they are running in.
391 If not already set, sets the default editor. Falls back to vi(1),
392 if vim(1) is not available.
395 Some environment variables that add colour support to less(1) for viewing
396 man pages. See termcap(5) for details.
399 The mailbox file for the current user is set to /var/mail/$USER, if not
400 already set otherwise.
403 Set less(1) as default pager, if not already set to something different.
406 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
407 default to /bin/sh or /bin/bash.
411 Apart from zsh's default options, //grmlzshrc// sets some options
412 that change the behaviour of zsh. Options that change Z-shell's default
413 settings are marked by <grml>. But note, that zsh's defaults vary depending
414 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
417 Zsh sessions, that use //grmlzshrc//, will append their history list to the
418 history file, rather than replace it. Thus, multiple parallel zsh sessions
419 will all have the new entries from their history lists added to the history
420 file, in the order that they exit. The file will still be periodically
421 re-written to trim it when the number of lines grows 20% beyond the value
422 specified by $SAVEHIST.
425 If a command is issued that can't be executed as a normal command, and the
426 command is the name of a directory, perform the cd command to that directory.
428 : **auto_pushd** <grml>
429 Make cd push the old directory onto the directory stack.
431 : **completeinword** <grml>
432 If the cursor is inside a word, completion is done from both ends;
433 instead of moving the cursor to the end of the word first and starting
436 : **extended_glob** <grml>
437 Treat the '#', '~' and '^' characters as active globbing pattern characters.
439 : **extended_history** <grml>
440 Save each command's beginning timestamp (in seconds since the epoch) and the
441 duration (in seconds) to the history file.
444 Whenever a command completion is attempted, make sure the entire command
445 path is hashed first. This makes the first completion slower.
447 : **histignorealldups** <grml>
448 If a new command line being added to the history list duplicates an
449 older one, the older command is removed from the list, even if it is
450 not the previous event.
452 : **histignorespace** <grml>
453 Remove command lines from the history list when the first character on
454 the line is a space, or when one of the expanded aliases contains a
455 leading space. Note that the command lingers in the internal history
456 until the next command is entered before it vanishes.
458 : **longlistjobs** <grml>
459 List jobs in long format by default.
462 Avoid to beep on errors in zsh command line editing (zle).
465 A wildcard character never matches a leading '.'.
468 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
470 : **nonomatch** <grml>
471 If a pattern for filename generation has no matches, do not print an error
472 and leave it unchanged in the argument list. This also applies to file
473 expansion of an initial `~' or `='.
476 Report the status of background jobs immediately, rather than waiting until
477 just before printing a prompt.
479 : **pushd_ignore_dups** <grml>
480 Don't push multiple copies of the same directory onto the directory stack.
482 : **share_history** <grml>
483 As each line is added to the history file, it is checked to see if anything
484 else was written out by another shell, and if so it is included in the
485 history of the current shell too. Using !-style history, the commands from
486 the other sessions will not appear in the history list unless you explicitly
487 type the "history" command. This option is activated for zsh versions >= 4,
492 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
493 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
497 Edit the current command buffer in your favourite editor.
500 Deletes a word left of the cursor; seeing '/' as additional word separator.
503 Jump right after the first word.
506 Create directory under cursor or the selected area.
507 To select an area press ctrl-@ and use the cursor.
508 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
509 directory does not exist yet -> press **CTRL-xM** and problem solved.
512 Searches the last occurence of string before the cursor in the command history.
515 Display help on keybindings and zsh line editor. Press consecutively to page through content.
518 Brings a job, which got suspended with CTRL-z back to foreground.
521 === Customisation ===
523 To customise keybindings, you can just use zsh's bindkey utility. However, if
524 you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
525 yourself, make sure you call the following functions in the respective hook:
527 - **zle-line-init**: //zle-smkx//
528 - **zle-line-finish**: //zle-rmkx//
531 This is **required** so the keybindings set up by //grmlzshrc// work. The
532 reason for this is to turn the terminal into the right mode while zsh's line
533 editor (zle) is running. This enables us to query //terminfo// about escape
534 sequences for special keys and thus simplify and generalise our keybinding
538 == SHELL FUNCTIONS ==
539 //grmlzshrc// comes with a wide array of defined shell functions to ease the
542 : **855resolution()**
543 If 915resolution is available, issues a warning to the user to run it instead
544 to modify the resolution on intel graphics chipsets.
547 Lists files in current directory, which have been accessed within the
548 last N days. N is an integer to be passed as first and only argument.
549 If no argument is specified N is set to 1.
552 Sets all ulimit values to "unlimited".
555 Lists processes matching given pattern.
558 Login on the host provided as argument using autossh. Then reattach a GNU screen
559 session if a detached session is around or detach a currently attached screen or
560 else start a new screen. This is especially useful for roadwarriors using GNU
564 Simple backup management of a file or directory using standard unix programs.
565 The target file name is the original name plus a time stamp attached. Symlinks
566 and file attributes like mode, ownership and timestamps are preserved.
569 If the original cdrecord is not installed, issues a warning to the user to
570 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
574 Creates a temporary directory using mktemp. Then changes current
575 working directory to it.
578 Lists files in current directory, which have been changed within the
579 last N days. N is an integer to be passed as first and only argument.
580 If no argument is specified N is set to 1.
583 Returns true if given command exists either as program, function, alias,
584 builtin or reserved word. If the option -c is given, only returns true,
585 if command is a program.
588 Changes directory to $HOME on first invocation of zsh. This is necessary on
589 Grml systems with autologin.
592 Changes current directory to the one supplied by argument and lists the files
593 in it, including file names starting with ".".
596 Shows the changelog of given package in $PAGER.
599 Shows the copyright of given package in $PAGER.
602 Tells the user to use grml-debootstrap, if she wants to install debian to
606 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
607 back interactive responsiveness after suspend, when the system is swapping
611 Shows the NEWS file for the given package in $PAGER.
617 Edit given shell function.
620 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
622 : **grml_vcs_info_toggle_colour()**
623 Toggles between coloured and uncoloured formats in vcs_info configuration.
624 This is useful with prompts that break if colour codes are in vcs_info
625 format expansions (like the `clint' prompt and every other prompt that
626 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
627 customised vcs_info formats, you shouldn't be using this function, since
628 it will set all formats to grml's default values (either coloured or plain)
632 Use GNU diff with options -ubwd for mercurial.
635 Displays diffstat between the revision given as argument and tip (no
636 argument means last revision).
639 Outputs highlighted diff; needs highstring(1).
642 Returns true, if zsh version is equal or greater than 4, else false.
645 Returns true, if zsh version is equal or greater than 4.1, else false.
648 Returns true, if zsh version is equal or greater than 4.2, else false.
651 Returns true, if zsh version is equal or greater than 4.2.5, else false.
654 Returns true, if zsh version is equal or greater than 4.3, else false.
657 Returns true, if zsh version is equal or greater than 4.3.3, else false.
660 Returns true, if running on darwin, else false.
663 Returns true, if running on FreeBSD, else false.
666 Returns true, if running on a grml system, else false.
669 Returns true, if running on a grml system from a live cd, else false.
672 Returns true, if run on grml-small, else false.
675 Returns true, if running on Linux, else false.
678 Changes every occurrence of the string iso885915 or ISO885915 in
679 environment variables to UTF-8.
682 Returns true, if running on OpenBSD, else false.
685 Returns true, if run within an utf environment, else false.
688 Creates directory including parent directories, if necessary. Then changes
689 current working directory to it.
692 Lists files in current directory, which have been modified within the
693 last N days. N is an integer to be passed as first and only argument.
694 If no argument is specified N is set to 1.
697 A helper function for the "e" glob qualifier to list all files newer
698 than a reference file.
702 % NTREF=/reference/file
705 % ls -l *(e:'nt /reference/file':)
709 Runs a command in $SHELL with profiling enabled (See startup variable
710 ZSH_PROFILE_RC above).
713 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
714 for details. See also xunfunction() below.
716 : **simple-extract()**
717 Tries to uncompress/unpack given files with the appropriate programs. If an URI
718 starting with https, http or ftp is provided simple-extract tries to download
719 and then uncompress/unpack the file. The choice is made along the filename
720 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
721 .xz) unless you use the '-d' option.
724 Prints details of symlinks given as arguments.
726 : **ssl-cert-fingerprints**
727 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
728 First and only parameter must be a file containing a certificate. Use
729 /dev/stdin as file if you want to pipe a certificate to these
733 Prints all information of a x509 certificate including the SHA512,
734 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
735 containing a certificate. Use /dev/stdin as file if you want to pipe a
736 certificate to this function.
738 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
739 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
740 certificate. First and only parameter must be a file containing a
741 certificate. Use /dev/stdin as file if you want to pipe a certificate
744 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
745 Functions for controlling daemons.
752 Translates a word from german to english (-D) or vice versa (-E).
755 Shows upstreams changelog of a given package in $PAGER.
758 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
761 Changes every occurrence of the string UTF-8 or utf-8 in environment
762 variables to iso885915.
765 Wrapper for vim(1). It tries to set the title and hands vim the environment
766 variable VIM_OPTIONS on the command line. So the user may define command
767 line options, she always wants, in her .zshrc.local.
770 Searches the history for a given pattern and lists the results by date.
771 The first argument is the search pattern. The second and third ones are
772 optional and denote a search range (default: -100).
775 Tries to cat(1) file(s) given as parameter(s). Always returns true.
776 See also xunfunction() below.
779 Tries to source the file(s) given as parameter(s). Always returns true.
780 See zshbuiltins(1) for a detailed description of the source command.
781 See also xunfunction() below.
784 Changes the title of xterm window from within screen(1). Run without
785 arguments for details.
788 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
791 Wrapper around the autoload builtin. Loads the definitions of functions
792 from the file given as argument. Searches $fpath for the file. See also
796 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
797 where own modifications should go. See also zshbuiltins(1) for a description
798 of the source command.
802 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
803 life. A few aliases (like those involving //grep// or //ls//) use the option
804 //--color=auto// for colourizing output. That option is part of **GNU**
805 implementations of these tools, and will only be used if such an implementation
808 : **acp** (//apt-cache policy//)
809 With no arguments prints out the priorities of each source. If a package name
810 is given, it displays detailed information about the priority selection of the
813 : **acs** (//apt-cache search//)
814 Searches debian package lists for the regular expression provided as argument.
815 The search includes package names and descriptions. Prints out name and short
816 description of matching packages.
818 : **acsh** (//apt-cache show//)
819 Shows the package records for the packages provided as arguments.
821 : **adg** (//apt-get dist-upgrade//)
822 Performs an upgrade of all installed packages. Also tries to automatically
823 handle changing dependencies with new versions of packages. As this may change
824 the install status of (or even remove) installed packages, it is potentially
825 dangerous to use dist-upgrade; invoked by sudo, if necessary.
827 : **ag** (//apt-get upgrade//)
828 Downloads and installs the newest versions of all packages currently installed
829 on the system. Under no circumstances are currently installed packages removed,
830 or packages not already installed retrieved and installed. New versions of
831 currently installed packages that cannot be upgraded without changing the install
832 status of another package will be left at their current version. An update must
833 be performed first (see au below); run by sudo, if necessary.
835 : **agi** (//apt-get install//)
836 Downloads and installs or upgrades the packages given on the command line.
837 If a hyphen is appended to the package name, the identified package will be
838 removed if it is installed. Similarly a plus sign can be used to designate a
839 package to install. This may be useful to override decisions made by apt-get's
840 conflict resolution system.
841 A specific version of a package can be selected for installation by following
842 the package name with an equals and the version of the package to select. This
843 will cause that version to be located and selected for install. Alternatively a
844 specific distribution can be selected by following the package name with a slash
845 and the version of the distribution or the Archive name (stable, testing, unstable).
846 Gets invoked by sudo, if user id is not 0.
848 : **ati** (//aptitude install//)
849 Aptitude is a terminal-based package manager with a command line mode similar to
850 apt-get (see agi above); invoked by sudo, if necessary.
852 : **au** (//apt-get update//)
853 Resynchronizes the package index files from their sources. The indexes of
854 available packages are fetched from the location(s) specified in
855 /etc/apt/sources.list. An update should always be performed before an
856 upgrade or dist-upgrade; run by sudo, if necessary.
858 : **da** (//du -sch//)
859 Prints the summarized disk usage of the arguments as well as a grand total
860 in human readable format.
862 : **dbp** (//dpkg-buildpackage//)
863 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
865 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
866 Prints installed Packages sorted by size (descending).
868 : **dir** (//ls -lSrah//)
869 Lists files (including dot files) sorted by size (biggest last) in long and
870 human readable output format.
872 : **ge** (//grep-excuses//)
873 Searches the testing excuses files for a specific maintainer (See:
876 : **grep** (//grep --color=auto//)
877 Shows grep output in nice colors, if available.
879 : **grml-version** (//cat /etc/grml_version//)
880 Prints version of running grml.
882 : **hbp** (//hg-buildpackage//)
883 Helper program to maintain Debian packages with mercurial.
885 : **http** (//python -m SimpleHTTPServer//)
886 Basic HTTP server implemented in python. Listens on port 8000/tcp and
887 serves current directory. Implements GET and HEAD methods.
889 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
890 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
891 host key changes frequently, for example on virtualized test- or development-systems.
892 To be used only inside trusted networks, of course.
894 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
895 ssh with possible man-in-the-middle attack enabled
896 (for an explanation see insecscp above).
898 : **help-zshglob** (//H-Glob()//)
899 Runs the function H-Glob() to expand or explain wildcards.
901 : **j** (//jobs -l//)
902 Prints status of jobs in the current shell session in long format.
904 : **l** (//ls -l --color=auto//)
905 Lists files in long output format with indicator for filetype appended
906 to filename. If the terminal supports it, with colored output.
908 : **la** (//ls -la --color=auto//)
909 Lists files in long colored output format. Including file names
912 : **lad** (//ls -d .*(/)//)
913 Lists the dot directories (not their contents) in current directory.
915 : **lh** (//ls -hAl --color=auto//)
916 Lists files in long and human readable output format in nice colors,
917 if available. Includes file names starting with "." except "." and
920 : **ll** (//ls -l --color=auto//)
921 Lists files in long colored output format.
923 : **llog** (//$PAGER /var/log/syslog//)
924 Opens syslog in pager.
926 : **ls** (//ls -C --color=auto//)
927 Lists directory, entries are listed by columns and an indicator for
928 file type is appended to each file name. Additionally the output is
929 colored, if the terminal supports it.
931 : **lsa** (//ls -a .*(.)//)
932 Lists dot files in current working directory.
934 : **lsbig** (//ls -flh *(.OL[1,10])//)
935 Displays the ten biggest files (long and human readable output format).
937 : **lsd** (//ls -d *(/)//)
940 : **lse** (//ls -d *(/^F)//)
941 Shows empty directories.
943 : **lsl** (//ls -l *(@)//)
944 Lists symbolic links in current directory.
946 : **lsnew** (//ls -rl *(D.om[1,10])//)
947 Displays the ten newest files (long output format).
949 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
950 Displays the ten newest directories and ten newest .directories.
952 : **lsold** (//ls -rtlh *(D.om[1,10])//)
953 Displays the ten oldest files (long output format).
955 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
956 Displays the ten oldest directories and ten oldest .directories.
958 : **lss** (//ls -l *(s,S,t)//)
959 Lists files in current directory that have the setuid, setgid or sticky bit
962 : **lssmall** (//ls -Srl *(.oL[1,10])//)
963 Displays the ten smallest files (long output format).
965 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
966 Displays all files which are world readable and/or world writable and/or
967 world executable (long output format).
969 : **lsx** (//ls -l *(*)//)
970 Lists only executable files.
972 : **mdstat** (//cat /proc/mdstat//)
973 Lists all active md (i.e. linux software raid) devices with some information
976 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
977 Executes the commands on the versioned patch queue from current repository.
979 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
980 rmdir current working directory
982 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
983 If invoking user is root, starts screen session with /etc/grml/screenrc
984 as config file. If invoked by a regular user, start a screen session
985 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
988 : **su** (//sudo su//)
989 If user is running a Grml live system, don't ask for any password, if she
992 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
993 Sets mode from UTF-8 to ISO 2022 (See:
994 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
996 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
997 Sets mode from ISO 2022 to UTF-8 (See:
998 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1000 : **tlog** (//tail -f /var/log/syslog//)
1001 Prints syslog continuously (See tail(1)).
1003 : **up** (//aptitude update ; aptitude safe-upgrade//)
1004 Performs a system update followed by a system upgrade using aptitude; run
1005 by sudo, if necessary. See au and ag above.
1007 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1008 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1009 protect them from the shell.
1011 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1012 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1014 : **...** (//cd ../..///)
1015 Changes current directory two levels higher.
1019 This is a set of files, that - if they exist - can be used to customize the
1020 behaviour of //grmlzshrc//.
1023 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1024 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1027 # show battery status in RPROMPT
1028 GRML_DISPLAY_BATTERY=1
1029 # always load the complete setup, even for root
1030 GRML_ALWAYS_LOAD_ALL=1
1034 Sourced right before loading //grmlzshrc// is finished. There is a global
1035 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1039 Directory listing for persistent dirstack (see above).
1041 : **.important_commands**
1042 List of commands, used by persistent history (see above).
1045 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1046 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1047 (http://www.ubuntu.com) and similar systems - it is very easy to get
1048 //grmlzshrc// via grml's .deb repositories.
1050 On non-debian systems, that is not an option, but all is not lost:
1053 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1056 If you would also like to get separate function files (which you can put into
1057 your **$fpath**), you can browse and download them at:
1059 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1061 = ZSH REFCARD TAGS =
1062 If you read //grmlzshrc//'s code you may notice strange looking comments in
1063 it. These are there for a purpose. grml's zsh-refcard is automatically
1064 generated from the contents of the actual configuration file. However, we need
1065 a little extra information on which comments and what lines of code to take
1066 into account (and for what purpose).
1068 Here is what they mean:
1070 List of tags (comment types) used:
1072 Next line contains an important alias, that should be included in the
1073 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1076 Next line contains the beginning of an important function. (placement
1077 tag: @@INSERT-functions@@)
1080 Next line contains an important variable. (placement tag:
1081 @@INSERT-variables@@)
1084 Next line contains an important keybinding. (placement tag:
1085 @@INSERT-keybindings@@)
1088 Hashed directories list generation: //start//: denotes the start of a list of
1089 'hash -d' definitions. //end//: denotes its end. (placement tag:
1090 @@INSERT-hasheddirs@@)
1093 Abbreviation expansion list generation: //start//: denotes the beginning of
1094 abbreviations. //end//: denotes their end.
1096 Lines within this section that end in '#d .*' provide extra documentation to
1097 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1100 This tag allows you to manually generate refcard entries for code lines that
1101 are hard/impossible to parse.
1105 #m# k ESC-h Call the run-help function
1108 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1111 So the syntax is: #m# <section> <argument> <comment>
1114 This tag lets you insert entries to the 'other' hash. Generally, this should
1115 not be used. It is there for things that cannot be done easily in another way.
1116 (placement tag: @@INSERT-other-foobar@@)
1119 All of these tags (except for m and o) take two arguments, the first
1120 within the tag, the other after the tag:
1122 #<tag><section># <comment>
1124 Where <section> is really just a number, which are defined by the @secmap
1125 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1126 that for the reader, the tag should not differ much from a regular comment.
1127 For zsh, it is a regular comment indeed. The numbers have got the following
1152 So, the following will add an entry to the 'functions' table in the 'system'
1153 section, with a (hopefully) descriptive comment:
1156 #f1# Edit an alias via zle
1160 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1161 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1162 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1163 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1164 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1168 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1169 repository from git.grml.org:
1171 ``` % git clone git://git.grml.org/grml-etc-core.git
1173 Make your changes, commit them; use '**git format-patch**' to create a series
1174 of patches and send those to the following address via '**git send-email**':
1176 ``` grml-etc-core@grml.org
1178 Doing so makes sure the right people get your patches for review and
1183 This manual page is the **reference** manual for //grmlzshrc//.
1185 That means that in contrast to the existing refcard it should document **every**
1186 aspect of the setup.
1188 This manual is currently not complete. If you want to help improving it, visit
1189 the following pages:
1191 http://wiki.grml.org/doku.php?id=zshrcmanual
1193 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1195 Contributions are highly welcome.
1199 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1200 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1201 Beckert <abe@deuxchevaux.org>.
1205 Copyright (c) 2009-2013 Grml project <http://grml.org>
1207 This manpage is distributed under the terms of the GPL version 2.
1209 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1210 except for **accept-line()** which are distributed under the same conditions
1211 as zsh itself (which is BSD-like).