projects
/
grml-etc-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Release new version 0.10.3
[grml-etc-core.git]
/
doc
/
grmlzshrc.t2t
diff --git
a/doc/grmlzshrc.t2t
b/doc/grmlzshrc.t2t
index
cc7aa65
..
3a5b615
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".
@@
-581,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 nec
c
essary on
-
g
rml systems with autologin.
+Changes directory to $HOME on first invocation of zsh. This is necessary on
+
G
rml 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
@@
-655,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.
@@
-664,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.
@@
-973,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, don
t 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%@'//)
@@
-1012,7
+1025,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
```
@@
-1040,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 sep
e
rate function files (which you can put into
+If you would also like to get sep
a
rate 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