grml-zsh-refcard.tex.in: update copyright information
[grml-gen-zshrefcard.git] / grml-zsh-refcard.tex.in
index ab4d4d9..8ef23b4 100644 (file)
@@ -1,3 +1,13 @@
+% 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@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{The 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 of the user grml, as well). 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. Simply run 'zshskel'
-(as root) to source /etc/skel/.zshrc. Some aliases/functions are not activated
-if the appropriate executable isn't present on your system, either.
+\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.
 
-/etc/zsh/zshrc: this file can be adjusted according to your needs via a file
+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. This, you need to place all your changes in the file
-/etc/zsh/zshrc.local. If you do not have write permission to
-/etc/zsh/zshrc, copy the file /etc/zsh/zshrc to \kbd{\~}/.zshrc.global
-and it will be sourced by \kbd{\~}/.zshrc.
+management.
 
 Put important commands which you need on a regular basis into a file named
 \textbf{\kbd{\~}/.important\_commands}.
 
-Note that /etc/skel/.zshrc itself is not sourced by zsh, but copied to the
-\$HOME-directory of your non-root user on user creation. 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 by running 'ln -s /etc/skel/.zshrc
-\kbd{\~}/.zshrc'.}
+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
@@ -242,11 +227,15 @@ You can do this by running:
 
 \begin{tiny}
 \begin{verbatim}
-wget -O .zshrc        http://git.grml.org/f/grml-etc-core/etc/skel/.zshrc
-wget -O .zshrc.global 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
 \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 encounter while using the grml zsh
@@ -264,12 +253,7 @@ values:
 @@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*{Key-bindings}
+\subsection*{Keybindings}
 
 Default keybinding mode is Emacs, i.e. you can use Emacs keybinds like
 \kbd{^A {\rm or} ^E} on the command line. However, you can switch to vi
@@ -347,12 +331,12 @@ Please note: if not executed as root, these aliases try to run the command via s
 
 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 on the zsh wiki
@@ -371,13 +355,6 @@ like this as well.
 
 \subsection*{Functions for user (grml)}
 
-\textbf{Searching}
-
-\commandlistbegin
-@@INSERT-functions-search@@
-\commandlistend
-
-\vspace{12pt}
 \textbf{Shortcuts}
 
 \commandlistbegin