X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=doc%2Fgrmlzshrc.t2t;h=fafe2d316ccc74c1b9d5ddfd75a6b36a9dff2716;hb=cedfc98d894d4c53123046ef4c1ca65135f9f9a4;hp=ead2182ba480f6b31aa1771066b6fe408ae82bfc;hpb=21c8c5cf7e67b38bf42cdc19af6629fd6346d8f0;p=grml-etc-core.git

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index ead2182..fafe2d3 100644
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -55,6 +55,15 @@ Deprecated. Use **GRML_DISPLAY_BATTERY** instead.
 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_COMP_CACHING**
+If set to //yes// (the default), the setup will enable zsh's completion caching
+mechanism, with the caching data being placed into //$GRML_COMP_CACHE_DIR//.
+
+: **GRML_COMP_CACHE_DIR**
+This defines where zsh's completion caching data will be placed, if
+//$GRML_COMP_CACHING// is active. The default is //${ZDOTDIR:-$HOME}/.cache//.
+The setup will ensure the directory exists before attempting to use it.
+
 : **GRML_DISPLAY_BATTERY**
 If set to a value greater than zero, //grmlzshrc// will put the battery status
 into the right hand side interactive prompt. Supported OSes are //GNU/Linux//,
@@ -64,6 +73,15 @@ into the right hand side interactive prompt. Supported OSes are //GNU/Linux//,
 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".
 
+: **GRML_NO_APT_ALIASES**
+A non-empty value inhibits the definition of apt-specific short aliases,
+such as ag, agi, ati etc.
+
+: **GRML_NO_SMALL_ALIASES**
+A non-empty value inhibits the definition of 2-letter aliases such as da.
+ls, ll, la and other common ls-related aliases are exempt from this, as are
+the aliases inhibited by GRML_NO_APT_ALIASES.
+
 : **GRMLSMALL_SPECIFIC**
 Set this to zero to remove items in zsh config, which do not work in
 grml-small.
@@ -127,6 +145,14 @@ The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
 zshs inherit the dirstack of the zsh that most recently updated
 **DIRSTACKFILE**.
 
+If you would like to //disable// the persistent dirstack feature altogether,
+you can do that by setting the boolean //enable// style to //false// in the
+right context (the default is //true//):
+\
+```
+zstyle ':grml:chpwd:dirstack' enable false
+```
+
 It is possible to apply a filter to the names of directories that will be
 committed to the persistent dirstack file. There are two ways to configure this
 filter: A general function based filter and a pattern based filter. Both are
@@ -164,12 +190,15 @@ dirstack file, set the //filter-on-load// boolean style (the default is
 zstyle ':grml:chpwd:dirstack' filter-on-load true
 ```
 
-Setting the //filter-on-load// needs to be done in ".zshrc.pre" because the
-style needs to be set when the main setup is executing! The other styles do not
-have this limitation, but the initial filtering will obviously be done using
-the filters that are configured **at** **that** **point**. The rule of thumb
-is: If you want to filter on load, setup everything in ".zshrc.pre" otherwise
-".zshrc.local" works just as well.
+Setting the //filter-on-load// and //enable// styles needs to be done in
+".zshrc.pre" because the styles need to be set when the main setup is
+executing! The other styles do not have this limitation, but enabling the
+system as well as the initial filtering will obviously be done using settings
+and filters that are configured **at** **that** **point**.
+
+With respect to //filter-on-load//, the rule of thumb is: If you want to filter
+on load, setup everything in ".zshrc.pre" otherwise ".zshrc.local" works just
+as well.
 
 
 == DIRECTORY BASED PROFILES ==
@@ -370,7 +399,7 @@ By default, **grml** is used, unless //$GRMLPROMPT// is set to a value larger
 than zero, in which case **grml-large** is used. Lastly, if //$GRML_CHROOT// is
 non-empty, **grml-chroot** is used.
 
-As usual, with promtinit themes, the user may switch to a different theme using
+As usual, with promptinit themes, the user may switch to a different theme using
 the //prompt// utility:
 \
 ```
@@ -419,8 +448,9 @@ 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.
+shell's history, you can put them into $GRML_IMPORTANT_COMMANDS (which defaults
+for backward compatibility to ~/.important_commands) and they will be available
+via the usual history lookup widgets.
 
 
 = REFERENCE =