zshrc: no longer explicitly set SHELL

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

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index 7c496c0..975cc17 100644 (file)
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -1,6 +1,6 @@
 GRMLZSHRC
 
 GRMLZSHRC
 

-July, 2011
+September, 2014

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


@@ -44,18 +44,22 @@ zshenv file.
 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
 variables. These may be set temporarily when starting zsh like this:
 \
 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
 variables. These may be set temporarily when starting zsh like this:
 \

-``` % BATTERY=1 zsh
+``` % GRML_DISPLAY_BATTERY=1 zsh

 
 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
 
 : **BATTERY**
 
 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
 
 : **BATTERY**

-If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
-put the battery status into the right hand side interactive prompt.
+Deprecated. Use **GRML_DISPLAY_BATTERY** instead.

 
 : **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).
 
 
 : **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_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//,
+//FreeBSD//, //OpenBSD// and //Darwin//.
+

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


@@ -105,6 +109,9 @@ Import "/etc/default/locale", if set to zero (default).
 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).
 
 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).
 

+: **COMPDUMPFILE**
+Specifies the location of the completion dump file. Default: $HOME/.zcompdump.
+

 
 = 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


@@ -354,7 +361,7 @@ before doing so. A correct example customisation could look like this:
     PS1='%~ %# '
 ```
 
     PS1='%~ %# '
 ```
 

-You also add your own tokens by using the \`grml_theme_has_token()' function.
+You also add your own tokens by using the \`grml_theme_add_token()' function.

 Call the function without arguments for detailed documentation about that
 procedure.
 
 Call the function without arguments for detailed documentation about that
 procedure.
 


@@ -395,10 +402,6 @@ already set otherwise.
 : **PAGER**
 Set less(1) as default pager, if not already set to something different.
 
 : **PAGER**
 Set less(1) as default pager, if not already set to something different.
 

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


@@ -554,9 +557,9 @@ else start a new screen.  This is especially useful for roadwarriors using GNU
 screen and ssh.
 
 : **bk()**
 screen and ssh.
 
 : **bk()**

-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.
+Simple backup management of a file or directory using standard unix programs.
+The target file name is the original name plus a time stamp attached. Symlinks
+and file attributes like mode, ownership and timestamps are preserved.

 
 : **cdrecord()**
 If the original cdrecord is not installed, issues a warning to the user to
 
 : **cdrecord()**
 If the original cdrecord is not installed, issues a warning to the user to


@@ -578,8 +581,8 @@ builtin or reserved word. If the option -c is given, only returns true,
 if command is a program.
 
 : **checkhome()**
 if command is a program.
 
 : **checkhome()**

-Changes directory to $HOME on first invocation of zsh. This is neccessary on
-grml systems with autologin.
+Changes directory to $HOME on first invocation of zsh. This is necessary on
+Grml systems with autologin.

 
 : **cl()**
 Changes current directory to the one supplied by argument and lists the files
 
 : **cl()**
 Changes current directory to the one supplied by argument and lists the files


@@ -612,6 +615,15 @@ Edit given shell function.
 : **freload()**
 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
 
 : **freload()**
 Reloads an autoloadable shell function (See autoload in zshbuiltins(1)).
 

+: **grml_vcs_info_toggle_colour()**
+Toggles between coloured and uncoloured formats in vcs_info configuration.
+This is useful with prompts that break if colour codes are in vcs_info
+format expansions (like the `clint' prompt and every other prompt that
+uses %v to expand the contents of `$vcs_into_msg_0_'). If you are using
+customised vcs_info formats, you shouldn't be using this function, since
+it will set all formats to grml's default values (either coloured or plain)
+again.
+

 : **hgdi()**
 Use GNU diff with options -ubwd for mercurial.
 
 : **hgdi()**
 Use GNU diff with options -ubwd for mercurial.
 


@@ -643,6 +655,9 @@ Returns true, if zsh version is equal or greater than 4.3.3, else false.
 : **isdarwin()**
 Returns true, if running on darwin, else false.
 
 : **isdarwin()**
 Returns true, if running on darwin, else false.
 

+: **isfreebsd()**
+Returns true, if running on FreeBSD, else false.
+

 : **isgrml()**
 Returns true, if running on a grml system, else false.
 
 : **isgrml()**
 Returns true, if running on a grml system, else false.
 


@@ -652,10 +667,16 @@ Returns true, if running on a grml system from a live cd, else false.
 : **isgrmlsmall()**
 Returns true, if run on grml-small, else false.
 
 : **isgrmlsmall()**
 Returns true, if run on grml-small, else false.
 

+: **islinux()**
+Returns true, if running on Linux, else false.
+

 : **iso2utf()**
 Changes every occurrence of the string iso885915 or ISO885915 in
 environment variables to UTF-8.
 
 : **iso2utf()**
 Changes every occurrence of the string iso885915 or ISO885915 in
 environment variables to UTF-8.
 

+: **isopenbsd()**
+Returns true, if running on OpenBSD, else false.
+

 : **isutfenv()**
 Returns true, if run within an utf environment, else false.
 
 : **isutfenv()**
 Returns true, if run within an utf environment, else false.
 


@@ -876,7 +897,7 @@ Runs the function H-Glob() to expand or explain wildcards.
 : **j** (//jobs -l//)
 Prints status of jobs in the current shell session in long format.
 
 : **j** (//jobs -l//)
 Prints status of jobs in the current shell session in long format.
 

-: **l** (//ls -lF --color=auto//)
+: **l** (//ls -l --color=auto//)

 Lists files in long output format with indicator for filetype appended
 to filename. If the terminal supports it, with colored output.
 
 Lists files in long output format with indicator for filetype appended
 to filename. If the terminal supports it, with colored output.
 


@@ -898,11 +919,10 @@ Lists files in long colored output format.
 : **llog** (//$PAGER /var/log/syslog//)
 Opens syslog in pager.
 
 : **llog** (//$PAGER /var/log/syslog//)
 Opens syslog in pager.
 

-: **ls** (//ls -b -CF --color=auto//)
-Lists directory printing octal escapes for nongraphic characters.
-Entries are listed by columns and an indicator for file type is appended
-to each file name. Additionally the output is colored, if the terminal
-supports it.
+: **ls** (//ls -C --color=auto//)
+Lists directory, entries are listed by columns and an indicator for
+file type is appended to each file name. Additionally the output is
+colored, if the terminal supports it.

 
 : **lsa** (//ls -a .*(.)//)
 Lists dot files in current working directory.
 
 : **lsa** (//ls -a .*(.)//)
 Lists dot files in current working directory.


@@ -962,7 +982,7 @@ with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
 as configuration.
 
 : **su** (//sudo su//)
 as configuration.
 
 : **su** (//sudo su//)

-If user is running a grml live-CD, dont ask for any password, if she
+If user is running a Grml live system, don't ask for any password, if she

 wants a root shell.
 
 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)
 wants a root shell.
 
 : **term2iso** (//echo 'Setting terminal to iso mode' ; print -n '\e%@'//)


@@ -1001,7 +1021,7 @@ be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
 \
 ```
 # show battery status in RPROMPT
 \
 ```
 # show battery status in RPROMPT

-BATTERY=1
+GRML_DISPLAY_BATTERY=1

 # always load the complete setup, even for root
 GRML_ALWAYS_LOAD_ALL=1
 ```
 # always load the complete setup, even for root
 GRML_ALWAYS_LOAD_ALL=1
 ```


@@ -1029,7 +1049,7 @@ 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
 ```
 
 % 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
+If you would also like to get separate 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
 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