6 %!postproc(man): "^(\.TH.*) 1 " "\1 5 "
10 grmlzshrc - grml's zsh setup
14 //zsh// [**options**]...
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
23 To use //grmlzshrc//, you need at least version 3.1.7 of zsh (although not all
24 features are enabled in every version).
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). Also the umask(1) for the root user is set to 022,
30 while for regular users it is set to 002. So read/write permissions
31 for the regular user and her group are set for new files (keep that
32 in mind on systems, where regular users share a common group).
35 Some of the behaviour of //grmlzshrc// can be altered by setting certain shell
36 variables. These may be set temporarily when starting zsh like this:
40 Or by setting them permanently in **zshrc.pre** (See AUXILIARY FILES below).
43 If set to a value greater than zero and //acpi// installed, //grmlzshrc// will
44 put the battery status into the right hand side interactive prompt.
46 : **COMMAND_NOT_FOUND**
47 A non zero value activates a handler, which is called when a command can not
48 be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below).
50 : **GRML_ALWAYS_LOAD_ALL**
51 Enables the whole grml setup for root, if set to a non zero value.
53 : **GRML_ZSH_CNF_HANDLER**
54 This variable contains the handler to be used by COMMAND_NOT_FOUND (see above)
55 and defaults to "/usr/share/command-not-found/command-not-found".
57 : **GRMLSMALL_SPECIFIC**
58 Set this to zero to remove items in zsh config, which do not work in
62 Where zsh saves the history. Default: ${HOME}/.zsh_history.
65 Number of commands to be kept in the history. On a grml-CD this defaults to
66 500, on a hard disk installation to 5000.
69 Sets the frequency in seconds for zsh to check for new mail. Defaults to 30.
70 A value of zero turns off checking.
73 Non zero values deactivate automatic correction of commands.
76 If set to zero (default), allows selection from a menu, if there are at least
77 five possible options of completion.
80 A non zero value disables precmd and preexec commands. These are functions
81 that are run before every command (setting xterm/screen titles etc.).
84 Show time (user, system and cpu) used by external commands, if they run longer
85 than the defined number of seconds (default: 5).
88 Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a grml-CD
89 and to 10000 on an installation on hard disk.
91 : **ZSH_NO_DEFAULT_LOCALE**
92 Import "/etc/default/locale", if set to zero (default).
95 A non zero value causes shell functions to be profiled. The results can be
96 obtained with the zprof builtin command (see zshmodules(1) for details).
99 = FEATURE DESCRIPTION =
100 This is an in depth description of non-standard features implemented by
103 == DIRSTACK HANDLING ==
104 The dirstack in //grmlzshrc// has a persistent nature. It is stored into a
105 file each time zsh's working directory is changed. That file can be configured
106 via the **DIRSTACKFILE** variable and it defaults to **~/.zdirs**. The
107 **DIRSTACKSIZE** variable defaults to **20** in this setup.
109 The **DIRSTACKFILE** is loaded each time zsh starts, therefore freshly started
110 zshs inherit the dirstack of the zsh that most recently updated
113 == DIRECTORY BASED PROFILES ==
114 If you want certain settings to be active in certain directories (and
115 automatically switch back and forth between them), this is what you want.
118 zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
119 zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
122 When that's done and you enter a directory that matches the pattern
123 in the third part of the context, a function called chpwd_profile_grml,
124 for example, is called (if it exists).
126 If no pattern matches (read: no profile is detected) the profile is
127 set to 'default', which means chpwd_profile_default is attempted to
130 A word about the context (the ':chpwd:profiles:*' stuff in the zstyle
131 command) which is used: The third part in the context is matched against
132 **$PWD**. That's why using a pattern such as /foo/bar(|/|/*) makes sense.
133 Because that way the profile is detected for all these values of **$PWD**:
141 So, if you want to make double damn sure a profile works in /foo/bar
142 and everywhere deeper in that tree, just use (|/|/*) and be happy.
144 The name of the detected profile will be available in a variable called
145 'profile' in your functions. You don't need to do anything, it'll just
148 Then there is the parameter **$CHPWD_PROFILE** which is set to the profile,
149 that was active up to now. That way you can avoid running code for a
150 profile that is already active, by running code such as the following
151 at the start of your function:
154 function chpwd_profile_grml() {
155 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
160 The initial value for **$CHPWD_PROFILE** is 'default'.
162 === Signaling availabily/profile changes ===
164 If you use this feature and need to know whether it is active in your
165 current shell, there are several ways to do that. Here are two simple
168 a) If knowing if the profiles feature is active when zsh starts is
169 good enough for you, you can put the following snippet into your
173 (( ${+functions[chpwd_profiles]} )) &&
174 print "directory profiles active"
177 b) If that is not good enough, and you would prefer to be notified
178 whenever a profile changes, you can solve that by making sure you
179 start **every** profile function you create like this:
182 function chpwd_profile_myprofilename() {
183 [[ ${profile} == ${CHPWD_PROFILE} ]] && return 1
184 print "chpwd(): Switching to profile: $profile"
189 That makes sure you only get notified if a profile is **changed**,
190 not everytime you change directory.
192 === Version requirement ===
193 This feature requires zsh //4.3.3// or newer.
196 == ACCEPTLINE WRAPPER ==
197 The //accept-line// wiget is the one that is taking action when the **return**
198 key is hit. //grmlzshrc// uses a wrapper around that widget, which adds new
201 This wrapper is configured via styles. That means, you issue commands, that look
205 zstyle 'context' style value
208 The context namespace, that we are using is 'acceptline'. That means, the actual
209 context for your commands look like: **':acceptline:<subcontext>'**.
211 Where **<subcontext>** is one of: **default**, **normal**, **force**, **misc**
215 === Recognized Contexts ===
217 This is the value, the context is initialized with.
218 The //compwarnfmt and //rehash// styles are looked up in this context.
221 If the first word in the command line is either a command, alias, function,
222 builtin or reserved word, you are in this context.
225 This is the context, that is used if you hit enter again, after being warned
226 about the existence of a _completion for the non-existing command you
230 This is the context, you are in if the command line is empty or only
231 consists of whitespace.
234 This context is in effect, if you entered something that does not match any
235 of the above. (e.g.: variable assignments).
238 === Available Styles ===
240 If you set this style to true, the warning about non existent commands,
241 for which completions exist will not be issued. (Default: **false**)
244 The message, that is displayed to warn about the _completion issue.
245 (default: **'%c will not execute and completion %f exists.'**)
246 '%c' is replaced by the command name, '%f' by the completion's name.
249 If this is set, we'll force rehashing, if appropriate. (Defaults to
250 **true** in //grmlzshrc//).
253 This can be a list of wigdets to call in a given context. If you need a
254 specific order for these to be called, name them accordingly. The default value
255 is an **empty list**.
258 The name of a widget, that is called after the widgets from 'actions'.
259 By default, this will be '.accept-line' (which is the built-in accept-line
263 If true in the current context, call the widget in the 'default_action'
264 style. (The default is **true** in all contexts.)
270 == GNU/SCREEN STATUS SETTING ==
271 //grmlzshrc// sets screen's hardstatus lines to the currently running command
272 or **'zsh'** if the shell is idling at its prompt. If the current working
273 directory is inside a repository unter version control, screen status is set
274 to: **'zsh: <repository name>'** via zsh's vcs_info.
277 == PERSISTENT HISTORY ==
278 If you got commands you consider important enough to be included in every
279 shell's history, you can put them into ~/.important_commands and they will be
280 available via the usual history lookup widgets.
284 == ENVIRONMENT VARIABLES ==
285 //grmlzshrc// sets some environment variables, which influence the
286 behaviour of applications.
289 If X is running this is set to "firefox", otherwise to "w3m".
292 Set to "yes". Some applications read this to learn about properties
293 of the terminal they are running in.
296 If not already set, sets the default editor. Falls back to vi(1),
297 if vim(1) is not available.
300 The mailbox file for the current user is set to /var/mail/$USER, if not
301 already set otherwise.
304 Set less(1) as default pager, if not already set to something different.
307 Holds the path to shared files for the C++ application framework QT
311 Set explicitly to /bin/zsh, to prevent certain terminal emulators to
312 default to /bin/sh or /bin/bash.
316 Apart from zsh's default options, //grmlzshrc// sets some options
317 that change the behaviour of zsh. Options that change Z-shell's default
318 settings are marked by <grml>. But note, that zsh's defaults vary depending
319 on its emulation mode (csh, ksh, sh, or zsh). For details, see zshoptions(1).
322 Zsh sessions, that use //grmlzshrc//, will append their history list to the
323 history file, rather than replace it. Thus, multiple parallel zsh sessions
324 will all have the new entries from their history lists added to the history
325 file, in the order that they exit. The file will still be periodically
326 re-written to trim it when the number of lines grows 20% beyond the value
327 specified by $SAVEHIST.
330 If a command is issued that can't be executed as a normal command, and the
331 command is the name of a directory, perform the cd command to that directory.
333 : **auto_pushd** <grml>
334 Make cd push the old directory onto the directory stack.
336 : **completeinword** <grml>
337 If the cursor is inside a word, completion is done from both ends;
338 instead of moving the cursor to the end of the word first and starting
341 : **extended_glob** <grml>
342 Treat the '#', '~' and '^' characters as active globbing pattern characters.
344 : **extended_history** <grml>
345 Save each command's beginning timestamp (in seconds since the epoch) and the
346 duration (in seconds) to the history file.
349 Whenever a command completion is attempted, make sure the entire command
350 path is hashed first. This makes the first completion slower.
352 : **histignorealldups** <grml>
353 If a new command line being added to the history list duplicates an
354 older one, the older command is removed from the list, even if it is
355 not the previous event.
357 : **histignorespace** <grml>
358 Remove command lines from the history list when the first character on
359 the line is a space, or when one of the expanded aliases contains a
360 leading space. Note that the command lingers in the internal history
361 until the next command is entered before it vanishes.
363 : **longlistjobs** <grml>
364 List jobs in long format by default.
367 Avoid to beep on errors in zsh command line editing (zle).
370 A wildcard character never matches a leading '.'.
373 Do not send the hangup signal (HUP:1) to running jobs when the shell exits.
375 : **nonomatch** <grml>
376 If a pattern for filename generation has no matches, do not print an error
377 and leave it unchanged in the argument list. This also applies to file
378 expansion of an initial `~' or `='.
381 Report the status of background jobs immediately, rather than waiting until
382 just before printing a prompt.
384 : **pushd_ignore_dups** <grml>
385 Don't push multiple copies of the same directory onto the directory stack.
387 : **share_history** <grml>
388 As each line is added to the history file, it is checked to see if anything
389 else was written out by another shell, and if so it is included in the
390 history of the current shell too. Using !-style history, the commands from
391 the other sessions will not appear in the history list unless you explicitly
392 type the "history" command. This option is activated for zsh versions >= 4,
397 Apart from zsh's default key bindings, //grmlzshrc// comes with its own set of
398 key bindings. Note that bindings like **ESC-e** can also be typed as **ALT-e**
402 Edit the current command buffer in your favourite editor.
405 Deletes a word left of the cursor; seeing '/' as additional word separator.
408 Jump right after the first word.
411 Searches the last occurence of string before the cursor in the command history.
414 Brings a job, which got suspended with CTRL-z back to foreground.
417 == SHELL FUNCTIONS ==
418 //grmlzshrc// comes with a wide array of defined shell functions to ease the
422 Converts plaintext files to HTML using vim. The output is written to
425 : **855resolution()**
426 If 915resolution is available, issues a warning to the user to run it instead
427 to modify the resolution on intel graphics chipsets.
430 Lists files in current directory, which have been accessed within the
431 last N days. N is an integer to be passed as first and only argument.
432 If no argument is specified N is set to 1.
435 Searches for USENET postings from authors using google groups.
438 Sets all ulimit values to "unlimited".
441 Prints a colored table of available ansi color codes (to be used in escape
442 sequences) and the colors they represent.
444 : **aoeu(), asdf(), uiae()**
445 Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
449 Login on the host provided as argument using autossh. Then reattach a GNU screen
450 session if a detached session is around or detach a currently attached screen or
451 else start a new screen. This is especially useful for roadwarriors using GNU
455 Burns the files in ~/ripps (see audiorip() below) to an audio CD.
456 Then prompts the user if she wants to remove that directory. You might need
457 to tell audioburn which cdrom device to use like:
458 "DEVICE=/dev/cdrom audioburn"
461 Creates directory ~/ripps, if it does not exist. Then rips audio CD into
462 it. Then prompts the user if she wants to burn a audio CD with audioburn()
463 (see above). You might need to tell audiorip which cdrom device to use like:
464 "DEVICE=/dev/cdrom audioburn"
467 Simple backup of a file or directory using cp(1). The target file name is the
468 original name plus a time stamp attached. Symlinks and file attributes like mode,
469 ownership and timestamps are preserved.
472 The brltty(1) program provides a braille display, so a blind person can access
473 the console screen. This wrapper function works around problems with some
474 environments (f. e. utf8).
477 If the original cdrecord is not installed, issues a warning to the user to
478 use the wodim binary instead. Wodim is the debian fork of Joerg Schillings
482 Lists files in current directory, which have been changed within the
483 last N days. N is an integer to be passed as first and only argument.
484 If no argument is specified N is set to 1.
487 Returns true if given command exists either as program, function, alias,
488 builtin or reserved word. If the option -c is given, only returns true,
489 if command is a program.
492 Changes directory to $HOME on first invocation of zsh. This is neccessary on
493 grml systems with autologin.
496 Changes current directory to the one supplied by argument and lists the files
497 in it, including file names starting with ".".
500 Presents a numbered listing of the directory stack. Then changes current
501 working directory to the one chosen by the user.
504 Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers,
505 email addresses of submitters or any string given on the command line.
508 Shows bug report for debian given by number in mailbox format.
511 Tells the user to use grml-debootstrap, if she wants to install debian to
515 Shows the disk usage of the directories given in human readable format;
519 Translates C source code to assembly and ouputs both.
522 Takes packagename as argument. Sets current working directory to
523 /usr/share/doc/<packagename> and prints out a directory listing.
526 Renames image files based on date/time informations in their exif headers.
529 Opens given URL with Firefox (Iceweasel on Debian). If there is already an
530 instance of firefox running, attaches to the first window found and opens the
531 URL in a new tab (this even works across an ssh session).
533 : **fluxkey-change()**
534 Switches the key combinations for changing current workspace under fluxbox(1)
535 from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys.
536 Requires the window manager to reread configuration to take effect.
539 A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg",
540 ".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-<original
541 filename>". Creates an index.html with title "Images" showing the
542 thumbnails as clickable links to the respective original file.
543 //Warning:// On start genthumbs() silently removes a possibly existing "index.html"
544 and all files and/or directories beginning with "thumb-" in current directory!
547 Tries to download, unpack and run AIR (imaging software) version 1.2.8.
550 Tries to download and install Gizmo (VoIP software) for Debian.
553 Tries to download and install Skype (VoIP software) for Debian.
556 Downloads and installs newer version of Skype.
559 Tries to download and unpack X-lite (VoIP software) from counterpath.com into
563 Searches the zsh command history for a regular expression.
566 Prints the hexadecimal representation of the number supplied as argument
570 Outputs highlighted diff; needs highstring(1).
573 Shows source files in less(1) with syntax highlighting. Run "hl -h"
574 for detailed usage information.
577 Queries IMAP server (first parameter) for its capabilities. Takes
578 port number as optional second argument.
581 Returns true, if zsh version is equal or greater than 4, else false.
584 Returns true, if zsh version is equal or greater than 4.1, else false.
587 Returns true, if zsh version is equal or greater than 4.2, else false.
590 Returns true, if zsh version is equal or greater than 4.2.5, else false.
593 Returns true, if zsh version is equal or greater than 4.3, else false.
596 Returns true, if zsh version is equal or greater than 4.3.3, else false.
599 Returns true, if running on darwin, else false.
602 Returns true, if running on a grml system, else false.
605 Returns true, if running on a grml system from a live cd, else false.
608 Returns true, if run on grml-small, else false.
611 Changes every occurrence of the string iso885915 or ISO885915 in
612 environment variables to UTF-8.
615 Returns true, if run within an utf environment, else false.
618 Lists libraries that define the symbol containing the string given as
622 Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current
626 Prints specified range of (numbered) lines of a file.
627 Usage: linenr <start>[,<end>] <file>
630 Creates a PostScript and a PDF file (basename as first argument) from
634 Displays manpage in a streched style.
637 Creates directory including parent directories, if necessary. Then changes
638 current working directory to it.
641 Diffs the two arguments recursively and writes the
642 output (unified format) to a timestamped file.
645 Prints the summarized memory usage in bytes.
647 : **minimal-shell()**
648 Spawns a minimally set up MirBSD Korn shell. It references no files in /usr,
649 so that file system can be unmounted.
652 Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and
653 replaces spaces in file names with underscores. Then mkaudiocd()
654 normalizes the files and recodes them to WAV.
657 Creates an iso9660 filesystem image with Rockridge and Joliet extensions
658 enabled using mkisofs(8). Prompts the user for volume name, filename and
662 Creates a directory with first parameter as name inside $MAILDIR_ROOT
663 (defaults to $HOME/Mail) and subdirectories cur, new and tmp.
666 Runs "make install" and logs the output under ~/.errorlogs/; useful for
667 a clean deinstall later.
670 Lists files in current directory, which have been modified within the
671 last N days. N is an integer to be passed as first and only argument.
672 If no argument is specified N is set to 1.
675 Recodes an ogg file to mp3 with a bitrate of 192.
678 Evaluates a perl expression; useful as command line
679 calculator, therefore also available as "calc".
682 Lists all occurrences of the string given as argument in current $PATH.
685 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
686 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
687 Asks for confirmation.
690 Opens all README-like files in current working directory with the program
691 defined in the $PAGER environment variable.
694 Reloads functions given as parameters.
697 Checks whether a regular expression (first parameter) matches a string
698 (second parameter) using perl.
701 Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h"
702 for details. See also xunfunction() below.
705 Greps the history for the string provided as parameter and shows the numbered
706 findings in default pager. On exit of the pager the user is prompted for a
707 number. The shells readline buffer is then filled with the corresponding
711 Lists the contents of a (compressed) archive with the appropriate programs.
712 The choice is made along the filename extension.
715 Lists the content of a gzipped tar archive in default pager.
718 Shows the content of a zip archive in default pager.
720 : **simple-extract()**
721 Tries to uncompress/unpack given file with the appropriate programs. The
722 choice is made along the filename ending.
725 Prints the arguments slowly by sleeping 0.08 seconds between each character.
727 : **smartcompress()**
728 Compresses/archives the file given as first parameter. Takes an optional
729 second argument, which denotes the compression/archive type as typical
730 filename extension; defaults to "tar.gz".
733 Indents C source code files given; uses Kernighan & Ritchie style.
736 Creates directory named shots in user's home directory, if it does not yet
737 exist and changes current working directory to it. Then sleeps 5 seconds,
738 so you have plenty of time to switch desktops/windows. Then makes a screenshot
739 of the current desktop. The result is stored in ~/shots to a timestamped
742 : **ssl-cert-fingerprints**
743 Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate.
744 First and only parameter must be a file containing a certificate. Use
745 /dev/stdin as file if you want to pipe a certificate to these
749 Prints all information of a x509 certificate including the SHA512,
750 SHA256, SHA1 and MD5 digests. First and only parameter must be a file
751 containing a certificate. Use /dev/stdin as file if you want to pipe a
752 certificate to this function.
754 : **ssl-cert-sha512(), ssl-cert-sha256(), ssl-cert-sha1(), ssl-cert-md5()**
755 Prints the SHA512, SHA256, SHA1 respective MD5 digest of a x509
756 certificate. First and only parameter must be a file containing a
757 certificate. Use /dev/stdin as file if you want to pipe a certificate
761 Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else
762 issues a Warning to use the grml-x(1) script. Can be overridden by using
763 /usr/bin/startx directly.
766 Shows some information about current system status.
769 Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option
770 swspeak must be set for this to work.
773 Translates a word from german to english (-D) or vice versa (-E).
776 Makes a unified diff of the command line arguments trying hard to find a
777 smaller set of changes. Descends recursively into subdirectories. Ignores
778 hows some information about current status.
781 Downloads and displays a file using a suitable program for its
785 Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2.
788 Takes a string as its first argument and prints it RFC 2396 URL encoded to
792 Changes every occurrence of the string UTF-8 or utf-8 in environment
793 variables to iso885915.
799 Wrapper for vim(1). It tries to set the title and hands vim the environment
800 variable VIM_OPTIONS on the command line. So the user may define command
801 line options, she always wants, in her .zshrc.local.
804 Use vim(1) as manpage reader.
807 Searches the history for a given pattern and lists the results by date.
808 The first argument is the search pattern. The second and third ones are
809 optional and denote a search range (default: -100).
812 Retrieves and prints weather information from "http://weather.noaa.gov".
813 The first and only argument is the ICAO code for the desired station.
814 For a list of ICAO codes see
815 "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code".
818 Tries to cat(1) file(s) given as parameter(s). Always returns true.
819 See also xunfunction() below.
822 Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else
823 issues a Warning to use the grml-x(1) script. Can be overridden by using
824 /usr/bin/xinit directly.
827 Tries to source the file(s) given as parameter(s). Always returns true.
828 See zshbuiltins(1) for a detailed description of the source command.
829 See also xunfunction() below.
832 Changes the title of xterm window from within screen(1). Run without
833 arguments for details.
836 Removes the functions salias, xcat, xsource, xunfunction and zrcautoload.
839 Search for patterns in grml's zshrc using perl. zg takes no or exactly one
840 option plus a non empty pattern. Run zg without any arguments for a listing
841 of available command line switches. For a zshrc not in /etc/zsh, set the
842 GRML_ZSHRC environment variable.
845 Wrapper around the autoload builtin. Loads the definitions of functions
846 from the file given as argument. Searches $fpath for the file. See also
850 Sources /etc/zsh/zshrc.local and ${HOME}/.zshrc.local. These are the files
851 where own modifications should go. See also zshbuiltins(1) for a description
852 of the source command.
856 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's
857 life. A few aliases (like those involving //grep// or //ls//) use the option
858 //--color=auto// for colourizing output. That option is part of **GNU**
859 implementations of these tools, and will only be used if such an implementation
862 : **acp** (//apt-cache policy//)
863 With no arguments prints out the priorities of each source. If a package name
864 is given, it displays detailed information about the priority selection of the
867 : **acs** (//apt-cache search//)
868 Searches debian package lists for the regular expression provided as argument.
869 The search includes package names and descriptions. Prints out name and short
870 description of matching packages.
872 : **acsh** (//apt-cache show//)
873 Shows the package records for the packages provided as arguments.
875 : **adg** (//apt-get dist-upgrade//)
876 Performs an upgrade of all installed packages. Also tries to automatically
877 handle changing dependencies with new versions of packages. As this may change
878 the install status of (or even remove) installed packages, it is potentially
879 dangerous to use dist-upgrade; invoked by sudo, if necessary.
881 : **ag** (//apt-get upgrade//)
882 Downloads and installs the newest versions of all packages currently installed
883 on the system. Under no circumstances are currently installed packages removed,
884 or packages not already installed retrieved and installed. New versions of
885 currently installed packages that cannot be upgraded without changing the install
886 status of another package will be left at their current version. An update must
887 be performed first (see au below); run by sudo, if necessary.
889 : **agi** (//apt-get install//)
890 Downloads and installs or upgrades the packages given on the command line.
891 If a hyphen is appended to the package name, the identified package will be
892 removed if it is installed. Similarly a plus sign can be used to designate a
893 package to install. This may be useful to override decisions made by apt-get's
894 conflict resolution system.
895 A specific version of a package can be selected for installation by following
896 the package name with an equals and the version of the package to select. This
897 will cause that version to be located and selected for install. Alternatively a
898 specific distribution can be selected by following the package name with a slash
899 and the version of the distribution or the Archive name (stable, testing, unstable).
900 Gets invoked by sudo, if user id is not 0.
902 : **ati** (//aptitude install//)
903 Aptitude is a terminal-based package manager with a command line mode similar to
904 apt-get (see agi above); invoked by sudo, if necessary.
906 : **au** (//apt-get update//)
907 Resynchronizes the package index files from their sources. The indexes of
908 available packages are fetched from the location(s) specified in
909 /etc/apt/sources.list. An update should always be performed before an
910 upgrade or dist-upgrade; run by sudo, if necessary.
912 : **calc** (//peval//)
913 Evaluates a perl expression (see peval() above); useful as a command line
916 : **CH** (//./configure --help//)
917 Lists available compilation options for building program from source.
919 : **cmplayer** (//mplayer -vo fbdev//)
920 Video player with framebuffer as video output device, so you can watch
921 videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell
922 while watching a movie.
924 : **CO** (//./configure//)
925 Prepares compilation for building program from source.
927 : **da** (//du -sch//)
928 Prints the summarized disk usage of the arguments as well as a grand total
929 in human readable format.
931 : **default** (//echo -en [ escape sequence ]//)
932 Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15"
933 using escape sequence.
935 : **dir** (//ls -lSrah//)
936 Lists files (including dot files) sorted by size (biggest last) in long and
937 human readable output format.
939 : **fblinks** (//links2 -driver fb//)
940 A Web browser on the framebuffer device. So you can browse images and click
941 links on the virtual tty.
943 : **fbmplayer** (//mplayer -vo fbdev -fs -zoom//)
944 Fullscreen Video player with the framebuffer as video output device. So you
945 can watch videos on a virtual tty.
948 Revision control system by Linus Torvalds.
950 : **grep** (//grep --color=auto//)
951 Shows grep output in nice colors, if available.
953 : **GREP** (//grep -i --color=auto//)
954 Case insensitive grep with colored output.
956 : **grml-rebuildfstab** (//rebuildfstab -v -r -config//)
957 Scans for new devices and updates /etc/fstab according to the findings.
959 : **grml-version** (//cat /etc/grml_version//)
960 Prints version of running grml.
962 : **http** (//python -m SimpleHTTPServer//)
963 Basic HTTP server implemented in python. Listens on port 8000/tcp and
964 serves current directory. Implements GET and HEAD methods.
966 : **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
967 scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
968 host key changes frequently, for example on virtualized test- or development-systems.
969 To be used only inside trusted networks, of course.
971 : **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
972 ssh with possible man-in-the-middle attack enabled
973 (for an explanation see insecscp above).
975 : **help-zshglob** (//H-Glob()//)
976 Runs the function H-Glob() to expand or explain wildcards.
978 : **hide** (//echo -en [ escape sequence ]//)
979 Tries to hide xterm window using escape sequence.
981 : **huge** (//echo -en [ escape sequence ]//)
982 Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15")
983 using escape sequence.
985 : **j** (//jobs -l//)
986 Prints status of jobs in the current shell session in long format.
988 : **l** (//ls -lF --color=auto//)
989 Lists files in long output format with indicator for filetype appended
990 to filename. If the terminal supports it, with colored output.
992 : **la** (//ls -la --color=auto//)
993 Lists files in long colored output format. Including file names
996 : **lad** (//ls -d .*(/)//)
997 Lists the dot directories (not their contents) in current directory.
999 : **large** (//echo -en [ escape sequence ]//)
1000 Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15")
1001 using escape sequence.
1003 : **lh** (//ls -hAl --color=auto//)
1004 Lists files in long and human readable output format in nice colors,
1005 if available. Includes file names starting with "." except "." and
1008 : **ll** (//ls -l --color=auto//)
1009 Lists files in long colored output format.
1011 : **ls** (//ls -b -CF --color=auto//)
1012 Lists directory printing octal escapes for nongraphic characters.
1013 Entries are listed by columns and an indicator for file type is appended
1014 to each file name. Additionally the output is colored, if the terminal
1017 : **lsa** (//ls -a .*(.)//)
1018 Lists dot files in current working directory.
1020 : **lsbig** (//ls -flh *(.OL[1,10])//)
1021 Displays the ten biggest files (long and human readable output format).
1023 : **lsd** (//ls -d *(/)//)
1026 : **lse** (//ls -d *(/^F)//)
1027 Shows empty directories.
1029 : **lsl** (//ls -l *(@)//)
1030 Lists symbolic links in current directory.
1032 : **lsnew** (//ls -rl *(D.om[1,10])//)
1033 Displays the ten newest files (long output format).
1035 : **lsold** (//ls -rtlh *(D.om[1,10])//)
1036 Displays the ten oldest files (long output format).
1038 : **lss** (//ls -l *(s,S,t)//)
1039 Lists files in current directory that have the setuid, setgid or sticky bit
1042 : **lssmall** (//ls -Srl *(.oL[1,10])//)
1043 Displays the ten smallest files (long output format).
1045 : **lsw** (//ls -ld *(R,W,X.^ND/)//)
1046 Displays all files which are world readable and/or world writable and/or
1047 world executable (long output format).
1049 : **lsx** (//ls -l *(*)//)
1050 Lists only executable files.
1052 : **md** (//mkdir -p//)
1053 Creates directory including parent directories, if necessary
1055 : **medium** (//echo -en [ escape sequence ]//)
1056 Sets medium sized font
1057 ("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm
1058 using escape sequence.
1060 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
1061 If invoking user is root, starts screen session with /etc/grml/screenrc
1062 as config file. If invoked by a regular user, start a screen session
1063 with users .screenrc config if it exists, else use /etc/grml/screenrc_grml
1066 : **rw-** (//chmod 600//)
1067 Grants read and write permission of a file to the owner and nobody else.
1069 : **rwx** (//chmod 700//)
1070 Grants read, write and execute permission of a file to the owner and nobody
1073 : **r--** (//chmod 644//)
1074 Grants read and write permission of a file to the owner and read-only to
1077 : **r-x** (//chmod 755//)
1078 Grants read, write and execute permission of a file to the owner and
1079 read-only plus execute permission to anybody else.
1081 : **semifont** (//echo -en [ escape sequence ]//)
1082 Sets font of xterm to
1083 "-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using
1086 : **small** (//echo -en [ escape sequence ]//)
1087 Sets small xterm font ("6x10") using escape sequence.
1089 : **smartfont** (//echo -en [ escape sequence ]//)
1090 Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using
1093 : **su** (//sudo su//)
1094 If user is running a grml live-CD, dont ask for any password, if she
1097 : **tiny** (//echo -en [ escape sequence ]//)
1098 Sets tiny xterm font
1099 ("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
1102 : **truec** (//truecrypt [ mount options ]//)
1103 Mount a truecrypt volume with some reasonable mount options
1104 ("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if
1107 : **up** (//aptitude update ; aptitude safe-upgrade//)
1108 Performs a system update followed by a system upgrade using aptitude; run
1109 by sudo, if necessary. See au and ag above.
1111 : **?** (//qma zshall//)
1112 Runs the grml script qma (quick manual access) to build the collected man
1113 pages for the z-shell. This compressed file is kept at
1114 ~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is
1115 fast. See "man qma" for further information.
1119 This is a set of files, that - if they exist - can be used to customize the
1120 behaviour of //grmlzshrc//.
1123 Sourced at the very beginning of //grmlzshrc//. Among other things, it can
1124 be used to permantenly change //grmlzshrc//'s STARTUP VARIABLES (see above):
1127 # show battery status in RPROMPT
1129 # always load the complete setup, even for root
1130 GRML_ALWAYS_LOAD_ALL=1
1134 Sourced right before loading //grmlzshrc// is finished. There is a global
1135 version of this file (/etc/zsh/zshrc.local) which is sourced before the
1139 Directory listing for persistent dirstack (see above).
1141 : **.important_commands**
1142 List of commands, used by persistent history (see above).
1145 = INSTALLATION ON NON-DEBIAN SYSTEMS =
1146 On Debian systems (http://www.debian.org) - and possibly Ubuntu
1147 (http://www.ubuntu.com) and similar systems - it is very easy to get
1148 //grmlzshrc// via grml's .deb repositories.
1150 On non-debian systems, that is not an option, but all is not lost:
1153 % wget -O .zshrc http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1156 If you would also like to get seperate function files (which you can put into
1157 your **$fpath**), you can browse and download them at:
1159 http://git.grml.org/?p=grml-etc-core.git;a=tree;f=usr_share_grml/zsh;hb=HEAD
1161 = ZSH REFCARD TAGS =
1162 If you read //grmlzshrc//'s code you may notice strange looking comments in
1163 it. These are there for a purpose. grml's zsh-refcard is automatically
1164 generated from the contents of the actual configuration file. However, we need
1165 a little extra information on which comments and what lines of code to take
1166 into account (and for what purpose).
1168 Here is what they mean:
1170 List of tags (comment types) used:
1172 Next line contains an important alias, that should be included in the
1173 grml-zsh-refcard. (placement tag: @@INSERT-aliases@@)
1176 Next line contains the beginning of an important function. (placement
1177 tag: @@INSERT-functions@@)
1180 Next line contains an important variable. (placement tag:
1181 @@INSERT-variables@@)
1184 Next line contains an important keybinding. (placement tag:
1185 @@INSERT-keybindings@@)
1188 Hashed directories list generation: //start//: denotes the start of a list of
1189 'hash -d' definitions. //end//: denotes its end. (placement tag:
1190 @@INSERT-hasheddirs@@)
1193 Abbreviation expansion list generation: //start//: denotes the beginning of
1194 abbreviations. //end//: denotes their end.
1196 Lines within this section that end in '#d .*' provide extra documentation to
1197 be included in the refcard. (placement tag: @@INSERT-abbrev@@)
1200 This tag allows you to manually generate refcard entries for code lines that
1201 are hard/impossible to parse.
1205 #m# k ESC-h Call the run-help function
1208 That would add a refcard entry in the keybindings table for 'ESC-h' with the
1211 So the syntax is: #m# <section> <argument> <comment>
1214 This tag lets you insert entries to the 'other' hash. Generally, this should
1215 not be used. It is there for things that cannot be done easily in another way.
1216 (placement tag: @@INSERT-other-foobar@@)
1219 All of these tags (except for m and o) take two arguments, the first
1220 within the tag, the other after the tag:
1222 #<tag><section># <comment>
1224 Where <section> is really just a number, which are defined by the @secmap
1225 array on top of 'genrefcard.pl'. The reason for numbers instead of names is,
1226 that for the reader, the tag should not differ much from a regular comment.
1227 For zsh, it is a regular comment indeed. The numbers have got the following
1252 So, the following will add an entry to the 'functions' table in the 'system'
1253 section, with a (hopefully) descriptive comment:
1256 #f1# Edit an alias via zle
1260 It will then show up in the @@INSERT-aliases-system@@ replacement tag that can
1261 be found in 'grml-zsh-refcard.tex.in'. If the section number is omitted, the
1262 'default' section is assumed. Furthermore, in 'grml-zsh-refcard.tex.in'
1263 @@INSERT-aliases@@ is exactly the same as @@INSERT-aliases-default@@. If you
1264 want a list of **all** aliases, for example, use @@INSERT-aliases-all@@.
1268 If you want to help to improve grml's zsh setup, clone the grml-etc-core
1269 repository from git.grml.org:
1271 ``` % git clone git://git.grml.org/grml-etc-core.git
1273 Make your changes, commit them; use '**git format-patch**' to create a series
1274 of patches and send those to the following address via '**git send-email**':
1276 ``` grml-etc-core@grml.org
1278 Doing so makes sure the right people get your patches for review and
1283 This manual page is the **reference** manual for //grmlzshrc//.
1285 That means that in contrast to the existing refcard it should document **every**
1286 aspect of the setup.
1288 This manual is currently not complete. If you want to help improving it, visit
1289 the following pages:
1291 http://wiki.grml.org/doku.php?id=zshrcmanual
1293 http://lists.mur.at/pipermail/grml/2009-August/004609.html
1295 Contributions are highly welcome.
1299 This manpage was written by Frank Terbeck <ft@grml.org>, Joerg Woelke
1300 <joewoe@fsmail.de>, Maurice McCarthy <manselton@googlemail.com> and Axel
1301 Beckert <abe@deuxchevaux.org>.
1305 Copyright (c) 2009-2010 grml project <http://grml.org>
1307 This manpage is distributed under the terms of the GPL version 2.
1309 Most parts of grml's zshrc are distributed under the terms of GPL v2, too,
1310 except for **accept-line()** and **vcs_info()**, which are distributed under
1311 the same conditions as zsh itself (which is BSD-like).