doc/grmlzshrc.t2t

   1 GRMLZSHRC
   2
   3 August, 2009
   4
   5 %!target: man
   6 %!postproc(man): "^(\.TH.*) 1 "  "\1 5 "
   7
   8
   9 = NAME =
  10 grmlzshrc - grml's zsh setup
  11
  12
  13 = SYNOPSIS =
  14 //zsh// [**options**]...
  15
  16
  17 = DESCRIPTION =
  18 The grml project provides a fairly exhaustive interactive setup (referred to
  19 as //grmlzshrc// throughout this document) for the amazing unix shell zsh
  20 (http://zsh.sourceforge.net). This is the reference manual for that
  21 setup.
  22
  23 To use //grmlzshrc//, you need at least version 3.1.7 of zsh (although not all
  24 features are enabled in every version).
  25
  26 //grmlzshrc// behaves differently depending on which user loads it. For the
  27 root user (**EUID** == 0) only a subset of features is loaded by default. This
  28 behaviour can be altered by setting the **GRML_ALWAYS_LOAD_ALL** STARTUP
  29 VARIABLE (see below).
  30
  31 = STARTUP VARIABLES =
  32 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
  33 variables. These may be set temporarily when starting zsh like this:
  34 \
  35 ``` % BATTERY=1 zsh
  36
  37 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
  38
  39 : **BATTERY**
  40 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
  41 put the battery status into the right hand side interactive prompt.
  42
  43
  44 = FEATURE DESCRIPTION =
  45 This is an in depth description of non-standard features implemented by
  46 //grmlzshrc//.
  47
  48 == DIRSTACK HANDLING ==
  49 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
  50 file each time zsh's working directory is changed. That file can be configured
  51 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
  52 **DIRSTACKSIZE** variable defaults to **20** in this setup.
  53
  54 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
  55 zshs inherit the dirstack of the zsh that most recently updated
  56 **DIRSTACKFILE**.
  57
  58 == DIRECTORY BASED PROFILES ==
  59 If you want certain settings to be active in certain directories (and
  60 automatically switch back and forth between them), this is what you want.
  61 \
  62 ```
  63 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)'   profile grml
  64 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
  65 ```
  66
  67 When that's done and you enter a directory that matches the pattern
  68 in the third part of the context, a function called chpwd_profile_grml,
  69 for example, is called (if it exists).
  70
  71 If no pattern matches (read: no profile is detected) the profile is
  72 set to 'default', which means chpwd_profile_default is attempted to
  73 be called.
  74
  75 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
  76 command) which is used: The third part in the context is matched against
  77 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
  78 Because that way the profile is detected for all these values of **$PWD**:
  79 \
  80 ```
  81 /foo/bar
  82 /foo/bar/
  83 /foo/bar/baz
  84 ```
  85
  86 So, if you want to make double damn sure a profile works in /foo/bar
  87 and everywhere deeper in that tree, just use (|/|/*) and be happy.
  88
  89 The name of the detected profile will be available in a variable called
  90 'profile' in your functions. You don't need to do anything, it'll just
  91 be there.
  92
  93 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
  94 that was active up to now. That way you can avoid running code for a
  95 profile that is already active, by running code such as the following
  96 at the start of your function:
  97 \
  98 ```
  99 function chpwd_profile_grml() {
 100     [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
 101     ...
 102 }
 103 ```
 104
 105 The initial value for **$CHPWD_PROFILE** is 'default'.
 106
 107 === Signaling availabily/profile changes ===
 108
 109 If you use this feature and need to know whether it is active in your
 110 current shell, there are several ways to do that. Here are two simple
 111 ways:
 112
 113 a) If knowing if the profiles feature is active when zsh starts is
 114    good enough for you, you can put the following snippet into your
 115    //.zshrc.local//:
 116 \
 117 ```
 118 (( ${+functions[chpwd_profiles]} )) &&
 119     print "directory profiles active"
 120 ```
 121
 122 b) If that is not good enough, and you would prefer to be notified
 123    whenever a profile changes, you can solve that by making sure you
 124    start **every** profile function you create like this:
 125 \
 126 ```
 127 function chpwd_profile_myprofilename() {
 128     [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
 129     print "chpwd(): Switching to profile: $profile"
 130   ...
 131 }
 132 ```
 133
 134 That makes sure you only get notified if a profile is **changed**,
 135 not everytime you change directory.
 136
 137 === Version requirement ===
 138 This feature requires zsh //4.3.3// or newer.
 139
 140
 141 == ACCEPTLINE WRAPPER ==
 142 The //accept-line// wiget is the one that is taking action when the **return**
 143 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
 144 functionality.
 145
 146 This wrapper is configured via styles. That means, you issue commands, that look
 147 like:
 148 \
 149 ```
 150 zstyle 'context' style value
 151 ```
 152
 153 The context namespace, that we are using is 'acceptline'. That means, the actual
 154 context for your commands look like: **':acceptline:<subcontext>'**.
 155
 156 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
 157 or **empty**.
 158
 159
 160 === Recognized Contexts ===
 161 : **default**
 162 This is the value, the context is initialized with.
 163 The //compwarnfmt and //rehash// styles are looked up in this context.
 164
 165 : **normal**
 166 If the first word in the command line is either a command, alias, function,
 167 builtin or reserved word, you are in this context.
 168
 169 : **force**
 170 This is the context, that is used if you hit enter again, after being warned
 171 about the existence of a _completion for the non-existing command you
 172 entered.
 173
 174 : **empty**
 175 This is the context, you are in if the command line is empty or only
 176 consists of whitespace.
 177
 178 : **misc**
 179 This context is in effect, if you entered something that does not match any
 180 of the above. (e.g.: variable assignments).
 181
 182
 183 === Available Styles ===
 184 : **nocompwarn**
 185 If you set this style to true, the warning about non existent commands,
 186 for which completions exist will not be issued. (Default: **false**)
 187
 188 : **compwarnfmt**
 189 The message, that is displayed to warn about the _completion issue.
 190 (default: **'%c will not execute and completion %f exists.'**)
 191 '%c' is replaced by the command name, '%f' by the completion's name.
 192
 193 : **rehash**
 194 If this is set, we'll force rehashing, if appropriate. (Defaults to
 195 **true** in //grmlzshrc//).
 196
 197 : **actions**
 198 This can be a list of wigdets to call in a given context. If you need a
 199 specific order for these to be called, name them accordingly. The default value
 200 is an **empty list**.
 201
 202 : **default_action**
 203 The name of a widget, that is called after the widgets from 'actions'.
 204 By default, this will be '.accept-line' (which is the built-in accept-line
 205 widget).
 206
 207 : **call_default**
 208 If true in the current context, call the widget in the 'default_action'
 209 style. (The default is **true** in all contexts.)
 210
 211
 212 == PROMPT ==
 213
 214
 215 == GNU/SCREEN STATUS SETTING ==
 216 //grmlzshrc// sets screen's hardstatus lines to the currently running command
 217 or **'zsh'** if the shell is idling at its prompt. If the current working
 218 directory is inside a repository unter version control, screen status is set
 219 to: **'zsh: <repository name>'** via zsh's vcs_info.
 220
 221
 222 == PERSISTENT HISTORY ==
 223 If you got commands you consider important enough to be included in every
 224 shell's history, you can put them into ~/.important_commands and they will be
 225 available via the usual history lookup widgets.
 226
 227
 228 = REFERENCE =
 229 == KEYBINDINGS ==
 230 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
 231 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
 232 on PC keyboards.
 233
 234 : **ESC-e**
 235 Edit the current command buffer in your favourite editor.
 236
 237
 238 == SHELL FUNCTIONS ==
 239 //grmlzshrc// comes with a wide array of defined shell functions to ease the
 240 user's life.
 241
 242 : **2html()**
 243 Converts plaintext files to HTML using vim. The output is written to
 244 <filename>.html.
 245
 246 : **doc()**
 247 Takes packagename as argument. Sets current working directory to
 248 /usr/share/doc/<packagename> and prints out a directory listing.
 249
 250 : **hex()**
 251 Prints the hexadecimal representation of the number supplied as argument
 252 (base ten only).
 253
 254 : **readme()**
 255 Opens all README-like files in current working directory with the program
 256 defined in the $PAGER environment variable.
 257
 258 : **startx()**
 259 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
 260 issues a Warning to use the grml-x(1) script. Can be overridden by using
 261 /usr/bin/startx directly.
 262
 263 : **urlencode()**
 264 Takes a string as its first argument and prints it RFC 2396 URL encoded to
 265 standard out.
 266
 267 : **xinit()**
 268 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
 269 issues a Warning to use the grml-x(1) script. Can be overridden by using
 270 /usr/bin/xinit directly.
 271
 272
 273 == ALIASES ==
 274 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
 275 life.
 276
 277 : **cmplayer** (//mplayer -vo fbdev//)
 278 Video player with framebuffer as video output device, so you can watch
 279 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
 280 while watching a movie.
 281
 282 : **da** (//du -sch//)
 283 Prints the summarized disk usage of the arguments as well as a grand total
 284 in human readable format.
 285
 286 : **fblinks** (//links2 -driver fb//)
 287 A Web browser on the framebuffer device. So you can browse images and click
 288 links on the virtual tty.
 289
 290 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
 291 Fullscreen Video player with the framebuffer as video output device. So you
 292 can watch videos on a virtual tty.
 293
 294 : **g** (//git//)
 295 Revision control system by Linus Torvalds.
 296
 297 : **http** (//python -m SimpleHTTPServer//)
 298 Basic HTTP server implemented in python. Listens on port 8000/tcp and
 299 serves current directory. Implements GET and HEAD methods.
 300
 301 : **j** (//jobs -l//)
 302 Prints status of jobs in the current shell session in long format.
 303
 304 : **md** (//mkdir -p//)
 305 Creates directory including parent directories, if necessary
 306
 307 : **rw-** (//chmod 600//)
 308 Grants read and write permission of a file to the owner and nobody else.
 309
 310 : **rwx** (//chmod 700//)
 311 Grants read, write and execute permission of a file to the owner and nobody
 312 else.
 313
 314 : **r--** (//chmod 644//)
 315 Grants read and write permission of a file to the owner and read-only to
 316 anybody else.
 317
 318 : **r-x** (//chmod 755//)
 319 Grants read, write and execute permission of a file to the owner and
 320 read-only plus execute permission to anybody else.
 321
 322
 323 = AUXILIARY FILES =
 324 This is a set of files, that - if they exist - can be used to customize the
 325 behaviour of //grmlzshrc//.
 326
 327 : **.zshrc.pre**
 328 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
 329 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
 330 \
 331 ```
 332 # show battery status in RPROMPT
 333 BATTERY=1
 334 # always load the complete setup, even for root
 335 GRML_ALWAYS_LOAD_ALL=1
 336 ```
 337
 338 : **.zshrc.local**
 339 Sourced right before loading //grmlzshrc// is finished. There is a global
 340 version of this file (/etc/zsh/zshrc.local) which is sourced before the
 341 user-specific one.
 342
 343 : **.zdirs**
 344 Directory listing for persistent dirstack (see above).
 345
 346 : **.important_commands**
 347 List of commands, used by persistent history (see above).
 348
 349
 350 = INSTALLATION ON NON-DEBIAN SYSTEMS =
 351 On Debian systems (http://www.debian.org) - and possibly Ubuntu
 352 (http://www.ubuntu.com) and similar systems - it is very easy to get
 353 //grmlzshrc// via grml's .deb repositories.
 354
 355 On non-debian systems, that is not an option, but all is not lost:
 356 \
 357 ```
 358 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
 359 ```
 360
 361 If you would also like to get seperate function files (which you can put into
 362 your **$fpath**), you can browse and download them at:
 363
 364 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
 365
 366
 367 = CONTRIBUTING =
 368 If you want to help to improve grml's zsh setup, clone the grml-etc-core
 369 repository from git.grml.org:
 370 \
 371 ``` % git clone git://git.grml.org/grml-etc-core.git
 372
 373 Make your changes, commit them; use '**git format-patch**' to create a series
 374 of patches and send those to the following address via '**git send-email**':
 375 \
 376 ``` grml-etc-core@grml.org
 377
 378 Doing so makes sure the right people get your patches for review and
 379 possibly inclusion.
 380
 381
 382 = STATUS =
 383 This manual page is supposed to be a **reference** manual for //grmlzshrc//.
 384 That means that in contrast to the existing refcard it should document **every**
 385 aspect of the setup. That is currently **not** the case. Not for a long time
 386 yet. Contributions are highly welcome.
 387
 388
 389 = AUTHOR =
 390 This manpage was written by Frank Terbeck <ft@grml.org>.
 391
 392
 393 = COPYRIGHT =
 394 Copyright (c) 2009, grml project <http://grml.org>
 395
 396 This manpage is distributed under the terms of the GPL version 2.
 397
 398 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
 399 except for **accept-line()** and **vcs_info()**, which are distributed under
 400 the same conditions as zsh itself (which is BSD-like).