grmlzshrc.t2t: Document function linenr()

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

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index 4470062..384078f 100644 (file)
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -1,6 +1,6 @@
 GRMLZSHRC
 
 GRMLZSHRC
 

-August, 2009
+June, 2010

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


@@ -43,6 +43,47 @@ 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.
+
+: **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).
+
+: **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 +281,25 @@ 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.
+
+: **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 +415,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 +434,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 +467,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,


@@ -476,20 +548,6 @@ Downloads and installs newer version of Skype.
 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
 ~/tmp.
 
 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.
 


@@ -553,6 +611,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 +634,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 +655,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.


@@ -1195,10 +1258,19 @@ 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 =


@@ -1208,7 +1280,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.