grml-zsh-refcard.tex.in

   1 \documentclass[8pt,             % 8pt
   2                a4paper,         % A4
   3                oneside,         % Einseitig
   4                DIV20,           % Papiergröße
   5              % DIV15,           % Größer
   6              % draft,           % Entwurf
   7                headsepline,     % Trennlinie oben
   8                footsepline,     % -""-       unten
   9                smallheadings,   % Kleine Überschriften
  10              % pointlessnumbers,% Keine Punkte
  11                halfparskip,     % Halbe Zeile Absatz statt Einzug
  12                nochapterprefix, % Kein "Kapitel"
  13              % bibtotoc         % "Literatur" im TOC  oder
  14              % bibtotocnumbered,% -""-, nummeriert
  15              % idxtotoc,        % Index im TOC
  16                twocolumn
  17               ]{scrartcl}
  18
  19 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  20 %%% Pakete {{{
  21 \usepackage[latin1]{inputenc}       % ISO-Umlaute
  22 \usepackage[T1]{fontenc}            % T1-kodierte Fonts
  23 \usepackage{ae,aecompl}             % Kodierung für PDF
  24 %\usepackage{ngerman}                % Deutsche Trennungen,
  25                                     % dt. Begriffe
  26 \usepackage{setspace}               % Single- oder Onehalfspacing
  27 %\setcounter{tocdepth}{4}            % 4 Hirarchien im Inhaltsv.
  28 \usepackage{times}                  % Times als Schrift
  29 \usepackage{amsmath,amssymb,amstext}% Mathematische Symbole
  30 \usepackage{url}                    % Darstellung von URLs
  31 \usepackage{calc}
  32
  33 %%% Optional, je nach Dokument
  34 % \usepackage{listings}             % Quelltext-Listings
  35 % \usepackage{units}                % Technische Units
  36 % \usepackage{psfrag}               % Ersetzts PS-Schriften
  37 % \usepackage{color}                % Farben in LaTeX
  38 % \usepackage{floatflt}             % Textumflossene Bilder...
  39 % \usepackage{picins}               % Textumflossene Bilder
  40 % \usepackage{textcomp}             % Spezielle Zeichen
  41 % \usepackage[small,compact]{titlesec}             % Überschriften mit wenig Platz
  42 % \usepackage{gensymb}              % Spezielle Zeichen
  43 % \usepackage{eurosym}              % Euro-Symbol
  44
  45 %%% Layout
  46 \usepackage{scrpage2}               % KOMA-Überschriften und -Fußzeilen.
  47 %%% }}}
  48 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  49
  50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  51 %%% PDF {{{
  52 \newif\ifpdf
  53   \ifx\pdfoutput\undefined
  54     \pdffalse
  55   \else
  56     \pdfoutput=1
  57     \pdftrue
  58   \fi
  59
  60 \ifpdfoutput{
  61   \usepackage[pdftex]{graphicx}
  62   \DeclareGraphicsExtensions{.pdf}
  63   \pdfcompresslevel=9
  64   \usepackage[%
  65     pdftex=true,
  66     backref=true,
  67     colorlinks=true,
  68     bookmarks=true,
  69     breaklinks=true,
  70     linktocpage=true,
  71     bookmarksopen=false,
  72     bookmarksnumbered=false,
  73     pdfpagemode=None
  74   ]{hyperref}
  75 }{
  76   \usepackage[dvips]{graphicx}
  77   \DeclareGraphicsExtensions{.eps}
  78   % \usepackage[%
  79   %   dvips,
  80   %   breaklinks=true,
  81   %   colorlinks=false
  82   % ]{hyperref}
  83 }
  84 %%% }}}
  85 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  86
  87 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  88 %%% Eigene Funktionen {{{
  89 %%% Beispiel:  \bild{200pt}{foo}{That's a foo\ldots}
  90 \newcommand{\bild}[3]{
  91   \begin{figure}
  92     \includegraphics[width=#1, keepaspectratio=true]{#2}
  93     \caption{#3}
  94     \label{#2}
  95   \end{figure}
  96 }
  97
  98 \newcommand{\kbd}[1]{\texttt{#1}}
  99 \newcommand{\commandlistbegin}{
 100   \vspace{3pt}
 101   \begin{tabular}{ll}
 102 }
 103 \newcommand{\commandlistend}{
 104   \end{tabular}
 105 }
 106 \newcommand{\command}[2]{
 107   \texttt{#1} & \quad #2 \\
 108 }
 109
 110 %%% }}}
 111 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 112
 113 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 114 %%% Pagestyle {{{
 115   \pagestyle{scrheadings}
 116 % \pagestyle{fancyhdrs}
 117 % \pagestyle{empty}
 118 %%% }}}
 119 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 120
 121 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 122 %%% Seitenkopf- und -Fußzeilen {{{
 123  \automark[subsection*]{section} % \left- und \rightmark bekommen Inhalt
 124 %%% Oben: Links, Mitte, Rechts
 125  \ihead[]{{\Huge GRML-Zsh-Refcard}}
 126  \chead[]{}
 127  \ohead[]{Generated: \today}
 128 %%% Unten: Links, Mitte, Rechts
 129  \ifoot[]{\vspace{-3pt}GRML-Zsh-Refcard}
 130  \cfoot[]{}
 131  \ofoot[]{\vspace{-3pt}\copyright 2005-2008 \href{mailto:julius@grml.org}{Julius Plenz},
 132  \href{mailto:mika@grml.org}{Michael Prokop} and
 133  \href{mailto:ft@grml.org}{Frank Terbeck}}
 134 %%% }}}
 135 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 136
 137 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 138 %%% Sonstiges {{{
 139 % \setlength{\parindent}{17pt}      % Einzug 17pt,
 140 % \setlength{\parskip}{2pt}         % keine Leerzeilen.
 141
 142 % \textwidth      127mm             % Textbreite
 143 % \textheight     235mm             % Texthöhe
 144 % \topmargin     -5mm               % Abstand oben
 145 % \oddsidemargin  7mm               % Abstand Links, onepage
 146
 147 %\onehalfspacing                    % Zeilenabstand: Bei korrektur,
 148  \singlespacing                     % bei Abgabe
 149
 150 % Punkt- und Komma Abstände bei Tausendern/
 151 % Dezimalzahlen ans deutsche anpassen!
 152  \mathcode`,="013B
 153  \mathcode`.="613A
 154
 155  \setlength{\emergencystretch}{2em} % Notfallsstreckung
 156 %%% }}}
 157 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 158
 159 \addtolength{\voffset}{10pt}
 160 \renewcommand{\figurename}{Abb.}
 161 \begin{document}
 162
 163 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 164 %%% Titelseite {{{
 165 %\pagenumbering{none}                % Für die Titelseite: Keine Seitennummern,
 166 %\thispagestyle{empty}               % keine Kopf- und Fußzeilen.
 167 %
 168 %\begin{center}
 169 %
 170 %\end{center}
 171 %\newpage
 172 %
 173 %%% }}}
 174 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 175
 176 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 177 %%% Inhaltsverzeichnis {{{
 178   \pagenumbering{arabic}            % Arabische Nummerierung
 179 % \pagenumbering{roman}             % Kleine, römische Nummerierung
 180 % \tableofcontents                  % Das Inhaltsverzeichnis
 181 % \listoffigures                    % Verzeichnis aller Abbildungen
 182 % \listoftables                     % Verzeichnis aller Tabellen
 183 % \pagenumbering{arabic}            % ...und wieder Arabisch
 184 % \newpage
 185 %%% }}}
 186 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 187
 188 % we won't be using math mode much, so redefine some of the characters
 189 % we might want to talk about
 190 \catcode`\^=12
 191 \catcode`\_=12
 192
 193 \chardef\\=`\\
 194 \chardef\{=`\{
 195 \chardef\}=`\}
 196
 197 \parskip=0pt
 198 \setlength{\tabcolsep}{0pt}
 199
 200 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 201 %%% Inhalt {{{
 202
 203 %Schon in lhead
 204 %\section{GRML's Zsh-Setup Reference Card}
 205
 206 \subsection*{Configuration files}
 207
 208 \small{The global zsh configuration is located in \textbf{/etc/zsh/zshrc}. User
 209 specific settings are defined in \textbf{/etc/skel/.zshrc} (which can be found
 210 in \kbd{\~}/.zshrc of the user grml, as well). Please note that some
 211 functions/aliases are not active by default for user root (referred to as
 212 '... for user (grml)' below) for of security reasons. Simply run 'zshskel'
 213 (as root) to source /etc/skel/.zshrc. Some aliases/functions are not activated
 214 if the appropriate executable isn't present on your system, either.
 215
 216 /etc/zsh/zshrc: this file can be adjusted according to your needs via a file
 217 named /etc/zsh/zshrc.local, which is not under the control of Debian package
 218 management. This, you need to place all your changes in the file
 219 /etc/zsh/zshrc.local. If you do not have write permission to
 220 /etc/zsh/zshrc, copy the file /etc/zsh/zshrc to \kbd{\~}/.zshrc.global
 221 and it will be sourced by \kbd{\~}/.zshrc.
 222
 223 Put important commands which you need on a regular basis into a file named
 224 \textbf{\kbd{\~}/.important\_commands}.
 225
 226 Note that /etc/skel/.zshrc itself is not sourced by zsh, but copied to the
 227 \$HOME-directory of your non-root user on user creation. To keep your
 228 \textbf{\kbd{\~}/.zshrc} in sync with upstream's development, just put your
 229 personal stuff into a file named \textbf{\kbd{\~}/.zshrc.local} and point your
 230 \kbd{\~}/.zshrc to /etc/skel/.zshrc by running 'ln -s /etc/skel/.zshrc
 231 \kbd{\~}/.zshrc'.}
 232
 233 More information regarding configuration files and some environment
 234 variables to adjust runtime behaviour of grml's zsh can be accessed by
 235 running \textbf{zsh-help}.
 236
 237 \subsection*{Using grml's zsh configuration on a non-grml system}
 238
 239 You do not have to use grml/Debian to use grml's zsh configuration.
 240 Just retrieve and install the configuration files in your home directory.
 241 You can do this by running:
 242
 243 \begin{tiny}
 244 \begin{verbatim}
 245 wget -O .zshrc        http://git.grml.org/f/grml-etc-core/etc/skel/.zshrc
 246 wget -O .zshrc.global http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
 247 \end{verbatim}
 248 \end{tiny}
 249
 250 \subsection*{Problems?}
 251
 252 Please report any problems you encounter while using the grml zsh
 253 configuration to the grml team. The configuration has been tested on several
 254 Linux distributions (Debian, Gentoo, SuSE, etc) and non-Linux systems as well
 255 (FreeBSD, Solaris, AIX, etc), but there might be issues, anyway.
 256 \href{http://grml.org/bugs/}{Report them, please!}
 257
 258 \subsection*{Settings}
 259
 260 If not already defined, these variables are set to the following
 261 values:
 262
 263 \commandlistbegin
 264 @@INSERT-variables@@
 265 \commandlistend
 266
 267 \commandlistbegin
 268 \command{umask @@INSERT-other-umask@@}{new files automatically get permissions \kbd{@@INSERT-other-umaskstr@@}}
 269 \command{umask @@INSERT-other-r_umask@@}{new files for root user \kbd{@@INSERT-other-r_umaskstr@@}}
 270 \commandlistend
 271
 272 \subsection*{Key-bindings}
 273
 274 Default keybinding mode is Emacs, i.e. you can use Emacs keybinds like
 275 \kbd{^A {\rm or} ^E} on the command line. However, you can switch to vi
 276 mode.
 277
 278 \commandlistbegin
 279 \command{setopt emacs}{Switch to Emacs mode (default)}
 280 \command{setopt vi}{Switch to vi mode}
 281 \commandlistend
 282
 283 \vspace{8pt}
 284 The following documents some important keybindings which are not
 285 defined in zsh's default configuration. Hint: press <tab> twice when completing
 286 a command you installed which is not yet known to zsh or run 'rehash' manually.
 287
 288 \commandlistbegin
 289 @@INSERT-keybindings@@
 290 \commandlistend
 291
 292 \newpage
 293
 294 \subsection*{Terminal Settings}
 295
 296 There are 8 aliases designed to change the font size of terminal
 297 emulators (XTerm, Aterm, etc). They are:
 298 \kbd{hide},
 299 \kbd{tiny},
 300 \kbd{small},
 301 \kbd{medium},
 302 \kbd{default},
 303 \kbd{large},
 304 \kbd{huge},
 305 \kbd{smartfont},
 306 \kbd{semifont}.
 307
 308 \subsection*{Hashes}
 309
 310 Directory hashes are shortcuts for common directories. You can
 311 expand them by typing \kbd{\~{}hash}. Usage: 'cd \kbd{\~}doc'
 312
 313 \commandlistbegin
 314 @@INSERT-hasheddirs@@
 315 \commandlistend
 316
 317 \subsection*{System-Wide Aliases}
 318
 319 \commandlistbegin
 320 @@INSERT-aliases-system@@
 321 \commandlistend
 322
 323 \subsection*{Global Functions}
 324
 325 \commandlistbegin
 326 @@INSERT-functions-system@@
 327 @@INSERT-functions-services@@
 328 \commandlistend
 329
 330 \vspace{8pt}
 331 \subsection*{Debian commands}
 332
 333 Please note: if not executed as root, these aliases try to run the command via sudo.
 334
 335 \commandlistbegin
 336 @@INSERT-aliases-debian@@
 337 @@INSERT-functions-debian@@
 338 \commandlistend
 339
 340 \subsection*{Aliases for user (grml)}
 341
 342 \commandlistbegin
 343 @@INSERT-aliases-user@@
 344 \commandlistend
 345
 346 \subsection*{Abbreviation expansion for user (grml)}
 347
 348 As of version 0.9, grml does not enable global aliases anymore. Instead, a
 349 feature similiar to vim's 'iab' was added. The default key-sequence to trigger
 350 the expansion is ',.'.
 351
 352 Example:
 353
 354 \commandlistbegin
 355 \kbd{co}\begin{Huge},.\end{Huge} \quad expands to: \kbd{./configure \&\& make \&\& sudo make install}
 356 \commandlistend
 357
 358 The configuration of this feature and its implementation are described on the zsh wiki
 359 <\url{http://zshwiki.org/home/examples/zleiab}>.
 360
 361 \commandlistbegin
 362 @@INSERT-abbrev@@
 363 %\vspace{35pt} % temporary hack for alignment of columns/rows
 364 \commandlistend
 365
 366 \vspace{12pt}
 367 Most of the normal aliases are also added to this database, so you may expand them
 368 like this as well.
 369
 370 %\pagebreak
 371
 372 \subsection*{Functions for user (grml)}
 373
 374 \textbf{Searching}
 375
 376 \commandlistbegin
 377 @@INSERT-functions-search@@
 378 \commandlistend
 379
 380 \vspace{12pt}
 381 \textbf{Shortcuts}
 382
 383 \commandlistbegin
 384 @@INSERT-functions-shortcuts@@
 385 \commandlistend
 386
 387 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 388 % Dieser Trenner muss eingefügt werden, wenn eine Tabelle zu lang ist
 389 % und daher nicht von LaTeX umbrochen wird.
 390 %\commandlistend
 391 %
 392 %\commandlistbegin
 393 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 394
 395
 396 %%% }}}
 397 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 398
 399 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 400 %%% Bibliographieverzeichnis {{{
 401 %\newpage
 402 %\nocite{*}
 403 %\bibliographystyle{plaindin}
 404 %\bibliography{quellen}
 405 %%% }}}
 406 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 407
 408 \end{document}
 409
 410 %%% vim:set ai tw=80 fdm=marker:   EOF