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
29 VARIABLE (see below). Also the umask(1) for the root user is set to 022,
30 while for regular users it is set to 002. So read/write permissions
31 for the regular user and her group are set for new files (keep that
32 in mind on systems, where regular users share a common group).
35 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
36 variables. These may be set temporarily when starting zsh like this:
40 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
43 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
44 put the battery status into the right hand side interactive prompt.
47 = FEATURE DESCRIPTION =
48 This is an in depth description of non-standard features implemented by
51 == DIRSTACK HANDLING ==
52 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
53 file each time zsh's working directory is changed. That file can be configured
54 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
55 **DIRSTACKSIZE** variable defaults to **20** in this setup.
57 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
58 zshs inherit the dirstack of the zsh that most recently updated
61 == DIRECTORY BASED PROFILES ==
62 If you want certain settings to be active in certain directories (and
63 automatically switch back and forth between them), this is what you want.
66 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
67 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
70 When that's done and you enter a directory that matches the pattern
71 in the third part of the context, a function called chpwd_profile_grml,
72 for example, is called (if it exists).
74 If no pattern matches (read: no profile is detected) the profile is
75 set to 'default', which means chpwd_profile_default is attempted to
78 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
79 command) which is used: The third part in the context is matched against
80 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
81 Because that way the profile is detected for all these values of **$PWD**:
89 So, if you want to make double damn sure a profile works in /foo/bar
90 and everywhere deeper in that tree, just use (|/|/*) and be happy.
92 The name of the detected profile will be available in a variable called
93 'profile' in your functions. You don't need to do anything, it'll just
96 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
97 that was active up to now. That way you can avoid running code for a
98 profile that is already active, by running code such as the following
99 at the start of your function:
102 function chpwd_profile_grml() {
103 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
108 The initial value for **$CHPWD_PROFILE** is 'default'.
110 === Signaling availabily/profile changes ===
112 If you use this feature and need to know whether it is active in your
113 current shell, there are several ways to do that. Here are two simple
116 a) If knowing if the profiles feature is active when zsh starts is
117 good enough for you, you can put the following snippet into your
121 (( ${+functions[chpwd_profiles]} )) &&
122 print "directory profiles active"
125 b) If that is not good enough, and you would prefer to be notified
126 whenever a profile changes, you can solve that by making sure you
127 start **every** profile function you create like this:
130 function chpwd_profile_myprofilename() {
131 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
132 print "chpwd(): Switching to profile: $profile"
137 That makes sure you only get notified if a profile is **changed**,
138 not everytime you change directory.
140 === Version requirement ===
141 This feature requires zsh //4.3.3// or newer.
144 == ACCEPTLINE WRAPPER ==
145 The //accept-line// wiget is the one that is taking action when the **return**
146 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
149 This wrapper is configured via styles. That means, you issue commands, that look
153 zstyle 'context' style value
156 The context namespace, that we are using is 'acceptline'. That means, the actual
157 context for your commands look like: **':acceptline:<subcontext>'**.
159 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
163 === Recognized Contexts ===
165 This is the value, the context is initialized with.
166 The //compwarnfmt and //rehash// styles are looked up in this context.
169 If the first word in the command line is either a command, alias, function,
170 builtin or reserved word, you are in this context.
173 This is the context, that is used if you hit enter again, after being warned
174 about the existence of a _completion for the non-existing command you
178 This is the context, you are in if the command line is empty or only
179 consists of whitespace.
182 This context is in effect, if you entered something that does not match any
183 of the above. (e.g.: variable assignments).
186 === Available Styles ===
188 If you set this style to true, the warning about non existent commands,
189 for which completions exist will not be issued. (Default: **false**)
192 The message, that is displayed to warn about the _completion issue.
193 (default: **'%c will not execute and completion %f exists.'**)
194 '%c' is replaced by the command name, '%f' by the completion's name.
197 If this is set, we'll force rehashing, if appropriate. (Defaults to
198 **true** in //grmlzshrc//).
201 This can be a list of wigdets to call in a given context. If you need a
202 specific order for these to be called, name them accordingly. The default value
203 is an **empty list**.
206 The name of a widget, that is called after the widgets from 'actions'.
207 By default, this will be '.accept-line' (which is the built-in accept-line
211 If true in the current context, call the widget in the 'default_action'
212 style. (The default is **true** in all contexts.)
218 == GNU/SCREEN STATUS SETTING ==
219 //grmlzshrc// sets screen's hardstatus lines to the currently running command
220 or **'zsh'** if the shell is idling at its prompt. If the current working
221 directory is inside a repository unter version control, screen status is set
222 to: **'zsh: <repository name>'** via zsh's vcs_info.
225 == PERSISTENT HISTORY ==
226 If you got commands you consider important enough to be included in every
227 shell's history, you can put them into ~/.important_commands and they will be
228 available via the usual history lookup widgets.
232 == ENVIRONMENT VARIABLES ==
233 //grmlzshrc// sets some environment variables, which influence the
234 behaviour of applications.
237 If X is running this is set to "firefox", otherwise to "w3m".
240 Set to "yes". Some applications read this to learn about properties
241 of the terminal they are running in.
244 If not already set, sets the default editor. Falls back to vi(1),
245 if vim(1) is not available.
248 The mailbox file for the current user is set to /var/mail/$USER, if not
249 already set otherwise.
252 Set less(1) as default pager, if not already set to something different.
255 Holds the path to shared files for the C++ application framework QT
259 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
260 default to /bin/sh or /bin/bash.
264 Apart from zsh's default options, //grmlzshrc// sets some options
265 that change the behaviour of zsh. Options that change Z-shell's default
266 settings are marked by <grml>. But note, that zsh's defaults vary depending
267 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
270 Zsh sessions, that use //grmlzshrc//, will append their history list to the
271 history file, rather than replace it. Thus, multiple parallel zsh sessions
272 will all have the new entries from their history lists added to the history
273 file, in the order that they exit. The file will still be periodically
274 re-written to trim it when the number of lines grows 20% beyond the value
275 specified by $SAVEHIST.
278 If a command is issued that can't be executed as a normal command, and the
279 command is the name of a directory, perform the cd command to that directory.
281 : **auto_pushd** <grml>
282 Make cd push the old directory onto the directory stack.
284 : **completeinword** <grml>
285 If the cursor is inside a word, completion is done from both ends;
286 instead of moving the cursor to the end of the word first and starting
289 : **extended_glob** <grml>
290 Treat the '#', '~' and '^' characters as active globbing pattern characters.
292 : **extended_history** <grml>
293 Save each command's beginning timestamp (in seconds since the epoch) and the
294 duration (in seconds) to the history file.
297 Whenever a command completion is attempted, make sure the entire command
298 path is hashed first. This makes the first completion slower.
300 : **histignorealldups** <grml>
301 If a new command line being added to the history list duplicates an
302 older one, the older command is removed from the list, even if it is
303 not the previous event.
305 : **histignorespace** <grml>
306 Remove command lines from the history list when the first character on
307 the line is a space, or when one of the expanded aliases contains a
308 leading space. Note that the command lingers in the internal history
309 until the next command is entered before it vanishes.
311 : **longlistjobs** <grml>
312 List jobs in long format by default.
315 Avoid to beep on errors in zsh command line editing (zle).
318 A wildcard character never matches a leading '.'.
321 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
323 : **nonomatch** <grml>
324 If a pattern for filename generation has no matches, do not print an error
325 and leave it unchanged in the argument list. This also applies to file
326 expansion of an initial `~' or `='.
329 Report the status of background jobs immediately, rather than waiting until
330 just before printing a prompt.
332 : **pushd_ignore_dups** <grml>
333 Don't push multiple copies of the same directory onto the directory stack.
335 : **share_history** <grml>
336 As each line is added to the history file, it is checked to see if anything
337 else was written out by another shell, and if so it is included in the
338 history of the current shell too. Using !-style history, the commands from
339 the other sessions will not appear in the history list unless you explicitly
340 type the "history" command. This option is activated for zsh versions >= 4,
345 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
346 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
350 Edit the current command buffer in your favourite editor.
353 Deletes a word left of the cursor; seeing '/' as additional word separator.
356 Jump right after the first word.
359 Searches the last occurence of string before the cursor in the command history.
362 Brings a job, which got suspended with CTRL-z back to foreground.
365 == SHELL FUNCTIONS ==
366 //grmlzshrc// comes with a wide array of defined shell functions to ease the
370 Converts plaintext files to HTML using vim. The output is written to
373 : **855resolution()**
374 If 915resolution is available, issues a warning to the user to run it instead
375 to modify the resolution on intel graphics chipsets.
378 Searches for USENET postings from authors using google groups.
381 Sets all ulimit values to "unlimited".
384 Prints a colored table of available ansi color codes (to be used in escape
385 sequences) and the colors they represent.
387 : **aoeu(), asdf(), uiae()**
388 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
392 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
393 Then prompts the user if she wants to remove that directory. You might need
394 to tell audioburn which cdrom device to use like:
395 "DEVICE=/dev/cdrom audioburn"
398 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
399 it. Then prompts the user if she wants to burn a audio CD with audioburn()
400 (see above). You might need to tell audiorip which cdrom device to use like:
401 "DEVICE=/dev/cdrom audioburn"
404 Simple backup of a file or directory using cp(1). The target file name is the
405 original name plus a time stamp attached. Symlinks and file attributes like mode,
406 ownership and timestamps are preserved.
409 The brltty(1) program provides a braille display, so a blind person can access
410 the console screen. This wrapper function works around problems with some
411 environments (f. e. utf8).
414 If the original cdrecord is not installed, issues a warning to the user to
415 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
419 Returns true if given command exists either as program, function, alias,
420 builtin or reserved word. If the option -c is given, only returns true,
421 if command is a program.
424 Changes directory to $HOME on first invocation of zsh. This is neccessary on
425 grml systems with autologin.
428 Changes current directory to the one supplied by argument and lists the files
429 in it, including file names starting with ".".
432 Presents a numbered listing of the directory stack. Then changes current
433 working directory to the one chosen by the user.
436 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
437 email addresses of submitters or any string given on the command line.
440 Shows bug report for debian given by number in mailbox format.
443 Tells the user to use grml-debootstrap, if she wants to install debian to
447 Shows the disk usage of the directories given in human readable format;
451 Translates C source code to assembly and ouputs both.
454 Takes packagename as argument. Sets current working directory to
455 /usr/share/doc/<packagename> and prints out a directory listing.
458 Renames image files based on date/time informations in their exif headers.
461 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
462 instance of firefox running, attaches to the first window found and opens the
463 URL in a new tab (this even works across an ssh session).
465 : **fluxkey-change()**
466 Switches the key combinations for changing current workspace under fluxbox(1)
467 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
468 Requires the window manager to reread configuration to take effect.
471 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
472 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
473 filename>". Creates an index.html with title "Images" showing the
474 thumbnails as clickable links to the respective original file.
475 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
476 and all files and/or directories beginning with "thumb-" in current directory!
479 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
482 Tries to download and install Gizmo (VoIP software) for Debian.
485 Tries to download and install Skype (VoIP software) for Debian.
488 Downloads and installs newer version of Skype.
491 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
495 Opens a specific git commitdiff from kernel.org in default browser. Tree is
496 chosen by the environment variable GITTREE which defaults to Linus Torvalds'
499 : **git-get-commit()**
500 Opens a specific git commit from kernel.org in default browser. The tree to
501 fetch from is controlled by the environment variable GITTREE which defaults
502 to Linus Torvalds' kernel tree.
504 : **git-get-plaindiff()**
505 Fetches specific git diff from kernel.org. The tree is controlled by the
506 environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
509 Searches the zsh command history for a regular expression.
512 Prints the hexadecimal representation of the number supplied as argument
516 Outputs highlighted diff; needs highstring(1).
519 Shows source files in less(1) with syntax highlighting. Run "hl -h"
520 for detailed usage information.
523 Queries IMAP server (first parameter) for its capabilities. Takes
524 port number as optional second argument.
527 Returns true, if zsh version is equal or greater than 4, else false.
530 Returns true, if zsh version is equal or greater than 4.1, else false.
533 Returns true, if zsh version is equal or greater than 4.2, else false.
536 Returns true, if zsh version is equal or greater than 4.2.5, else false.
539 Returns true, if zsh version is equal or greater than 4.3, else false.
542 Returns true, if zsh version is equal or greater than 4.3.3, else false.
545 Returns true, if running on darwin, else false.
548 Returns true, if running on a grml system, else false.
551 Returns true, if running on a grml system from a live cd, else false.
554 Returns true, if run on grml-small, else false.
557 Changes every occurrence of the string iso885915 or ISO885915 in
558 environment variables to UTF-8.
561 Returns true, if run within an utf environment, else false.
564 Lists libraries that define the symbol containing the string given as
568 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
572 Creates a PostScript and a PDF file (basename as first argument) from
576 Displays manpage in a streched style.
579 Creates directory including parent directories, if necessary. Then changes
580 current working directory to it.
583 Diffs the two arguments recursively and writes the
584 output (unified format) to a timestamped file.
587 Prints the summarized memory usage in bytes.
589 : **minimal-shell()**
590 Spawns a absolute minimal Korn shell. It references no files in /usr, so
591 that file system can be unmounted.
594 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
595 replaces spaces in file names with underscores. Then mkaudiocd()
596 normalizes the files and recodes them to WAV.
599 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
600 enabled using mkisofs(8). Prompts the user for volume name, filename and
604 Creates a directory with first parameter as name inside $MAILDIR_ROOT
605 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
608 Runs "make install" and logs the output under ~/.errorlogs/; useful for
609 a clean deinstall later.
612 Lists files in current directory, which have been modified within the
613 last N days. N is an integer required as first and only argument.
616 Recodes an ogg file to mp3 with a bitrate of 192.
619 Evaluates a perl expression; useful as command line
620 calculator, therefore also available as "calc".
623 Lists all occurrences of the string given as argument in current $PATH.
626 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
627 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
628 Asks for confirmation.
631 Opens all README-like files in current working directory with the program
632 defined in the $PAGER environment variable.
635 Reloads functions given as parameters.
638 Checks whether a regular expression (first parameter) matches a string
639 (second parameter) using perl.
642 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
643 for details. See also xunfunction() below.
646 Greps the history for the string provided as parameter and shows the numbered
647 findings in default pager. On exit of the pager the user is prompted for a
648 number. The shells readline buffer is then filled with the corresponding
652 Lists the contents of a (compressed) archive with the appropriate programs.
653 The choice is made along the filename extension.
656 Lists the content of a gzipped tar archive in default pager.
659 Shows the content of a zip archive in default pager.
661 : **simple-extract()**
662 Tries to uncompress/unpack given file with the appropriate programs. The
663 choice is made along the filename ending.
666 Prints the arguments slowly by sleeping 0.08 seconds between each character.
668 : **smartcompress()**
669 Compresses/archives the file given as first parameter. Takes an optional
670 second argument, which denotes the compression/archive type as typical
671 filename extension; defaults to "tar.gz".
674 Indents C source code files given; uses Kernighan & Ritchie style.
677 Creates directory named shots in user's home directory, if it does not yet
678 exist and changes current working directory to it. Then sleeps 5 seconds,
679 so you have plenty of time to switch desktops/windows. Then makes a screenshot
680 of the current desktop. The result is stored in ~/shots to a timestamped
683 : **ssl-cert-fingerprints**
684 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
685 First and only parameter must be a file containing a certificate. Use
686 /dev/stdin as file if you want to pipe a certificate to these
690 Prints all information of a x509 certificate including the SHA512,
691 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
692 containing a certificate. Use /dev/stdin as file if you want to pipe a
693 certificate to this function.
695 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
696 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
697 certificate. First and only parameter must be a file containing a
698 certificate. Use /dev/stdin as file if you want to pipe a certificate
702 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
703 issues a Warning to use the grml-x(1) script. Can be overridden by using
704 /usr/bin/startx directly.
707 Shows some information about current system status.
710 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
711 swspeak must be set for this to work.
714 Translates a word from german to english (-D) or vice versa (-E).
717 Makes a unified diff of the command line arguments trying hard to find a
718 smaller set of changes. Descends recursively into subdirectories. Ignores
719 hows some information about current status.
722 Downloads and displays a file using a suitable program for its
726 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
729 Takes a string as its first argument and prints it RFC 2396 URL encoded to
733 Changes every occurrence of the string UTF-8 or utf-8 in environment
734 variables to iso885915.
740 Wrapper for vim(1). It tries to set the title and hands vim the environment
741 variable VIM_OPTIONS on the command line. So the user may define command
742 line options, she always wants, in her .zshrc.local.
745 Use vim(1) as manpage reader.
748 Tries to cat(1) file(s) given as parameter(s). Always returns true.
749 See also xunfunction() below.
752 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
753 issues a Warning to use the grml-x(1) script. Can be overridden by using
754 /usr/bin/xinit directly.
757 Tries to source the file(s) given as parameter(s). Always returns true.
758 See zshbuiltins(1) for a detailed description of the source command.
759 See also xunfunction() below.
762 Changes the title of xterm window from within screen(1). Run without
763 arguments for details.
766 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
769 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
770 option plus a non empty pattern. Run zg without any arguments for a listing
771 of available command line switches. For a zshrc not in /etc/zsh, set the
772 GRML_ZSHRC environment variable.
775 Wrapper around the autoload builtin. Loads the definitions of functions
776 from the file given as argument. Searches $fpath for the file. See also
780 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
781 where own modifications should go. See also zshbuiltins(1) for a description
782 of the source command.
786 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
787 life. A few aliases (like those involving //grep// or //ls//) use the option
788 //--color=auto// for colourizing output. That option is part of **GNU**
789 implementations of these tools, and will only be used if such an implementation
792 : **acp** (//apt-cache policy//)
793 With no arguments prints out the priorities of each source. If a package name
794 is given, it displays detailed information about the priority selection of the
797 : **acs** (//apt-cache search//)
798 Searches debian package lists for the regular expression provided as argument.
799 The search includes package names and descriptions. Prints out name and short
800 description of matching packages.
802 : **acsh** (//apt-cache show//)
803 Shows the package records for the packages provided as arguments.
805 : **adg** (//apt-get dist-upgrade//)
806 Performs an upgrade of all installed packages. Also tries to automatically
807 handle changing dependencies with new versions of packages. As this may change
808 the install status of (or even remove) installed packages, it is potentially
809 dangerous to use dist-upgrade; invoked by sudo, if necessary.
811 : **ag** (//apt-get upgrade//)
812 Downloads and installs the newest versions of all packages currently installed
813 on the system. Under no circumstances are currently installed packages removed,
814 or packages not already installed retrieved and installed. New versions of
815 currently installed packages that cannot be upgraded without changing the install
816 status of another package will be left at their current version. An update must
817 be performed first (see au below); run by sudo, if necessary.
819 : **agi** (//apt-get install//)
820 Downloads and installs or upgrades the packages given on the command line.
821 If a hyphen is appended to the package name, the identified package will be
822 removed if it is installed. Similarly a plus sign can be used to designate a
823 package to install. This may be useful to override decisions made by apt-get's
824 conflict resolution system.
825 A specific version of a package can be selected for installation by following
826 the package name with an equals and the version of the package to select. This
827 will cause that version to be located and selected for install. Alternatively a
828 specific distribution can be selected by following the package name with a slash
829 and the version of the distribution or the Archive name (stable, testing, unstable).
830 Gets invoked by sudo, if user id is not 0.
832 : **ati** (//aptitude install//)
833 Aptitude is a terminal-based package manager with a command line mode similar to
834 apt-get (see agi above); invoked by sudo, if necessary.
836 : **au** (//apt-get update//)
837 Resynchronizes the package index files from their sources. The indexes of
838 available packages are fetched from the location(s) specified in
839 /etc/apt/sources.list. An update should always be performed before an
840 upgrade or dist-upgrade; run by sudo, if necessary.
842 : **calc** (//peval//)
843 Evaluates a perl expression (see peval() above); useful as a command line
846 : **CH** (//./configure --help//)
847 Lists available compilation options for building program from source.
849 : **cmplayer** (//mplayer -vo fbdev//)
850 Video player with framebuffer as video output device, so you can watch
851 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
852 while watching a movie.
854 : **CO** (//./configure//)
855 Prepares compilation for building program from source.
857 : **da** (//du -sch//)
858 Prints the summarized disk usage of the arguments as well as a grand total
859 in human readable format.
861 : **default** (//echo -en [ escape sequence ]//)
862 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
863 using escape sequence.
865 : **dir** (//ls -lSrah//)
866 Lists files (including dot files) sorted by size (biggest last) in long and
867 human readable output format.
869 : **fblinks** (//links2 -driver fb//)
870 A Web browser on the framebuffer device. So you can browse images and click
871 links on the virtual tty.
873 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
874 Fullscreen Video player with the framebuffer as video output device. So you
875 can watch videos on a virtual tty.
878 Revision control system by Linus Torvalds.
880 : **grep** (//grep --color=auto//)
881 Shows grep output in nice colors, if available.
883 : **GREP** (//grep -i --color=auto//)
884 Case insensitive grep with colored output.
886 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
887 Scans for new devices and updates /etc/fstab according to the findings.
889 : **grml-version** (//cat /etc/grml_version//)
890 Prints version of running grml.
892 : **http** (//python -m SimpleHTTPServer//)
893 Basic HTTP server implemented in python. Listens on port 8000/tcp and
894 serves current directory. Implements GET and HEAD methods.
896 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
897 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
898 host key changes frequently, for example on virtualized test- or development-systems.
899 To be used only inside trusted networks, of course.
901 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
902 ssh with possible man-in-the-middle attack enabled
903 (for an explanation see insecscp above).
905 : **help-zshglob** (//H-Glob()//)
906 Runs the function H-Glob() to expand or explain wildcards.
908 : **hide** (//echo -en [ escape sequence ]//)
909 Tries to hide xterm window using escape sequence.
911 : **huge** (//echo -en [ escape sequence ]//)
912 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
913 using escape sequence.
915 : **j** (//jobs -l//)
916 Prints status of jobs in the current shell session in long format.
918 : **l** (//ls -lF --color=auto//)
919 Lists files in long output format with indicator for filetype appended
920 to filename. If the terminal supports it, with colored output.
922 : **la** (//ls -la --color=auto//)
923 Lists files in long colored output format. Including file names
926 : **lad** (//ls -d .*(/)//)
927 Lists the dot directories (not their contents) in current directory.
929 : **large** (//echo -en [ escape sequence ]//)
930 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
931 using escape sequence.
933 : **lh** (//ls -hAl --color=auto//)
934 Lists files in long and human readable output format in nice colors,
935 if available. Includes file names starting with "." except "." and
938 : **ll** (//ls -l --color=auto//)
939 Lists files in long colored output format.
941 : **ls** (//ls -b -CF --color=auto//)
942 Lists directory printing octal escapes for nongraphic characters.
943 Entries are listed by columns and an indicator for file type is appended
944 to each file name. Additionally the output is colored, if the terminal
947 : **lsa** (//ls -a .*(.)//)
948 Lists dot files in current working directory.
950 : **lsbig** (//ls -flh *(.OL[1,10])//)
951 Displays the ten biggest files (long and human readable output format).
953 : **lsd** (//ls -d *(/)//)
956 : **lse** (//ls -d *(/^F)//)
957 Shows empty directories.
959 : **lsl** (//ls -l *(@)//)
960 Lists symbolic links in current directory.
962 : **lsnew** (//ls -rl *(D.om[1,10])//)
963 Displays the ten newest files (long output format).
965 : **lsold** (//ls -rtlh *(D.om[1,10])//)
966 Displays the ten oldest files (long output format).
968 : **lss** (//ls -l *(s,S,t)//)
969 Lists files in current directory that have the setuid, setgid or sticky bit
972 : **lssmall** (//ls -Srl *(.oL[1,10])//)
973 Displays the ten smallest files (long output format).
975 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
976 Displays all files which are world readable and/or world writable and/or
977 world executable (long output format).
979 : **lsx** (//ls -l *(*)//)
980 Lists only executable files.
982 : **md** (//mkdir -p//)
983 Creates directory including parent directories, if necessary
985 : **medium** (//echo -en [ escape sequence ]//)
986 Sets medium sized font
987 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
988 using escape sequence.
990 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
991 If invoking user is root, starts screen session with /etc/grml/screenrc
992 as config file. If invoked by a regular user, start a screen session
993 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
996 : **rw-** (//chmod 600//)
997 Grants read and write permission of a file to the owner and nobody else.
999 : **rwx** (//chmod 700//)
1000 Grants read, write and execute permission of a file to the owner and nobody
1003 : **r--** (//chmod 644//)
1004 Grants read and write permission of a file to the owner and read-only to
1007 : **r-x** (//chmod 755//)
1008 Grants read, write and execute permission of a file to the owner and
1009 read-only plus execute permission to anybody else.
1011 : **semifont** (//echo -en [ escape sequence ]//)
1012 Sets font of xterm to
1013 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1016 : **small** (//echo -en [ escape sequence ]//)
1017 Sets small xterm font ("6x10") using escape sequence.
1019 : **smartfont** (//echo -en [ escape sequence ]//)
1020 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1023 : **su** (//sudo su//)
1024 If user is running a grml live-CD, dont ask for any password, if she
1027 : **tiny** (//echo -en [ escape sequence ]//)
1028 Sets tiny xterm font
1029 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1032 : **truec** (//truecrypt [ mount options ]//)
1033 Mount a truecrypt volume with some reasonable mount options
1034 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1037 : **up** (//aptitude update ; aptitude safe-upgrade//)
1038 Performs a system update followed by a system upgrade using aptitude; run
1039 by sudo, if necessary. See au and ag above.
1041 : **?** (//qma zshall//)
1042 Runs the grml script qma (quick manual access) to build the collected man
1043 pages for the z-shell. This compressed file is kept at
1044 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1045 fast. See "man qma" for further information.
1049 This is a set of files, that - if they exist - can be used to customize the
1050 behaviour of //grmlzshrc//.
1053 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1054 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1057 # show battery status in RPROMPT
1059 # always load the complete setup, even for root
1060 GRML_ALWAYS_LOAD_ALL=1
1064 Sourced right before loading //grmlzshrc// is finished. There is a global
1065 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1069 Directory listing for persistent dirstack (see above).
1071 : **.important_commands**
1072 List of commands, used by persistent history (see above).
1075 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1076 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1077 (http://www.ubuntu.com) and similar systems - it is very easy to get
1078 //grmlzshrc// via grml's .deb repositories.
1080 On non-debian systems, that is not an option, but all is not lost:
1083 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1086 If you would also like to get seperate function files (which you can put into
1087 your **$fpath**), you can browse and download them at:
1089 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1091 = ZSH REFCARD TAGS =
1092 If you read //grmlzshrc//'s code you may notice strange looking comments in
1093 it. These are there for a purpose. grml's zsh-refcard is automatically
1094 generated from the contents of the actual configuration file. However, we need
1095 a little extra information on which comments and what lines of code to take
1096 into account (and for what purpose).
1098 Here is what they mean:
1100 List of tags (comment types) used:
1102 Next line contains an important alias, that should be included in the
1103 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1106 Next line contains the beginning of an important function. (placement
1107 tag: @@INSERT-functions@@)
1110 Next line contains an important variable. (placement tag:
1111 @@INSERT-variables@@)
1114 Next line contains an important keybinding. (placement tag:
1115 @@INSERT-keybindings@@)
1118 Hashed directories list generation: //start//: denotes the start of a list of
1119 'hash -d' definitions. //end//: denotes its end. (placement tag:
1120 @@INSERT-hasheddirs@@)
1123 Abbreviation expansion list generation: //start//: denotes the beginning of
1124 abbreviations. //end//: denotes their end.
1126 Lines within this section that end in '#d .*' provide extra documentation to
1127 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1130 This tag allows you to manually generate refcard entries for code lines that
1131 are hard/impossible to parse.
1135 #m# k ESC-h Call the run-help function
1138 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1141 So the syntax is: #m# <section> <argument> <comment>
1144 This tag lets you insert entries to the 'other' hash. Generally, this should
1145 not be used. It is there for things that cannot be done easily in another way.
1146 (placement tag: @@INSERT-other-foobar@@)
1149 All of these tags (except for m and o) take two arguments, the first
1150 within the tag, the other after the tag:
1152 #<tag><section># <comment>
1154 Where <section> is really just a number, which are defined by the @secmap
1155 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1156 that for the reader, the tag should not differ much from a regular comment.
1157 For zsh, it is a regular comment indeed. The numbers have got the following
1182 So, the following will add an entry to the 'functions' table in the 'system'
1183 section, with a (hopefully) descriptive comment:
1186 #f1# Edit an alias via zle
1190 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1191 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1192 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1193 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1194 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1198 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1199 repository from git.grml.org:
1201 ``` % git clone git://git.grml.org/grml-etc-core.git
1203 Make your changes, commit them; use '**git format-patch**' to create a series
1204 of patches and send those to the following address via '**git send-email**':
1206 ``` grml-etc-core@grml.org
1208 Doing so makes sure the right people get your patches for review and
1213 This manual page is the **reference** manual for //grmlzshrc//.
1215 That means that in contrast to the existing refcard it should document **every**
1216 aspect of the setup.
1218 This manual is currently not complete. If you want to help improving it, visit
1219 the following pages:
1221 http://wiki.grml.org/doku.php?id=zshrcmanual
1223 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1225 Contributions are highly welcome.
1229 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1230 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1231 Beckert <abe@deuxchevaux.org>.
1235 Copyright (c) 2009, grml project <http://grml.org>
1237 This manpage is distributed under the terms of the GPL version 2.
1239 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1240 except for **accept-line()** and **vcs_info()**, which are distributed under
1241 the same conditions as zsh itself (which is BSD-like).