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_COMP_CACHING**
59 If set to //yes// (the default), the setup will enable zsh's completion caching
60 mechanism, with the caching data being placed into //$GRML_COMP_CACHE_DIR//.
62 : **GRML_COMP_CACHE_DIR**
63 This defines where zsh's completion caching data will be placed, if
64 //$GRML_COMP_CACHING// is active. The default is //${ZDOTDIR:-$HOME}/.cache//.
65 The setup will ensure the directory exists before attempting to use it.
67 : **GRML_DISPLAY_BATTERY**
68 If set to a value greater than zero, //grmlzshrc// will put the battery status
69 into the right hand side interactive prompt. Supported OSes are //GNU/Linux//,
70 //FreeBSD//, //OpenBSD// and //Darwin//.
72 : **GRML_ZSH_CNF_HANDLER**
73 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
74 and defaults to "/usr/share/command-not-found/command-not-found".
76 : **GRML_NO_APT_ALIASES**
77 A non-empty value inhibits the definition of apt-specific short aliases,
78 such as ag, agi, ati etc.
80 : **GRML_NO_SMALL_ALIASES**
81 A non-empty value inhibits the definition of 2-letter aliases such as da.
82 ls, ll, la and other common ls-related aliases are exempt from this, as are
83 the aliases inhibited by GRML_NO_APT_ALIASES.
85 : **GRMLSMALL_SPECIFIC**
86 Set this to zero to remove items in zsh config, which do not work in
90 Where zsh saves the history. Default: ${HOME}/.zsh_history.
93 Number of commands to be kept in the history. On a Grml-CD this defaults to
94 500, on a hard disk installation to 5000.
97 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
98 A value of zero turns off checking.
101 Non zero values deactivate automatic correction of commands.
104 If set to zero (default), allows selection from a menu, if there are at least
105 five possible options of completion.
108 A non zero value disables precmd and preexec commands. These are functions
109 that are run before every command (setting xterm/screen titles etc.).
112 Show time (user, system and cpu) used by external commands, if they run longer
113 than the defined number of seconds (default: 5).
116 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
117 and to 10000 on an installation on hard disk.
120 As in tcsh(1) an array of login/logout events to be reported by the shell
121 builtin "log". For details see zshparam(1). Defaults to (notme root).
123 : **ZSH_NO_DEFAULT_LOCALE**
124 Import "/etc/default/locale", if set to zero (default).
127 A non zero value causes shell functions to be profiled. The results can be
128 obtained with the zprof builtin command (see zshmodules(1) for details).
131 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
134 = GRML-ZSHRC SPECIFIC STYLES =
136 Styles are a context sensitive configuration mechanism included with zsh. The
137 shell uses it extensively in sub-systems like the completion and the VCS info
138 system. It lives outside of the classic shell variable namespace, so it avoids
139 polluting it. New functionality in grml's zshrc will likely use styles instead
140 of variables. Some features of the setup (like the directory stack handling)
141 already use styles. Those styles are documented with the specific features.
142 This section documents more general styles.
144 == Context: :grml:completion:compinit ==
145 This context revolves around the zshrc's //compinit// function call, that
146 initialises zsh's function based completion system.
149 This style allows the injection of arguments to the command line that is used
150 to run compinit. It is a list style and its default is the empty list. Using
151 this style, it's possible to add **-i** to //compinit// in order to disable
155 zstyle ':grml:completion:compinit' arguments -i
158 Only do this, if you know what sort of security checks are disabled if
159 //compaudit// is not active and if that's acceptable with your specific setup.
161 This style has to be set at the point that Grml's zshrc runs //compinit//. A
162 possible way to achieve this is to set it in //~/.zshrc.pre// (see AUXILIARY
163 FILES below for details).
166 = FEATURE DESCRIPTION =
167 This is an in depth description of non-standard features implemented by
170 == DIRSTACK HANDLING ==
171 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
172 file each time zsh's working directory is changed. That file can be configured
173 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
174 **DIRSTACKSIZE** variable defaults to **20** in this setup.
176 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
177 zshs inherit the dirstack of the zsh that most recently updated
180 If you would like to //disable// the persistent dirstack feature altogether,
181 you can do that by setting the boolean //enable// style to //false// in the
182 right context (the default is //true//):
185 zstyle ':grml:chpwd:dirstack' enable false
188 It is possible to apply a filter to the names of directories that will be
189 committed to the persistent dirstack file. There are two ways to configure this
190 filter: A general function based filter and a pattern based filter. Both are
191 setup via styles in the **':grml:chpwd:dirstack'** context.
193 To use a function based filter set the //filter// style for that context to the
194 name of a function to call every time a directory name is to be added to the
195 persistent dirstack. If the function's return value signals success (ie. return
196 value "0"), the directory name is filtered out and **not** added to the
197 persistent stack. Example:
200 function my_dirstack_filter() { [[ $1 == /tmp(|/*) ]] }
201 zstyle ':grml:chpwd:dirstack' filter my_dirstack_filter
204 The pattern based filter uses a list of patterns passed to the //exclude//
205 style in the aforementioned context. Each pattern is tested and the first that
206 matches will keep the directory name from being added to the persistent stack.
207 If none of the patterns matches, the name is added. example:
210 zstyle ':grml:chpwd:dirstack' exclude "/tmp(|/*)" "$HOME/tmp(|/*)"
213 The function based filter is more general, the pattern based filter easier to
214 set up. If both filter variants are used at the same time, the function based
215 filter will be executed //before// the pattern based one.
217 If you would like to apply your filters while //loading// the persistent
218 dirstack file, set the //filter-on-load// boolean style (the default is
222 zstyle ':grml:chpwd:dirstack' filter-on-load true
225 Setting the //filter-on-load// and //enable// styles needs to be done in
226 ".zshrc.pre" because the styles need to be set when the main setup is
227 executing! The other styles do not have this limitation, but enabling the
228 system as well as the initial filtering will obviously be done using settings
229 and filters that are configured **at** **that** **point**.
231 With respect to //filter-on-load//, the rule of thumb is: If you want to filter
232 on load, setup everything in ".zshrc.pre" otherwise ".zshrc.local" works just
236 == DIRECTORY BASED PROFILES ==
238 If you need to perform certain actions each time you enter certain
239 directory-trees, this is the feature you are looking for.
242 === Initialisation ===
243 To initialise the system, you need to call the function `chpwd_profiles' at
244 some point in your `zshrc.local'; preferably **after** you configured the
245 system. The configuration of the system is described further below.
247 If you need to do initialisations the first time `chpwd_profiles' is called
248 (which should be in your configuration file), you can do that in a function
249 called "chpwd_profiles_init". That function needs to be defined **before**
250 `chpwd_profiles' is called for this to work.
252 During the **first** call of `chpwd_profiles' (and therefore all its profile
253 functions) the parameter `$CHPWD_PROFILES_INIT' exists and is set to `1'. In
254 all other cases, the parameter does not exist at all.
257 === Styles and Profile-names ===
258 To store its configuration, the system uses **functions** and **styles**
259 (zsh's context sensitive configuration system), such as this:
263 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
264 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
267 When that's done and you enter a directory that matches the pattern in the
268 third part of the context, a function called chpwd_profile_grml, for example,
269 is called (if it exists).
271 If no pattern matches (read: no profile is detected) the profile is set to
272 'default', which means chpwd_profile_default is attempted to be called.
274 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle command)
275 which is used: The third part in the context is matched against ${PWD}. That's
276 why using a pattern such as /foo/bar(|/|/*) makes sense. Because that way the
277 profile is detected for all these values of ${PWD}:
284 So, if you want to make double damn sure a profile works in /foo/bar and
285 everywhere deeper in that tree, just use (|/|/*) and be happy.
287 The name of the detected profile will be available in a variable called
288 'profile' in your functions. You don't need to do anything, it'll just be
292 === Controlling Profile Execution ===
294 During its initialisation run, the system creates a parameter $CHPWD_PROFILE,
295 which is set to the profile that was is currently active (the default value is
296 "default"). That way you can avoid running code for a profile that is already
297 active, by running code such as the following at the start of your function:
300 function chpwd_profile_grml() {
301 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
306 If you know you are going to do that all the time for each and every
307 directory-profile function you are ever going to write, you may also set the
308 `re-execute' style to `false' (which only defaults to `true' for backwards
309 compatibility), like this:
312 zstyle ':chpwd:profiles:*' re-execute false
316 === Signaling availabily/profile changes ===
318 If you use this feature and need to know whether it is active in your current
319 shell, there are several ways to do that. Here are two simple ways:
321 a) If knowing if the profiles feature is active when zsh starts is good
322 enough for you, you can use the following snippet:
324 (( ${+functions[chpwd_profiles]} )) && print "directory profiles active"
326 b) If that is not good enough, and you would prefer to be notified whenever a
327 profile changes, you can solve that by making sure you start **every**
328 profile function you create like this:
330 function chpwd_profile_myprofilename() {
331 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
332 print "chpwd(): Switching to profile: $profile"
336 That makes sure you only get notified if a profile is **changed**, not
337 everytime you change directory. (To avoid this, you may also set the newer
338 `re-execute' style like described further above instead of the test on top of
342 === Leaving Profiles ===
344 When the system switches from one profile to another, it executes a function
345 named "chpwd_leave_profile_<PREVIOUS-PROFILE-NAME>()" before calling the
346 profile-function for the new profile.
349 === Version requirement ===
350 This feature requires zsh //4.3.3// or newer.
353 == ACCEPTLINE WRAPPER ==
354 The //accept-line// wiget is the one that is taking action when the **return**
355 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
358 This wrapper is configured via styles. That means, you issue commands, that look
362 zstyle 'context' style value
365 The context namespace, that we are using is 'acceptline'. That means, the actual
366 context for your commands look like: **':acceptline:<subcontext>'**.
368 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
372 === Recognized Contexts ===
374 This is the value, the context is initialized with.
375 The //compwarnfmt and //rehash// styles are looked up in this context.
378 If the first word in the command line is either a command, alias, function,
379 builtin or reserved word, you are in this context.
382 This is the context, that is used if you hit enter again, after being warned
383 about the existence of a _completion for the non-existing command you
387 This is the context, you are in if the command line is empty or only
388 consists of whitespace.
391 This context is in effect, if you entered something that does not match any
392 of the above. (e.g.: variable assignments).
395 === Available Styles ===
397 If you set this style to true, the warning about non existent commands,
398 for which completions exist will not be issued. (Default: **false**)
401 The message, that is displayed to warn about the _completion issue.
402 (default: **'%c will not execute and completion %f exists.'**)
403 '%c' is replaced by the command name, '%f' by the completion's name.
406 If this is set, we'll force rehashing, if appropriate. (Defaults to
407 **true** in //grmlzshrc//).
410 This can be a list of wigdets to call in a given context. If you need a
411 specific order for these to be called, name them accordingly. The default value
412 is an **empty list**.
415 The name of a widget, that is called after the widgets from 'actions'.
416 By default, this will be '.accept-line' (which is the built-in accept-line
420 If true in the current context, call the widget in the 'default_action'
421 style. (The default is **true** in all contexts.)
426 The //grmlzshrc// now supplies three prompt themes compatible with zsh's
427 **promptinit** system. The three themes are called **grml**, **grml-large** and
430 By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
431 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
432 non-empty, **grml-chroot** is used.
434 As usual, with promptinit themes, the user may switch to a different theme using
435 the //prompt// utility:
441 That will use the **grml-large** prompt theme.
443 The themes are highly customisable. The main source of documentation about
444 customisation is the main **grml** theme's doc-string, that is available via
445 the following command:
451 The other themes also come with doc-strings, but the main theme's is the
452 canonical reference about all of them.
454 This feature requires version //4.3.7// of the shell. Older versions will use
455 the classic grml prompt as a fallback.
457 A note to people who like customisation: If you are **not** using a prompt
458 theme for your customisation, but you're either statically setting $PS1 (or
459 $PROMPT) or you're constructing one of those variables in zsh's \`precmd()'
460 function, make sure you are turning the zsh's prompt theme system **off**
461 before doing so. A correct example customisation could look like this:
464 # Turn the prompt system off:
466 # Customise the prompt yourself:
470 You also add your own tokens by using the \`grml_theme_add_token()' function.
471 Call the function without arguments for detailed documentation about that
474 == GNU/SCREEN STATUS SETTING ==
475 //grmlzshrc// sets screen's hardstatus lines to the currently running command
476 or **'zsh'** if the shell is idling at its prompt. If the current working
477 directory is inside a repository unter version control, screen status is set
478 to: **'zsh: <repository name>'** via zsh's vcs_info.
481 == PERSISTENT HISTORY ==
482 If you got commands you consider important enough to be included in every
483 shell's history, you can put them into $GRML_IMPORTANT_COMMANDS (which defaults
484 for backward compatibility to ~/.important_commands) and they will be available
485 via the usual history lookup widgets.
489 == ENVIRONMENT VARIABLES ==
490 //grmlzshrc// sets some environment variables, which influence the
491 behaviour of applications.
494 Set to "yes". Some applications read this to learn about properties
495 of the terminal they are running in.
498 If not already set, sets the default editor. Falls back to vi(1),
499 if vim(1) is not available.
502 Some environment variables that add colour support to less(1) for viewing
503 man pages. See termcap(5) for details.
506 The mailbox file for the current user is set to /var/mail/$USER, if not
507 already set otherwise.
510 Set less(1) as default pager, if not already set to something different.
514 Apart from zsh's default options, //grmlzshrc// sets some options
515 that change the behaviour of zsh. Options that change Z-shell's default
516 settings are marked by <grml>. But note, that zsh's defaults vary depending
517 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
520 Zsh sessions, that use //grmlzshrc//, will append their history list to the
521 history file, rather than replace it. Thus, multiple parallel zsh sessions
522 will all have the new entries from their history lists added to the history
523 file, in the order that they exit. The file will still be periodically
524 re-written to trim it when the number of lines grows 20% beyond the value
525 specified by $SAVEHIST.
528 If a command is issued that can't be executed as a normal command, and the
529 command is the name of a directory, perform the cd command to that directory.
531 : **auto_pushd** <grml>
532 Make cd push the old directory onto the directory stack.
534 : **completeinword** <grml>
535 If the cursor is inside a word, completion is done from both ends;
536 instead of moving the cursor to the end of the word first and starting
539 : **extended_glob** <grml>
540 Treat the '#', '~' and '^' characters as active globbing pattern characters.
542 : **extended_history** <grml>
543 Save each command's beginning timestamp (in seconds since the epoch) and the
544 duration (in seconds) to the history file.
547 Whenever a command completion is attempted, make sure the entire command
548 path is hashed first. This makes the first completion slower.
550 : **histignorespace** <grml>
551 Remove command lines from the history list when the first character on
552 the line is a space, or when one of the expanded aliases contains a
553 leading space. Note that the command lingers in the internal history
554 until the next command is entered before it vanishes.
556 : **longlistjobs** <grml>
557 List jobs in long format by default.
560 Avoid to beep on errors in zsh command line editing (zle).
563 A wildcard character never matches a leading '.'.
566 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
568 : **nonomatch** <grml>
569 If a pattern for filename generation has no matches, do not print an error
570 and leave it unchanged in the argument list. This also applies to file
571 expansion of an initial `~' or `='.
574 Report the status of background jobs immediately, rather than waiting until
575 just before printing a prompt.
577 : **pushd_ignore_dups** <grml>
578 Don't push multiple copies of the same directory onto the directory stack.
580 : **share_history** <grml>
581 As each line is added to the history file, it is checked to see if anything
582 else was written out by another shell, and if so it is included in the
583 history of the current shell too. Using !-style history, the commands from
584 the other sessions will not appear in the history list unless you explicitly
585 type the "history" command. This option is activated for zsh versions >= 4,
590 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
591 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
595 Edit the current command buffer in your favourite editor.
598 Deletes a word left of the cursor; seeing '/' as additional word separator.
601 Jump right after the first word.
604 Create directory under cursor or the selected area.
605 To select an area press ctrl-@ and use the cursor.
606 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
607 directory does not exist yet -> press **CTRL-xM** and problem solved.
610 Searches the last occurrence of string before the cursor in the command history.
613 Display help on keybindings and zsh line editor. Press consecutively to page through content.
616 Brings a job, which got suspended with CTRL-z back to foreground.
619 === Customisation ===
621 To customise keybindings, you can just use zsh's bindkey utility. However, if
622 you plan to use the `//zle-line-init//' or `//zle-line-finish//' hooks
623 yourself, make sure you call the following functions in the respective hook:
625 - **zle-line-init**: //zle-smkx//
626 - **zle-line-finish**: //zle-rmkx//
629 This is **required** so the keybindings set up by //grmlzshrc// work. The
630 reason for this is to turn the terminal into the right mode while zsh's line
631 editor (zle) is running. This enables us to query //terminfo// about escape
632 sequences for special keys and thus simplify and generalise our keybinding
636 == SHELL FUNCTIONS ==
637 //grmlzshrc// comes with a wide array of defined shell functions to ease the
640 : **855resolution()**
641 If 915resolution is available, issues a warning to the user to run it instead
642 to modify the resolution on intel graphics chipsets.
645 Lists files in current directory, which have been accessed within the
646 last N days. N is an integer to be passed as first and only argument.
647 If no argument is specified N is set to 1.
650 Lists processes matching given pattern.
653 Login on the host provided as argument using autossh. Then reattach a GNU screen
654 session if a detached session is around or detach a currently attached screen or
655 else start a new screen. This is especially useful for roadwarriors using GNU
659 Simple backup management of a file or directory using standard unix programs.
660 The target file name is the original name plus a time stamp attached. Symlinks
661 and file attributes like mode, ownership and timestamps are preserved.
664 If the original cdrecord is not installed, issues a warning to the user to
665 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
669 Creates a temporary directory using mktemp. Then changes current
670 working directory to it.
673 Lists files in current directory, which have been changed within the
674 last N days. N is an integer to be passed as first and only argument.
675 If no argument is specified N is set to 1.
678 Returns true if given command exists either as program, function, alias,
679 builtin or reserved word. If the option -c is given, only returns true,
680 if command is a program.
683 Changes directory to $HOME on first invocation of zsh. This is necessary on
684 Grml systems with autologin.
687 Changes current directory to the one supplied by argument and lists the files
688 in it, including file names starting with ".".
691 Shows the changelog of given package in $PAGER.
694 Shows the copyright of given package in $PAGER.
697 Tells the user to use grml-debootstrap, if she wants to install debian to
701 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
702 back interactive responsiveness after suspend, when the system is swapping
706 Shows the NEWS file for the given package in $PAGER.
712 Edit given shell function.
715 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
717 : **grml_status_features()**
718 Prints a summary of features the grml setup is trying to load. The result of
719 loading a feature is recorded. This function lets you query the result. The
720 function takes one argument: "-h" or "--help" to display this help text, "+" to
721 display a list of all successfully loaded features, "-" for a list of all
722 features that failed to load. "+-" to show a list of all features with their
723 statuses. Any other word is considered to by a feature and prints its status.
725 The default mode is "+-".
727 : **grml_vcs_info_toggle_colour()**
728 Toggles between coloured and uncoloured formats in vcs_info configuration.
729 This is useful with prompts that break if colour codes are in vcs_info
730 format expansions (like the `clint' prompt and every other prompt that
731 uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
732 customised vcs_info formats, you shouldn't be using this function, since
733 it will set all formats to grml's default values (either coloured or plain)
737 Use GNU diff with options -ubwd for mercurial.
740 Displays diffstat between the revision given as argument and tip (no
741 argument means last revision).
744 Outputs highlighted diff; needs highstring(1).
747 Returns true, if zsh version is equal or greater than 4, else false.
750 Returns true, if zsh version is equal or greater than 4.1, else false.
753 Returns true, if zsh version is equal or greater than 4.2, else false.
756 Returns true, if zsh version is equal or greater than 4.2.5, else false.
759 Returns true, if zsh version is equal or greater than 4.3, else false.
762 Returns true, if zsh version is equal or greater than 4.3.3, else false.
765 Returns true, if running on darwin, else false.
768 Returns true, if running on FreeBSD, else false.
771 Returns true, if running on a grml system, else false.
774 Returns true, if running on a grml system from a live cd, else false.
777 Returns true, if run on grml-small, else false.
780 Returns true, if running on Linux, else false.
783 Changes every occurrence of the string iso885915 or ISO885915 in
784 environment variables to UTF-8.
787 Returns true, if running on OpenBSD, else false.
790 Returns true, if run within an utf environment, else false.
793 Creates directory including parent directories, if necessary. Then changes
794 current working directory to it.
797 Lists files in current directory, which have been modified within the
798 last N days. N is an integer to be passed as first and only argument.
799 If no argument is specified N is set to 1.
802 A helper function for the "e" glob qualifier to list all files newer
803 than a reference file.
807 % NTREF=/reference/file
810 % ls -l *(e:'nt /reference/file':)
814 Runs a command in zsh with profiling enabled (See startup variable
815 ZSH_PROFILE_RC above).
818 Creates an alias with sudo prepended, if $EUID is not zero. Run "salias -h"
819 for details. See also xunfunction() below.
821 : **simple-extract()**
822 Tries to uncompress/unpack given files with the appropriate programs. If an URI
823 starting with https, http or ftp is provided simple-extract tries to download
824 and then uncompress/unpack the file. The choice is made along the filename
825 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
826 .xz) unless you use the '-d' option.
829 Prints details of symlinks given as arguments.
831 : **ssl-cert-fingerprints**
832 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
833 First and only parameter must be a file containing a certificate. Use
834 /dev/stdin as file if you want to pipe a certificate to these
838 Prints all information of a x509 certificate including the SHA512,
839 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
840 containing a certificate. Use /dev/stdin as file if you want to pipe a
841 certificate to this function.
843 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
844 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
845 certificate. First and only parameter must be a file containing a
846 certificate. Use /dev/stdin as file if you want to pipe a certificate
849 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
850 Functions for controlling daemons.
857 Translates a word from german to english (-D) or vice versa (-E).
860 Shows upstreams changelog of a given package in $PAGER.
863 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
866 Changes every occurrence of the string UTF-8 or utf-8 in environment
867 variables to iso885915.
870 Wrapper for vim(1). It tries to set the title and hands vim the environment
871 variable VIM_OPTIONS on the command line. So the user may define command
872 line options, she always wants, in her .zshrc.local.
875 Searches the history for a given pattern and lists the results by date.
876 The first argument is the search pattern. The second and third ones are
877 optional and denote a search range (default: -100).
880 Tries to cat(1) file(s) given as parameter(s). Always returns true.
881 See also xunfunction() below.
884 Tries to source the file(s) given as parameter(s). Always returns true.
885 See zshbuiltins(1) for a detailed description of the source command.
886 See also xunfunction() below.
889 Changes the title of xterm window from within screen(1). Run without
890 arguments for details.
893 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
896 Wrapper around the autoload builtin. Loads the definitions of functions
897 from the file given as argument. Searches $fpath for the file. See also
901 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
902 where own modifications should go. See also zshbuiltins(1) for a description
903 of the source command.
907 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
908 life. A few aliases (like those involving //grep// or //ls//) use the option
909 //--color=auto// for colourizing output. That option is part of **GNU**
910 implementations of these tools, and will only be used if such an implementation
913 : **acp** (//apt-cache policy//)
914 With no arguments prints out the priorities of each source. If a package name
915 is given, it displays detailed information about the priority selection of the
918 : **acs** (//apt search//)
919 Searches debian package lists for the regular expression provided as argument.
920 The search includes package names and descriptions. Prints out name and short
921 description of matching packages.
923 : **acsh** (//apt show//)
924 Shows the package records for the packages provided as arguments.
926 : **adg** (//apt dist-upgrade//)
927 Performs an upgrade of all installed packages. Also tries to automatically
928 handle changing dependencies with new versions of packages. As this may change
929 the install status of (or even remove) installed packages, it is potentially
930 dangerous to use dist-upgrade; invoked by sudo, if necessary.
932 : **ag** (//apt upgrade//)
933 Downloads and installs the newest versions of all packages currently installed
934 on the system. Under no circumstances are currently installed packages removed,
935 or packages not already installed retrieved and installed. New versions of
936 currently installed packages that cannot be upgraded without changing the install
937 status of another package will be left at their current version. An update must
938 be performed first (see au below); run by sudo, if necessary.
940 : **agi** (//apt install//)
941 Downloads and installs or upgrades the packages given on the command line.
942 If a hyphen is appended to the package name, the identified package will be
943 removed if it is installed. Similarly a plus sign can be used to designate a
944 package to install. This may be useful to override decisions made by apt's
945 conflict resolution system.
946 A specific version of a package can be selected for installation by following
947 the package name with an equals and the version of the package to select. This
948 will cause that version to be located and selected for install. Alternatively a
949 specific distribution can be selected by following the package name with a slash
950 and the version of the distribution or the Archive name (stable, testing, unstable).
951 Gets invoked by sudo, if user id is not 0.
953 : **ati** (//aptitude install//)
954 Aptitude is a terminal-based package manager with a command line mode similar to
955 apt (see agi above); invoked by sudo, if necessary.
957 : **au** (//apt update//)
958 Resynchronizes the package index files from their sources. The indexes of
959 available packages are fetched from the location(s) specified in
960 /etc/apt/sources.list. An update should always be performed before an
961 upgrade or dist-upgrade; run by sudo, if necessary.
963 : **da** (//du -sch//)
964 Prints the summarized disk usage of the arguments as well as a grand total
965 in human readable format.
967 : **dbp** (//dpkg-buildpackage//)
968 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
970 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
971 Prints installed Packages sorted by size (descending).
973 : **dir** (//ls -lSrah//)
974 Lists files (including dot files) sorted by size (biggest last) in long and
975 human readable output format.
977 : **ge** (//grep-excuses//)
978 Searches the testing excuses files for a specific maintainer (See:
981 : **grep** (//grep --color=auto//)
982 Shows grep output in nice colors, if available.
984 : **grml-version** (//cat /etc/grml_version//)
985 Prints version of running grml.
987 : **hbp** (//hg-buildpackage//)
988 Helper program to maintain Debian packages with mercurial.
990 : **http** (//python -m SimpleHTTPServer//)
991 Basic HTTP server implemented in python. Listens on port 8000/tcp and
992 serves current directory. Implements GET and HEAD methods.
994 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
995 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
996 host key changes frequently, for example on virtualized test- or development-systems.
997 To be used only inside trusted networks, of course.
999 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
1000 ssh with possible man-in-the-middle attack enabled
1001 (for an explanation see insecscp above).
1003 : **help-zshglob** (//H-Glob()//)
1004 Runs the function H-Glob() to expand or explain wildcards.
1006 : **j** (//jobs -l//)
1007 Prints status of jobs in the current shell session in long format.
1009 : **l** (//ls -l --color=auto//)
1010 Lists files in long output format with indicator for filetype appended
1011 to filename. If the terminal supports it, with colored output.
1013 : **la** (//ls -la --color=auto//)
1014 Lists files in long colored output format. Including file names
1017 : **lad** (//ls -d .*(/)//)
1018 Lists the dot directories (not their contents) in current directory.
1020 : **lh** (//ls -hAl --color=auto//)
1021 Lists files in long and human readable output format in nice colors,
1022 if available. Includes file names starting with "." except "." and
1025 : **ll** (//ls -l --color=auto//)
1026 Lists files in long colored output format.
1028 : **llog** (//$PAGER /var/log/syslog//)
1029 Opens syslog in pager.
1031 : **ls** (//ls -C --color=auto//)
1032 Lists directory, entries are listed by columns and an indicator for
1033 file type is appended to each file name. Additionally the output is
1034 colored, if the terminal supports it.
1036 : **lsa** (//ls -a .*(.)//)
1037 Lists dot files in current working directory.
1039 : **lsbig** (//ls -flh *(.OL[1,10])//)
1040 Displays the ten biggest files (long and human readable output format).
1042 : **lsd** (//ls -d *(/)//)
1045 : **lse** (//ls -d *(/^F)//)
1046 Shows empty directories.
1048 : **lsl** (//ls -l *(@)//)
1049 Lists symbolic links in current directory.
1051 : **lsnew** (//ls -rl *(D.om[1,10])//)
1052 Displays the ten newest files (long output format).
1054 : **lsnewdir** (//ls -rthdl *(/om[1,10]) .*(D/om[1,10])//)
1055 Displays the ten newest directories and ten newest .directories.
1057 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1058 Displays the ten oldest files (long output format).
1060 : **lsolddir** (//ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])//)
1061 Displays the ten oldest directories and ten oldest .directories.
1063 : **lss** (//ls -l *(s,S,t)//)
1064 Lists files in current directory that have the setuid, setgid or sticky bit
1067 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1068 Displays the ten smallest files (long output format).
1070 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1071 Displays all files which are world readable and/or world writable and/or
1072 world executable (long output format).
1074 : **lsx** (//ls -l *(*)//)
1075 Lists only executable files.
1077 : **mdstat** (//cat /proc/mdstat//)
1078 Lists all active md (i.e. linux software raid) devices with some information
1081 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
1082 Executes the commands on the versioned patch queue from current repository.
1084 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
1085 rmdir current working directory
1087 : **screen** (//screen -c file//)
1088 If invoking user is root, starts screen session with /etc/grml/screenrc
1089 as config file. If invoked by a regular user and users .screenc does not exist,
1090 starts screen with /etc/grml/screenrc_grml config if it exists, else fallbacks
1091 to /etc/grml/screenrc.
1093 : **su** (//sudo su//)
1094 If user is running a Grml live system, don't ask for any password, if she
1097 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
1098 Sets mode from UTF-8 to ISO 2022 (See:
1099 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1101 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
1102 Sets mode from ISO 2022 to UTF-8 (See:
1103 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
1105 : **tlog** (//tail -f /var/log/syslog//)
1106 Prints syslog continuously (See tail(1)).
1108 : **up** (//aptitude update ; aptitude safe-upgrade//)
1109 Performs a system update followed by a system upgrade using aptitude; run
1110 by sudo, if necessary. See au and ag above.
1112 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
1113 After calling, characters of URLs as typed get automatically escaped, if necessary, to
1114 protect them from the shell.
1116 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
1117 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
1119 : **...** (//cd ../..///)
1120 Changes current directory two levels higher.
1124 This is a set of files, that - if they exist - can be used to customize the
1125 behaviour of //grmlzshrc//.
1128 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1129 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1132 # show battery status in RPROMPT
1133 GRML_DISPLAY_BATTERY=1
1134 # always load the complete setup, even for root
1135 GRML_ALWAYS_LOAD_ALL=1
1139 Sourced right before loading //grmlzshrc// is finished. There is a global
1140 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1144 Directory listing for persistent dirstack (see above).
1146 : **.important_commands**
1147 List of commands, used by persistent history (see above).
1150 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1151 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1152 (http://www.ubuntu.com) and similar systems - it is very easy to get
1153 //grmlzshrc// via grml's .deb repositories.
1155 On non-debian systems, that is not an option, but all is not lost:
1158 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1161 If you would also like to get separate function files (which you can put into
1162 your **$fpath**), you can browse and download them at:
1164 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1166 = ZSH REFCARD TAGS =
1167 If you read //grmlzshrc//'s code you may notice strange looking comments in
1168 it. These are there for a purpose. grml's zsh-refcard is automatically
1169 generated from the contents of the actual configuration file. However, we need
1170 a little extra information on which comments and what lines of code to take
1171 into account (and for what purpose).
1173 Here is what they mean:
1175 List of tags (comment types) used:
1177 Next line contains an important alias, that should be included in the
1178 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1181 Next line contains the beginning of an important function. (placement
1182 tag: @@INSERT-functions@@)
1185 Next line contains an important variable. (placement tag:
1186 @@INSERT-variables@@)
1189 Next line contains an important keybinding. (placement tag:
1190 @@INSERT-keybindings@@)
1193 Hashed directories list generation: //start//: denotes the start of a list of
1194 'hash -d' definitions. //end//: denotes its end. (placement tag:
1195 @@INSERT-hasheddirs@@)
1198 Abbreviation expansion list generation: //start//: denotes the beginning of
1199 abbreviations. //end//: denotes their end.
1201 Lines within this section that end in '#d .*' provide extra documentation to
1202 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1205 This tag allows you to manually generate refcard entries for code lines that
1206 are hard/impossible to parse.
1210 #m# k ESC-h Call the run-help function
1213 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1216 So the syntax is: #m# <section> <argument> <comment>
1219 This tag lets you insert entries to the 'other' hash. Generally, this should
1220 not be used. It is there for things that cannot be done easily in another way.
1221 (placement tag: @@INSERT-other-foobar@@)
1224 All of these tags (except for m and o) take two arguments, the first
1225 within the tag, the other after the tag:
1227 #<tag><section># <comment>
1229 Where <section> is really just a number, which are defined by the @secmap
1230 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1231 that for the reader, the tag should not differ much from a regular comment.
1232 For zsh, it is a regular comment indeed. The numbers have got the following
1257 So, the following will add an entry to the 'functions' table in the 'system'
1258 section, with a (hopefully) descriptive comment:
1261 #f1# Edit an alias via zle
1265 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1266 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1267 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1268 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1269 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1273 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1274 repository from git.grml.org:
1276 ``` % git clone git://git.grml.org/grml-etc-core.git
1278 Make your changes, commit them; use '**git format-patch**' to create a series
1279 of patches and send those to the following address via '**git send-email**':
1281 ``` grml-etc-core@grml.org
1283 Doing so makes sure the right people get your patches for review and
1288 This manual page is the **reference** manual for //grmlzshrc//.
1290 That means that in contrast to the existing refcard it should document **every**
1291 aspect of the setup.
1293 This manual is currently not complete. If you want to help improving it, visit
1294 the following pages:
1296 http://wiki.grml.org/doku.php?id=zshrcmanual
1298 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1300 Contributions are highly welcome.
1304 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1305 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1306 Beckert <abe@deuxchevaux.org>.
1310 Copyright (c) 2009-2013 Grml project <http://grml.org>
1312 This manpage is distributed under the terms of the GPL version 2.
1314 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1315 except for **accept-line()** which are distributed under the same conditions
1316 as zsh itself (which is BSD-like).