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.
46 : **COMMAND_NOT_FOUND**
47 A non zero value activates a handler, which is called when a command can not
48 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
50 : **GRML_ALWAYS_LOAD_ALL**
51 Enables the whole grml setup for root, if set to a non zero value.
53 : **GRML_ZSH_CNF_HANDLER**
54 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
55 and defaults to "/usr/share/command-not-found/command-not-found".
57 : **GRMLSMALL_SPECIFIC**
58 Set this to zero to remove items in zsh config, which do not work in
62 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
63 A value of zero turns off checking.
66 Non zero values deactivate automatic correction of commands.
69 If set to zero (default), allows selection from a menu, if there are at least
70 five possible options of completion.
73 A non zero value disables precmd and preexec commands. These are functions
74 that are run before every command (setting xterm/screen titles etc.).
77 Show time (user, system and cpu) used by external commands, if they run longer
78 than the defined number of seconds (default: 5).
80 : **ZSH_NO_DEFAULT_LOCALE**
81 Import "/etc/default/locale", if set to zero (default).
84 A non zero value causes shell functions to be profiled. The results can be
85 obtained with the zprof builtin command (see zshmodules(1) for details).
88 = FEATURE DESCRIPTION =
89 This is an in depth description of non-standard features implemented by
92 == DIRSTACK HANDLING ==
93 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
94 file each time zsh's working directory is changed. That file can be configured
95 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
96 **DIRSTACKSIZE** variable defaults to **20** in this setup.
98 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
99 zshs inherit the dirstack of the zsh that most recently updated
102 == DIRECTORY BASED PROFILES ==
103 If you want certain settings to be active in certain directories (and
104 automatically switch back and forth between them), this is what you want.
107 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
108 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
111 When that's done and you enter a directory that matches the pattern
112 in the third part of the context, a function called chpwd_profile_grml,
113 for example, is called (if it exists).
115 If no pattern matches (read: no profile is detected) the profile is
116 set to 'default', which means chpwd_profile_default is attempted to
119 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
120 command) which is used: The third part in the context is matched against
121 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
122 Because that way the profile is detected for all these values of **$PWD**:
130 So, if you want to make double damn sure a profile works in /foo/bar
131 and everywhere deeper in that tree, just use (|/|/*) and be happy.
133 The name of the detected profile will be available in a variable called
134 'profile' in your functions. You don't need to do anything, it'll just
137 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
138 that was active up to now. That way you can avoid running code for a
139 profile that is already active, by running code such as the following
140 at the start of your function:
143 function chpwd_profile_grml() {
144 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
149 The initial value for **$CHPWD_PROFILE** is 'default'.
151 === Signaling availabily/profile changes ===
153 If you use this feature and need to know whether it is active in your
154 current shell, there are several ways to do that. Here are two simple
157 a) If knowing if the profiles feature is active when zsh starts is
158 good enough for you, you can put the following snippet into your
162 (( ${+functions[chpwd_profiles]} )) &&
163 print "directory profiles active"
166 b) If that is not good enough, and you would prefer to be notified
167 whenever a profile changes, you can solve that by making sure you
168 start **every** profile function you create like this:
171 function chpwd_profile_myprofilename() {
172 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
173 print "chpwd(): Switching to profile: $profile"
178 That makes sure you only get notified if a profile is **changed**,
179 not everytime you change directory.
181 === Version requirement ===
182 This feature requires zsh //4.3.3// or newer.
185 == ACCEPTLINE WRAPPER ==
186 The //accept-line// wiget is the one that is taking action when the **return**
187 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
190 This wrapper is configured via styles. That means, you issue commands, that look
194 zstyle 'context' style value
197 The context namespace, that we are using is 'acceptline'. That means, the actual
198 context for your commands look like: **':acceptline:<subcontext>'**.
200 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
204 === Recognized Contexts ===
206 This is the value, the context is initialized with.
207 The //compwarnfmt and //rehash// styles are looked up in this context.
210 If the first word in the command line is either a command, alias, function,
211 builtin or reserved word, you are in this context.
214 This is the context, that is used if you hit enter again, after being warned
215 about the existence of a _completion for the non-existing command you
219 This is the context, you are in if the command line is empty or only
220 consists of whitespace.
223 This context is in effect, if you entered something that does not match any
224 of the above. (e.g.: variable assignments).
227 === Available Styles ===
229 If you set this style to true, the warning about non existent commands,
230 for which completions exist will not be issued. (Default: **false**)
233 The message, that is displayed to warn about the _completion issue.
234 (default: **'%c will not execute and completion %f exists.'**)
235 '%c' is replaced by the command name, '%f' by the completion's name.
238 If this is set, we'll force rehashing, if appropriate. (Defaults to
239 **true** in //grmlzshrc//).
242 This can be a list of wigdets to call in a given context. If you need a
243 specific order for these to be called, name them accordingly. The default value
244 is an **empty list**.
247 The name of a widget, that is called after the widgets from 'actions'.
248 By default, this will be '.accept-line' (which is the built-in accept-line
252 If true in the current context, call the widget in the 'default_action'
253 style. (The default is **true** in all contexts.)
259 == GNU/SCREEN STATUS SETTING ==
260 //grmlzshrc// sets screen's hardstatus lines to the currently running command
261 or **'zsh'** if the shell is idling at its prompt. If the current working
262 directory is inside a repository unter version control, screen status is set
263 to: **'zsh: <repository name>'** via zsh's vcs_info.
266 == PERSISTENT HISTORY ==
267 If you got commands you consider important enough to be included in every
268 shell's history, you can put them into ~/.important_commands and they will be
269 available via the usual history lookup widgets.
273 == ENVIRONMENT VARIABLES ==
274 //grmlzshrc// sets some environment variables, which influence the
275 behaviour of applications.
278 If X is running this is set to "firefox", otherwise to "w3m".
281 Set to "yes". Some applications read this to learn about properties
282 of the terminal they are running in.
285 If not already set, sets the default editor. Falls back to vi(1),
286 if vim(1) is not available.
289 The mailbox file for the current user is set to /var/mail/$USER, if not
290 already set otherwise.
293 Set less(1) as default pager, if not already set to something different.
296 Holds the path to shared files for the C++ application framework QT
300 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
301 default to /bin/sh or /bin/bash.
305 Apart from zsh's default options, //grmlzshrc// sets some options
306 that change the behaviour of zsh. Options that change Z-shell's default
307 settings are marked by <grml>. But note, that zsh's defaults vary depending
308 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
311 Zsh sessions, that use //grmlzshrc//, will append their history list to the
312 history file, rather than replace it. Thus, multiple parallel zsh sessions
313 will all have the new entries from their history lists added to the history
314 file, in the order that they exit. The file will still be periodically
315 re-written to trim it when the number of lines grows 20% beyond the value
316 specified by $SAVEHIST.
319 If a command is issued that can't be executed as a normal command, and the
320 command is the name of a directory, perform the cd command to that directory.
322 : **auto_pushd** <grml>
323 Make cd push the old directory onto the directory stack.
325 : **completeinword** <grml>
326 If the cursor is inside a word, completion is done from both ends;
327 instead of moving the cursor to the end of the word first and starting
330 : **extended_glob** <grml>
331 Treat the '#', '~' and '^' characters as active globbing pattern characters.
333 : **extended_history** <grml>
334 Save each command's beginning timestamp (in seconds since the epoch) and the
335 duration (in seconds) to the history file.
338 Whenever a command completion is attempted, make sure the entire command
339 path is hashed first. This makes the first completion slower.
341 : **histignorealldups** <grml>
342 If a new command line being added to the history list duplicates an
343 older one, the older command is removed from the list, even if it is
344 not the previous event.
346 : **histignorespace** <grml>
347 Remove command lines from the history list when the first character on
348 the line is a space, or when one of the expanded aliases contains a
349 leading space. Note that the command lingers in the internal history
350 until the next command is entered before it vanishes.
352 : **longlistjobs** <grml>
353 List jobs in long format by default.
356 Avoid to beep on errors in zsh command line editing (zle).
359 A wildcard character never matches a leading '.'.
362 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
364 : **nonomatch** <grml>
365 If a pattern for filename generation has no matches, do not print an error
366 and leave it unchanged in the argument list. This also applies to file
367 expansion of an initial `~' or `='.
370 Report the status of background jobs immediately, rather than waiting until
371 just before printing a prompt.
373 : **pushd_ignore_dups** <grml>
374 Don't push multiple copies of the same directory onto the directory stack.
376 : **share_history** <grml>
377 As each line is added to the history file, it is checked to see if anything
378 else was written out by another shell, and if so it is included in the
379 history of the current shell too. Using !-style history, the commands from
380 the other sessions will not appear in the history list unless you explicitly
381 type the "history" command. This option is activated for zsh versions >= 4,
386 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
387 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
391 Edit the current command buffer in your favourite editor.
394 Deletes a word left of the cursor; seeing '/' as additional word separator.
397 Jump right after the first word.
400 Searches the last occurence of string before the cursor in the command history.
403 Brings a job, which got suspended with CTRL-z back to foreground.
406 == SHELL FUNCTIONS ==
407 //grmlzshrc// comes with a wide array of defined shell functions to ease the
411 Converts plaintext files to HTML using vim. The output is written to
414 : **855resolution()**
415 If 915resolution is available, issues a warning to the user to run it instead
416 to modify the resolution on intel graphics chipsets.
419 Searches for USENET postings from authors using google groups.
422 Sets all ulimit values to "unlimited".
425 Prints a colored table of available ansi color codes (to be used in escape
426 sequences) and the colors they represent.
428 : **aoeu(), asdf(), uiae()**
429 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
433 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
434 Then prompts the user if she wants to remove that directory. You might need
435 to tell audioburn which cdrom device to use like:
436 "DEVICE=/dev/cdrom audioburn"
439 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
440 it. Then prompts the user if she wants to burn a audio CD with audioburn()
441 (see above). You might need to tell audiorip which cdrom device to use like:
442 "DEVICE=/dev/cdrom audioburn"
445 Simple backup of a file or directory using cp(1). The target file name is the
446 original name plus a time stamp attached. Symlinks and file attributes like mode,
447 ownership and timestamps are preserved.
450 The brltty(1) program provides a braille display, so a blind person can access
451 the console screen. This wrapper function works around problems with some
452 environments (f. e. utf8).
455 If the original cdrecord is not installed, issues a warning to the user to
456 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
460 Lists files in current directory, which have been changed within the
461 last N days. N is an integer required as first and only argument.
464 Returns true if given command exists either as program, function, alias,
465 builtin or reserved word. If the option -c is given, only returns true,
466 if command is a program.
469 Changes directory to $HOME on first invocation of zsh. This is neccessary on
470 grml systems with autologin.
473 Changes current directory to the one supplied by argument and lists the files
474 in it, including file names starting with ".".
477 Presents a numbered listing of the directory stack. Then changes current
478 working directory to the one chosen by the user.
481 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
482 email addresses of submitters or any string given on the command line.
485 Shows bug report for debian given by number in mailbox format.
488 Tells the user to use grml-debootstrap, if she wants to install debian to
492 Shows the disk usage of the directories given in human readable format;
496 Translates C source code to assembly and ouputs both.
499 Takes packagename as argument. Sets current working directory to
500 /usr/share/doc/<packagename> and prints out a directory listing.
503 Renames image files based on date/time informations in their exif headers.
506 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
507 instance of firefox running, attaches to the first window found and opens the
508 URL in a new tab (this even works across an ssh session).
510 : **fluxkey-change()**
511 Switches the key combinations for changing current workspace under fluxbox(1)
512 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
513 Requires the window manager to reread configuration to take effect.
516 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
517 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
518 filename>". Creates an index.html with title "Images" showing the
519 thumbnails as clickable links to the respective original file.
520 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
521 and all files and/or directories beginning with "thumb-" in current directory!
524 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
527 Tries to download and install Gizmo (VoIP software) for Debian.
530 Tries to download and install Skype (VoIP software) for Debian.
533 Downloads and installs newer version of Skype.
536 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
540 Opens a specific git commitdiff from kernel.org in default browser. Tree is
541 chosen by the environment variable GITTREE which defaults to Linus Torvalds'
544 : **git-get-commit()**
545 Opens a specific git commit from kernel.org in default browser. The tree to
546 fetch from is controlled by the environment variable GITTREE which defaults
547 to Linus Torvalds' kernel tree.
549 : **git-get-plaindiff()**
550 Fetches specific git diff from kernel.org. The tree is controlled by the
551 environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
554 Searches the zsh command history for a regular expression.
557 Prints the hexadecimal representation of the number supplied as argument
561 Outputs highlighted diff; needs highstring(1).
564 Shows source files in less(1) with syntax highlighting. Run "hl -h"
565 for detailed usage information.
568 Queries IMAP server (first parameter) for its capabilities. Takes
569 port number as optional second argument.
572 Returns true, if zsh version is equal or greater than 4, else false.
575 Returns true, if zsh version is equal or greater than 4.1, else false.
578 Returns true, if zsh version is equal or greater than 4.2, else false.
581 Returns true, if zsh version is equal or greater than 4.2.5, else false.
584 Returns true, if zsh version is equal or greater than 4.3, else false.
587 Returns true, if zsh version is equal or greater than 4.3.3, else false.
590 Returns true, if running on darwin, else false.
593 Returns true, if running on a grml system, else false.
596 Returns true, if running on a grml system from a live cd, else false.
599 Returns true, if run on grml-small, else false.
602 Changes every occurrence of the string iso885915 or ISO885915 in
603 environment variables to UTF-8.
606 Returns true, if run within an utf environment, else false.
609 Lists libraries that define the symbol containing the string given as
613 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
617 Creates a PostScript and a PDF file (basename as first argument) from
621 Displays manpage in a streched style.
624 Creates directory including parent directories, if necessary. Then changes
625 current working directory to it.
628 Diffs the two arguments recursively and writes the
629 output (unified format) to a timestamped file.
632 Prints the summarized memory usage in bytes.
634 : **minimal-shell()**
635 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
636 so that file system can be unmounted.
639 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
640 replaces spaces in file names with underscores. Then mkaudiocd()
641 normalizes the files and recodes them to WAV.
644 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
645 enabled using mkisofs(8). Prompts the user for volume name, filename and
649 Creates a directory with first parameter as name inside $MAILDIR_ROOT
650 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
653 Runs "make install" and logs the output under ~/.errorlogs/; useful for
654 a clean deinstall later.
657 Lists files in current directory, which have been modified within the
658 last N days. N is an integer required as first and only argument.
661 Recodes an ogg file to mp3 with a bitrate of 192.
664 Evaluates a perl expression; useful as command line
665 calculator, therefore also available as "calc".
668 Lists all occurrences of the string given as argument in current $PATH.
671 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
672 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
673 Asks for confirmation.
676 Opens all README-like files in current working directory with the program
677 defined in the $PAGER environment variable.
680 Reloads functions given as parameters.
683 Checks whether a regular expression (first parameter) matches a string
684 (second parameter) using perl.
687 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
688 for details. See also xunfunction() below.
691 Greps the history for the string provided as parameter and shows the numbered
692 findings in default pager. On exit of the pager the user is prompted for a
693 number. The shells readline buffer is then filled with the corresponding
697 Lists the contents of a (compressed) archive with the appropriate programs.
698 The choice is made along the filename extension.
701 Lists the content of a gzipped tar archive in default pager.
704 Shows the content of a zip archive in default pager.
706 : **simple-extract()**
707 Tries to uncompress/unpack given file with the appropriate programs. The
708 choice is made along the filename ending.
711 Prints the arguments slowly by sleeping 0.08 seconds between each character.
713 : **smartcompress()**
714 Compresses/archives the file given as first parameter. Takes an optional
715 second argument, which denotes the compression/archive type as typical
716 filename extension; defaults to "tar.gz".
719 Indents C source code files given; uses Kernighan & Ritchie style.
722 Creates directory named shots in user's home directory, if it does not yet
723 exist and changes current working directory to it. Then sleeps 5 seconds,
724 so you have plenty of time to switch desktops/windows. Then makes a screenshot
725 of the current desktop. The result is stored in ~/shots to a timestamped
728 : **ssl-cert-fingerprints**
729 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
730 First and only parameter must be a file containing a certificate. Use
731 /dev/stdin as file if you want to pipe a certificate to these
735 Prints all information of a x509 certificate including the SHA512,
736 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
737 containing a certificate. Use /dev/stdin as file if you want to pipe a
738 certificate to this function.
740 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
741 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
742 certificate. First and only parameter must be a file containing a
743 certificate. Use /dev/stdin as file if you want to pipe a certificate
747 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
748 issues a Warning to use the grml-x(1) script. Can be overridden by using
749 /usr/bin/startx directly.
752 Shows some information about current system status.
755 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
756 swspeak must be set for this to work.
759 Translates a word from german to english (-D) or vice versa (-E).
762 Makes a unified diff of the command line arguments trying hard to find a
763 smaller set of changes. Descends recursively into subdirectories. Ignores
764 hows some information about current status.
767 Downloads and displays a file using a suitable program for its
771 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
774 Takes a string as its first argument and prints it RFC 2396 URL encoded to
778 Changes every occurrence of the string UTF-8 or utf-8 in environment
779 variables to iso885915.
785 Wrapper for vim(1). It tries to set the title and hands vim the environment
786 variable VIM_OPTIONS on the command line. So the user may define command
787 line options, she always wants, in her .zshrc.local.
790 Use vim(1) as manpage reader.
793 Tries to cat(1) file(s) given as parameter(s). Always returns true.
794 See also xunfunction() below.
797 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
798 issues a Warning to use the grml-x(1) script. Can be overridden by using
799 /usr/bin/xinit directly.
802 Tries to source the file(s) given as parameter(s). Always returns true.
803 See zshbuiltins(1) for a detailed description of the source command.
804 See also xunfunction() below.
807 Changes the title of xterm window from within screen(1). Run without
808 arguments for details.
811 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
814 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
815 option plus a non empty pattern. Run zg without any arguments for a listing
816 of available command line switches. For a zshrc not in /etc/zsh, set the
817 GRML_ZSHRC environment variable.
820 Wrapper around the autoload builtin. Loads the definitions of functions
821 from the file given as argument. Searches $fpath for the file. See also
825 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
826 where own modifications should go. See also zshbuiltins(1) for a description
827 of the source command.
831 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
832 life. A few aliases (like those involving //grep// or //ls//) use the option
833 //--color=auto// for colourizing output. That option is part of **GNU**
834 implementations of these tools, and will only be used if such an implementation
837 : **acp** (//apt-cache policy//)
838 With no arguments prints out the priorities of each source. If a package name
839 is given, it displays detailed information about the priority selection of the
842 : **acs** (//apt-cache search//)
843 Searches debian package lists for the regular expression provided as argument.
844 The search includes package names and descriptions. Prints out name and short
845 description of matching packages.
847 : **acsh** (//apt-cache show//)
848 Shows the package records for the packages provided as arguments.
850 : **adg** (//apt-get dist-upgrade//)
851 Performs an upgrade of all installed packages. Also tries to automatically
852 handle changing dependencies with new versions of packages. As this may change
853 the install status of (or even remove) installed packages, it is potentially
854 dangerous to use dist-upgrade; invoked by sudo, if necessary.
856 : **ag** (//apt-get upgrade//)
857 Downloads and installs the newest versions of all packages currently installed
858 on the system. Under no circumstances are currently installed packages removed,
859 or packages not already installed retrieved and installed. New versions of
860 currently installed packages that cannot be upgraded without changing the install
861 status of another package will be left at their current version. An update must
862 be performed first (see au below); run by sudo, if necessary.
864 : **agi** (//apt-get install//)
865 Downloads and installs or upgrades the packages given on the command line.
866 If a hyphen is appended to the package name, the identified package will be
867 removed if it is installed. Similarly a plus sign can be used to designate a
868 package to install. This may be useful to override decisions made by apt-get's
869 conflict resolution system.
870 A specific version of a package can be selected for installation by following
871 the package name with an equals and the version of the package to select. This
872 will cause that version to be located and selected for install. Alternatively a
873 specific distribution can be selected by following the package name with a slash
874 and the version of the distribution or the Archive name (stable, testing, unstable).
875 Gets invoked by sudo, if user id is not 0.
877 : **ati** (//aptitude install//)
878 Aptitude is a terminal-based package manager with a command line mode similar to
879 apt-get (see agi above); invoked by sudo, if necessary.
881 : **au** (//apt-get update//)
882 Resynchronizes the package index files from their sources. The indexes of
883 available packages are fetched from the location(s) specified in
884 /etc/apt/sources.list. An update should always be performed before an
885 upgrade or dist-upgrade; run by sudo, if necessary.
887 : **calc** (//peval//)
888 Evaluates a perl expression (see peval() above); useful as a command line
891 : **CH** (//./configure --help//)
892 Lists available compilation options for building program from source.
894 : **cmplayer** (//mplayer -vo fbdev//)
895 Video player with framebuffer as video output device, so you can watch
896 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
897 while watching a movie.
899 : **CO** (//./configure//)
900 Prepares compilation for building program from source.
902 : **da** (//du -sch//)
903 Prints the summarized disk usage of the arguments as well as a grand total
904 in human readable format.
906 : **default** (//echo -en [ escape sequence ]//)
907 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
908 using escape sequence.
910 : **dir** (//ls -lSrah//)
911 Lists files (including dot files) sorted by size (biggest last) in long and
912 human readable output format.
914 : **fblinks** (//links2 -driver fb//)
915 A Web browser on the framebuffer device. So you can browse images and click
916 links on the virtual tty.
918 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
919 Fullscreen Video player with the framebuffer as video output device. So you
920 can watch videos on a virtual tty.
923 Revision control system by Linus Torvalds.
925 : **grep** (//grep --color=auto//)
926 Shows grep output in nice colors, if available.
928 : **GREP** (//grep -i --color=auto//)
929 Case insensitive grep with colored output.
931 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
932 Scans for new devices and updates /etc/fstab according to the findings.
934 : **grml-version** (//cat /etc/grml_version//)
935 Prints version of running grml.
937 : **http** (//python -m SimpleHTTPServer//)
938 Basic HTTP server implemented in python. Listens on port 8000/tcp and
939 serves current directory. Implements GET and HEAD methods.
941 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
942 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
943 host key changes frequently, for example on virtualized test- or development-systems.
944 To be used only inside trusted networks, of course.
946 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
947 ssh with possible man-in-the-middle attack enabled
948 (for an explanation see insecscp above).
950 : **help-zshglob** (//H-Glob()//)
951 Runs the function H-Glob() to expand or explain wildcards.
953 : **hide** (//echo -en [ escape sequence ]//)
954 Tries to hide xterm window using escape sequence.
956 : **huge** (//echo -en [ escape sequence ]//)
957 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
958 using escape sequence.
960 : **j** (//jobs -l//)
961 Prints status of jobs in the current shell session in long format.
963 : **l** (//ls -lF --color=auto//)
964 Lists files in long output format with indicator for filetype appended
965 to filename. If the terminal supports it, with colored output.
967 : **la** (//ls -la --color=auto//)
968 Lists files in long colored output format. Including file names
971 : **lad** (//ls -d .*(/)//)
972 Lists the dot directories (not their contents) in current directory.
974 : **large** (//echo -en [ escape sequence ]//)
975 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
976 using escape sequence.
978 : **lh** (//ls -hAl --color=auto//)
979 Lists files in long and human readable output format in nice colors,
980 if available. Includes file names starting with "." except "." and
983 : **ll** (//ls -l --color=auto//)
984 Lists files in long colored output format.
986 : **ls** (//ls -b -CF --color=auto//)
987 Lists directory printing octal escapes for nongraphic characters.
988 Entries are listed by columns and an indicator for file type is appended
989 to each file name. Additionally the output is colored, if the terminal
992 : **lsa** (//ls -a .*(.)//)
993 Lists dot files in current working directory.
995 : **lsbig** (//ls -flh *(.OL[1,10])//)
996 Displays the ten biggest files (long and human readable output format).
998 : **lsd** (//ls -d *(/)//)
1001 : **lse** (//ls -d *(/^F)//)
1002 Shows empty directories.
1004 : **lsl** (//ls -l *(@)//)
1005 Lists symbolic links in current directory.
1007 : **lsnew** (//ls -rl *(D.om[1,10])//)
1008 Displays the ten newest files (long output format).
1010 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1011 Displays the ten oldest files (long output format).
1013 : **lss** (//ls -l *(s,S,t)//)
1014 Lists files in current directory that have the setuid, setgid or sticky bit
1017 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1018 Displays the ten smallest files (long output format).
1020 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1021 Displays all files which are world readable and/or world writable and/or
1022 world executable (long output format).
1024 : **lsx** (//ls -l *(*)//)
1025 Lists only executable files.
1027 : **md** (//mkdir -p//)
1028 Creates directory including parent directories, if necessary
1030 : **medium** (//echo -en [ escape sequence ]//)
1031 Sets medium sized font
1032 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1033 using escape sequence.
1035 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1036 If invoking user is root, starts screen session with /etc/grml/screenrc
1037 as config file. If invoked by a regular user, start a screen session
1038 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1041 : **rw-** (//chmod 600//)
1042 Grants read and write permission of a file to the owner and nobody else.
1044 : **rwx** (//chmod 700//)
1045 Grants read, write and execute permission of a file to the owner and nobody
1048 : **r--** (//chmod 644//)
1049 Grants read and write permission of a file to the owner and read-only to
1052 : **r-x** (//chmod 755//)
1053 Grants read, write and execute permission of a file to the owner and
1054 read-only plus execute permission to anybody else.
1056 : **semifont** (//echo -en [ escape sequence ]//)
1057 Sets font of xterm to
1058 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1061 : **small** (//echo -en [ escape sequence ]//)
1062 Sets small xterm font ("6x10") using escape sequence.
1064 : **smartfont** (//echo -en [ escape sequence ]//)
1065 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1068 : **su** (//sudo su//)
1069 If user is running a grml live-CD, dont ask for any password, if she
1072 : **tiny** (//echo -en [ escape sequence ]//)
1073 Sets tiny xterm font
1074 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1077 : **truec** (//truecrypt [ mount options ]//)
1078 Mount a truecrypt volume with some reasonable mount options
1079 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1082 : **up** (//aptitude update ; aptitude safe-upgrade//)
1083 Performs a system update followed by a system upgrade using aptitude; run
1084 by sudo, if necessary. See au and ag above.
1086 : **?** (//qma zshall//)
1087 Runs the grml script qma (quick manual access) to build the collected man
1088 pages for the z-shell. This compressed file is kept at
1089 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1090 fast. See "man qma" for further information.
1094 This is a set of files, that - if they exist - can be used to customize the
1095 behaviour of //grmlzshrc//.
1098 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1099 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1102 # show battery status in RPROMPT
1104 # always load the complete setup, even for root
1105 GRML_ALWAYS_LOAD_ALL=1
1109 Sourced right before loading //grmlzshrc// is finished. There is a global
1110 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1114 Directory listing for persistent dirstack (see above).
1116 : **.important_commands**
1117 List of commands, used by persistent history (see above).
1120 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1121 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1122 (http://www.ubuntu.com) and similar systems - it is very easy to get
1123 //grmlzshrc// via grml's .deb repositories.
1125 On non-debian systems, that is not an option, but all is not lost:
1128 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1131 If you would also like to get seperate function files (which you can put into
1132 your **$fpath**), you can browse and download them at:
1134 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1136 = ZSH REFCARD TAGS =
1137 If you read //grmlzshrc//'s code you may notice strange looking comments in
1138 it. These are there for a purpose. grml's zsh-refcard is automatically
1139 generated from the contents of the actual configuration file. However, we need
1140 a little extra information on which comments and what lines of code to take
1141 into account (and for what purpose).
1143 Here is what they mean:
1145 List of tags (comment types) used:
1147 Next line contains an important alias, that should be included in the
1148 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1151 Next line contains the beginning of an important function. (placement
1152 tag: @@INSERT-functions@@)
1155 Next line contains an important variable. (placement tag:
1156 @@INSERT-variables@@)
1159 Next line contains an important keybinding. (placement tag:
1160 @@INSERT-keybindings@@)
1163 Hashed directories list generation: //start//: denotes the start of a list of
1164 'hash -d' definitions. //end//: denotes its end. (placement tag:
1165 @@INSERT-hasheddirs@@)
1168 Abbreviation expansion list generation: //start//: denotes the beginning of
1169 abbreviations. //end//: denotes their end.
1171 Lines within this section that end in '#d .*' provide extra documentation to
1172 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1175 This tag allows you to manually generate refcard entries for code lines that
1176 are hard/impossible to parse.
1180 #m# k ESC-h Call the run-help function
1183 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1186 So the syntax is: #m# <section> <argument> <comment>
1189 This tag lets you insert entries to the 'other' hash. Generally, this should
1190 not be used. It is there for things that cannot be done easily in another way.
1191 (placement tag: @@INSERT-other-foobar@@)
1194 All of these tags (except for m and o) take two arguments, the first
1195 within the tag, the other after the tag:
1197 #<tag><section># <comment>
1199 Where <section> is really just a number, which are defined by the @secmap
1200 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1201 that for the reader, the tag should not differ much from a regular comment.
1202 For zsh, it is a regular comment indeed. The numbers have got the following
1227 So, the following will add an entry to the 'functions' table in the 'system'
1228 section, with a (hopefully) descriptive comment:
1231 #f1# Edit an alias via zle
1235 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1236 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1237 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1238 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1239 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1243 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1244 repository from git.grml.org:
1246 ``` % git clone git://git.grml.org/grml-etc-core.git
1248 Make your changes, commit them; use '**git format-patch**' to create a series
1249 of patches and send those to the following address via '**git send-email**':
1251 ``` grml-etc-core@grml.org
1253 Doing so makes sure the right people get your patches for review and
1258 This manual page is the **reference** manual for //grmlzshrc//.
1260 That means that in contrast to the existing refcard it should document **every**
1261 aspect of the setup.
1263 This manual is currently not complete. If you want to help improving it, visit
1264 the following pages:
1266 http://wiki.grml.org/doku.php?id=zshrcmanual
1268 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1270 Contributions are highly welcome.
1274 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1275 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1276 Beckert <abe@deuxchevaux.org>.
1280 Copyright (c) 2009, grml project <http://grml.org>
1282 This manpage is distributed under the terms of the GPL version 2.
1284 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1285 except for **accept-line()** and **vcs_info()**, which are distributed under
1286 the same conditions as zsh itself (which is BSD-like).