zshrc: drop 2mp3_192 function

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

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index 8abdf32..05a0275 100644 (file)
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -1,13 +1,13 @@
 GRMLZSHRC
 
 GRMLZSHRC
 

-June, 2010
+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


@@ -48,7 +57,7 @@ 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**
 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.
+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)
 
 : **GRML_ZSH_CNF_HANDLER**
 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)


@@ -62,7 +71,7 @@ grml-small.
 Where zsh saves the history. Default: ${HOME}/.zsh_history.
 
 : **HISTSIZE**
 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
+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**
 500, on a hard disk installation to 5000.
 
 : **MAILCHECK**


@@ -85,7 +94,7 @@ Show time (user, system and cpu) used by external commands, if they run longer
 than the defined number of seconds (default: 5).
 
 : **SAVEHIST**
 than the defined number of seconds (default: 5).
 
 : **SAVEHIST**

-Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a grml-CD
+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**
 and to 10000 on an installation on hard disk.
 
 : **watch**


@@ -415,9 +424,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.
 


@@ -482,11 +500,6 @@ 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.
 
 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).
-

 : **cdiff()**
 Runs a recursive diff(1) over two given directories trying to find the
 smallest set of changes. Three lines of context will be printed and binary
 : **cdiff()**
 Runs a recursive diff(1) over two given directories trying to find the
 smallest set of changes. Three lines of context will be printed and binary


@@ -497,6 +510,10 @@ 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.
 

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


@@ -534,10 +551,6 @@ Generates a changelog using rcs2log and shows it in $PAGER.
 : **cvss()**
 Shows cvs status of given files.
 
 : **cvss()**
 Shows cvs status of given files.
 

-: **d()**
-Presents a numbered listing of the directory stack. Then changes current
-working directory to the one chosen by the user.
-

 : **dchange()**
 Shows the changelog of given package in $PAGER.
 
 : **dchange()**
 Shows the changelog of given package in $PAGER.
 


@@ -706,6 +719,9 @@ directory.
 Prints specified range of (numbered) lines of a file.
 Usage: linenr <start>[,<end>] <file>
 
 Prints specified range of (numbered) lines of a file.
 Usage: linenr <start>[,<end>] <file>
 

+: **lsdisk()**
+Uses udev's /dev/disk to list block devices with their LABEL, UUID and IDs.
+

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


@@ -773,9 +789,6 @@ Example usages:
 % ls -l *(e:'nt /reference/file':)
 ```
 
 % ls -l *(e:'nt /reference/file':)
 ```
 

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

 : **oleo()**
 Translates the given word using the english - german online
 dictionary dict.leo.org.
 : **oleo()**
 Translates the given word using the english - german online
 dictionary dict.leo.org.


@@ -792,9 +805,16 @@ Runs a command in $SHELL with profiling enabled (See startup variable
 ZSH_PROFILE_RC above).
 
 : **purge()**
 ZSH_PROFILE_RC above).
 
 : **purge()**

-Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
-"a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
-Asks for confirmation.
+Removes temporary files from current directory. Asks for confirmation. Uses sudo if necessary.
+In detail it purges
+ - common temp files like "*~", ".*~", "#*#", "*.o", "a.out", "*.orig", "*.rej", "*.cmo", "*.cmi" and ".*.swp"
+ - core dumps
+ - debconf backup files: "*.dpkg-old", "*.dkpg-new", "*.dpkg-dist"
+ - gentoo dispatch-conf backups: ".cfg0000_*", ".mrg0000_*"
+ - precompiled python code ("*.pyc", "*.pyo") as long as matching "*.py" source is also present
+ - LaTeX temp files i.e. "*.(log|toc|aux|nav|snm|out|tex.backup|bbl|blg|bib.backup|vrb|lof|lot|hd|idx)" for any present "*.tex"
+ - ghc temp files, as long as matching "*.hs" or "*.lhs" is also present
+ - "*.mood(D)" Files which are missing their corresponding audio file

 
 : **readme()**
 Opens all README-like files in current working directory with the program
 
 : **readme()**
 Opens all README-like files in current working directory with the program


@@ -807,6 +827,11 @@ Reloads functions given as parameters.
 Checks whether a regular expression (first parameter) matches a string
 (second parameter) using perl.
 
 Checks whether a regular expression (first parameter) matches a string
 (second parameter) using perl.
 

+: **rundirs()**
+Takes as first parameter a quoted string containing an exectuable command or function with arguments.
+Following that it takes a bunch of directories, which will then be traversed, executing the
+first argument in each one. E.g.: rundirs purge . **/*(/-/)
+

 : **salias()**
 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
 for details. See also xunfunction() below.
 : **salias()**
 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
 for details. See also xunfunction() below.


@@ -831,8 +856,11 @@ Lists the content of a gzipped tar archive in default pager.
 Shows the content of a zip archive in default pager.
 
 : **simple-extract()**
 Shows the content of a zip archive in default pager.
 
 : **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.

 
 : **sll()**
 Prints details of symlinks given as arguments.
 
 : **sll()**
 Prints details of symlinks given as arguments.


@@ -886,10 +914,6 @@ Shows some information about current system status.
 : **swiki()**
 Searches articles in the german Wikipedia for the term given as argument.
 
 : **swiki()**
 Searches articles in the german Wikipedia for the term given as argument.
 

-: **swspeak()**
-Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
-swspeak must be set for this to work.
-

 : **trans()**
 Translates a word from german to english (-D) or vice versa (-E).
 
 : **trans()**
 Translates a word from german to english (-D) or vice versa (-E).
 


@@ -1506,10 +1530,10 @@ Beckert <abe@deuxchevaux.org>.
 
 
 = COPYRIGHT =
 
 
 = COPYRIGHT =

-Copyright (c) 2009-2010 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).