X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=doc%2Fgrmlzshrc.t2t;h=46b0170e947cd6c779ee033204f09623e50dc03b;hb=5f07a91fbbec4a04c9dec58355ba94472cfbadb0;hp=8accb743a7e58044daed59a256b70de4bc6e194d;hpb=fd3a55f78b1e316727760a92dcd3f0759013549c;p=grml-etc-core.git

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index 8accb74..46b0170 100644
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -73,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.
@@ -122,6 +131,38 @@ obtained with the zprof builtin command (see zshmodules(1) for details).
 Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
 
 
+= GRML-ZSHRC SPECIFIC STYLES =
+
+Styles are a context sensitive configuration mechanism included with zsh. The
+shell uses it extensively in sub-systems like the completion and the VCS info
+system. It lives outside of the classic shell variable namespace, so it avoids
+polluting it. New functionality in grml's zshrc will likely use styles instead
+of variables. Some features of the setup (like the directory stack handling)
+already use styles. Those styles are documented with the specific features.
+This section documents more general styles.
+
+== Context: :grml:completion:compinit ==
+This context revolves around the zshrc's //compinit// function call, that
+initialises zsh's function based completion system.
+
+: **arguments**
+This style allows the injection of arguments to the command line that is used
+to run compinit. It is a list style and its default is the empty list. Using
+this style, it's possible to add **-i** to //compinit// in order to disable
+//compaudit//.
+\
+```
+zstyle ':grml:completion:compinit' arguments -i
+```
+\
+Only do this, if you know what sort of security checks are disabled if
+//compaudit// is not active and if that's acceptable with your specific setup.
+\
+This style has to be set at the point that Grml's zshrc runs //compinit//. A
+possible way to achieve this is to set it in //~/.zshrc.pre// (see AUXILIARY
+FILES below for details).
+
+
 = FEATURE DESCRIPTION =
 This is an in depth description of non-standard features implemented by
 //grmlzshrc//.
@@ -136,6 +177,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
@@ -173,12 +222,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 ==
@@ -379,7 +431,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:
 \
 ```
@@ -428,8 +480,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 =
@@ -559,7 +612,7 @@ 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.
+Searches the last occurrence 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.
@@ -571,7 +624,7 @@ Brings a job, which got suspended with CTRL-z back to foreground.
 === Customisation ===
 
 To customise keybindings, you can just use zsh's bindkey utility. However, if
-you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
+you plan to use the `//zle-line-init//' or `//zle-line-finish//' hooks
 yourself, make sure you call the following functions in the respective hook:
 
 - **zle-line-init**: //zle-smkx//
@@ -757,7 +810,7 @@ Runs a command in zsh with profiling enabled (See startup variable
 ZSH_PROFILE_RC above).
 
 : **salias()**
-Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
+Creates an alias with sudo prepended, if $EUID is not zero. Run "salias -h"
 for details. See also xunfunction() below.
 
 : **simple-extract()**