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 Lists files in current directory, which have been accessed within the
420 last N days. N is an integer to be passed as first and only argument.
421 If no argument is specified N is set to 1.
424 Searches for USENET postings from authors using google groups.
427 Sets all ulimit values to "unlimited".
430 Prints a colored table of available ansi color codes (to be used in escape
431 sequences) and the colors they represent.
433 : **aoeu(), asdf(), uiae()**
434 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
438 Login on the host provided as argument using autossh. Then reattach a GNU screen
439 session if a detached session is around or detach a currently attached screen or
440 else start a new screen. This is especially useful for roadwarriors using GNU
444 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
445 Then prompts the user if she wants to remove that directory. You might need
446 to tell audioburn which cdrom device to use like:
447 "DEVICE=/dev/cdrom audioburn"
450 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
451 it. Then prompts the user if she wants to burn a audio CD with audioburn()
452 (see above). You might need to tell audiorip which cdrom device to use like:
453 "DEVICE=/dev/cdrom audioburn"
456 Simple backup of a file or directory using cp(1). The target file name is the
457 original name plus a time stamp attached. Symlinks and file attributes like mode,
458 ownership and timestamps are preserved.
461 The brltty(1) program provides a braille display, so a blind person can access
462 the console screen. This wrapper function works around problems with some
463 environments (f. e. utf8).
466 If the original cdrecord is not installed, issues a warning to the user to
467 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
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 Presents a numbered listing of the directory stack. Then changes current
490 working directory to the one chosen by the user.
493 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
494 email addresses of submitters or any string given on the command line.
497 Shows bug report for debian given by number in mailbox format.
500 Tells the user to use grml-debootstrap, if she wants to install debian to
504 Shows the disk usage of the directories given in human readable format;
508 Translates C source code to assembly and ouputs both.
511 Takes packagename as argument. Sets current working directory to
512 /usr/share/doc/<packagename> and prints out a directory listing.
515 Renames image files based on date/time informations in their exif headers.
518 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
519 instance of firefox running, attaches to the first window found and opens the
520 URL in a new tab (this even works across an ssh session).
522 : **fluxkey-change()**
523 Switches the key combinations for changing current workspace under fluxbox(1)
524 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
525 Requires the window manager to reread configuration to take effect.
528 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
529 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
530 filename>". Creates an index.html with title "Images" showing the
531 thumbnails as clickable links to the respective original file.
532 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
533 and all files and/or directories beginning with "thumb-" in current directory!
536 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
539 Tries to download and install Gizmo (VoIP software) for Debian.
542 Tries to download and install Skype (VoIP software) for Debian.
545 Downloads and installs newer version of Skype.
548 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
552 Opens a specific git commitdiff from kernel.org in default browser. Tree is
553 chosen by the environment variable GITTREE which defaults to Linus Torvalds'
556 : **git-get-commit()**
557 Opens a specific git commit from kernel.org in default browser. The tree to
558 fetch from is controlled by the environment variable GITTREE which defaults
559 to Linus Torvalds' kernel tree.
561 : **git-get-plaindiff()**
562 Fetches specific git diff from kernel.org. The tree is controlled by the
563 environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
566 Searches the zsh command history for a regular expression.
569 Prints the hexadecimal representation of the number supplied as argument
573 Outputs highlighted diff; needs highstring(1).
576 Shows source files in less(1) with syntax highlighting. Run "hl -h"
577 for detailed usage information.
580 Queries IMAP server (first parameter) for its capabilities. Takes
581 port number as optional second argument.
584 Returns true, if zsh version is equal or greater than 4, else false.
587 Returns true, if zsh version is equal or greater than 4.1, else false.
590 Returns true, if zsh version is equal or greater than 4.2, else false.
593 Returns true, if zsh version is equal or greater than 4.2.5, else false.
596 Returns true, if zsh version is equal or greater than 4.3, else false.
599 Returns true, if zsh version is equal or greater than 4.3.3, else false.
602 Returns true, if running on darwin, else false.
605 Returns true, if running on a grml system, else false.
608 Returns true, if running on a grml system from a live cd, else false.
611 Returns true, if run on grml-small, else false.
614 Changes every occurrence of the string iso885915 or ISO885915 in
615 environment variables to UTF-8.
618 Returns true, if run within an utf environment, else false.
621 Lists libraries that define the symbol containing the string given as
625 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
629 Creates a PostScript and a PDF file (basename as first argument) from
633 Displays manpage in a streched style.
636 Creates directory including parent directories, if necessary. Then changes
637 current working directory to it.
640 Diffs the two arguments recursively and writes the
641 output (unified format) to a timestamped file.
644 Prints the summarized memory usage in bytes.
646 : **minimal-shell()**
647 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
648 so that file system can be unmounted.
651 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
652 replaces spaces in file names with underscores. Then mkaudiocd()
653 normalizes the files and recodes them to WAV.
656 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
657 enabled using mkisofs(8). Prompts the user for volume name, filename and
661 Creates a directory with first parameter as name inside $MAILDIR_ROOT
662 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
665 Runs "make install" and logs the output under ~/.errorlogs/; useful for
666 a clean deinstall later.
669 Lists files in current directory, which have been modified within the
670 last N days. N is an integer to be passed as first and only argument.
671 If no argument is specified N is set to 1.
674 Recodes an ogg file to mp3 with a bitrate of 192.
677 Evaluates a perl expression; useful as command line
678 calculator, therefore also available as "calc".
681 Lists all occurrences of the string given as argument in current $PATH.
684 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
685 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
686 Asks for confirmation.
689 Opens all README-like files in current working directory with the program
690 defined in the $PAGER environment variable.
693 Reloads functions given as parameters.
696 Checks whether a regular expression (first parameter) matches a string
697 (second parameter) using perl.
700 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
701 for details. See also xunfunction() below.
704 Greps the history for the string provided as parameter and shows the numbered
705 findings in default pager. On exit of the pager the user is prompted for a
706 number. The shells readline buffer is then filled with the corresponding
710 Lists the contents of a (compressed) archive with the appropriate programs.
711 The choice is made along the filename extension.
714 Lists the content of a gzipped tar archive in default pager.
717 Shows the content of a zip archive in default pager.
719 : **simple-extract()**
720 Tries to uncompress/unpack given file with the appropriate programs. The
721 choice is made along the filename ending.
724 Prints the arguments slowly by sleeping 0.08 seconds between each character.
726 : **smartcompress()**
727 Compresses/archives the file given as first parameter. Takes an optional
728 second argument, which denotes the compression/archive type as typical
729 filename extension; defaults to "tar.gz".
732 Indents C source code files given; uses Kernighan & Ritchie style.
735 Creates directory named shots in user's home directory, if it does not yet
736 exist and changes current working directory to it. Then sleeps 5 seconds,
737 so you have plenty of time to switch desktops/windows. Then makes a screenshot
738 of the current desktop. The result is stored in ~/shots to a timestamped
741 : **ssl-cert-fingerprints**
742 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
743 First and only parameter must be a file containing a certificate. Use
744 /dev/stdin as file if you want to pipe a certificate to these
748 Prints all information of a x509 certificate including the SHA512,
749 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
750 containing a certificate. Use /dev/stdin as file if you want to pipe a
751 certificate to this function.
753 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
754 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
755 certificate. First and only parameter must be a file containing a
756 certificate. Use /dev/stdin as file if you want to pipe a certificate
760 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
761 issues a Warning to use the grml-x(1) script. Can be overridden by using
762 /usr/bin/startx directly.
765 Shows some information about current system status.
768 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
769 swspeak must be set for this to work.
772 Translates a word from german to english (-D) or vice versa (-E).
775 Makes a unified diff of the command line arguments trying hard to find a
776 smaller set of changes. Descends recursively into subdirectories. Ignores
777 hows some information about current status.
780 Downloads and displays a file using a suitable program for its
784 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
787 Takes a string as its first argument and prints it RFC 2396 URL encoded to
791 Changes every occurrence of the string UTF-8 or utf-8 in environment
792 variables to iso885915.
798 Wrapper for vim(1). It tries to set the title and hands vim the environment
799 variable VIM_OPTIONS on the command line. So the user may define command
800 line options, she always wants, in her .zshrc.local.
803 Use vim(1) as manpage reader.
806 Tries to cat(1) file(s) given as parameter(s). Always returns true.
807 See also xunfunction() below.
810 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
811 issues a Warning to use the grml-x(1) script. Can be overridden by using
812 /usr/bin/xinit directly.
815 Tries to source the file(s) given as parameter(s). Always returns true.
816 See zshbuiltins(1) for a detailed description of the source command.
817 See also xunfunction() below.
820 Changes the title of xterm window from within screen(1). Run without
821 arguments for details.
824 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
827 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
828 option plus a non empty pattern. Run zg without any arguments for a listing
829 of available command line switches. For a zshrc not in /etc/zsh, set the
830 GRML_ZSHRC environment variable.
833 Wrapper around the autoload builtin. Loads the definitions of functions
834 from the file given as argument. Searches $fpath for the file. See also
838 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
839 where own modifications should go. See also zshbuiltins(1) for a description
840 of the source command.
844 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
845 life. A few aliases (like those involving //grep// or //ls//) use the option
846 //--color=auto// for colourizing output. That option is part of **GNU**
847 implementations of these tools, and will only be used if such an implementation
850 : **acp** (//apt-cache policy//)
851 With no arguments prints out the priorities of each source. If a package name
852 is given, it displays detailed information about the priority selection of the
855 : **acs** (//apt-cache search//)
856 Searches debian package lists for the regular expression provided as argument.
857 The search includes package names and descriptions. Prints out name and short
858 description of matching packages.
860 : **acsh** (//apt-cache show//)
861 Shows the package records for the packages provided as arguments.
863 : **adg** (//apt-get dist-upgrade//)
864 Performs an upgrade of all installed packages. Also tries to automatically
865 handle changing dependencies with new versions of packages. As this may change
866 the install status of (or even remove) installed packages, it is potentially
867 dangerous to use dist-upgrade; invoked by sudo, if necessary.
869 : **ag** (//apt-get upgrade//)
870 Downloads and installs the newest versions of all packages currently installed
871 on the system. Under no circumstances are currently installed packages removed,
872 or packages not already installed retrieved and installed. New versions of
873 currently installed packages that cannot be upgraded without changing the install
874 status of another package will be left at their current version. An update must
875 be performed first (see au below); run by sudo, if necessary.
877 : **agi** (//apt-get install//)
878 Downloads and installs or upgrades the packages given on the command line.
879 If a hyphen is appended to the package name, the identified package will be
880 removed if it is installed. Similarly a plus sign can be used to designate a
881 package to install. This may be useful to override decisions made by apt-get's
882 conflict resolution system.
883 A specific version of a package can be selected for installation by following
884 the package name with an equals and the version of the package to select. This
885 will cause that version to be located and selected for install. Alternatively a
886 specific distribution can be selected by following the package name with a slash
887 and the version of the distribution or the Archive name (stable, testing, unstable).
888 Gets invoked by sudo, if user id is not 0.
890 : **ati** (//aptitude install//)
891 Aptitude is a terminal-based package manager with a command line mode similar to
892 apt-get (see agi above); invoked by sudo, if necessary.
894 : **au** (//apt-get update//)
895 Resynchronizes the package index files from their sources. The indexes of
896 available packages are fetched from the location(s) specified in
897 /etc/apt/sources.list. An update should always be performed before an
898 upgrade or dist-upgrade; run by sudo, if necessary.
900 : **calc** (//peval//)
901 Evaluates a perl expression (see peval() above); useful as a command line
904 : **CH** (//./configure --help//)
905 Lists available compilation options for building program from source.
907 : **cmplayer** (//mplayer -vo fbdev//)
908 Video player with framebuffer as video output device, so you can watch
909 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
910 while watching a movie.
912 : **CO** (//./configure//)
913 Prepares compilation for building program from source.
915 : **da** (//du -sch//)
916 Prints the summarized disk usage of the arguments as well as a grand total
917 in human readable format.
919 : **default** (//echo -en [ escape sequence ]//)
920 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
921 using escape sequence.
923 : **dir** (//ls -lSrah//)
924 Lists files (including dot files) sorted by size (biggest last) in long and
925 human readable output format.
927 : **fblinks** (//links2 -driver fb//)
928 A Web browser on the framebuffer device. So you can browse images and click
929 links on the virtual tty.
931 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
932 Fullscreen Video player with the framebuffer as video output device. So you
933 can watch videos on a virtual tty.
936 Revision control system by Linus Torvalds.
938 : **grep** (//grep --color=auto//)
939 Shows grep output in nice colors, if available.
941 : **GREP** (//grep -i --color=auto//)
942 Case insensitive grep with colored output.
944 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
945 Scans for new devices and updates /etc/fstab according to the findings.
947 : **grml-version** (//cat /etc/grml_version//)
948 Prints version of running grml.
950 : **http** (//python -m SimpleHTTPServer//)
951 Basic HTTP server implemented in python. Listens on port 8000/tcp and
952 serves current directory. Implements GET and HEAD methods.
954 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
955 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
956 host key changes frequently, for example on virtualized test- or development-systems.
957 To be used only inside trusted networks, of course.
959 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
960 ssh with possible man-in-the-middle attack enabled
961 (for an explanation see insecscp above).
963 : **help-zshglob** (//H-Glob()//)
964 Runs the function H-Glob() to expand or explain wildcards.
966 : **hide** (//echo -en [ escape sequence ]//)
967 Tries to hide xterm window using escape sequence.
969 : **huge** (//echo -en [ escape sequence ]//)
970 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
971 using escape sequence.
973 : **j** (//jobs -l//)
974 Prints status of jobs in the current shell session in long format.
976 : **l** (//ls -lF --color=auto//)
977 Lists files in long output format with indicator for filetype appended
978 to filename. If the terminal supports it, with colored output.
980 : **la** (//ls -la --color=auto//)
981 Lists files in long colored output format. Including file names
984 : **lad** (//ls -d .*(/)//)
985 Lists the dot directories (not their contents) in current directory.
987 : **large** (//echo -en [ escape sequence ]//)
988 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
989 using escape sequence.
991 : **lh** (//ls -hAl --color=auto//)
992 Lists files in long and human readable output format in nice colors,
993 if available. Includes file names starting with "." except "." and
996 : **ll** (//ls -l --color=auto//)
997 Lists files in long colored output format.
999 : **ls** (//ls -b -CF --color=auto//)
1000 Lists directory printing octal escapes for nongraphic characters.
1001 Entries are listed by columns and an indicator for file type is appended
1002 to each file name. Additionally the output is colored, if the terminal
1005 : **lsa** (//ls -a .*(.)//)
1006 Lists dot files in current working directory.
1008 : **lsbig** (//ls -flh *(.OL[1,10])//)
1009 Displays the ten biggest files (long and human readable output format).
1011 : **lsd** (//ls -d *(/)//)
1014 : **lse** (//ls -d *(/^F)//)
1015 Shows empty directories.
1017 : **lsl** (//ls -l *(@)//)
1018 Lists symbolic links in current directory.
1020 : **lsnew** (//ls -rl *(D.om[1,10])//)
1021 Displays the ten newest files (long output format).
1023 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1024 Displays the ten oldest files (long output format).
1026 : **lss** (//ls -l *(s,S,t)//)
1027 Lists files in current directory that have the setuid, setgid or sticky bit
1030 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1031 Displays the ten smallest files (long output format).
1033 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1034 Displays all files which are world readable and/or world writable and/or
1035 world executable (long output format).
1037 : **lsx** (//ls -l *(*)//)
1038 Lists only executable files.
1040 : **md** (//mkdir -p//)
1041 Creates directory including parent directories, if necessary
1043 : **medium** (//echo -en [ escape sequence ]//)
1044 Sets medium sized font
1045 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1046 using escape sequence.
1048 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1049 If invoking user is root, starts screen session with /etc/grml/screenrc
1050 as config file. If invoked by a regular user, start a screen session
1051 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1054 : **rw-** (//chmod 600//)
1055 Grants read and write permission of a file to the owner and nobody else.
1057 : **rwx** (//chmod 700//)
1058 Grants read, write and execute permission of a file to the owner and nobody
1061 : **r--** (//chmod 644//)
1062 Grants read and write permission of a file to the owner and read-only to
1065 : **r-x** (//chmod 755//)
1066 Grants read, write and execute permission of a file to the owner and
1067 read-only plus execute permission to anybody else.
1069 : **semifont** (//echo -en [ escape sequence ]//)
1070 Sets font of xterm to
1071 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1074 : **small** (//echo -en [ escape sequence ]//)
1075 Sets small xterm font ("6x10") using escape sequence.
1077 : **smartfont** (//echo -en [ escape sequence ]//)
1078 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1081 : **su** (//sudo su//)
1082 If user is running a grml live-CD, dont ask for any password, if she
1085 : **tiny** (//echo -en [ escape sequence ]//)
1086 Sets tiny xterm font
1087 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1090 : **truec** (//truecrypt [ mount options ]//)
1091 Mount a truecrypt volume with some reasonable mount options
1092 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1095 : **up** (//aptitude update ; aptitude safe-upgrade//)
1096 Performs a system update followed by a system upgrade using aptitude; run
1097 by sudo, if necessary. See au and ag above.
1099 : **?** (//qma zshall//)
1100 Runs the grml script qma (quick manual access) to build the collected man
1101 pages for the z-shell. This compressed file is kept at
1102 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1103 fast. See "man qma" for further information.
1107 This is a set of files, that - if they exist - can be used to customize the
1108 behaviour of //grmlzshrc//.
1111 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1112 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1115 # show battery status in RPROMPT
1117 # always load the complete setup, even for root
1118 GRML_ALWAYS_LOAD_ALL=1
1122 Sourced right before loading //grmlzshrc// is finished. There is a global
1123 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1127 Directory listing for persistent dirstack (see above).
1129 : **.important_commands**
1130 List of commands, used by persistent history (see above).
1133 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1134 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1135 (http://www.ubuntu.com) and similar systems - it is very easy to get
1136 //grmlzshrc// via grml's .deb repositories.
1138 On non-debian systems, that is not an option, but all is not lost:
1141 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1144 If you would also like to get seperate function files (which you can put into
1145 your **$fpath**), you can browse and download them at:
1147 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1149 = ZSH REFCARD TAGS =
1150 If you read //grmlzshrc//'s code you may notice strange looking comments in
1151 it. These are there for a purpose. grml's zsh-refcard is automatically
1152 generated from the contents of the actual configuration file. However, we need
1153 a little extra information on which comments and what lines of code to take
1154 into account (and for what purpose).
1156 Here is what they mean:
1158 List of tags (comment types) used:
1160 Next line contains an important alias, that should be included in the
1161 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1164 Next line contains the beginning of an important function. (placement
1165 tag: @@INSERT-functions@@)
1168 Next line contains an important variable. (placement tag:
1169 @@INSERT-variables@@)
1172 Next line contains an important keybinding. (placement tag:
1173 @@INSERT-keybindings@@)
1176 Hashed directories list generation: //start//: denotes the start of a list of
1177 'hash -d' definitions. //end//: denotes its end. (placement tag:
1178 @@INSERT-hasheddirs@@)
1181 Abbreviation expansion list generation: //start//: denotes the beginning of
1182 abbreviations. //end//: denotes their end.
1184 Lines within this section that end in '#d .*' provide extra documentation to
1185 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1188 This tag allows you to manually generate refcard entries for code lines that
1189 are hard/impossible to parse.
1193 #m# k ESC-h Call the run-help function
1196 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1199 So the syntax is: #m# <section> <argument> <comment>
1202 This tag lets you insert entries to the 'other' hash. Generally, this should
1203 not be used. It is there for things that cannot be done easily in another way.
1204 (placement tag: @@INSERT-other-foobar@@)
1207 All of these tags (except for m and o) take two arguments, the first
1208 within the tag, the other after the tag:
1210 #<tag><section># <comment>
1212 Where <section> is really just a number, which are defined by the @secmap
1213 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1214 that for the reader, the tag should not differ much from a regular comment.
1215 For zsh, it is a regular comment indeed. The numbers have got the following
1240 So, the following will add an entry to the 'functions' table in the 'system'
1241 section, with a (hopefully) descriptive comment:
1244 #f1# Edit an alias via zle
1248 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1249 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1250 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1251 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1252 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1256 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1257 repository from git.grml.org:
1259 ``` % git clone git://git.grml.org/grml-etc-core.git
1261 Make your changes, commit them; use '**git format-patch**' to create a series
1262 of patches and send those to the following address via '**git send-email**':
1264 ``` grml-etc-core@grml.org
1266 Doing so makes sure the right people get your patches for review and
1271 This manual page is the **reference** manual for //grmlzshrc//.
1273 That means that in contrast to the existing refcard it should document **every**
1274 aspect of the setup.
1276 This manual is currently not complete. If you want to help improving it, visit
1277 the following pages:
1279 http://wiki.grml.org/doku.php?id=zshrcmanual
1281 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1283 Contributions are highly welcome.
1287 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1288 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1289 Beckert <abe@deuxchevaux.org>.
1293 Copyright (c) 2009, grml project <http://grml.org>
1295 This manpage is distributed under the terms of the GPL version 2.
1297 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1298 except for **accept-line()** and **vcs_info()**, which are distributed under
1299 the same conditions as zsh itself (which is BSD-like).