X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=doc%2Fgrmlzshrc.t2t;h=38ba6184b4a2f5159db0ace94c17d8c7921ed5aa;hb=dd58483b53d5e9893955057c1377d07bc8497759;hp=8b6e27fac7d0f7acee5fce66638ab51cce99cd8b;hpb=5173aead615141e4e777e692cef94ae86d6a74d6;p=grml-etc-core.git diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t index 8b6e27f..38ba618 100644 --- a/doc/grmlzshrc.t2t +++ b/doc/grmlzshrc.t2t @@ -298,9 +298,6 @@ available via the usual history lookup widgets. //grmlzshrc// sets some environment variables, which influence the behaviour of applications. -: **BROWSER** -If X is running this is set to "firefox", otherwise to "w3m". - : **COLORTERM** Set to "yes". Some applications read this to learn about properties of the terminal they are running in. @@ -444,10 +441,6 @@ Brings a job, which got suspended with CTRL-z back to foreground. //grmlzshrc// comes with a wide array of defined shell functions to ease the user's life. -: **2html()** -Converts plaintext files to HTML using vim. The output is written to -.html. - : **855resolution()** If 915resolution is available, issues a warning to the user to run it instead to modify the resolution on intel graphics chipsets. @@ -457,54 +450,23 @@ Lists files in current directory, which have been accessed 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. -: **agoogle()** -Searches for USENET postings from authors using google groups. - : **allulimit()** Sets all ulimit values to "unlimited". -: **ansi-colors()** -Prints a colored table of available ansi color codes (to be used in escape -sequences) and the colors they represent. - : **any()** Lists processes matching given pattern. -: **aoeu(), asdf(), uiae()** -Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard -layout. - -: **apache2-ssl-certificate()** -Advices the user how to create self signed certificates. - : **asc()** Login on the host provided as argument using autossh. Then reattach a GNU screen session if a detached session is around or detach a currently attached screen or else start a new screen. This is especially useful for roadwarriors using GNU screen and ssh. -: **audioburn()** -Burns the files in ~/ripps (see audiorip() below) to an audio CD. -Then prompts the user if she wants to remove that directory. You might need -to tell audioburn which cdrom device to use like: -"DEVICE=/dev/cdrom audioburn" - -: **audiorip()** -Creates directory ~/ripps, if it does not exist. Then rips audio CD into -it. Then prompts the user if she wants to burn a audio CD with audioburn() -(see above). You might need to tell audiorip which cdrom device to use like: -"DEVICE=/dev/cdrom audioburn" - : **bk()** 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. -: **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 @@ -532,35 +494,9 @@ grml systems with autologin. Changes current directory to the one supplied by argument and lists the files in it, including file names starting with ".". -: **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. -: **debbug()** -Searches the Debian bug tracking system (bugs.debian.org) for Bug numbers, -email addresses of submitters or any string given on the command line. - -: **debbugm()** -Shows bug report for debian given by number in mailbox format. - : **debian2hd()** Tells the user to use grml-debootstrap, if she wants to install debian to harddisk. @@ -570,81 +506,18 @@ 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. - -: **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. -: **doc()** -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. - -: **fir()** -Opens given URL with Firefox (Iceweasel on Debian). If there is already an -instance of firefox running, attaches to the first window found and opens the -URL in a new tab (this even works across an ssh session). - -: **fluxkey-change()** -Switches the key combinations for changing current workspace under fluxbox(1) -from Alt-[0-9] to Alt-F[0-9] and vice versa by rewriting $HOME/.fluxbox/keys. -Requires the window manager to reread configuration to take effect. - : **freload()** Reloads an autoloadable shell function (See autoload in zshbuiltins(1)). -: **genthumbs()** -A simple thumbnails generator. Resizes images (i. e. files that end in ".jpg", -".jpeg", ".gif" or ".png") to 100x200. Output files are named "thumb-". Creates an index.html with title "Images" showing the -thumbnails as clickable links to the respective original file. -//Warning:// On start genthumbs() silently removes a possibly existing "index.html" -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. - -: **hex()** -Prints the hexadecimal representation of the number supplied as argument -(base ten only). - : **hgdi()** Use GNU diff with options -ubwd for mercurial. @@ -655,18 +528,6 @@ argument means last revision). : **hidiff()** Outputs highlighted diff; needs highstring(1). -: **hl()** -Shows source files in less(1) with syntax highlighting. Run "hl -h" -for detailed usage information. - -: **ic_get()** -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. @@ -704,79 +565,15 @@ 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. - -: **limg()** -Lists images (i. e. files ending with ".jpg", ".gif" or ".png") in current -directory. - -: **linenr()** -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. - -: **man2()** -Displays manpage in a streched style. - -: **manzsh()** -Shows the zshall manpage and jumps to the first match of the regular -expression optionally given as argument (Needs qma(1)). - -: **mcd()** +: **mkcd()** Creates directory including parent directories, if necessary. Then changes current working directory to it. -: **mdiff()** -Diffs the two arguments recursively and writes the -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. - -: **mkaudiocd()** -Renames all mp3 files in ~/ripps (see audiorip above) to lowercase and -replaces spaces in file names with underscores. Then mkaudiocd() -normalizes the files and recodes them to WAV. - -: **mkiso()** -Creates an iso9660 filesystem image with Rockridge and Joliet extensions -enabled using mkisofs(8). Prompts the user for volume name, filename and -target directory. - -: **mkmaildir()** -Creates a directory with first parameter as name inside $MAILDIR_ROOT -(defaults to $HOME/Mail) and subdirectories cur, new and tmp. - -: **mmake()** -Runs "make install" and logs the output under ~/.errorlogs/; useful for -a clean deinstall later. - : **modified()** 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. @@ -789,72 +586,21 @@ Example usages: % ls -l *(e:'nt /reference/file':) ``` -: **oleo()** -Translates the given word using the english - german online -dictionary dict.leo.org. - -: **peval()** -Evaluates a perl expression; useful as command line -calculator, therefore also available as "calc". - -: **plap()** -Lists all occurrences of the string given as argument in current $PATH. - : **profile()** Runs a command in $SHELL with profiling enabled (See startup variable ZSH_PROFILE_RC above). -: **purge()** -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 -defined in the $PAGER environment variable. - : **refunc()** Reloads functions given as parameters. -: **regcheck()** -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. -: **selhist()** -Greps the history for the string provided as parameter and shows the numbered -findings in default pager. On exit of the pager the user is prompted for a -number. The shells readline buffer is then filled with the corresponding -command line. - -: **setenv()** -Reimplementation of the csh(1) builtin setenv. - : **show-archive()** Lists the contents of a (compressed) archive with the appropriate programs. The choice is made along the filename extension. -: **shtar()** -Lists the content of a gzipped tar archive in default pager. - -: **shzip()** -Shows the content of a zip archive in default pager. - : **simple-extract()** 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 @@ -865,24 +611,11 @@ ending. simple-extract will not delete the original archive (even on .gz,.bz2 or : **sll()** Prints details of symlinks given as arguments. -: **slow_print()** -Prints the arguments slowly by sleeping 0.08 seconds between each character. - : **smartcompress()** Compresses/archives the file given as first parameter. Takes an optional second argument, which denotes the compression/archive type as typical filename extension; defaults to "tar.gz". -: **smart-indent()** -Indents C source code files given; uses Kernighan & Ritchie style. - -: **sshot()** -Creates directory named shots in user's home directory, if it does not yet -exist and changes current working directory to it. Then sleeps 5 seconds, -so you have plenty of time to switch desktops/windows. Then makes a screenshot -of the current desktop. The result is stored in ~/shots to a timestamped -jpg file. - : **ssl-cert-fingerprints** Prints the SHA512, SHA256, SHA1 and MD5 digest of a x509 certificate. First and only parameter must be a file containing a certificate. Use @@ -908,71 +641,29 @@ Example usage: % Restart ssh ``` -: **status()** -Shows some information about current system status. - -: **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). : **uchange()** Shows upstreams changelog of a given package in $PAGER. -: **udiff()** -Makes a unified diff of the command line arguments trying hard to find a -smaller set of changes. Descends recursively into subdirectories. Ignores -hows some information about current status. - -: **uopen()** -Downloads and displays a file using a suitable program for its -Content-Type. - : **uprint()** Works around the "print -l ${(u)foo}"-limitation on zsh older than 4.2. -: **urlencode()** -Takes a string as its first argument and prints it RFC 2396 URL encoded to -standard out. - : **utf2iso()** Changes every occurrence of the string UTF-8 or utf-8 in environment variables to iso885915. -: **viless()** -Vim as pager. - : **vim()** Wrapper for vim(1). It tries to set the title and hands vim the environment variable VIM_OPTIONS on the command line. So the user may define command line options, she always wants, in her .zshrc.local. -: **vman()** -Use vim(1) as manpage reader. - : **whatwhen()** Searches the history for a given pattern and lists the results by date. The first argument is the search pattern. The second and third ones are optional and denote a search range (default: -100). -: **weather()** -Retrieves and prints weather information from "http://weather.noaa.gov". -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. @@ -989,12 +680,6 @@ arguments for details. : **xunfunction()** Removes the functions salias, xcat, xsource, xunfunction and zrcautoload. -: **zg()** -Search for patterns in grml's zshrc using perl. zg takes no or exactly one -option plus a non empty pattern. Run zg without any arguments for a listing -of available command line switches. For a zshrc not in /etc/zsh, set the -GRML_ZSHRC environment variable. - : **zrcautoload()** Wrapper around the autoload builtin. Loads the definitions of functions from the file given as argument. Searches $fpath for the file. See also @@ -1063,24 +748,6 @@ available packages are fetched from the location(s) specified in /etc/apt/sources.list. An update should always be performed before an upgrade or dist-upgrade; run by sudo, if necessary. -: **calc** (//peval//) -Evaluates a perl expression (see peval() above); useful as a command line -calculator. - -: **CH** (//./configure --help//) -Lists available compilation options for building program from source. - -: **cmplayer** (//mplayer -vo fbdev//) -Video player with framebuffer as video output device, so you can watch -videos on a virtual tty. Hint: Using fbdev2 allows you to use the shell -while watching a movie. - -: **CO** (//./configure//) -Prepares compilation for building program from source. - -: **cp** (//nocorrect cp//) -cp(1) without spelling correction. - : **da** (//du -sch//) Prints the summarized disk usage of the arguments as well as a grand total in human readable format. @@ -1091,25 +758,10 @@ Builds binary or source packages from sources (See: dpkg-buildpackage(1)). : **debs-by-size** (//grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd " \n" | sort -rn//) Prints installed Packages sorted by size (descending). -: **default** (//echo -en [ escape sequence ]//) -Sets font of xterm to "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15" -using escape sequence. - : **dir** (//ls -lSrah//) Lists files (including dot files) sorted by size (biggest last) in long and human readable output format. -: **fblinks** (//links2 -driver fb//) -A Web browser on the framebuffer device. So you can browse images and click -links on the virtual tty. - -: **fbmplayer** (//mplayer -vo fbdev -fs -zoom//) -Fullscreen Video player with the framebuffer as video output device. So you -can watch videos on a virtual tty. - -: **g** (//git//) -Revision control system by Linus Torvalds. - : **ge** (//grep-excuses//) Searches the testing excuses files for a specific maintainer (See: grep-excuses(1)). @@ -1117,9 +769,6 @@ grep-excuses(1)). : **grep** (//grep --color=auto//) Shows grep output in nice colors, if available. -: **GREP** (//grep -i --color=auto//) -Case insensitive grep with colored output. - : **grml-rebuildfstab** (//rebuildfstab -v -r -config//) Scans for new devices and updates /etc/fstab according to the findings. @@ -1145,16 +794,6 @@ ssh with possible man-in-the-middle attack enabled : **help-zshglob** (//H-Glob()//) Runs the function H-Glob() to expand or explain wildcards. -: **hide** (//echo -en [ escape sequence ]//) -Tries to hide xterm window using escape sequence. - -: **hidiff** (//histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'//) -If histring(1) is installed, highlight important stuff in diff(1) output. - -: **huge** (//echo -en [ escape sequence ]//) -Sets huge font in xterm ("-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15") -using escape sequence. - : **j** (//jobs -l//) Prints status of jobs in the current shell session in long format. @@ -1169,10 +808,6 @@ starting with ".". : **lad** (//ls -d .*(/)//) Lists the dot directories (not their contents) in current directory. -: **large** (//echo -en [ escape sequence ]//) -Sets large font in xterm ("-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15") -using escape sequence. - : **lh** (//ls -hAl --color=auto//) Lists files in long and human readable output format in nice colors, if available. Includes file names starting with "." except "." and @@ -1225,33 +860,13 @@ world executable (long output format). : **lsx** (//ls -l *(*)//) Lists only executable files. -: **md** (//mkdir -p//) -Creates directory including parent directories, if necessary - : **mdstat** (//cat /proc/mdstat//) Lists all active md (i.e. linux software raid) devices with some information about them. -: **medium** (//echo -en [ escape sequence ]//) -Sets medium sized font -("-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15") in xterm -using escape sequence. - -: **mkdir** (//nocorrect mkdir//) -mkdir(1) without spelling correction. - : **mq** (//hg -R $(readlink -f $(hg root)/.hg/patches)//) Executes the commands on the versioned patch queue from current repository. -: **mv** (//nocorrect mv//) -mv(1) without spelling correction. - -: **rd** (//rmdir//) -Short rmdir(1) (remove directory). - -: **rm** (//nocorrect rm//) -rm(1) without spelling correction. - : **rmcdir** (//'cd ..; rmdir $OLDPWD || cd $OLDPWD//) rmdir current working directory @@ -1261,39 +876,6 @@ as config file. If invoked by a regular user, start a screen session with users .screenrc config if it exists, else use /etc/grml/screenrc_grml as configuration. -: **rw-** (//chmod 600//) -Grants read and write permission of a file to the owner and nobody else. - -: **rwx** (//chmod 700//) -Grants read, write and execute permission of a file to the owner and nobody -else. - -: **r--** (//chmod 644//) -Grants read and write permission of a file to the owner and read-only to -anybody else. - -: **r-x** (//chmod 755//) -Grants read, write and execute permission of a file to the owner and -read-only plus execute permission to anybody else. - -: **S** (//screen//) -Short for screen(1). - -: **s** (//ssh//) -Short for ssh(1). - -: **semifont** (//echo -en [ escape sequence ]//) -Sets font of xterm to -"-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15" using -escape sequence. - -: **small** (//echo -en [ escape sequence ]//) -Sets small xterm font ("6x10") using escape sequence. - -: **smartfont** (//echo -en [ escape sequence ]//) -Sets font of xterm to "-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*" using -escape sequence. - : **su** (//sudo su//) If user is running a grml live-CD, dont ask for any password, if she wants a root shell. @@ -1306,22 +888,9 @@ http://www.cl.cam.ac.uk/~mgk25/unicode.html#term). Sets mode from ISO 2022 to UTF-8 (See: http://www.cl.cam.ac.uk/~mgk25/unicode.html#term). -: **tiny** (//echo -en [ escape sequence ]//) -Sets tiny xterm font -("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape -sequence. - : **tlog** (//tail -f /var/log/syslog//) Prints syslog continuously (See tail(1)). -: **top10** (//print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10//) -Prints the ten most used shell commands. - -: **truec** (//truecrypt [ mount options ]//) -Mount a truecrypt volume with some reasonable mount options -("rw,sync,dirsync,users,uid=1000,gid=users,umask=077" and "utf8", if -available). - : **up** (//aptitude update ; aptitude safe-upgrade//) Performs a system update followed by a system upgrade using aptitude; run by sudo, if necessary. See au and ag above. @@ -1330,21 +899,12 @@ by sudo, if necessary. See au and ag above. After calling, characters of URLs as typed get automatically escaped, if necessary, to protect them from the shell. -: **0** (//return 0//) -Gives a clean prompt (i.e. without $?). - : **$(uname -r)-reboot** (//kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)"//) Reboots using kexec(8) and thus reduces boot time by skipping hardware initialization of BIOS/firmware. : **...** (//cd ../..///) Changes current directory two levels higher. -: **?** (//qma zshall//) -Runs the grml script qma (quick manual access) to build the collected man -pages for the z-shell. This compressed file is kept at -~/man/zshall.txt.lzo Once it is built, the second use of the alias '?' is -fast. See "man qma" for further information. - = AUXILIARY FILES = This is a set of files, that - if they exist - can be used to customize the