grmlzshrc.t2t: aliases hidiff, url-quote, mdstat and ...

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

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index 382c80f..41239c9 100644 (file)
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -1,6 +1,6 @@
 GRMLZSHRC
 
 GRMLZSHRC
 

-Oktober, 2009
+June, 2010

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


@@ -43,6 +43,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


@@ -240,10 +296,29 @@ If X is running this is set to "firefox", otherwise to "w3m".
 Set to "yes". Some applications read this to learn about properties
 of the terminal they are running in.
 
 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).
 
 : **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
 
 == OPTIONS ==
 Apart from zsh's default options, //grmlzshrc// sets some options


@@ -359,6 +434,11 @@ Converts plaintext files to HTML using vim. The output is written to
 If 915resolution is available, issues a warning to the user to run it instead
 to modify the resolution on intel graphics chipsets.
 
 If 915resolution is available, issues a warning to the user to run it instead
 to modify the resolution on intel graphics chipsets.
 

+: **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.
+

 : **agoogle()**
 Searches for USENET postings from authors using google groups.
 
 : **agoogle()**
 Searches for USENET postings from authors using google groups.
 


@@ -373,6 +453,12 @@ sequences) and the colors they represent.
 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
 layout.
 
 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
 layout.
 

+: **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.
+

 : **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
 : **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


@@ -400,6 +486,11 @@ 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.
 
 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
 cdrecord.
 

+: **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,
 : **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,


@@ -460,36 +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.
-
-: **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.
 
 : **greph()**
 Searches the zsh command history for a regular expression.
 


@@ -497,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).
 


@@ -553,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.


@@ -572,8 +644,8 @@ output (unified format) to a timestamped file.
 Prints the summarized memory usage in bytes.
 
 : **minimal-shell()**
 Prints the summarized memory usage in bytes.
 
 : **minimal-shell()**

-Spawns a absolute minimal Korn shell. It references no files in /usr, so
-that file system can be unmounted.
+Spawns a minimally set up MirBSD 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
 
 : **mkaudiocd()**
 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and


@@ -593,9 +665,10 @@ Creates a directory with first parameter as name inside $MAILDIR_ROOT
 Runs "make install" and logs the output under ~/.errorlogs/; useful for
 a clean deinstall later.
 
 Runs "make install" and logs the output under ~/.errorlogs/; useful for
 a clean deinstall later.
 

-: **new()**
+: **modified()**

 Lists files in current directory, which have been modified within the
 Lists files in current directory, which have been modified within the

-last N days. N is an integer required as first and only argument.
+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.

 
 : **ogg2mp3_192()**
 Recodes an ogg file to mp3 with a bitrate of 192.
 
 : **ogg2mp3_192()**
 Recodes an ogg file to mp3 with a bitrate of 192.


@@ -729,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.


@@ -874,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.


@@ -893,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.


@@ -967,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


@@ -1023,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


@@ -1217,7 +1321,7 @@ Beckert <abe@deuxchevaux.org>.
 
 
 = COPYRIGHT =
 
 
 = COPYRIGHT =

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

 
 This manpage is distributed under the terms of the GPL version 2.
 
 
 This manpage is distributed under the terms of the GPL version 2.