grmlzshrc.t2t: Update date
[grml-etc-core.git] / doc / grmlzshrc.t2t
index e85c512..f3d0358 100644 (file)
@@ -1,6 +1,6 @@
 GRMLZSHRC
 
-May, 2009
+August, 2009
 
 %!target: man
 %!postproc(man): "^(\.TH.*) 1 "  "\1 5 "
@@ -211,19 +211,35 @@ style. (The default is **true** in all contexts.)
 
 == PROMPT ==
 
+
 == GNU/SCREEN STATUS SETTING ==
+//grmlzshrc// sets screen's hardstatus lines to the currently running command
+or **'zsh'** if the shell is idling at its prompt. If the current working
+directory is inside a repository unter version control, screen status is set
+to: **'zsh: <repository name>'** via zsh's vcs_info.
+
 
 == PERSISTENT HISTORY ==
+If you got commands you consider important enough to be included in every
+shell's history, you can put them into ~/.important_commands and they will be
+available via the usual history lookup widgets.
 
 
 = REFERENCE =
 == KEYBINDINGS ==
+Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
+key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
+on PC keyboards.
+
+: **ESC-e**
+Edit the current command buffer in your favourite editor.
+
 
 == SHELL FUNCTIONS ==
 //grmlzshrc// comes with a wide array of defined shell functions to ease the
 user's life.
 
-: urlencode()
+: **urlencode()**
 Takes a string as its first argument and prints it RFC 2396 URL encoded to
 standard out.
 
@@ -232,7 +248,7 @@ standard out.
 This is a set of files, that - if they exist - can be used to customize the
 behaviour of //grmlzshrc//.
 
-: .zshrc.pre
+: **.zshrc.pre**
 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
 \
@@ -243,14 +259,33 @@ BATTERY=1
 GRML_ALWAYS_LOAD_ALL=1
 ```
 
-: .zshrc.local
+: **.zshrc.local**
 Sourced right before loading //grmlzshrc// is finished. There is a global
 version of this file (/etc/zsh/zshrc.local) which is sourced before the
 user-specific one.
 
+: **.zdirs**
+Directory listing for persistent dirstack (see above).
+
+: **.important_commands**
+List of commands, used by persistent history (see above).
 
 
 = INSTALLATION ON NON-DEBIAN SYSTEMS =
+On Debian systems (http://www.debian.org) - and possibly Ubuntu
+(http://www.ubuntu.com) and similar systems - it is very easy to get
+//grmlzshrc// via grml's .deb repositories.
+
+On non-debian systems, that is not an option, but all is not lost:
+\
+```
+% wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
+```
+
+If you would also like to get seperate function files (which you can put into
+your **$fpath**), you can browse and download them at:
+
+http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
 
 
 = CONTRIBUTING =