+% This file is free software: you can redistribute it and/or modify
+% it under the terms of the GNU General Public License as published by
+% the Free Software Foundation, either version 3 of the License, or
+% (at your option) any later version.
+%
+% This file is distributed in the hope that it will be useful,
+% but WITHOUT ANY WARRANTY; without even the implied warranty of
+% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+% GNU General Public License for more details.
+
\documentclass[8pt, % 8pt
a4paper, % A4
oneside, % Einseitig
%%% }}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%% PDF {{{
-\newif\ifpdf
- \ifx\pdfoutput\undefined
- \pdffalse
- \else
- \pdfoutput=1
- \pdftrue
- \fi
-
-\ifpdfoutput{
- \usepackage[pdftex]{graphicx}
- \DeclareGraphicsExtensions{.pdf}
- \pdfcompresslevel=9
- \usepackage[%
- pdftex=true,
- backref=true,
- colorlinks=true,
- bookmarks=true,
- breaklinks=true,
- linktocpage=true,
- bookmarksopen=false,
- bookmarksnumbered=false,
- pdfpagemode=None
- ]{hyperref}
-}{
- \usepackage[dvips]{graphicx}
- \DeclareGraphicsExtensions{.eps}
- % \usepackage[%
- % dvips,
- % breaklinks=true,
- % colorlinks=false
- % ]{hyperref}
-}
+\usepackage[pdftex]{graphicx}
+\DeclareGraphicsExtensions{.pdf}
+\pdfcompresslevel=9
+\usepackage[%
+ pdftex=true,
+ backref=true,
+ colorlinks=true,
+ bookmarks=true,
+ breaklinks=true,
+ linktocpage=true,
+ bookmarksopen=false,
+ bookmarksnumbered=false,
+ pdfpagemode=None
+]{hyperref}
%%% }}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Seitenkopf- und -Fußzeilen {{{
\automark[subsection*]{section} % \left- und \rightmark bekommen Inhalt
%%% Oben: Links, Mitte, Rechts
- \ihead[]{{\Huge GRML-Zsh-Refcard}}
+ \ihead[]{{\Huge Grml-Zsh-Refcard}}
\chead[]{}
\ohead[]{Generated: \today}
%%% Unten: Links, Mitte, Rechts
- \ifoot[]{\vspace{-3pt}GRML-Zsh-Refcard}
+ \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-2018 \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}}
%%% }}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Inhalt {{{
%Schon in lhead
-%\section{GRML's Zsh-Setup Reference Card}
+%\section{Grml's Zsh-Setup Reference Card}
\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
@@INSERT-variables@@
\commandlistend
-\commandlistbegin
-\command{umask @@INSERT-other-umask@@}{new files automatically get permissions \kbd{@@INSERT-other-umaskstr@@}}
-\command{umask @@INSERT-other-r_umask@@}{new files for root user \kbd{@@INSERT-other-r_umaskstr@@}}
-\commandlistend
-
\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)}
\commandlistend
\vspace{8pt}
-The following keybindings document some important keybindings which are not
-defined by zsh's default configuration. Tip: press <tab> 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 <tab> twice when completing
+a command you installed which is not yet known to zsh or run 'rehash' manually.
\commandlistbegin
@@INSERT-keybindings@@
\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},
\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@@
\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@@
\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 ',.'.
+the expansion is '\texttt{C-x\,.}'.
Example:
\commandlistbegin
-\kbd{co}\begin{Huge},.\end{Huge} \quad expands to: \kbd{./configure \&\& make \&\& sudo make install}
+\kbd{co}\textbf{<C-x\,.>} \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
\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
\subsection*{Functions for user (grml)}
-\textbf{Searching}
-
-\commandlistbegin
-@@INSERT-functions-search@@
-\commandlistend
-
-\vspace{12pt}
\textbf{Shortcuts}
\commandlistbegin
projects / grml-gen-zshrefcard.git / blobdiff