zshrc: Remove hidiff

[grml-etc-core.git] / doc / grmlzshrc.t2t

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index 38e6cbd..6a1c706 100644 (file)
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -1,13 +1,13 @@
 GRMLZSHRC
 
 GRMLZSHRC
 

-August, 2009
+July, 2011

 
 %!target: man
 %!postproc(man): "^(\.TH.*) 1 "  "\1 5 "
 
 
 = NAME =
 
 %!target: man
 %!postproc(man): "^(\.TH.*) 1 "  "\1 5 "
 
 
 = NAME =

-grmlzshrc - grml's zsh setup
+grmlzshrc - Grml's zsh setup

 
 
 = SYNOPSIS =
 
 
 = SYNOPSIS =


@@ -15,7 +15,7 @@ grmlzshrc - grml's zsh setup
 
 
 = DESCRIPTION =
 
 
 = DESCRIPTION =

-The grml project provides a fairly exhaustive interactive setup (referred to
+The Grml project provides a fairly exhaustive interactive setup (referred to

 as //grmlzshrc// throughout this document) for the amazing unix shell zsh
 (http://zsh.sourceforge.net). This is the reference manual for that
 setup.
 as //grmlzshrc// throughout this document) for the amazing unix shell zsh
 (http://zsh.sourceforge.net). This is the reference manual for that
 setup.


@@ -26,10 +26,19 @@ features are enabled in every version).
 //grmlzshrc// behaves differently depending on which user loads it. For the
 root user (**EUID** == 0) only a subset of features is loaded by default. This
 behaviour can be altered by setting the **GRML_ALWAYS_LOAD_ALL** STARTUP
 //grmlzshrc// behaves differently depending on which user loads it. For the
 root user (**EUID** == 0) only a subset of features is loaded by default. This
 behaviour can be altered by setting the **GRML_ALWAYS_LOAD_ALL** STARTUP

-VARIABLE (see below). Also the umask(1) for the root user is set to 022,
-while for regular users it is set to 002. So read/write permissions
-for the regular user and her group are set for new files (keep that
-in mind on systems, where regular users share a common group).
+VARIABLE (see below).
+
+Users may want to keep an up-to-date version of the setup (possibly from the
+git-sources) in //~/.zshrc//. If that happens on a system where the global
+zshrc is also a //grmlzshrc// (but possibly an older one), you can inhibit
+loading the global version by doing:
+\
+```
+echo setopt no_global_rcs >> ~/.zshenv
+```
+
+Note, that this will disable //ANY// global files, except for the global
+zshenv file.

 
 = STARTUP VARIABLES =
 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
 
 = STARTUP VARIABLES =
 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell


@@ -43,6 +52,62 @@ Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
 put the battery status into the right hand side interactive prompt.
 
 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
 put the battery status into the right hand side interactive prompt.
 

+: **COMMAND_NOT_FOUND**
+A non zero value activates a handler, which is called when a command can not
+be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
+
+: **GRML_ALWAYS_LOAD_ALL**
+Enables the whole Grml setup for root, if set to a non zero value.
+
+: **GRML_ZSH_CNF_HANDLER**
+This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
+and defaults to "/usr/share/command-not-found/command-not-found".
+
+: **GRMLSMALL_SPECIFIC**
+Set this to zero to remove items in zsh config, which do not work in
+grml-small.
+
+: **HISTFILE**
+Where zsh saves the history. Default: ${HOME}/.zsh_history.
+
+: **HISTSIZE**
+Number of commands to be kept in the history. On a Grml-CD this defaults to
+500, on a hard disk installation to 5000.
+
+: **MAILCHECK**
+Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
+A value of zero turns off checking.
+
+: **NOCOR**
+Non zero values deactivate automatic correction of commands.
+
+: **NOMENU**
+If set to zero (default), allows selection from a menu, if there are at least
+five possible options of completion.
+
+: **NOPRECMD**
+A non zero value disables precmd and preexec commands. These are functions
+that are run before every command (setting xterm/screen titles etc.).
+
+: **REPORTTIME**
+Show time (user, system and cpu) used by external commands, if they run longer
+than the defined number of seconds (default: 5).
+
+: **SAVEHIST**
+Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD
+and to 10000 on an installation on hard disk.
+
+: **watch**
+As in tcsh(1) an array of login/logout events to be reported by the shell
+builtin "log". For details see zshparam(1). Defaults to (notme root).
+
+: **ZSH_NO_DEFAULT_LOCALE**
+Import "/etc/default/locale", if set to zero (default).
+
+: **ZSH_PROFILE_RC**
+A non zero value causes shell functions to be profiled. The results can be
+obtained with the zprof builtin command (see zshmodules(1) for details).
+

 
 = FEATURE DESCRIPTION =
 This is an in depth description of non-standard features implemented by
 
 = FEATURE DESCRIPTION =
 This is an in depth description of non-standard features implemented by


@@ -229,6 +294,38 @@ available via the usual history lookup widgets.
 
 
 = REFERENCE =
 
 
 = REFERENCE =

+== ENVIRONMENT VARIABLES ==
+//grmlzshrc// sets some environment variables, which influence the
+behaviour of applications.
+
+: **COLORTERM**
+Set to "yes". Some applications read this to learn about properties
+of the terminal they are running in.
+
+: **EDITOR**
+If not already set, sets the default editor. Falls back to vi(1),
+if vim(1) is not available.
+
+: **LESS_TERMCAP_***
+Some environment variables that add colour support to less(1) for viewing
+man pages. See termcap(5) for details.
+
+: **MAIL**
+The mailbox file for the current user is set to /var/mail/$USER, if not
+already set otherwise.
+
+: **PAGER**
+Set less(1) as default pager, if not already set to something different.
+
+: **QTDIR**
+Holds the path to shared files for the C++ application framework QT
+(version 3 or 4).
+
+: **SHELL**
+Set explicitly to /bin/zsh, to prevent certain terminal emulators to
+default to /bin/sh or /bin/bash.
+
+

 == OPTIONS ==
 Apart from zsh's default options, //grmlzshrc// sets some options
 that change the behaviour of zsh. Options that change Z-shell's default
 == OPTIONS ==
 Apart from zsh's default options, //grmlzshrc// sets some options
 that change the behaviour of zsh. Options that change Z-shell's default


@@ -324,9 +421,18 @@ Deletes a word left of the cursor; seeing '/' as additional word separator.
 : **CTRL-x-1**
 Jump right after the first word.
 
 : **CTRL-x-1**
 Jump right after the first word.
 

+: **CTRL-x-M()**
+Create directory under cursor or the selected area.
+To select an area press ctrl-@ and use the cursor.
+Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
+directory does not exist yet -> press **CTRL-xM** and problem solved.
+

 : **CTRL-x-p**
 Searches the last occurence of string before the cursor in the command history.
 
 : **CTRL-x-p**
 Searches the last occurence of string before the cursor in the command history.
 

+: **CTRL-x-z**
+Display help on keybindings and zsh line editor. Press consecutively to page through content.
+

 : **CTRL-z**
 Brings a job, which got suspended with CTRL-z back to foreground.
 
 : **CTRL-z**
 Brings a job, which got suspended with CTRL-z back to foreground.
 


@@ -335,135 +441,89 @@ Brings a job, which got suspended with CTRL-z back to foreground.
 //grmlzshrc// comes with a wide array of defined shell functions to ease the
 user's life.
 
 //grmlzshrc// comes with a wide array of defined shell functions to ease the
 user's life.
 

-: **2html()**
-Converts plaintext files to HTML using vim. The output is written to
-<filename>.html.
-

 : **855resolution()**
 If 915resolution is available, issues a warning to the user to run it instead
 to modify the resolution on intel graphics chipsets.
 
 : **855resolution()**
 If 915resolution is available, issues a warning to the user to run it instead
 to modify the resolution on intel graphics chipsets.
 

-: **agoogle()**
-Searches for USENET postings from authors using google groups.
+: **accessed()**
+Lists files in current directory, which have been accessed within the
+last N days. N is an integer to be passed as first and only argument.
+If no argument is specified N is set to 1.

 
 : **allulimit()**
 Sets all ulimit values to "unlimited".
 
 
 : **allulimit()**
 Sets all ulimit values to "unlimited".
 

-: **ansi-colors()**
-Prints a colored table of available ansi color codes (to be used in escape
-sequences) and the colors they represent.
+: **any()**
+Lists processes matching given pattern.

 
 

-: **aoeu(), asdf(), uiae()**
-Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
-layout.
-
-: **audioburn()**
-Burns the files in ~/ripps (see audiorip() below) to an audio CD.
-Then prompts the user if she wants to remove that directory. You might need
-to tell audioburn which cdrom device to use like:
-"DEVICE=/dev/cdrom audioburn"
-
-: **audiorip()**
-Creates directory ~/ripps, if it does not exist. Then rips audio CD into
-it. Then prompts the user if she wants to burn a audio CD with audioburn()
-(see above). You might need to tell audiorip which cdrom device to use like:
-"DEVICE=/dev/cdrom audioburn"
+: **asc()**
+Login on the host provided as argument using autossh. Then reattach a GNU screen
+session if a detached session is around or detach a currently attached screen or
+else start a new screen.  This is especially useful for roadwarriors using GNU
+screen and ssh.

 
 : **bk()**
 Simple backup of a file or directory using cp(1). The target file name is the
 original name plus a time stamp attached. Symlinks and file attributes like mode,
 ownership and timestamps are preserved.
 
 
 : **bk()**
 Simple backup of a file or directory using cp(1). The target file name is the
 original name plus a time stamp attached. Symlinks and file attributes like mode,
 ownership and timestamps are preserved.
 

-: **brltty()**
-The brltty(1) program provides a braille display, so a blind person can access
-the console screen. This wrapper function works around problems with some
-environments (f. e. utf8).
-

 : **cdrecord()**
 If the original cdrecord is not installed, issues a warning to the user to
 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
 cdrecord.
 
 : **cdrecord()**
 If the original cdrecord is not installed, issues a warning to the user to
 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
 cdrecord.
 

+: **cdt()**
+Creates a temporary directory using mktemp. Then changes current
+working directory to it.
+
+: **changed()**
+Lists files in current directory, which have been changed within the
+last N days. N is an integer to be passed as first and only argument.
+If no argument is specified N is set to 1.
+
+: **check_com()**
+Returns true if given command exists either as program, function, alias,
+builtin or reserved word. If the option -c is given, only returns true,
+if command is a program.
+
+: **checkhome()**
+Changes directory to $HOME on first invocation of zsh. This is neccessary on
+grml systems with autologin.
+

 : **cl()**
 Changes current directory to the one supplied by argument and lists the files
 in it, including file names starting with ".".
 
 : **cl()**
 Changes current directory to the one supplied by argument and lists the files
 in it, including file names starting with ".".
 

-: **debbug()**
-Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
-email addresses of submitters or any string given on the command line.
-
-: **debbugm()**
-Shows bug report for debian given by number in mailbox format.
+: **dchange()**
+Shows the changelog of given package in $PAGER.

 
 : **debian2hd()**
 Tells the user to use grml-debootstrap, if she wants to install debian to
 harddisk.
 
 
 : **debian2hd()**
 Tells the user to use grml-debootstrap, if she wants to install debian to
 harddisk.
 

-: **dirspace()**
-Shows the disk usage of the directories given in human readable format;
-defaults to $path.
-
-: **disassemble()**
-Translates C source code to assembly and ouputs both.
-
-: **doc()**
-Takes packagename as argument. Sets current working directory to
-/usr/share/doc/<packagename> and prints out a directory listing.
-
-: **fir()**
-Opens given URL with Firefox (Iceweasel on Debian). If there is already an
-instance of firefox running, attaches to the first window found and opens the
-URL in a new tab (this even works across an ssh session).
-
-: **fluxkey-change()**
-Switches the key combinations for changing current workspace under fluxbox(1)
-from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
-Requires the window manager to reread configuration to take effect.
+: **deswap()**
+A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings
+back interactive responsiveness after suspend, when the system is swapping
+heavily.

 
 

-: **genthumbs()**
-A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
-".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
-filename>". Creates an index.html with title "Images" showing the
-thumbnails as clickable links to the respective original file.
-//Warning:// On start genthumbs() silently removes a possibly existing "index.html"
-and all files and/or directories beginning with "thumb-" in current directory!
+: **dnews()**
+Shows the NEWS file for the given package in $PAGER.

 
 

-: **getair()**
-Tries to download, unpack and run AIR (imaging software) version 1.2.8.
+: **edalias()**
+Edit given alias.

 
 

-: **getgizmo()**
-Tries to download and install Gizmo (VoIP software) for Debian.
+: **edfunc()**
+Edit given shell function.

 
 

-: **getskype()**
-Tries to download and install Skype (VoIP software) for Debian.
+: **freload()**
+Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).

 
 

-: **getskypebeta()**
-Downloads and installs newer version of Skype.
+: **hgdi()**
+Use GNU diff with options -ubwd for mercurial.

 
 

-: **getxlite()**
-Tries to download and unpack X-lite (VoIP software) from counterpath.com into
-~/tmp.
-
-: **git-get-diff()**
-Opens a specific git commitdiff from kernel.org in default browser. Tree is
-chosen by the environment variable GITTREE which defaults to Linus Torvalds'
-kernel tree.
-
-: **git-get-commit()**
-Opens a specific git commit from kernel.org in default browser. The tree to
-fetch from is controlled by the environment variable GITTREE which defaults
-to Linus Torvalds' kernel tree.
-
-: **git-get-plaindiff()**
-Fetches specific git diff from kernel.org. The tree is controlled by the
-environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
-
-: **greph()**
-Searches the zsh command history for a regular expression.
-
-: **hex()**
-Prints the hexadecimal representation of the number supplied as argument
-(base ten only).
+: **hgstat()**
+Displays diffstat between the revision given as argument and tip (no
+argument means last revision).

 
 : **hidiff()**
 Outputs highlighted diff; needs highstring(1).
 
 : **hidiff()**
 Outputs highlighted diff; needs highstring(1).


@@ -498,141 +558,137 @@ Returns true, if running on a grml system from a live cd, else false.
 : **isgrmlsmall()**
 Returns true, if run on grml-small, else false.
 
 : **isgrmlsmall()**
 Returns true, if run on grml-small, else false.
 

+: **iso2utf()**
+Changes every occurrence of the string iso885915 or ISO885915 in
+environment variables to UTF-8.
+

 : **isutfenv()**
 Returns true, if run within an utf environment, else false.
 
 : **isutfenv()**
 Returns true, if run within an utf environment, else false.
 

-: **lcheck()**
-Lists libraries that define the symbol containing the string given as
-parameter.
-
-: **limg()**
-Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
-directory.
-
-: **mcd()**
+: **mkcd()**

 Creates directory including parent directories, if necessary. Then changes
 current working directory to it.
 
 Creates directory including parent directories, if necessary. Then changes
 current working directory to it.
 

-: **minimal-shell()**
-Spawns a absolute minimal Korn shell. It references no files in /usr, so
-that file system can be unmounted.
-
-: **mkaudiocd()**
-Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
-replaces spaces in file names with underscores. Then mkaudiocd()
-normalizes the files and recodes them to WAV.
-
-: **mkiso()**
-Creates an iso9660 filesystem image with Rockridge and Joliet extensions
-enabled using mkisofs(8). Prompts the user for volume name, filename and
-target directory.
-
-: **mmake()**
-Runs "make install" and logs the output under ~/.errorlogs/; useful for
-a clean deinstall later.
-
-: **ogg2mp3_192()**
-Recodes an ogg file to mp3 with a bitrate of 192.
-
-: **peval()**
-Evaluates a perl expression; useful as command line
-calculator, therefore also available as "calc".
+: **modified()**
+Lists files in current directory, which have been modified within the
+last N days. N is an integer to be passed as first and only argument.
+If no argument is specified N is set to 1.

 
 

-: **plap()**
-Lists all occurrences of the string given as argument in current $PATH.
-
-: **purge()**
-Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
-"a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
-Asks for confirmation.
+: **nt()**
+A helper function for the "e" glob qualifier to list all files newer
+than a reference file.
+\
+Example usages:
+```
+% NTREF=/reference/file
+% ls -l *(e:nt:)
+% # Inline:
+% ls -l *(e:'nt /reference/file':)
+```

 
 

-: **readme()**
-Opens all README-like files in current working directory with the program
-defined in the $PAGER environment variable.
+: **profile()**
+Runs a command in $SHELL with profiling enabled (See startup variable
+ZSH_PROFILE_RC above).

 
 : **refunc()**
 Reloads functions given as parameters.
 
 
 : **refunc()**
 Reloads functions given as parameters.
 

-: **regcheck()**
-Checks whether a regular expression (first parameter) matches a string
-(second parameter) using perl.
-
-: **selhist()**
-Greps the history for the string provided as parameter and shows the numbered
-findings in default pager. On exit of the pager the user is prompted for a
-number. The shells readline buffer is then filled with the corresponding
-command line.
+: **salias()**
+Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
+for details. See also xunfunction() below.

 
 : **show-archive()**
 Lists the contents of a (compressed) archive with the appropriate programs.
 The choice is made along the filename extension.
 
 
 : **show-archive()**
 Lists the contents of a (compressed) archive with the appropriate programs.
 The choice is made along the filename extension.
 

-: **shtar()**
-Lists the content of a gzipped tar archive in default pager.
-
-: **shzip()**
-Shows the content of a zip archive in default pager.
-

 : **simple-extract()**
 : **simple-extract()**

-Tries to uncompress/unpack given file with the appropriate programs. The
-choice is made along the filename ending.
+Tries to uncompress/unpack given files with the appropriate programs. If an URI
+starting with https, http or ftp is provided simple-extract tries to download
+and then uncompress/unpack the file. The choice is made along the filename
+ending. simple-extract will not delete the original archive (even on .gz,.bz2 or
+.xz) unless you use the '-d' option.

 
 

-: **slow_print()**
-Prints the arguments slowly by sleeping 0.08 seconds between each character.
+: **sll()**
+Prints details of symlinks given as arguments.

 
 : **smartcompress()**
 Compresses/archives the file given as first parameter. Takes an optional
 second argument, which denotes the compression/archive type as typical
 filename extension; defaults to "tar.gz".
 
 
 : **smartcompress()**
 Compresses/archives the file given as first parameter. Takes an optional
 second argument, which denotes the compression/archive type as typical
 filename extension; defaults to "tar.gz".
 

-: **smartindent()**
-Indents C source code files given; uses Kernighan & Ritchie style.
-
-: **sshot()**
-Creates directory named shots in user's home directory, if it does not yet
-exist and changes current working directory to it. Then sleeps 5 seconds,
-so you have plenty of time to switch desktops/windows. Then makes a screenshot
-of the current desktop. The result is stored in ~/shots to a timestamped
-jpg file.
-
-: **startx()**
-Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
-issues a Warning to use the grml-x(1) script. Can be overridden by using
-/usr/bin/startx directly.
+: **ssl-cert-fingerprints**
+Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
+First and only parameter must be a file containing a certificate. Use
+/dev/stdin as file if you want to pipe a certificate to these
+functions.
+
+: **ssl-cert-info**
+Prints all information of a x509 certificate including the SHA512,
+SHA256, SHA1 and MD5 digests. First and only parameter must be a file
+containing a certificate. Use /dev/stdin as file if you want to pipe a
+certificate to this function.
+
+: **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
+Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
+certificate. First and only parameter must be a file containing a
+certificate. Use /dev/stdin as file if you want to pipe a certificate
+to this function.
+
+: **Start(), Restart(), Stop(), Force-Reload(), Reload()**
+Functions for controlling daemons.
+```
+Example usage:
+% Restart ssh
+```

 
 

-: **status()**
-Shows some information about current system status.
+: **trans()**
+Translates a word from german to english (-D) or vice versa (-E).

 
 

-: **udiff()**
-Makes a unified diff of the command line arguments trying hard to find a
-smaller set of changes. Descends recursively into subdirectories. Ignores
-hows some information about current status.
+: **uchange()**
+Shows upstreams changelog of a given package in $PAGER.

 
 

-: **urlencode()**
-Takes a string as its first argument and prints it RFC 2396 URL encoded to
-standard out.
+: **uprint()**
+Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.

 
 

-: **viless()**
-Vim as pager.
+: **utf2iso()**
+Changes every occurrence of the string UTF-8 or utf-8 in environment
+variables to iso885915.

 
 : **vim()**
 Wrapper for vim(1). It tries to set the title and hands vim the environment
 variable VIM_OPTIONS on the command line. So the user may define command
 line options, she always wants, in her .zshrc.local.
 
 
 : **vim()**
 Wrapper for vim(1). It tries to set the title and hands vim the environment
 variable VIM_OPTIONS on the command line. So the user may define command
 line options, she always wants, in her .zshrc.local.
 

-: **vman()**
-Use vim(1) as manpage reader.
+: **whatwhen()**
+Searches the history for a given pattern and lists the results by date.
+The first argument is the search pattern. The second and third ones are
+optional and denote a search range (default: -100).
+
+: **xcat()**
+Tries to cat(1) file(s) given as parameter(s). Always returns true.
+See also xunfunction() below.

 
 

-: **xinit()**
-Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
-issues a Warning to use the grml-x(1) script. Can be overridden by using
-/usr/bin/xinit directly.
+: **xsource()**
+Tries to source the file(s) given as parameter(s). Always returns true.
+See zshbuiltins(1) for a detailed description of the source command.
+See also xunfunction() below.

 
 

-: **zg()**
-Search for patterns in grml's zshrc using perl. zg takes no or exactly one
-option plus a non empty pattern. Run zg without any arguments for a listing
-of available command line switches. For a zshrc not in /etc/zsh, set the
-GRML_ZSHRC environment variable.
+: **xtrename()**
+Changes the title of xterm window from within screen(1). Run without
+arguments for details.
+
+: **xunfunction()**
+Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
+
+: **zrcautoload()**
+Wrapper around the autoload builtin. Loads the definitions of functions
+from the file given as argument. Searches $fpath for the file. See also
+xunfunction() above.
+
+: **zrclocal()**
+Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
+where own modifications should go. See also zshbuiltins(1) for a description
+of the source command.

 
 
 == ALIASES ==
 
 
 == ALIASES ==


@@ -692,10 +748,6 @@ available packages are fetched from the location(s) specified in
 /etc/apt/sources.list. An update should always be performed before an
 upgrade or dist-upgrade; run by sudo, if necessary.
 
 /etc/apt/sources.list. An update should always be performed before an
 upgrade or dist-upgrade; run by sudo, if necessary.
 

-: **calc** (//peval//)
-Evaluates a perl expression (see peval() above); useful as a command line
-calculator.
-

 : **CH** (//./configure --help//)
 Lists available compilation options for building program from source.
 
 : **CH** (//./configure --help//)
 Lists available compilation options for building program from source.
 


@@ -707,10 +759,19 @@ while watching a movie.
 : **CO** (//./configure//)
 Prepares compilation for building program from source.
 
 : **CO** (//./configure//)
 Prepares compilation for building program from source.
 

+: **cp** (//nocorrect cp//)
+cp(1) without spelling correction.
+

 : **da** (//du -sch//)
 Prints the summarized disk usage of the arguments as well as a grand total
 in human readable format.
 
 : **da** (//du -sch//)
 Prints the summarized disk usage of the arguments as well as a grand total
 in human readable format.
 

+: **dbp** (//dpkg-buildpackage//)
+Builds binary or source packages from sources (See: dpkg-buildpackage(1)).
+
+: **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd "  \n" | sort -rn//)
+Prints installed Packages sorted by size (descending).
+

 : **default** (//echo -en [ escape sequence ]//)
 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
 using escape sequence.
 : **default** (//echo -en [ escape sequence ]//)
 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
 using escape sequence.


@@ -730,6 +791,10 @@ can watch videos on a virtual tty.
 : **g** (//git//)
 Revision control system by Linus Torvalds.
 
 : **g** (//git//)
 Revision control system by Linus Torvalds.
 

+: **ge** (//grep-excuses//)
+Searches the testing excuses files for a specific maintainer (See:
+grep-excuses(1)).
+

 : **grep** (//grep --color=auto//)
 Shows grep output in nice colors, if available.
 
 : **grep** (//grep --color=auto//)
 Shows grep output in nice colors, if available.
 


@@ -742,6 +807,9 @@ Scans for new devices and updates /etc/fstab according to the findings.
 : **grml-version** (//cat /etc/grml_version//)
 Prints version of running grml.
 
 : **grml-version** (//cat /etc/grml_version//)
 Prints version of running grml.
 

+: **hbp** (//hg-buildpackage//)
+Helper program to maintain Debian packages with mercurial.
+

 : **http** (//python -m SimpleHTTPServer//)
 Basic HTTP server implemented in python. Listens on port 8000/tcp and
 serves current directory. Implements GET and HEAD methods.
 : **http** (//python -m SimpleHTTPServer//)
 Basic HTTP server implemented in python. Listens on port 8000/tcp and
 serves current directory. Implements GET and HEAD methods.


@@ -791,6 +859,9 @@ if available. Includes file names starting with "." except "." and
 : **ll** (//ls -l --color=auto//)
 Lists files in long colored output format.
 
 : **ll** (//ls -l --color=auto//)
 Lists files in long colored output format.
 

+: **llog** (//$PAGER /var/log/syslog//)
+Opens syslog in pager.
+

 : **ls** (//ls -b -CF --color=auto//)
 Lists directory printing octal escapes for nongraphic characters.
 Entries are listed by columns and an indicator for file type is appended
 : **ls** (//ls -b -CF --color=auto//)
 Lists directory printing octal escapes for nongraphic characters.
 Entries are listed by columns and an indicator for file type is appended


@@ -835,11 +906,33 @@ Lists only executable files.
 : **md** (//mkdir -p//)
 Creates directory including parent directories, if necessary
 
 : **md** (//mkdir -p//)
 Creates directory including parent directories, if necessary
 

+: **mdstat** (//cat /proc/mdstat//)
+Lists all active md (i.e. linux software raid) devices with some information
+about them.
+

 : **medium** (//echo -en [ escape sequence ]//)
 Sets medium sized font
 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
 using escape sequence.
 
 : **medium** (//echo -en [ escape sequence ]//)
 Sets medium sized font
 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
 using escape sequence.
 

+: **mkdir** (//nocorrect mkdir//)
+mkdir(1) without spelling correction.
+
+: **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
+Executes the commands on the versioned patch queue from current repository.
+
+: **mv** (//nocorrect mv//)
+mv(1) without spelling correction.
+
+: **rd** (//rmdir//)
+Short rmdir(1) (remove directory).
+
+: **rm** (//nocorrect rm//)
+rm(1) without spelling correction.
+
+: **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//)
+rmdir current working directory
+

 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
 If invoking user is root, starts screen session with /etc/grml/screenrc
 as config file. If invoked by a regular user, start a screen session
 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
 If invoking user is root, starts screen session with /etc/grml/screenrc
 as config file. If invoked by a regular user, start a screen session


@@ -861,6 +954,12 @@ anybody else.
 Grants read, write and execute permission of a file to the owner and
 read-only plus execute permission to anybody else.
 
 Grants read, write and execute permission of a file to the owner and
 read-only plus execute permission to anybody else.
 

+: **S** (//screen//)
+Short for screen(1).
+
+: **s** (//ssh//)
+Short for ssh(1).
+

 : **semifont** (//echo -en [ escape sequence ]//)
 Sets font of xterm to
 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
 : **semifont** (//echo -en [ escape sequence ]//)
 Sets font of xterm to
 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using


@@ -877,11 +976,25 @@ escape sequence.
 If user is running a grml live-CD, dont ask for any password, if she
 wants a root shell.
 
 If user is running a grml live-CD, dont ask for any password, if she
 wants a root shell.
 

+: **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
+Sets mode from UTF-8 to ISO 2022 (See:
+http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
+
+: **term2utf** (//echo 'Setting terminal to utf-8 mode'; print -n '\e%G'//)
+Sets mode from ISO 2022 to UTF-8 (See:
+http://www.cl.cam.ac.uk/~mgk25/unicode.html#term).
+

 : **tiny** (//echo -en [ escape sequence ]//)
 Sets tiny xterm font
 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
 sequence.
 
 : **tiny** (//echo -en [ escape sequence ]//)
 Sets tiny xterm font
 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
 sequence.
 

+: **tlog** (//tail -f /var/log/syslog//)
+Prints syslog continuously (See tail(1)).
+
+: **top10** (//print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10//)
+Prints the ten most used shell commands.
+

 : **truec** (//truecrypt [ mount options ]//)
 Mount a truecrypt volume with some reasonable mount options
 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
 : **truec** (//truecrypt [ mount options ]//)
 Mount a truecrypt volume with some reasonable mount options
 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if


@@ -891,11 +1004,18 @@ available).
 Performs a system update followed by a system upgrade using aptitude; run
 by sudo, if necessary. See au and ag above.
 
 Performs a system update followed by a system upgrade using aptitude; run
 by sudo, if necessary. See au and ag above.
 

-: **?** (//qma zshall//)
-Runs the grml script qma (quick manual access) to build the collected man
-pages for the z-shell. This compressed file is kept at
-~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
-fast. See "man qma" for further information.
+: **url-quote** (//autoload -U url-quote-magic ; zle -N self-insert url-quote-magic//)
+After calling, characters of URLs as typed get automatically escaped, if necessary, to
+protect them from the shell.
+
+: **0** (//return 0//)
+Gives a clean prompt (i.e. without $?).
+
+: **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//)
+Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware.
+
+: **...** (//cd ../..///)
+Changes current directory two levels higher.

 
 
 = AUXILIARY FILES =
 
 
 = AUXILIARY FILES =


@@ -1063,22 +1183,32 @@ possibly inclusion.
 
 
 = STATUS =
 
 
 = STATUS =

-This manual page is supposed to be a **reference** manual for //grmlzshrc//.
+This manual page is the **reference** manual for //grmlzshrc//.
+

 That means that in contrast to the existing refcard it should document **every**
 That means that in contrast to the existing refcard it should document **every**

-aspect of the setup. That is currently **not** the case. Not for a long time
-yet. Contributions are highly welcome.
+aspect of the setup.
+
+This manual is currently not complete. If you want to help improving it, visit
+the following pages:
+
+http://wiki.grml.org/doku.php?id=zshrcmanual
+
+http://lists.mur.at/pipermail/grml/2009-August/004609.html
+
+Contributions are highly welcome.

 
 
 = AUTHORS =
 
 
 = AUTHORS =

-This manpage was written by Frank Terbeck <ft@grml.org> and Joerg Woelke
-<joewoe@fsmail.de>.
+This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
+<joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
+Beckert <abe@deuxchevaux.org>.

 
 
 = COPYRIGHT =
 
 
 = COPYRIGHT =

-Copyright (c) 2009, grml project <http://grml.org>
+Copyright (c) 2009-2011 Grml project <http://grml.org>

 
 This manpage is distributed under the terms of the GPL version 2.
 
 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
 
 This manpage is distributed under the terms of the GPL version 2.
 
 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,

-except for **accept-line()** and **vcs_info()**, which are distributed under
-the same conditions as zsh itself (which is BSD-like).
+except for **accept-line()** which are distributed under the same conditions
+as zsh itself (which is BSD-like).