X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=doc%2Fgrmlzshrc.t2t;h=05a02750b5dbad648d1e3c78022d4d8939c4ec84;hb=91e66592c4348014dda162477eb7116c45a2326e;hp=38d19ef87267dd0ef2d78e66ee1b4164b04db42a;hpb=d56e5285200bd651b68d8a8cf9a65e8b63d24a3d;p=grml-etc-core.git diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t index 38d19ef..05a0275 100644 --- a/doc/grmlzshrc.t2t +++ b/doc/grmlzshrc.t2t @@ -1,13 +1,13 @@ GRMLZSHRC -June, 2010 +July, 2011 %!target: man %!postproc(man): "^(\.TH.*) 1 " "\1 5 " = NAME = -grmlzshrc - grml's zsh setup +grmlzshrc - Grml's zsh setup = SYNOPSIS = @@ -15,7 +15,7 @@ grmlzshrc - grml's zsh setup = DESCRIPTION = -The grml project provides a fairly exhaustive interactive setup (referred to +The Grml project provides a fairly exhaustive interactive setup (referred to as //grmlzshrc// throughout this document) for the amazing unix shell zsh (http://zsh.sourceforge.net). This is the reference manual for that setup. @@ -26,10 +26,19 @@ features are enabled in every version). //grmlzshrc// behaves differently depending on which user loads it. For the root user (**EUID** == 0) only a subset of features is loaded by default. This behaviour can be altered by setting the **GRML_ALWAYS_LOAD_ALL** STARTUP -VARIABLE (see below). Also the umask(1) for the root user is set to 022, -while for regular users it is set to 002. So read/write permissions -for the regular user and her group are set for new files (keep that -in mind on systems, where regular users share a common group). +VARIABLE (see below). + +Users may want to keep an up-to-date version of the setup (possibly from the +git-sources) in //~/.zshrc//. If that happens on a system where the global +zshrc is also a //grmlzshrc// (but possibly an older one), you can inhibit +loading the global version by doing: +\ +``` +echo setopt no_global_rcs >> ~/.zshenv +``` + +Note, that this will disable //ANY// global files, except for the global +zshenv file. = STARTUP VARIABLES = Some of the behaviour of //grmlzshrc// can be altered by setting certain shell @@ -48,7 +57,7 @@ A non zero value activates a handler, which is called when a command can not be found. The handler is defined by GRML_ZSH_CNF_HANDLER (see below). : **GRML_ALWAYS_LOAD_ALL** -Enables the whole grml setup for root, if set to a non zero value. +Enables the whole Grml setup for root, if set to a non zero value. : **GRML_ZSH_CNF_HANDLER** This variable contains the handler to be used by COMMAND_NOT_FOUND (see above) @@ -62,7 +71,7 @@ grml-small. Where zsh saves the history. Default: ${HOME}/.zsh_history. : **HISTSIZE** -Number of commands to be kept in the history. On a grml-CD this defaults to +Number of commands to be kept in the history. On a Grml-CD this defaults to 500, on a hard disk installation to 5000. : **MAILCHECK** @@ -85,7 +94,7 @@ Show time (user, system and cpu) used by external commands, if they run longer than the defined number of seconds (default: 5). : **SAVEHIST** -Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a grml-CD +Number of commands to be stored in ${HISTFILE}. Defaults to 1000 on a Grml-CD and to 10000 on an installation on hard disk. : **watch** @@ -415,9 +424,18 @@ Deletes a word left of the cursor; seeing '/' as additional word separator. : **CTRL-x-1** Jump right after the first word. +: **CTRL-x-M()** +Create directory under cursor or the selected area. +To select an area press ctrl-@ and use the cursor. +Use case: you type "mv abc ~/testa/testb/testc/" and remember that the +directory does not exist yet -> press **CTRL-xM** and problem solved. + : **CTRL-x-p** Searches the last occurence of string before the cursor in the command history. +: **CTRL-x-z** +Display help on keybindings and zsh line editor. Press consecutively to page through content. + : **CTRL-z** Brings a job, which got suspended with CTRL-z back to foreground. @@ -482,16 +500,20 @@ Simple backup of a file or directory using cp(1). The target file name is the original name plus a time stamp attached. Symlinks and file attributes like mode, ownership and timestamps are preserved. -: **brltty()** -The brltty(1) program provides a braille display, so a blind person can access -the console screen. This wrapper function works around problems with some -environments (f. e. utf8). +: **cdiff()** +Runs a recursive diff(1) over two given directories trying to find the +smallest set of changes. Three lines of context will be printed and binary +files filtered out. : **cdrecord()** If the original cdrecord is not installed, issues a warning to the user to use the wodim binary instead. Wodim is the debian fork of Joerg Schillings cdrecord. +: **cdt()** +Creates a temporary directory using mktemp. Then changes current +working directory to it. + : **changed()** Lists files in current directory, which have been changed within the last N days. N is an integer to be passed as first and only argument. @@ -510,9 +532,24 @@ grml systems with autologin. Changes current directory to the one supplied by argument and lists the files in it, including file names starting with ".". -: **d()** -Presents a numbered listing of the directory stack. Then changes current -working directory to the one chosen by the user. +: **cvsa()** +Adds and commits the given files using cvs(1). The commit message will be +'initial checkin'. + +: **cvsd()** +Shows a cvs diff of the arguments in $PAGER. + +: **cvsl()** +Shows the cvs log in $PAGER. + +: **cvsq()** +Runs a cvs update. + +: **cvsr()** +Generates a changelog using rcs2log and shows it in $PAGER. + +: **cvss()** +Shows cvs status of given files. : **dchange()** Shows the changelog of given package in $PAGER. @@ -528,6 +565,11 @@ Shows bug report for debian given by number in mailbox format. Tells the user to use grml-debootstrap, if she wants to install debian to harddisk. +: **deswap()** +A trick from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt. It brings +back interactive responsiveness after suspend, when the system is swapping +heavily. + : **dirspace()** Shows the disk usage of the directories given in human readable format; defaults to $path. @@ -535,6 +577,10 @@ defaults to $path. : **disassemble()** Translates C source code to assembly and ouputs both. +: **dmoz()** +Searches for the first argument (optional) in the Open Directory Project +(See http://www.dmoz.org/docs/en/about.html). + : **dnews()** Shows the NEWS file for the given package in $PAGER. @@ -542,12 +588,20 @@ Shows the NEWS file for the given package in $PAGER. Takes packagename as argument. Sets current working directory to /usr/share/doc/ and prints out a directory listing. +: **dwicti()** +Looks up the first argument (optional) in the german Wiktionary +which is an online dictionary (See: http://de.wiktionary.org/). + : **edalias()** Edit given alias. : **edfunc()** Edit given shell function. +: **ewicti()** +Looks up the first argument (optional in the english Wiktionary +which is an online dictionary (See: http://en.wiktionary.org/). + : **exirename()** Renames image files based on date/time informations in their exif headers. @@ -575,6 +629,15 @@ and all files and/or directories beginning with "thumb-" in current directory! : **get_tw_cli()** Fetches 3ware RAID controller software using get_3ware(1). +: **gex()** +Performs an exact (i. e. quoted) web search using Google. + +: **ggogle()** +Searches the arguments on Google Groups, a web to USENET gateway. + +: **google()** +Searches the search engine Google using arguments as search string. + : **greph()** Searches the zsh command history for a regular expression. @@ -600,6 +663,10 @@ for detailed usage information. Queries IMAP server (first parameter) for its capabilities. Takes port number as optional second argument. +: **ipv6-tunnel()** +Sets up an IPv6 tunnel on interface sit1. Needs one argument - +either "start", "stop" or "status". + : **is4()** Returns true, if zsh version is equal or greater than 4, else false. @@ -637,6 +704,9 @@ environment variables to UTF-8. : **isutfenv()** Returns true, if run within an utf environment, else false. +: **iwclient()** +Searches a wireless interface and runs dhclient(8) on it. + : **lcheck()** Lists libraries that define the symbol containing the string given as parameter. @@ -649,6 +719,9 @@ directory. Prints specified range of (numbered) lines of a file. Usage: linenr [,] +: **lsdisk()** +Uses udev's /dev/disk to list block devices with their LABEL, UUID and IDs. + : **makereadable()** Creates a PostScript and a PDF file (basename as first argument) from source code files. @@ -671,6 +744,9 @@ output (unified format) to a timestamped file. : **memusage()** Prints the summarized memory usage in bytes. +: **mggogle()** +Searches Google Groups for a USENET message-ID. + : **minimal-shell()** Spawns a minimally set up MirBSD Korn shell. It references no files in /usr, so that file system can be unmounted. @@ -698,6 +774,9 @@ Lists files in current directory, which have been modified within the last N days. N is an integer to be passed as first and only argument. If no argument is specified N is set to 1. +: **netcraft()** +Asks netcraft.com for informations about the site given as argument. + : **nt()** A helper function for the "e" glob qualifier to list all files newer than a reference file. @@ -710,8 +789,9 @@ Example usages: % ls -l *(e:'nt /reference/file':) ``` -: **ogg2mp3_192()** -Recodes an ogg file to mp3 with a bitrate of 192. +: **oleo()** +Translates the given word using the english - german online +dictionary dict.leo.org. : **peval()** Evaluates a perl expression; useful as command line @@ -725,9 +805,16 @@ Runs a command in $SHELL with profiling enabled (See startup variable ZSH_PROFILE_RC above). : **purge()** -Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o", -"a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory. -Asks for confirmation. +Removes temporary files from current directory. Asks for confirmation. Uses sudo if necessary. +In detail it purges + - common temp files like "*~", ".*~", "#*#", "*.o", "a.out", "*.orig", "*.rej", "*.cmo", "*.cmi" and ".*.swp" + - core dumps + - debconf backup files: "*.dpkg-old", "*.dkpg-new", "*.dpkg-dist" + - gentoo dispatch-conf backups: ".cfg0000_*", ".mrg0000_*" + - precompiled python code ("*.pyc", "*.pyo") as long as matching "*.py" source is also present + - LaTeX temp files i.e. "*.(log|toc|aux|nav|snm|out|tex.backup|bbl|blg|bib.backup|vrb|lof|lot|hd|idx)" for any present "*.tex" + - ghc temp files, as long as matching "*.hs" or "*.lhs" is also present + - "*.mood(D)" Files which are missing their corresponding audio file : **readme()** Opens all README-like files in current working directory with the program @@ -740,6 +827,11 @@ Reloads functions given as parameters. Checks whether a regular expression (first parameter) matches a string (second parameter) using perl. +: **rundirs()** +Takes as first parameter a quoted string containing an exectuable command or function with arguments. +Following that it takes a bunch of directories, which will then be traversed, executing the +first argument in each one. E.g.: rundirs purge . **/*(/-/) + : **salias()** Creates an alias whith sudo prepended, if $EUID is not zero. Run "salias -h" for details. See also xunfunction() below. @@ -764,8 +856,11 @@ Lists the content of a gzipped tar archive in default pager. Shows the content of a zip archive in default pager. : **simple-extract()** -Tries to uncompress/unpack given file with the appropriate programs. The -choice is made along the filename ending. +Tries to uncompress/unpack given files with the appropriate programs. If an URI +starting with https, http or ftp is provided simple-extract tries to download +and then uncompress/unpack the file. The choice is made along the filename +ending. simple-extract will not delete the original archive (even on .gz,.bz2 or +.xz) unless you use the '-d' option. : **sll()** Prints details of symlinks given as arguments. @@ -806,17 +901,18 @@ certificate. First and only parameter must be a file containing a certificate. Use /dev/stdin as file if you want to pipe a certificate to this function. -: **startx()** -Initializes an X session using startx(1) if /etc/X11/xorg.conf exists, else -issues a Warning to use the grml-x(1) script. Can be overridden by using -/usr/bin/startx directly. +: **Start(), Restart(), Stop(), Force-Reload(), Reload()** +Functions for controlling daemons. +``` +Example usage: +% Restart ssh +``` : **status()** Shows some information about current system status. -: **swspeak()** -Sets up software synthesizer by calling swspeak-setup(8). Kernel boot option -swspeak must be set for this to work. +: **swiki()** +Searches articles in the german Wikipedia for the term given as argument. : **trans()** Translates a word from german to english (-D) or vice versa (-E). @@ -866,15 +962,21 @@ The first and only argument is the ICAO code for the desired station. For a list of ICAO codes see "http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code". +: **wikide()** +Looks up the argument on Wikipedia (german). + +: **wikien()** +Looks up the argument on Wikipedia (english). + +: **wodeb()** +Searches the list of official debian packages for the term given as +first argument. The optional second argument denotes the distribution +(stable, testing or unstable) and defaults to unstable. + : **xcat()** Tries to cat(1) file(s) given as parameter(s). Always returns true. See also xunfunction() below. -: **xinit()** -Initializes an X session using xinit(1) if /etc/X11/xorg.conf exists, else -issues a Warning to use the grml-x(1) script. Can be overridden by using -/usr/bin/xinit directly. - : **xsource()** Tries to source the file(s) given as parameter(s). Always returns true. See zshbuiltins(1) for a detailed description of the source command. @@ -1428,10 +1530,10 @@ Beckert . = COPYRIGHT = -Copyright (c) 2009-2010 grml project +Copyright (c) 2009-2011 Grml project This manpage is distributed under the terms of the GPL version 2. Most parts of grml's zshrc are distributed under the terms of GPL v2, too, -except for **accept-line()** and **vcs_info()**, which are distributed under -the same conditions as zsh itself (which is BSD-like). +except for **accept-line()** which are distributed under the same conditions +as zsh itself (which is BSD-like).