grmlzshrc.t2t: aliases hidiff, url-quote, mdstat and ...
[grml-etc-core.git] / doc / grmlzshrc.t2t
index 6cd01c3..41239c9 100644 (file)
@@ -58,6 +58,13 @@ and defaults to "/usr/share/command-not-found/command-not-found".
 Set this to zero to remove items in zsh config, which do not work in
 grml-small.
 
 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.
 : **MAILCHECK**
 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
 A value of zero turns off checking.
@@ -77,6 +84,14 @@ that are run before every command (setting xterm/screen titles etc.).
 Show time (user, system and cpu) used by external commands, if they run longer
 than the defined number of seconds (default: 5).
 
 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_NO_DEFAULT_LOCALE**
 Import "/etc/default/locale", if set to zero (default).
 
@@ -285,6 +300,10 @@ of the terminal they are running in.
 If not already set, sets the default editor. Falls back to vi(1),
 if vim(1) is not available.
 
 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.
 : **MAIL**
 The mailbox file for the current user is set to /var/mail/$USER, if not
 already set otherwise.
@@ -532,22 +551,6 @@ 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!
 
 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
 and all files and/or directories beginning with "thumb-" in current directory!
 
-: **getair()**
-Tries to download, unpack and run AIR (imaging software) version 1.2.8.
-
-: **getgizmo()**
-Tries to download and install Gizmo (VoIP software) for Debian.
-
-: **getskype()**
-Tries to download and install Skype (VoIP software) for Debian.
-
-: **getskypebeta()**
-Downloads and installs newer version of Skype.
-
-: **getxlite()**
-Tries to download and unpack X-lite (VoIP software) from counterpath.com into
-~/tmp.
-
 : **greph()**
 Searches the zsh command history for a regular expression.
 
 : **greph()**
 Searches the zsh command history for a regular expression.
 
@@ -555,6 +558,13 @@ Searches the zsh command history for a regular expression.
 Prints the hexadecimal representation of the number supplied as argument
 (base ten only).
 
 Prints the hexadecimal representation of the number supplied as argument
 (base ten only).
 
+: **hgdi()**
+Use GNU diff with options -ubwd for mercurial.
+
+: **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).
 
@@ -611,6 +621,10 @@ parameter.
 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
 directory.
 
 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
 directory.
 
+: **linenr()**
+Prints specified range of (numbered) lines of a file.
+Usage: linenr <start>[,<end>] <file>
+
 : **makereadable()**
 Creates a PostScript and a PDF file (basename as first argument) from
 source code files.
 : **makereadable()**
 Creates a PostScript and a PDF file (basename as first argument) from
 source code files.
@@ -788,6 +802,17 @@ line options, she always wants, in her .zshrc.local.
 : **vman()**
 Use vim(1) as manpage reader.
 
 : **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).
+
+: **weather()**
+Retrieves and prints weather information from "http://weather.noaa.gov".
+The first and only argument is the ICAO code for the desired station.
+For a list of ICAO codes see
+"http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
+
 : **xcat()**
 Tries to cat(1) file(s) given as parameter(s). Always returns true.
 See also xunfunction() below.
 : **xcat()**
 Tries to cat(1) file(s) given as parameter(s). Always returns true.
 See also xunfunction() below.
@@ -933,6 +958,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.
@@ -952,6 +980,9 @@ Runs the function H-Glob() to expand or explain wildcards.
 : **hide** (//echo -en [ escape sequence ]//)
 Tries to hide xterm window using escape sequence.
 
 : **hide** (//echo -en [ escape sequence ]//)
 Tries to hide xterm window using escape sequence.
 
+: **hidiff** (//histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'//)
+If histring(1) is installed, highlight important stuff in diff(1) output.
+
 : **huge** (//echo -en [ escape sequence ]//)
 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
 using escape sequence.
 : **huge** (//echo -en [ escape sequence ]//)
 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
 using escape sequence.
@@ -1026,11 +1057,18 @@ 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.
 
+: **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//)
+Executes the commands on the versioned patch queue from current repository.
+
 : **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
@@ -1082,6 +1120,13 @@ 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.
 
+: **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.
+
+: **...** (cd ../../)
+Changes current directory two levels higher.
+
 : **?** (//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
 : **?** (//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