minimal-shellrc: sync ls related alias behaviour with main zshrc

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

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index d0462c7..ab49647 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 "


@@ -56,8 +56,9 @@ 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**
 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
 
 : **GRML_DISPLAY_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.
+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)
 
 : **GRML_ZSH_CNF_HANDLER**
 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)


@@ -560,9 +561,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


@@ -584,8 +585,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


@@ -658,6 +659,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.
 


@@ -667,10 +671,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.
 


@@ -891,7 +901,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.
 


@@ -913,7 +923,7 @@ 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 -CF --color=auto//)
+: **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.
 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.


@@ -976,7 +986,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%@'//)


@@ -1043,7 +1053,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