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_ALWAYS_LOAD_ALL**
60 Enables the whole Grml setup for root, if set to a non zero value.
62 : **GRML_ZSH_CNF_HANDLER**
63 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
64 and defaults to "/usr/share/command-not-found/command-not-found".
66 : **GRMLSMALL_SPECIFIC**
67 Set this to zero to remove items in zsh config, which do not work in
71 Where zsh saves the history. Default: ${HOME}/.zsh_history.
74 Number of commands to be kept in the history. On a Grml-CD this defaults to
75 500, on a hard disk installation to 5000.
78 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
79 A value of zero turns off checking.
82 Non zero values deactivate automatic correction of commands.
85 If set to zero (default), allows selection from a menu, if there are at least
86 five possible options of completion.
89 A non zero value disables precmd and preexec commands. These are functions
90 that are run before every command (setting xterm/screen titles etc.).
93 Show time (user, system and cpu) used by external commands, if they run longer
94 than the defined number of seconds (default: 5).
97 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
98 and to 10000 on an installation on hard disk.
101 As in tcsh(1) an array of login/logout events to be reported by the shell
102 builtin "log". For details see zshparam(1). Defaults to (notme root).
104 : **ZSH_NO_DEFAULT_LOCALE**
105 Import "/etc/default/locale", if set to zero (default).
108 A non zero value causes shell functions to be profiled. The results can be
109 obtained with the zprof builtin command (see zshmodules(1) for details).
112 = FEATURE DESCRIPTION =
113 This is an in depth description of non-standard features implemented by
116 == DIRSTACK HANDLING ==
117 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
118 file each time zsh's working directory is changed. That file can be configured
119 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
120 **DIRSTACKSIZE** variable defaults to **20** in this setup.
122 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
123 zshs inherit the dirstack of the zsh that most recently updated
126 == DIRECTORY BASED PROFILES ==
127 If you want certain settings to be active in certain directories (and
128 automatically switch back and forth between them), this is what you want.
131 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
132 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
135 When that's done and you enter a directory that matches the pattern
136 in the third part of the context, a function called chpwd_profile_grml,
137 for example, is called (if it exists).
139 If no pattern matches (read: no profile is detected) the profile is
140 set to 'default', which means chpwd_profile_default is attempted to
143 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
144 command) which is used: The third part in the context is matched against
145 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
146 Because that way the profile is detected for all these values of **$PWD**:
154 So, if you want to make double damn sure a profile works in /foo/bar
155 and everywhere deeper in that tree, just use (|/|/*) and be happy.
157 The name of the detected profile will be available in a variable called
158 'profile' in your functions. You don't need to do anything, it'll just
161 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
162 that was active up to now. That way you can avoid running code for a
163 profile that is already active, by running code such as the following
164 at the start of your function:
167 function chpwd_profile_grml() {
168 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
173 The initial value for **$CHPWD_PROFILE** is 'default'.
175 === Signaling availabily/profile changes ===
177 If you use this feature and need to know whether it is active in your
178 current shell, there are several ways to do that. Here are two simple
181 a) If knowing if the profiles feature is active when zsh starts is
182 good enough for you, you can put the following snippet into your
186 (( ${+functions[chpwd_profiles]} )) &&
187 print "directory profiles active"
190 b) If that is not good enough, and you would prefer to be notified
191 whenever a profile changes, you can solve that by making sure you
192 start **every** profile function you create like this:
195 function chpwd_profile_myprofilename() {
196 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
197 print "chpwd(): Switching to profile: $profile"
202 That makes sure you only get notified if a profile is **changed**,
203 not everytime you change directory.
205 === Version requirement ===
206 This feature requires zsh //4.3.3// or newer.
209 == ACCEPTLINE WRAPPER ==
210 The //accept-line// wiget is the one that is taking action when the **return**
211 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
214 This wrapper is configured via styles. That means, you issue commands, that look
218 zstyle 'context' style value
221 The context namespace, that we are using is 'acceptline'. That means, the actual
222 context for your commands look like: **':acceptline:<subcontext>'**.
224 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
228 === Recognized Contexts ===
230 This is the value, the context is initialized with.
231 The //compwarnfmt and //rehash// styles are looked up in this context.
234 If the first word in the command line is either a command, alias, function,
235 builtin or reserved word, you are in this context.
238 This is the context, that is used if you hit enter again, after being warned
239 about the existence of a _completion for the non-existing command you
243 This is the context, you are in if the command line is empty or only
244 consists of whitespace.
247 This context is in effect, if you entered something that does not match any
248 of the above. (e.g.: variable assignments).
251 === Available Styles ===
253 If you set this style to true, the warning about non existent commands,
254 for which completions exist will not be issued. (Default: **false**)
257 The message, that is displayed to warn about the _completion issue.
258 (default: **'%c will not execute and completion %f exists.'**)
259 '%c' is replaced by the command name, '%f' by the completion's name.
262 If this is set, we'll force rehashing, if appropriate. (Defaults to
263 **true** in //grmlzshrc//).
266 This can be a list of wigdets to call in a given context. If you need a
267 specific order for these to be called, name them accordingly. The default value
268 is an **empty list**.
271 The name of a widget, that is called after the widgets from 'actions'.
272 By default, this will be '.accept-line' (which is the built-in accept-line
276 If true in the current context, call the widget in the 'default_action'
277 style. (The default is **true** in all contexts.)
283 == GNU/SCREEN STATUS SETTING ==
284 //grmlzshrc// sets screen's hardstatus lines to the currently running command
285 or **'zsh'** if the shell is idling at its prompt. If the current working
286 directory is inside a repository unter version control, screen status is set
287 to: **'zsh: <repository name>'** via zsh's vcs_info.
290 == PERSISTENT HISTORY ==
291 If you got commands you consider important enough to be included in every
292 shell's history, you can put them into ~/.important_commands and they will be
293 available via the usual history lookup widgets.
297 == ENVIRONMENT VARIABLES ==
298 //grmlzshrc// sets some environment variables, which influence the
299 behaviour of applications.
302 Set to "yes". Some applications read this to learn about properties
303 of the terminal they are running in.
306 If not already set, sets the default editor. Falls back to vi(1),
307 if vim(1) is not available.
310 Some environment variables that add colour support to less(1) for viewing
311 man pages. See termcap(5) for details.
314 The mailbox file for the current user is set to /var/mail/$USER, if not
315 already set otherwise.
318 Set less(1) as default pager, if not already set to something different.
321 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
322 default to /bin/sh or /bin/bash.
326 Apart from zsh's default options, //grmlzshrc// sets some options
327 that change the behaviour of zsh. Options that change Z-shell's default
328 settings are marked by <grml>. But note, that zsh's defaults vary depending
329 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
332 Zsh sessions, that use //grmlzshrc//, will append their history list to the
333 history file, rather than replace it. Thus, multiple parallel zsh sessions
334 will all have the new entries from their history lists added to the history
335 file, in the order that they exit. The file will still be periodically
336 re-written to trim it when the number of lines grows 20% beyond the value
337 specified by $SAVEHIST.
340 If a command is issued that can't be executed as a normal command, and the
341 command is the name of a directory, perform the cd command to that directory.
343 : **auto_pushd** <grml>
344 Make cd push the old directory onto the directory stack.
346 : **completeinword** <grml>
347 If the cursor is inside a word, completion is done from both ends;
348 instead of moving the cursor to the end of the word first and starting
351 : **extended_glob** <grml>
352 Treat the '#', '~' and '^' characters as active globbing pattern characters.
354 : **extended_history** <grml>
355 Save each command's beginning timestamp (in seconds since the epoch) and the
356 duration (in seconds) to the history file.
359 Whenever a command completion is attempted, make sure the entire command
360 path is hashed first. This makes the first completion slower.
362 : **histignorealldups** <grml>
363 If a new command line being added to the history list duplicates an
364 older one, the older command is removed from the list, even if it is
365 not the previous event.
367 : **histignorespace** <grml>
368 Remove command lines from the history list when the first character on
369 the line is a space, or when one of the expanded aliases contains a
370 leading space. Note that the command lingers in the internal history
371 until the next command is entered before it vanishes.
373 : **longlistjobs** <grml>
374 List jobs in long format by default.
377 Avoid to beep on errors in zsh command line editing (zle).
380 A wildcard character never matches a leading '.'.
383 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
386 Report the status of background jobs immediately, rather than waiting until
387 just before printing a prompt.
389 : **pushd_ignore_dups** <grml>
390 Don't push multiple copies of the same directory onto the directory stack.
392 : **share_history** <grml>
393 As each line is added to the history file, it is checked to see if anything
394 else was written out by another shell, and if so it is included in the
395 history of the current shell too. Using !-style history, the commands from
396 the other sessions will not appear in the history list unless you explicitly
397 type the "history" command. This option is activated for zsh versions >= 4,
402 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
403 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
407 Edit the current command buffer in your favourite editor.
410 Deletes a word left of the cursor; seeing '/' as additional word separator.
413 Jump right after the first word.
416 Create directory under cursor or the selected area.
417 To select an area press ctrl-@ and use the cursor.
418 Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
419 directory does not exist yet -> press **CTRL-xM** and problem solved.
422 Searches the last occurence of string before the cursor in the command history.
425 Display help on keybindings and zsh line editor. Press consecutively to page through content.
428 Brings a job, which got suspended with CTRL-z back to foreground.
431 == SHELL FUNCTIONS ==
432 //grmlzshrc// comes with a wide array of defined shell functions to ease the
435 : **855resolution()**
436 If 915resolution is available, issues a warning to the user to run it instead
437 to modify the resolution on intel graphics chipsets.
440 Lists files in current directory, which have been accessed within the
441 last N days. N is an integer to be passed as first and only argument.
442 If no argument is specified N is set to 1.
445 Sets all ulimit values to "unlimited".
448 Lists processes matching given pattern.
451 Login on the host provided as argument using autossh. Then reattach a GNU screen
452 session if a detached session is around or detach a currently attached screen or
453 else start a new screen. This is especially useful for roadwarriors using GNU
457 Simple backup of a file or directory using cp(1). The target file name is the
458 original name plus a time stamp attached. Symlinks and file attributes like mode,
459 ownership and timestamps are preserved.
462 If the original cdrecord is not installed, issues a warning to the user to
463 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
467 Creates a temporary directory using mktemp. Then changes current
468 working directory to it.
471 Lists files in current directory, which have been changed within the
472 last N days. N is an integer to be passed as first and only argument.
473 If no argument is specified N is set to 1.
476 Returns true if given command exists either as program, function, alias,
477 builtin or reserved word. If the option -c is given, only returns true,
478 if command is a program.
481 Changes directory to $HOME on first invocation of zsh. This is neccessary on
482 grml systems with autologin.
485 Changes current directory to the one supplied by argument and lists the files
486 in it, including file names starting with ".".
489 Shows the changelog of given package in $PAGER.
492 Tells the user to use grml-debootstrap, if she wants to install debian to
496 A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
497 back interactive responsiveness after suspend, when the system is swapping
501 Shows the NEWS file for the given package in $PAGER.
507 Edit given shell function.
510 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
513 Use GNU diff with options -ubwd for mercurial.
516 Displays diffstat between the revision given as argument and tip (no
517 argument means last revision).
520 Outputs highlighted diff; needs highstring(1).
523 Returns true, if zsh version is equal or greater than 4, else false.
526 Returns true, if zsh version is equal or greater than 4.1, else false.
529 Returns true, if zsh version is equal or greater than 4.2, else false.
532 Returns true, if zsh version is equal or greater than 4.2.5, else false.
535 Returns true, if zsh version is equal or greater than 4.3, else false.
538 Returns true, if zsh version is equal or greater than 4.3.3, else false.
541 Returns true, if running on darwin, else false.
544 Returns true, if running on a grml system, else false.
547 Returns true, if running on a grml system from a live cd, else false.
550 Returns true, if run on grml-small, else false.
553 Changes every occurrence of the string iso885915 or ISO885915 in
554 environment variables to UTF-8.
557 Returns true, if run within an utf environment, else false.
560 Creates directory including parent directories, if necessary. Then changes
561 current working directory to it.
564 Lists files in current directory, which have been modified within the
565 last N days. N is an integer to be passed as first and only argument.
566 If no argument is specified N is set to 1.
569 A helper function for the "e" glob qualifier to list all files newer
570 than a reference file.
574 % NTREF=/reference/file
577 % ls -l *(e:'nt /reference/file':)
581 Runs a command in $SHELL with profiling enabled (See startup variable
582 ZSH_PROFILE_RC above).
585 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
586 for details. See also xunfunction() below.
588 : **simple-extract()**
589 Tries to uncompress/unpack given files with the appropriate programs. If an URI
590 starting with https, http or ftp is provided simple-extract tries to download
591 and then uncompress/unpack the file. The choice is made along the filename
592 ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
593 .xz) unless you use the '-d' option.
596 Prints details of symlinks given as arguments.
598 : **ssl-cert-fingerprints**
599 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
600 First and only parameter must be a file containing a certificate. Use
601 /dev/stdin as file if you want to pipe a certificate to these
605 Prints all information of a x509 certificate including the SHA512,
606 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
607 containing a certificate. Use /dev/stdin as file if you want to pipe a
608 certificate to this function.
610 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
611 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
612 certificate. First and only parameter must be a file containing a
613 certificate. Use /dev/stdin as file if you want to pipe a certificate
616 : **Start(), Restart(), Stop(), Force-Reload(), Reload()**
617 Functions for controlling daemons.
624 Translates a word from german to english (-D) or vice versa (-E).
627 Shows upstreams changelog of a given package in $PAGER.
630 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
633 Changes every occurrence of the string UTF-8 or utf-8 in environment
634 variables to iso885915.
637 Wrapper for vim(1). It tries to set the title and hands vim the environment
638 variable VIM_OPTIONS on the command line. So the user may define command
639 line options, she always wants, in her .zshrc.local.
642 Searches the history for a given pattern and lists the results by date.
643 The first argument is the search pattern. The second and third ones are
644 optional and denote a search range (default: -100).
647 Tries to cat(1) file(s) given as parameter(s). Always returns true.
648 See also xunfunction() below.
651 Tries to source the file(s) given as parameter(s). Always returns true.
652 See zshbuiltins(1) for a detailed description of the source command.
653 See also xunfunction() below.
656 Changes the title of xterm window from within screen(1). Run without
657 arguments for details.
660 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
663 Wrapper around the autoload builtin. Loads the definitions of functions
664 from the file given as argument. Searches $fpath for the file. See also
668 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
669 where own modifications should go. See also zshbuiltins(1) for a description
670 of the source command.
674 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
675 life. A few aliases (like those involving //grep// or //ls//) use the option
676 //--color=auto// for colourizing output. That option is part of **GNU**
677 implementations of these tools, and will only be used if such an implementation
680 : **acp** (//apt-cache policy//)
681 With no arguments prints out the priorities of each source. If a package name
682 is given, it displays detailed information about the priority selection of the
685 : **acs** (//apt-cache search//)
686 Searches debian package lists for the regular expression provided as argument.
687 The search includes package names and descriptions. Prints out name and short
688 description of matching packages.
690 : **acsh** (//apt-cache show//)
691 Shows the package records for the packages provided as arguments.
693 : **adg** (//apt-get dist-upgrade//)
694 Performs an upgrade of all installed packages. Also tries to automatically
695 handle changing dependencies with new versions of packages. As this may change
696 the install status of (or even remove) installed packages, it is potentially
697 dangerous to use dist-upgrade; invoked by sudo, if necessary.
699 : **ag** (//apt-get upgrade//)
700 Downloads and installs the newest versions of all packages currently installed
701 on the system. Under no circumstances are currently installed packages removed,
702 or packages not already installed retrieved and installed. New versions of
703 currently installed packages that cannot be upgraded without changing the install
704 status of another package will be left at their current version. An update must
705 be performed first (see au below); run by sudo, if necessary.
707 : **agi** (//apt-get install//)
708 Downloads and installs or upgrades the packages given on the command line.
709 If a hyphen is appended to the package name, the identified package will be
710 removed if it is installed. Similarly a plus sign can be used to designate a
711 package to install. This may be useful to override decisions made by apt-get's
712 conflict resolution system.
713 A specific version of a package can be selected for installation by following
714 the package name with an equals and the version of the package to select. This
715 will cause that version to be located and selected for install. Alternatively a
716 specific distribution can be selected by following the package name with a slash
717 and the version of the distribution or the Archive name (stable, testing, unstable).
718 Gets invoked by sudo, if user id is not 0.
720 : **ati** (//aptitude install//)
721 Aptitude is a terminal-based package manager with a command line mode similar to
722 apt-get (see agi above); invoked by sudo, if necessary.
724 : **au** (//apt-get update//)
725 Resynchronizes the package index files from their sources. The indexes of
726 available packages are fetched from the location(s) specified in
727 /etc/apt/sources.list. An update should always be performed before an
728 upgrade or dist-upgrade; run by sudo, if necessary.
730 : **da** (//du -sch//)
731 Prints the summarized disk usage of the arguments as well as a grand total
732 in human readable format.
734 : **dbp** (//dpkg-buildpackage//)
735 Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
737 : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//)
738 Prints installed Packages sorted by size (descending).
740 : **dir** (//ls -lSrah//)
741 Lists files (including dot files) sorted by size (biggest last) in long and
742 human readable output format.
744 : **ge** (//grep-excuses//)
745 Searches the testing excuses files for a specific maintainer (See:
748 : **grep** (//grep --color=auto//)
749 Shows grep output in nice colors, if available.
751 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
752 Scans for new devices and updates /etc/fstab according to the findings.
754 : **grml-version** (//cat /etc/grml_version//)
755 Prints version of running grml.
757 : **hbp** (//hg-buildpackage//)
758 Helper program to maintain Debian packages with mercurial.
760 : **http** (//python -m SimpleHTTPServer//)
761 Basic HTTP server implemented in python. Listens on port 8000/tcp and
762 serves current directory. Implements GET and HEAD methods.
764 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
765 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
766 host key changes frequently, for example on virtualized test- or development-systems.
767 To be used only inside trusted networks, of course.
769 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
770 ssh with possible man-in-the-middle attack enabled
771 (for an explanation see insecscp above).
773 : **help-zshglob** (//H-Glob()//)
774 Runs the function H-Glob() to expand or explain wildcards.
776 : **j** (//jobs -l//)
777 Prints status of jobs in the current shell session in long format.
779 : **l** (//ls -lF --color=auto//)
780 Lists files in long output format with indicator for filetype appended
781 to filename. If the terminal supports it, with colored output.
783 : **la** (//ls -la --color=auto//)
784 Lists files in long colored output format. Including file names
787 : **lad** (//ls -d .*(/)//)
788 Lists the dot directories (not their contents) in current directory.
790 : **lh** (//ls -hAl --color=auto//)
791 Lists files in long and human readable output format in nice colors,
792 if available. Includes file names starting with "." except "." and
795 : **ll** (//ls -l --color=auto//)
796 Lists files in long colored output format.
798 : **llog** (//$PAGER /var/log/syslog//)
799 Opens syslog in pager.
801 : **ls** (//ls -b -CF --color=auto//)
802 Lists directory printing octal escapes for nongraphic characters.
803 Entries are listed by columns and an indicator for file type is appended
804 to each file name. Additionally the output is colored, if the terminal
807 : **lsa** (//ls -a .*(.)//)
808 Lists dot files in current working directory.
810 : **lsbig** (//ls -flh *(.OL[1,10])//)
811 Displays the ten biggest files (long and human readable output format).
813 : **lsd** (//ls -d *(/)//)
816 : **lse** (//ls -d *(/^F)//)
817 Shows empty directories.
819 : **lsl** (//ls -l *(@)//)
820 Lists symbolic links in current directory.
822 : **lsnew** (//ls -rl *(D.om[1,10])//)
823 Displays the ten newest files (long output format).
825 : **lsold** (//ls -rtlh *(D.om[1,10])//)
826 Displays the ten oldest files (long output format).
828 : **lss** (//ls -l *(s,S,t)//)
829 Lists files in current directory that have the setuid, setgid or sticky bit
832 : **lssmall** (//ls -Srl *(.oL[1,10])//)
833 Displays the ten smallest files (long output format).
835 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
836 Displays all files which are world readable and/or world writable and/or
837 world executable (long output format).
839 : **lsx** (//ls -l *(*)//)
840 Lists only executable files.
842 : **mdstat** (//cat /proc/mdstat//)
843 Lists all active md (i.e. linux software raid) devices with some information
846 : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
847 Executes the commands on the versioned patch queue from current repository.
849 : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
850 rmdir current working directory
852 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
853 If invoking user is root, starts screen session with /etc/grml/screenrc
854 as config file. If invoked by a regular user, start a screen session
855 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
858 : **su** (//sudo su//)
859 If user is running a grml live-CD, dont ask for any password, if she
862 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
863 Sets mode from UTF-8 to ISO 2022 (See:
864 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
866 : **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
867 Sets mode from ISO 2022 to UTF-8 (See:
868 http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
870 : **tlog** (//tail -f /var/log/syslog//)
871 Prints syslog continuously (See tail(1)).
873 : **up** (//aptitude update ; aptitude safe-upgrade//)
874 Performs a system update followed by a system upgrade using aptitude; run
875 by sudo, if necessary. See au and ag above.
877 : **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
878 After calling, characters of URLs as typed get automatically escaped, if necessary, to
879 protect them from the shell.
881 : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
882 Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
884 : **...** (//cd ../..///)
885 Changes current directory two levels higher.
889 This is a set of files, that - if they exist - can be used to customize the
890 behaviour of //grmlzshrc//.
893 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
894 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
897 # show battery status in RPROMPT
899 # always load the complete setup, even for root
900 GRML_ALWAYS_LOAD_ALL=1
904 Sourced right before loading //grmlzshrc// is finished. There is a global
905 version of this file (/etc/zsh/zshrc.local) which is sourced before the
909 Directory listing for persistent dirstack (see above).
911 : **.important_commands**
912 List of commands, used by persistent history (see above).
915 = INSTALLATION ON NON-DEBIAN SYSTEMS =
916 On Debian systems (http://www.debian.org) - and possibly Ubuntu
917 (http://www.ubuntu.com) and similar systems - it is very easy to get
918 //grmlzshrc// via grml's .deb repositories.
920 On non-debian systems, that is not an option, but all is not lost:
923 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
926 If you would also like to get seperate function files (which you can put into
927 your **$fpath**), you can browse and download them at:
929 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
932 If you read //grmlzshrc//'s code you may notice strange looking comments in
933 it. These are there for a purpose. grml's zsh-refcard is automatically
934 generated from the contents of the actual configuration file. However, we need
935 a little extra information on which comments and what lines of code to take
936 into account (and for what purpose).
938 Here is what they mean:
940 List of tags (comment types) used:
942 Next line contains an important alias, that should be included in the
943 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
946 Next line contains the beginning of an important function. (placement
947 tag: @@INSERT-functions@@)
950 Next line contains an important variable. (placement tag:
951 @@INSERT-variables@@)
954 Next line contains an important keybinding. (placement tag:
955 @@INSERT-keybindings@@)
958 Hashed directories list generation: //start//: denotes the start of a list of
959 'hash -d' definitions. //end//: denotes its end. (placement tag:
960 @@INSERT-hasheddirs@@)
963 Abbreviation expansion list generation: //start//: denotes the beginning of
964 abbreviations. //end//: denotes their end.
966 Lines within this section that end in '#d .*' provide extra documentation to
967 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
970 This tag allows you to manually generate refcard entries for code lines that
971 are hard/impossible to parse.
975 #m# k ESC-h Call the run-help function
978 That would add a refcard entry in the keybindings table for 'ESC-h' with the
981 So the syntax is: #m# <section> <argument> <comment>
984 This tag lets you insert entries to the 'other' hash. Generally, this should
985 not be used. It is there for things that cannot be done easily in another way.
986 (placement tag: @@INSERT-other-foobar@@)
989 All of these tags (except for m and o) take two arguments, the first
990 within the tag, the other after the tag:
992 #<tag><section># <comment>
994 Where <section> is really just a number, which are defined by the @secmap
995 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
996 that for the reader, the tag should not differ much from a regular comment.
997 For zsh, it is a regular comment indeed. The numbers have got the following
1022 So, the following will add an entry to the 'functions' table in the 'system'
1023 section, with a (hopefully) descriptive comment:
1026 #f1# Edit an alias via zle
1030 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1031 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1032 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1033 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1034 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1038 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1039 repository from git.grml.org:
1041 ``` % git clone git://git.grml.org/grml-etc-core.git
1043 Make your changes, commit them; use '**git format-patch**' to create a series
1044 of patches and send those to the following address via '**git send-email**':
1046 ``` grml-etc-core@grml.org
1048 Doing so makes sure the right people get your patches for review and
1053 This manual page is the **reference** manual for //grmlzshrc//.
1055 That means that in contrast to the existing refcard it should document **every**
1056 aspect of the setup.
1058 This manual is currently not complete. If you want to help improving it, visit
1059 the following pages:
1061 http://wiki.grml.org/doku.php?id=zshrcmanual
1063 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1065 Contributions are highly welcome.
1069 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1070 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1071 Beckert <abe@deuxchevaux.org>.
1075 Copyright (c) 2009-2011 Grml project <http://grml.org>
1077 This manpage is distributed under the terms of the GPL version 2.
1079 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1080 except for **accept-line()** which are distributed under the same conditions
1081 as zsh itself (which is BSD-like).