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 Where zsh saves the history. Default: ${HOME}/.zsh_history.
65 Number of commands to be kept in the history. On a grml-CD this defaults to
66 500, on a hard disk installation to 5000.
69 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
70 A value of zero turns off checking.
73 Non zero values deactivate automatic correction of commands.
76 If set to zero (default), allows selection from a menu, if there are at least
77 five possible options of completion.
80 A non zero value disables precmd and preexec commands. These are functions
81 that are run before every command (setting xterm/screen titles etc.).
84 Show time (user, system and cpu) used by external commands, if they run longer
85 than the defined number of seconds (default: 5).
88 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a grml-CD
89 and to 10000 on an installation on hard disk.
92 As in tcsh(1) an array of login/logout events to be reported by the shell
93 builtin "log". For details see zshparam(1). Defaults to (notme root).
95 : **ZSH_NO_DEFAULT_LOCALE**
96 Import "/etc/default/locale", if set to zero (default).
99 A non zero value causes shell functions to be profiled. The results can be
100 obtained with the zprof builtin command (see zshmodules(1) for details).
103 = FEATURE DESCRIPTION =
104 This is an in depth description of non-standard features implemented by
107 == DIRSTACK HANDLING ==
108 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
109 file each time zsh's working directory is changed. That file can be configured
110 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
111 **DIRSTACKSIZE** variable defaults to **20** in this setup.
113 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
114 zshs inherit the dirstack of the zsh that most recently updated
117 == DIRECTORY BASED PROFILES ==
118 If you want certain settings to be active in certain directories (and
119 automatically switch back and forth between them), this is what you want.
122 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
123 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
126 When that's done and you enter a directory that matches the pattern
127 in the third part of the context, a function called chpwd_profile_grml,
128 for example, is called (if it exists).
130 If no pattern matches (read: no profile is detected) the profile is
131 set to 'default', which means chpwd_profile_default is attempted to
134 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
135 command) which is used: The third part in the context is matched against
136 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
137 Because that way the profile is detected for all these values of **$PWD**:
145 So, if you want to make double damn sure a profile works in /foo/bar
146 and everywhere deeper in that tree, just use (|/|/*) and be happy.
148 The name of the detected profile will be available in a variable called
149 'profile' in your functions. You don't need to do anything, it'll just
152 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
153 that was active up to now. That way you can avoid running code for a
154 profile that is already active, by running code such as the following
155 at the start of your function:
158 function chpwd_profile_grml() {
159 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
164 The initial value for **$CHPWD_PROFILE** is 'default'.
166 === Signaling availabily/profile changes ===
168 If you use this feature and need to know whether it is active in your
169 current shell, there are several ways to do that. Here are two simple
172 a) If knowing if the profiles feature is active when zsh starts is
173 good enough for you, you can put the following snippet into your
177 (( ${+functions[chpwd_profiles]} )) &&
178 print "directory profiles active"
181 b) If that is not good enough, and you would prefer to be notified
182 whenever a profile changes, you can solve that by making sure you
183 start **every** profile function you create like this:
186 function chpwd_profile_myprofilename() {
187 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
188 print "chpwd(): Switching to profile: $profile"
193 That makes sure you only get notified if a profile is **changed**,
194 not everytime you change directory.
196 === Version requirement ===
197 This feature requires zsh //4.3.3// or newer.
200 == ACCEPTLINE WRAPPER ==
201 The //accept-line// wiget is the one that is taking action when the **return**
202 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
205 This wrapper is configured via styles. That means, you issue commands, that look
209 zstyle 'context' style value
212 The context namespace, that we are using is 'acceptline'. That means, the actual
213 context for your commands look like: **':acceptline:<subcontext>'**.
215 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
219 === Recognized Contexts ===
221 This is the value, the context is initialized with.
222 The //compwarnfmt and //rehash// styles are looked up in this context.
225 If the first word in the command line is either a command, alias, function,
226 builtin or reserved word, you are in this context.
229 This is the context, that is used if you hit enter again, after being warned
230 about the existence of a _completion for the non-existing command you
234 This is the context, you are in if the command line is empty or only
235 consists of whitespace.
238 This context is in effect, if you entered something that does not match any
239 of the above. (e.g.: variable assignments).
242 === Available Styles ===
244 If you set this style to true, the warning about non existent commands,
245 for which completions exist will not be issued. (Default: **false**)
248 The message, that is displayed to warn about the _completion issue.
249 (default: **'%c will not execute and completion %f exists.'**)
250 '%c' is replaced by the command name, '%f' by the completion's name.
253 If this is set, we'll force rehashing, if appropriate. (Defaults to
254 **true** in //grmlzshrc//).
257 This can be a list of wigdets to call in a given context. If you need a
258 specific order for these to be called, name them accordingly. The default value
259 is an **empty list**.
262 The name of a widget, that is called after the widgets from 'actions'.
263 By default, this will be '.accept-line' (which is the built-in accept-line
267 If true in the current context, call the widget in the 'default_action'
268 style. (The default is **true** in all contexts.)
274 == GNU/SCREEN STATUS SETTING ==
275 //grmlzshrc// sets screen's hardstatus lines to the currently running command
276 or **'zsh'** if the shell is idling at its prompt. If the current working
277 directory is inside a repository unter version control, screen status is set
278 to: **'zsh: <repository name>'** via zsh's vcs_info.
281 == PERSISTENT HISTORY ==
282 If you got commands you consider important enough to be included in every
283 shell's history, you can put them into ~/.important_commands and they will be
284 available via the usual history lookup widgets.
288 == ENVIRONMENT VARIABLES ==
289 //grmlzshrc// sets some environment variables, which influence the
290 behaviour of applications.
293 If X is running this is set to "firefox", otherwise to "w3m".
296 Set to "yes". Some applications read this to learn about properties
297 of the terminal they are running in.
300 If not already set, sets the default editor. Falls back to vi(1),
301 if vim(1) is not available.
304 The mailbox file for the current user is set to /var/mail/$USER, if not
305 already set otherwise.
308 Set less(1) as default pager, if not already set to something different.
311 Holds the path to shared files for the C++ application framework QT
315 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
316 default to /bin/sh or /bin/bash.
320 Apart from zsh's default options, //grmlzshrc// sets some options
321 that change the behaviour of zsh. Options that change Z-shell's default
322 settings are marked by <grml>. But note, that zsh's defaults vary depending
323 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
326 Zsh sessions, that use //grmlzshrc//, will append their history list to the
327 history file, rather than replace it. Thus, multiple parallel zsh sessions
328 will all have the new entries from their history lists added to the history
329 file, in the order that they exit. The file will still be periodically
330 re-written to trim it when the number of lines grows 20% beyond the value
331 specified by $SAVEHIST.
334 If a command is issued that can't be executed as a normal command, and the
335 command is the name of a directory, perform the cd command to that directory.
337 : **auto_pushd** <grml>
338 Make cd push the old directory onto the directory stack.
340 : **completeinword** <grml>
341 If the cursor is inside a word, completion is done from both ends;
342 instead of moving the cursor to the end of the word first and starting
345 : **extended_glob** <grml>
346 Treat the '#', '~' and '^' characters as active globbing pattern characters.
348 : **extended_history** <grml>
349 Save each command's beginning timestamp (in seconds since the epoch) and the
350 duration (in seconds) to the history file.
353 Whenever a command completion is attempted, make sure the entire command
354 path is hashed first. This makes the first completion slower.
356 : **histignorealldups** <grml>
357 If a new command line being added to the history list duplicates an
358 older one, the older command is removed from the list, even if it is
359 not the previous event.
361 : **histignorespace** <grml>
362 Remove command lines from the history list when the first character on
363 the line is a space, or when one of the expanded aliases contains a
364 leading space. Note that the command lingers in the internal history
365 until the next command is entered before it vanishes.
367 : **longlistjobs** <grml>
368 List jobs in long format by default.
371 Avoid to beep on errors in zsh command line editing (zle).
374 A wildcard character never matches a leading '.'.
377 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
379 : **nonomatch** <grml>
380 If a pattern for filename generation has no matches, do not print an error
381 and leave it unchanged in the argument list. This also applies to file
382 expansion of an initial `~' or `='.
385 Report the status of background jobs immediately, rather than waiting until
386 just before printing a prompt.
388 : **pushd_ignore_dups** <grml>
389 Don't push multiple copies of the same directory onto the directory stack.
391 : **share_history** <grml>
392 As each line is added to the history file, it is checked to see if anything
393 else was written out by another shell, and if so it is included in the
394 history of the current shell too. Using !-style history, the commands from
395 the other sessions will not appear in the history list unless you explicitly
396 type the "history" command. This option is activated for zsh versions >= 4,
401 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
402 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
406 Edit the current command buffer in your favourite editor.
409 Deletes a word left of the cursor; seeing '/' as additional word separator.
412 Jump right after the first word.
415 Searches the last occurence of string before the cursor in the command history.
418 Brings a job, which got suspended with CTRL-z back to foreground.
421 == SHELL FUNCTIONS ==
422 //grmlzshrc// comes with a wide array of defined shell functions to ease the
426 Converts plaintext files to HTML using vim. The output is written to
429 : **855resolution()**
430 If 915resolution is available, issues a warning to the user to run it instead
431 to modify the resolution on intel graphics chipsets.
434 Lists files in current directory, which have been accessed within the
435 last N days. N is an integer to be passed as first and only argument.
436 If no argument is specified N is set to 1.
439 Searches for USENET postings from authors using google groups.
442 Sets all ulimit values to "unlimited".
445 Prints a colored table of available ansi color codes (to be used in escape
446 sequences) and the colors they represent.
448 : **aoeu(), asdf(), uiae()**
449 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
453 Login on the host provided as argument using autossh. Then reattach a GNU screen
454 session if a detached session is around or detach a currently attached screen or
455 else start a new screen. This is especially useful for roadwarriors using GNU
459 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
460 Then prompts the user if she wants to remove that directory. You might need
461 to tell audioburn which cdrom device to use like:
462 "DEVICE=/dev/cdrom audioburn"
465 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
466 it. Then prompts the user if she wants to burn a audio CD with audioburn()
467 (see above). You might need to tell audiorip which cdrom device to use like:
468 "DEVICE=/dev/cdrom audioburn"
471 Simple backup of a file or directory using cp(1). The target file name is the
472 original name plus a time stamp attached. Symlinks and file attributes like mode,
473 ownership and timestamps are preserved.
476 The brltty(1) program provides a braille display, so a blind person can access
477 the console screen. This wrapper function works around problems with some
478 environments (f. e. utf8).
481 If the original cdrecord is not installed, issues a warning to the user to
482 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
486 Lists files in current directory, which have been changed within the
487 last N days. N is an integer to be passed as first and only argument.
488 If no argument is specified N is set to 1.
491 Returns true if given command exists either as program, function, alias,
492 builtin or reserved word. If the option -c is given, only returns true,
493 if command is a program.
496 Changes directory to $HOME on first invocation of zsh. This is neccessary on
497 grml systems with autologin.
500 Changes current directory to the one supplied by argument and lists the files
501 in it, including file names starting with ".".
504 Presents a numbered listing of the directory stack. Then changes current
505 working directory to the one chosen by the user.
508 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
509 email addresses of submitters or any string given on the command line.
512 Shows bug report for debian given by number in mailbox format.
515 Tells the user to use grml-debootstrap, if she wants to install debian to
519 Shows the disk usage of the directories given in human readable format;
523 Translates C source code to assembly and ouputs both.
526 Takes packagename as argument. Sets current working directory to
527 /usr/share/doc/<packagename> and prints out a directory listing.
530 Renames image files based on date/time informations in their exif headers.
533 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
534 instance of firefox running, attaches to the first window found and opens the
535 URL in a new tab (this even works across an ssh session).
537 : **fluxkey-change()**
538 Switches the key combinations for changing current workspace under fluxbox(1)
539 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
540 Requires the window manager to reread configuration to take effect.
543 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
544 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
545 filename>". Creates an index.html with title "Images" showing the
546 thumbnails as clickable links to the respective original file.
547 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
548 and all files and/or directories beginning with "thumb-" in current directory!
551 Searches the zsh command history for a regular expression.
554 Prints the hexadecimal representation of the number supplied as argument
558 Use GNU diff with options -ubwd for mercurial.
561 Displays diffstat between the revision given as argument and tip (no
562 argument means last revision).
565 Outputs highlighted diff; needs highstring(1).
568 Shows source files in less(1) with syntax highlighting. Run "hl -h"
569 for detailed usage information.
572 Queries IMAP server (first parameter) for its capabilities. Takes
573 port number as optional second argument.
576 Returns true, if zsh version is equal or greater than 4, else false.
579 Returns true, if zsh version is equal or greater than 4.1, else false.
582 Returns true, if zsh version is equal or greater than 4.2, else false.
585 Returns true, if zsh version is equal or greater than 4.2.5, else false.
588 Returns true, if zsh version is equal or greater than 4.3, else false.
591 Returns true, if zsh version is equal or greater than 4.3.3, else false.
594 Returns true, if running on darwin, else false.
597 Returns true, if running on a grml system, else false.
600 Returns true, if running on a grml system from a live cd, else false.
603 Returns true, if run on grml-small, else false.
606 Changes every occurrence of the string iso885915 or ISO885915 in
607 environment variables to UTF-8.
610 Returns true, if run within an utf environment, else false.
613 Lists libraries that define the symbol containing the string given as
617 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
621 Prints specified range of (numbered) lines of a file.
622 Usage: linenr <start>[,<end>] <file>
625 Creates a PostScript and a PDF file (basename as first argument) from
629 Displays manpage in a streched style.
632 Creates directory including parent directories, if necessary. Then changes
633 current working directory to it.
636 Diffs the two arguments recursively and writes the
637 output (unified format) to a timestamped file.
640 Prints the summarized memory usage in bytes.
642 : **minimal-shell()**
643 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
644 so that file system can be unmounted.
647 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
648 replaces spaces in file names with underscores. Then mkaudiocd()
649 normalizes the files and recodes them to WAV.
652 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
653 enabled using mkisofs(8). Prompts the user for volume name, filename and
657 Creates a directory with first parameter as name inside $MAILDIR_ROOT
658 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
661 Runs "make install" and logs the output under ~/.errorlogs/; useful for
662 a clean deinstall later.
665 Lists files in current directory, which have been modified within the
666 last N days. N is an integer to be passed as first and only argument.
667 If no argument is specified N is set to 1.
670 Recodes an ogg file to mp3 with a bitrate of 192.
673 Evaluates a perl expression; useful as command line
674 calculator, therefore also available as "calc".
677 Lists all occurrences of the string given as argument in current $PATH.
680 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
681 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
682 Asks for confirmation.
685 Opens all README-like files in current working directory with the program
686 defined in the $PAGER environment variable.
689 Reloads functions given as parameters.
692 Checks whether a regular expression (first parameter) matches a string
693 (second parameter) using perl.
696 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
697 for details. See also xunfunction() below.
700 Greps the history for the string provided as parameter and shows the numbered
701 findings in default pager. On exit of the pager the user is prompted for a
702 number. The shells readline buffer is then filled with the corresponding
706 Lists the contents of a (compressed) archive with the appropriate programs.
707 The choice is made along the filename extension.
710 Lists the content of a gzipped tar archive in default pager.
713 Shows the content of a zip archive in default pager.
715 : **simple-extract()**
716 Tries to uncompress/unpack given file with the appropriate programs. The
717 choice is made along the filename ending.
720 Prints the arguments slowly by sleeping 0.08 seconds between each character.
722 : **smartcompress()**
723 Compresses/archives the file given as first parameter. Takes an optional
724 second argument, which denotes the compression/archive type as typical
725 filename extension; defaults to "tar.gz".
728 Indents C source code files given; uses Kernighan & Ritchie style.
731 Creates directory named shots in user's home directory, if it does not yet
732 exist and changes current working directory to it. Then sleeps 5 seconds,
733 so you have plenty of time to switch desktops/windows. Then makes a screenshot
734 of the current desktop. The result is stored in ~/shots to a timestamped
737 : **ssl-cert-fingerprints**
738 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
739 First and only parameter must be a file containing a certificate. Use
740 /dev/stdin as file if you want to pipe a certificate to these
744 Prints all information of a x509 certificate including the SHA512,
745 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
746 containing a certificate. Use /dev/stdin as file if you want to pipe a
747 certificate to this function.
749 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
750 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
751 certificate. First and only parameter must be a file containing a
752 certificate. Use /dev/stdin as file if you want to pipe a certificate
756 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
757 issues a Warning to use the grml-x(1) script. Can be overridden by using
758 /usr/bin/startx directly.
761 Shows some information about current system status.
764 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
765 swspeak must be set for this to work.
768 Translates a word from german to english (-D) or vice versa (-E).
771 Makes a unified diff of the command line arguments trying hard to find a
772 smaller set of changes. Descends recursively into subdirectories. Ignores
773 hows some information about current status.
776 Downloads and displays a file using a suitable program for its
780 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
783 Takes a string as its first argument and prints it RFC 2396 URL encoded to
787 Changes every occurrence of the string UTF-8 or utf-8 in environment
788 variables to iso885915.
794 Wrapper for vim(1). It tries to set the title and hands vim the environment
795 variable VIM_OPTIONS on the command line. So the user may define command
796 line options, she always wants, in her .zshrc.local.
799 Use vim(1) as manpage reader.
802 Searches the history for a given pattern and lists the results by date.
803 The first argument is the search pattern. The second and third ones are
804 optional and denote a search range (default: -100).
807 Retrieves and prints weather information from "http://weather.noaa.gov".
808 The first and only argument is the ICAO code for the desired station.
809 For a list of ICAO codes see
810 "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
813 Tries to cat(1) file(s) given as parameter(s). Always returns true.
814 See also xunfunction() below.
817 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
818 issues a Warning to use the grml-x(1) script. Can be overridden by using
819 /usr/bin/xinit directly.
822 Tries to source the file(s) given as parameter(s). Always returns true.
823 See zshbuiltins(1) for a detailed description of the source command.
824 See also xunfunction() below.
827 Changes the title of xterm window from within screen(1). Run without
828 arguments for details.
831 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
834 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
835 option plus a non empty pattern. Run zg without any arguments for a listing
836 of available command line switches. For a zshrc not in /etc/zsh, set the
837 GRML_ZSHRC environment variable.
840 Wrapper around the autoload builtin. Loads the definitions of functions
841 from the file given as argument. Searches $fpath for the file. See also
845 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
846 where own modifications should go. See also zshbuiltins(1) for a description
847 of the source command.
851 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
852 life. A few aliases (like those involving //grep// or //ls//) use the option
853 //--color=auto// for colourizing output. That option is part of **GNU**
854 implementations of these tools, and will only be used if such an implementation
857 : **acp** (//apt-cache policy//)
858 With no arguments prints out the priorities of each source. If a package name
859 is given, it displays detailed information about the priority selection of the
862 : **acs** (//apt-cache search//)
863 Searches debian package lists for the regular expression provided as argument.
864 The search includes package names and descriptions. Prints out name and short
865 description of matching packages.
867 : **acsh** (//apt-cache show//)
868 Shows the package records for the packages provided as arguments.
870 : **adg** (//apt-get dist-upgrade//)
871 Performs an upgrade of all installed packages. Also tries to automatically
872 handle changing dependencies with new versions of packages. As this may change
873 the install status of (or even remove) installed packages, it is potentially
874 dangerous to use dist-upgrade; invoked by sudo, if necessary.
876 : **ag** (//apt-get upgrade//)
877 Downloads and installs the newest versions of all packages currently installed
878 on the system. Under no circumstances are currently installed packages removed,
879 or packages not already installed retrieved and installed. New versions of
880 currently installed packages that cannot be upgraded without changing the install
881 status of another package will be left at their current version. An update must
882 be performed first (see au below); run by sudo, if necessary.
884 : **agi** (//apt-get install//)
885 Downloads and installs or upgrades the packages given on the command line.
886 If a hyphen is appended to the package name, the identified package will be
887 removed if it is installed. Similarly a plus sign can be used to designate a
888 package to install. This may be useful to override decisions made by apt-get's
889 conflict resolution system.
890 A specific version of a package can be selected for installation by following
891 the package name with an equals and the version of the package to select. This
892 will cause that version to be located and selected for install. Alternatively a
893 specific distribution can be selected by following the package name with a slash
894 and the version of the distribution or the Archive name (stable, testing, unstable).
895 Gets invoked by sudo, if user id is not 0.
897 : **ati** (//aptitude install//)
898 Aptitude is a terminal-based package manager with a command line mode similar to
899 apt-get (see agi above); invoked by sudo, if necessary.
901 : **au** (//apt-get update//)
902 Resynchronizes the package index files from their sources. The indexes of
903 available packages are fetched from the location(s) specified in
904 /etc/apt/sources.list. An update should always be performed before an
905 upgrade or dist-upgrade; run by sudo, if necessary.
907 : **calc** (//peval//)
908 Evaluates a perl expression (see peval() above); useful as a command line
911 : **CH** (//./configure --help//)
912 Lists available compilation options for building program from source.
914 : **cmplayer** (//mplayer -vo fbdev//)
915 Video player with framebuffer as video output device, so you can watch
916 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
917 while watching a movie.
919 : **CO** (//./configure//)
920 Prepares compilation for building program from source.
922 : **da** (//du -sch//)
923 Prints the summarized disk usage of the arguments as well as a grand total
924 in human readable format.
926 : **default** (//echo -en [ escape sequence ]//)
927 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
928 using escape sequence.
930 : **dir** (//ls -lSrah//)
931 Lists files (including dot files) sorted by size (biggest last) in long and
932 human readable output format.
934 : **fblinks** (//links2 -driver fb//)
935 A Web browser on the framebuffer device. So you can browse images and click
936 links on the virtual tty.
938 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
939 Fullscreen Video player with the framebuffer as video output device. So you
940 can watch videos on a virtual tty.
943 Revision control system by Linus Torvalds.
945 : **grep** (//grep --color=auto//)
946 Shows grep output in nice colors, if available.
948 : **GREP** (//grep -i --color=auto//)
949 Case insensitive grep with colored output.
951 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
952 Scans for new devices and updates /etc/fstab according to the findings.
954 : **grml-version** (//cat /etc/grml_version//)
955 Prints version of running grml.
957 : **http** (//python -m SimpleHTTPServer//)
958 Basic HTTP server implemented in python. Listens on port 8000/tcp and
959 serves current directory. Implements GET and HEAD methods.
961 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
962 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
963 host key changes frequently, for example on virtualized test- or development-systems.
964 To be used only inside trusted networks, of course.
966 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
967 ssh with possible man-in-the-middle attack enabled
968 (for an explanation see insecscp above).
970 : **help-zshglob** (//H-Glob()//)
971 Runs the function H-Glob() to expand or explain wildcards.
973 : **hide** (//echo -en [ escape sequence ]//)
974 Tries to hide xterm window using escape sequence.
976 : **huge** (//echo -en [ escape sequence ]//)
977 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
978 using escape sequence.
980 : **j** (//jobs -l//)
981 Prints status of jobs in the current shell session in long format.
983 : **l** (//ls -lF --color=auto//)
984 Lists files in long output format with indicator for filetype appended
985 to filename. If the terminal supports it, with colored output.
987 : **la** (//ls -la --color=auto//)
988 Lists files in long colored output format. Including file names
991 : **lad** (//ls -d .*(/)//)
992 Lists the dot directories (not their contents) in current directory.
994 : **large** (//echo -en [ escape sequence ]//)
995 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
996 using escape sequence.
998 : **lh** (//ls -hAl --color=auto//)
999 Lists files in long and human readable output format in nice colors,
1000 if available. Includes file names starting with "." except "." and
1003 : **ll** (//ls -l --color=auto//)
1004 Lists files in long colored output format.
1006 : **ls** (//ls -b -CF --color=auto//)
1007 Lists directory printing octal escapes for nongraphic characters.
1008 Entries are listed by columns and an indicator for file type is appended
1009 to each file name. Additionally the output is colored, if the terminal
1012 : **lsa** (//ls -a .*(.)//)
1013 Lists dot files in current working directory.
1015 : **lsbig** (//ls -flh *(.OL[1,10])//)
1016 Displays the ten biggest files (long and human readable output format).
1018 : **lsd** (//ls -d *(/)//)
1021 : **lse** (//ls -d *(/^F)//)
1022 Shows empty directories.
1024 : **lsl** (//ls -l *(@)//)
1025 Lists symbolic links in current directory.
1027 : **lsnew** (//ls -rl *(D.om[1,10])//)
1028 Displays the ten newest files (long output format).
1030 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1031 Displays the ten oldest files (long output format).
1033 : **lss** (//ls -l *(s,S,t)//)
1034 Lists files in current directory that have the setuid, setgid or sticky bit
1037 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1038 Displays the ten smallest files (long output format).
1040 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1041 Displays all files which are world readable and/or world writable and/or
1042 world executable (long output format).
1044 : **lsx** (//ls -l *(*)//)
1045 Lists only executable files.
1047 : **md** (//mkdir -p//)
1048 Creates directory including parent directories, if necessary
1050 : **medium** (//echo -en [ escape sequence ]//)
1051 Sets medium sized font
1052 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1053 using escape sequence.
1055 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1056 If invoking user is root, starts screen session with /etc/grml/screenrc
1057 as config file. If invoked by a regular user, start a screen session
1058 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1061 : **rw-** (//chmod 600//)
1062 Grants read and write permission of a file to the owner and nobody else.
1064 : **rwx** (//chmod 700//)
1065 Grants read, write and execute permission of a file to the owner and nobody
1068 : **r--** (//chmod 644//)
1069 Grants read and write permission of a file to the owner and read-only to
1072 : **r-x** (//chmod 755//)
1073 Grants read, write and execute permission of a file to the owner and
1074 read-only plus execute permission to anybody else.
1076 : **semifont** (//echo -en [ escape sequence ]//)
1077 Sets font of xterm to
1078 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1081 : **small** (//echo -en [ escape sequence ]//)
1082 Sets small xterm font ("6x10") using escape sequence.
1084 : **smartfont** (//echo -en [ escape sequence ]//)
1085 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1088 : **su** (//sudo su//)
1089 If user is running a grml live-CD, dont ask for any password, if she
1092 : **tiny** (//echo -en [ escape sequence ]//)
1093 Sets tiny xterm font
1094 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1097 : **truec** (//truecrypt [ mount options ]//)
1098 Mount a truecrypt volume with some reasonable mount options
1099 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1102 : **up** (//aptitude update ; aptitude safe-upgrade//)
1103 Performs a system update followed by a system upgrade using aptitude; run
1104 by sudo, if necessary. See au and ag above.
1106 : **?** (//qma zshall//)
1107 Runs the grml script qma (quick manual access) to build the collected man
1108 pages for the z-shell. This compressed file is kept at
1109 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1110 fast. See "man qma" for further information.
1114 This is a set of files, that - if they exist - can be used to customize the
1115 behaviour of //grmlzshrc//.
1118 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1119 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1122 # show battery status in RPROMPT
1124 # always load the complete setup, even for root
1125 GRML_ALWAYS_LOAD_ALL=1
1129 Sourced right before loading //grmlzshrc// is finished. There is a global
1130 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1134 Directory listing for persistent dirstack (see above).
1136 : **.important_commands**
1137 List of commands, used by persistent history (see above).
1140 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1141 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1142 (http://www.ubuntu.com) and similar systems - it is very easy to get
1143 //grmlzshrc// via grml's .deb repositories.
1145 On non-debian systems, that is not an option, but all is not lost:
1148 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1151 If you would also like to get seperate function files (which you can put into
1152 your **$fpath**), you can browse and download them at:
1154 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1156 = ZSH REFCARD TAGS =
1157 If you read //grmlzshrc//'s code you may notice strange looking comments in
1158 it. These are there for a purpose. grml's zsh-refcard is automatically
1159 generated from the contents of the actual configuration file. However, we need
1160 a little extra information on which comments and what lines of code to take
1161 into account (and for what purpose).
1163 Here is what they mean:
1165 List of tags (comment types) used:
1167 Next line contains an important alias, that should be included in the
1168 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1171 Next line contains the beginning of an important function. (placement
1172 tag: @@INSERT-functions@@)
1175 Next line contains an important variable. (placement tag:
1176 @@INSERT-variables@@)
1179 Next line contains an important keybinding. (placement tag:
1180 @@INSERT-keybindings@@)
1183 Hashed directories list generation: //start//: denotes the start of a list of
1184 'hash -d' definitions. //end//: denotes its end. (placement tag:
1185 @@INSERT-hasheddirs@@)
1188 Abbreviation expansion list generation: //start//: denotes the beginning of
1189 abbreviations. //end//: denotes their end.
1191 Lines within this section that end in '#d .*' provide extra documentation to
1192 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1195 This tag allows you to manually generate refcard entries for code lines that
1196 are hard/impossible to parse.
1200 #m# k ESC-h Call the run-help function
1203 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1206 So the syntax is: #m# <section> <argument> <comment>
1209 This tag lets you insert entries to the 'other' hash. Generally, this should
1210 not be used. It is there for things that cannot be done easily in another way.
1211 (placement tag: @@INSERT-other-foobar@@)
1214 All of these tags (except for m and o) take two arguments, the first
1215 within the tag, the other after the tag:
1217 #<tag><section># <comment>
1219 Where <section> is really just a number, which are defined by the @secmap
1220 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1221 that for the reader, the tag should not differ much from a regular comment.
1222 For zsh, it is a regular comment indeed. The numbers have got the following
1247 So, the following will add an entry to the 'functions' table in the 'system'
1248 section, with a (hopefully) descriptive comment:
1251 #f1# Edit an alias via zle
1255 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1256 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1257 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1258 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1259 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1263 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1264 repository from git.grml.org:
1266 ``` % git clone git://git.grml.org/grml-etc-core.git
1268 Make your changes, commit them; use '**git format-patch**' to create a series
1269 of patches and send those to the following address via '**git send-email**':
1271 ``` grml-etc-core@grml.org
1273 Doing so makes sure the right people get your patches for review and
1278 This manual page is the **reference** manual for //grmlzshrc//.
1280 That means that in contrast to the existing refcard it should document **every**
1281 aspect of the setup.
1283 This manual is currently not complete. If you want to help improving it, visit
1284 the following pages:
1286 http://wiki.grml.org/doku.php?id=zshrcmanual
1288 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1290 Contributions are highly welcome.
1294 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1295 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1296 Beckert <abe@deuxchevaux.org>.
1300 Copyright (c) 2009-2010 grml project <http://grml.org>
1302 This manpage is distributed under the terms of the GPL version 2.
1304 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1305 except for **accept-line()** and **vcs_info()**, which are distributed under
1306 the same conditions as zsh itself (which is BSD-like).