1 % This file is free software: you can redistribute it and/or modify
2 % it under the terms of the GNU General Public License as published by
3 % the Free Software Foundation, either version 3 of the License, or
4 % (at your option) any later version.
6 % This file is distributed in the hope that it will be useful,
7 % but WITHOUT ANY WARRANTY; without even the implied warranty of
8 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 % GNU General Public License for more details.
11 \documentclass[8pt, % 8pt
17 headsepline, % Trennlinie oben
18 footsepline, % -""- unten
19 smallheadings, % Kleine Überschriften
20 % pointlessnumbers,% Keine Punkte
21 halfparskip, % Halbe Zeile Absatz statt Einzug
22 nochapterprefix, % Kein "Kapitel"
23 % bibtotoc % "Literatur" im TOC oder
24 % bibtotocnumbered,% -""-, nummeriert
25 % idxtotoc, % Index im TOC
29 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31 \usepackage[latin1]{inputenc} % ISO-Umlaute
32 \usepackage[T1]{fontenc} % T1-kodierte Fonts
33 \usepackage{ae,aecompl} % Kodierung für PDF
34 %\usepackage{ngerman} % Deutsche Trennungen,
36 \usepackage{setspace} % Single- oder Onehalfspacing
37 %\setcounter{tocdepth}{4} % 4 Hirarchien im Inhaltsv.
38 \usepackage{times} % Times als Schrift
39 \usepackage{amsmath,amssymb,amstext}% Mathematische Symbole
40 \usepackage{url} % Darstellung von URLs
43 %%% Optional, je nach Dokument
44 % \usepackage{listings} % Quelltext-Listings
45 % \usepackage{units} % Technische Units
46 % \usepackage{psfrag} % Ersetzts PS-Schriften
47 % \usepackage{color} % Farben in LaTeX
48 % \usepackage{floatflt} % Textumflossene Bilder...
49 % \usepackage{picins} % Textumflossene Bilder
50 % \usepackage{textcomp} % Spezielle Zeichen
51 % \usepackage[small,compact]{titlesec} % Überschriften mit wenig Platz
52 % \usepackage{gensymb} % Spezielle Zeichen
53 % \usepackage{eurosym} % Euro-Symbol
56 \usepackage{scrpage2} % KOMA-Überschriften und -Fußzeilen.
58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
60 \usepackage[pdftex]{graphicx}
61 \DeclareGraphicsExtensions{.pdf}
71 bookmarksnumbered=false,
75 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
78 %%% Eigene Funktionen {{{
79 %%% Beispiel: \bild{200pt}{foo}{That's a foo\ldots}
80 \newcommand{\bild}[3]{
82 \includegraphics[width=#1, keepaspectratio=true]{#2}
88 \newcommand{\kbd}[1]{\texttt{#1}}
89 \newcommand{\commandlistbegin}{
93 \newcommand{\commandlistend}{
96 \newcommand{\command}[2]{
97 \texttt{#1} & \quad #2 \\
101 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
103 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
105 \pagestyle{scrheadings}
106 % \pagestyle{fancyhdrs}
109 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
111 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
112 %%% Seitenkopf- und -Fußzeilen {{{
113 \automark[subsection*]{section} % \left- und \rightmark bekommen Inhalt
114 %%% Oben: Links, Mitte, Rechts
115 \ihead[]{{\Huge GRML-Zsh-Refcard}}
117 \ohead[]{Generated: \today}
118 %%% Unten: Links, Mitte, Rechts
119 \ifoot[]{\vspace{-3pt}GRML-Zsh-Refcard}
121 \ofoot[]{\vspace{-3pt}\copyright 2005-2011 \href{mailto:julius@grml.org}{Julius Plenz},
122 \href{mailto:mika@grml.org}{Michael Prokop} and
123 \href{mailto:ft@grml.org}{Frank Terbeck}}
125 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
127 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
129 % \setlength{\parindent}{17pt} % Einzug 17pt,
130 % \setlength{\parskip}{2pt} % keine Leerzeilen.
132 % \textwidth 127mm % Textbreite
133 % \textheight 235mm % Texthöhe
134 % \topmargin -5mm % Abstand oben
135 % \oddsidemargin 7mm % Abstand Links, onepage
137 %\onehalfspacing % Zeilenabstand: Bei korrektur,
138 \singlespacing % bei Abgabe
140 % Punkt- und Komma Abstände bei Tausendern/
141 % Dezimalzahlen ans deutsche anpassen!
145 \setlength{\emergencystretch}{2em} % Notfallsstreckung
147 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
149 \addtolength{\voffset}{10pt}
150 \renewcommand{\figurename}{Abb.}
153 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
155 %\pagenumbering{none} % Für die Titelseite: Keine Seitennummern,
156 %\thispagestyle{empty} % keine Kopf- und Fußzeilen.
164 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
166 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
167 %%% Inhaltsverzeichnis {{{
168 \pagenumbering{arabic} % Arabische Nummerierung
169 % \pagenumbering{roman} % Kleine, römische Nummerierung
170 % \tableofcontents % Das Inhaltsverzeichnis
171 % \listoffigures % Verzeichnis aller Abbildungen
172 % \listoftables % Verzeichnis aller Tabellen
173 % \pagenumbering{arabic} % ...und wieder Arabisch
176 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
178 % we won't be using math mode much, so redefine some of the characters
179 % we might want to talk about
188 \setlength{\tabcolsep}{0pt}
190 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
194 %\section{GRML's Zsh-Setup Reference Card}
196 \subsection*{Configuration files}
198 \small{Grml's zsh configuration is located in \textbf{/etc/zsh/zshrc}. Please
199 note that some functions/aliases are not active by default for user root
200 (referred to as '... for user (grml)' below) for of security reasons.
201 If you want your root user to use the full setup on your box, put
202 \textbf{GRML\_ALWAYS\_LOAD\_ALL=1} into root's \kbd{\~}/.zshrc.pre.
203 Some aliases/functions are not activated if the appropriate executable
204 isn't present on your system, either.
206 You can adjust the grml setup globally to your systems via a file
207 named /etc/zsh/zshrc.local, which is not under the control of Debian package
210 Put important commands which you need on a regular basis into a file named
211 \textbf{\kbd{\~}/.important\_commands}.
213 You can put personal configuration for a user into a file named
214 \textbf{\kbd{\~}/.zshrc.local}. Changes you need to have sourced
215 \textbf{before} the grml zsh setup is loaded can be put into
216 \textbf{\kbd{\~}/.zshrc.pre}.
218 More information regarding configuration files and some environment
219 variables to adjust runtime behaviour of grml's zsh can be accessed by
220 running \textbf{zsh-help}.
222 \subsection*{Using grml's zsh configuration on a non-grml system}
224 You do not have to use grml/Debian to use grml's zsh configuration.
225 Just retrieve and install the configuration files in your home directory.
226 You can do this by running:
230 wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
234 This is \textbf{different} from earlier versions of grml's zsh setup.
235 You only use the zshrc file from /etc/zsh/ \textbf{not} the .zshrc file
236 from /etc/skel/ these days. You can remove \kbd{\~}/.zshrc.global if it is
237 still present in your home directory.
239 \subsection*{Problems?}
241 Please report any problems you encounter while using the grml zsh
242 configuration to the grml team. The configuration has been tested on several
243 Linux distributions (Debian, Gentoo, SuSE, etc) and non-Linux systems as well
244 (FreeBSD, Solaris, AIX, etc), but there might be issues, anyway.
245 \href{http://grml.org/bugs/}{Report them, please!}
247 \subsection*{Settings}
249 If not already defined, these variables are set to the following
256 \subsection*{Keybindings}
258 Default keybinding mode is Emacs, i.e. you can use Emacs keybinds like
259 \kbd{^A {\rm or} ^E} on the command line. However, you can switch to vi
263 \command{setopt emacs}{Switch to Emacs mode (default)}
264 \command{setopt vi}{Switch to vi mode}
268 The following documents some important keybindings which are not
269 defined in zsh's default configuration. Hint: press <tab> twice when completing
270 a command you installed which is not yet known to zsh or run 'rehash' manually.
273 @@INSERT-keybindings@@
278 \subsection*{Terminal Settings}
280 There are 8 aliases designed to change the font size of terminal
281 emulators (XTerm, Aterm, etc). They are:
294 Directory hashes are shortcuts for common directories. You can
295 expand them by typing \kbd{\~{}hash}. Usage: 'cd \kbd{\~}doc'
298 @@INSERT-hasheddirs@@
301 \subsection*{System-Wide Aliases}
304 @@INSERT-aliases-system@@
307 \subsection*{Global Functions}
310 @@INSERT-functions-system@@
311 @@INSERT-functions-services@@
315 \subsection*{Debian commands}
317 Please note: if not executed as root, these aliases try to run the command via sudo.
320 @@INSERT-aliases-debian@@
321 @@INSERT-functions-debian@@
324 \subsection*{Aliases for user (grml)}
327 @@INSERT-aliases-user@@
330 \subsection*{Abbreviation expansion for user (grml)}
332 As of version 0.9, grml does not enable global aliases anymore. Instead, a
333 feature similiar to vim's 'iab' was added. The default key-sequence to trigger
334 the expansion is ',.'.
339 \kbd{co}\begin{Huge},.\end{Huge} \quad expands to: \kbd{./configure \&\& make \&\& sudo make install}
342 The configuration of this feature and its implementation are described on the zsh wiki
343 <\url{http://zshwiki.org/home/examples/zleiab}>.
347 %\vspace{35pt} % temporary hack for alignment of columns/rows
351 Most of the normal aliases are also added to this database, so you may expand them
356 \subsection*{Functions for user (grml)}
361 @@INSERT-functions-search@@
368 @@INSERT-functions-shortcuts@@
371 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
372 % Dieser Trenner muss eingefügt werden, wenn eine Tabelle zu lang ist
373 % und daher nicht von LaTeX umbrochen wird.
377 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
381 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
383 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
384 %%% Bibliographieverzeichnis {{{
387 %\bibliographystyle{plaindin}
388 %\bibliography{quellen}
390 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
394 %%% vim:set ai tw=80 fdm=marker: EOF