X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=grml-zsh-refcard.tex.in;h=389cc9a984547d12cf464df7db32312d4c5a1356;hb=2b83e07b0599541ec53104b51f9235e81c3e4189;hp=4902b9268da1b50dff44461085e383415886f426;hpb=7a153417f8b38612e80126813f30aac5ea39cb87;p=grml-gen-zshrefcard.git diff --git a/grml-zsh-refcard.tex.in b/grml-zsh-refcard.tex.in index 4902b92..389cc9a 100644 --- a/grml-zsh-refcard.tex.in +++ b/grml-zsh-refcard.tex.in @@ -128,9 +128,9 @@ %%% Unten: Links, Mitte, Rechts \ifoot[]{\vspace{-3pt}GRML-Zsh-Refcard} \cfoot[]{} - \ofoot[]{\vspace{-3pt}\copyright 2005-2008 \href{mailto:julius@grml.org}{Julius Plenz}, + \ofoot[]{\vspace{-3pt}\copyright 2005-2009 \href{mailto:julius@grml.org}{Julius Plenz}, \href{mailto:mika@grml.org}{Michael Prokop} and - \href{mailto:ft@bewatermyfriend.org}{Frank Terbeck}} + \href{mailto:ft@grml.org}{Frank Terbeck}} %%% }}} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -205,57 +205,58 @@ \subsection*{Configuration files} -\small{Global zsh configuration is located in \textbf{/etc/zsh/zshrc}. User -specific settings are defined in \textbf{/etc/skel/.zshrc} (which can be found -in \kbd{\~}/.zshrc for user grml too). Please note that some functions/aliases -are not active by default for user root (referred to as '... for user (grml)' -below) because of security reasons. Just run 'zshskel' (as user root) to source -the file /etc/skel/.zshrc. Some aliases/functions also aren't active if the -appropriate executable isn't present on your system. - -/etc/zsh/zshrc: this file can be adjusted according to your needs via using a -file named /etc/zsh/zshrc.local which is not part of the Debian package -management. So place all your changes in the file /etc/zsh/zshrc.local. If you -don't have write permissions to /etc/zsh/zshrc on your own, copy the file -/etc/zsh/zshrc to \kbd{\~}/.zshrc.global and it will be sourced by -\kbd{\~}/.zshrc then. - -Write important commands you always need (no matter what's inside zsh's -history!) to a file named \textbf{\kbd{\~}/.important\_commands}. - -Note that /etc/skel/.zshrc itself is not sourced by zsh but copied to -\$HOME-directory of your non-root user once. To keep your -\textbf{\kbd{\~}/.zshrc} in sync with upstream's development just put your -personal stuff into a file named \textbf{\kbd{\~}/.zshrc.local} and point your -\kbd{\~}/.zshrc to /etc/skel/.zshrc running 'ln -s /etc/skel/.zshrc -\kbd{\~}/.zshrc'.} - -You can get information regarding configuration files and some environment -variables to adjust runtime behaviour of grml's zsh running \textbf{zsh-help}. +\small{Grml's zsh configuration is located in \textbf{/etc/zsh/zshrc}. Please +note that some functions/aliases are not active by default for user root +(referred to as '... for user (grml)' below) for of security reasons. +If you want your root user to use the full setup on your box, put +\textbf{GRML\_ALWAYS\_LOAD\_ALL=1} into root's \kbd{\~}/.zshrc.pre. +Some aliases/functions are not activated if the appropriate executable +isn't present on your system, either. + +You can adjust the grml setup globally to your systems via a file +named /etc/zsh/zshrc.local, which is not under the control of Debian package +management. + +Put important commands which you need on a regular basis into a file named +\textbf{\kbd{\~}/.important\_commands}. + +You can put personal configuration for a user into a file named +\textbf{\kbd{\~}/.zshrc.local}. Changes you need to have sourced +\textbf{before} the grml zsh setup is loaded can be put into +\textbf{\kbd{\~}/.zshrc.pre}. + +More information regarding configuration files and some environment +variables to adjust runtime behaviour of grml's zsh can be accessed by +running \textbf{zsh-help}. \subsection*{Using grml's zsh configuration on a non-grml system} You do not have to use grml/Debian to use grml's zsh configuration. -Just retrieve and install the configuration files for example running: +Just retrieve and install the configuration files in your home directory. +You can do this by running: \begin{tiny} \begin{verbatim} -wget -O ~/.zshrc http://hg.grml.org/grml-etc-core/raw-file/tip/etc/skel/.zshrc -wget -O ~/.zshrc.global http://hg.grml.org/grml-etc-core/raw-file/tip/etc/zsh/zshrc +wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc \end{verbatim} \end{tiny} +This is \textbf{different} from earlier versions of grml's zsh setup. +You only use the zshrc file from /etc/zsh/ \textbf{not} the .zshrc file +from /etc/skel/ these days. You can remove \kbd{\~}/.zshrc.global if it is +still present in your home directory. + \subsection*{Problems?} -Please report any problems you notice using the grml zsh configuration -to the grml-team. The configuration has been tested on several Linux -Distribution (Debian, Gentoo, SuSE,...) and non-Linux systems as well -(FreeBSD, Solaris, AIX,...) but there might be issues anyway. Please -\href{http://grml.org/bugs/}{report them}! +Please report any problems you encounter while using the grml zsh +configuration to the grml team. The configuration has been tested on several +Linux distributions (Debian, Gentoo, SuSE, etc) and non-Linux systems as well +(FreeBSD, Solaris, AIX, etc), but there might be issues, anyway. +\href{http://grml.org/bugs/}{Report them, please!} \subsection*{Settings} -If not already defined, the variables are set to the following +If not already defined, these variables are set to the following values: \commandlistbegin @@ -270,8 +271,8 @@ values: \subsection*{Keybindings} Default keybinding mode is Emacs, i.e. you can use Emacs keybinds like -\kbd{^A {\rm or} ^E} on the command line. You can however also switch -to vi mode. +\kbd{^A {\rm or} ^E} on the command line. However, you can switch to vi +mode. \commandlistbegin \command{setopt emacs}{Switch to Emacs mode (default)} @@ -279,9 +280,9 @@ to vi mode. \commandlistend \vspace{8pt} -The following keybindings document some important keybindings which are not -defined by zsh's default configuration. Tip: press twice when completing a -command you installed which is not yet known to zsh or run 'rehash' manually. +The following documents some important keybindings which are not +defined in zsh's default configuration. Hint: press twice when completing +a command you installed which is not yet known to zsh or run 'rehash' manually. \commandlistbegin @@INSERT-keybindings@@ @@ -291,8 +292,8 @@ command you installed which is not yet known to zsh or run 'rehash' manually. \subsection*{Terminal Settings} -There are 8 aliases designed to change the font size of the -XTerm, Aterm\ldots These are: +There are 8 aliases designed to change the font size of terminal +emulators (XTerm, Aterm, etc). They are: \kbd{hide}, \kbd{tiny}, \kbd{small}, @@ -305,8 +306,8 @@ XTerm, Aterm\ldots These are: \subsection*{Hashes} -Directory hashes are shortcuts for often used directories. You can -expand them by typing \kbd{\~{}hash}. Usage example: 'cd \kbd{\~}doc' +Directory hashes are shortcuts for common directories. You can +expand them by typing \kbd{\~{}hash}. Usage: 'cd \kbd{\~}doc' \commandlistbegin @@INSERT-hasheddirs@@ @@ -328,8 +329,7 @@ expand them by typing \kbd{\~{}hash}. Usage example: 'cd \kbd{\~}doc' \vspace{8pt} \subsection*{Debian commands} -Note: if not executed as root zsh tries to run the command via sudo if -necessary. +Please note: if not executed as root, these aliases try to run the command via sudo. \commandlistbegin @@INSERT-aliases-debian@@ @@ -344,7 +344,7 @@ necessary. \subsection*{Abbreviation expansion for user (grml)} -As of version 0.9 grml does not enable global aliases anymore. Instead, a +As of version 0.9, grml does not enable global aliases anymore. Instead, a feature similiar to vim's 'iab' was added. The default key-sequence to trigger the expansion is ',.'. @@ -354,7 +354,7 @@ Example: \kbd{co}\begin{Huge},.\end{Huge} \quad expands to: \kbd{./configure \&\& make \&\& sudo make install} \commandlistend -The configuration of this feature and its implementation are described in the zshwiki +The configuration of this feature and its implementation are described on the zsh wiki <\url{http://zshwiki.org/home/examples/zleiab}>. \commandlistbegin @@ -364,7 +364,7 @@ The configuration of this feature and its implementation are described in the zs \vspace{12pt} Most of the normal aliases are also added to this database, so you may expand them -just like this as well. +like this as well. %\pagebreak