grmlzshrc.t2t: Docs for software installing functions.
[grml-etc-core.git] / doc / grmlzshrc.t2t
index dd63663..3f0d90d 100644 (file)
@@ -243,6 +243,24 @@ user's life.
 Converts plaintext files to HTML using vim. The output is written to
 <filename>.html.
 
+: **855resolution()**
+If 915resolution is available, issues a warning to the user to run it instead
+to modify the resolution on intel graphics chipsets.
+
+: **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.
+
+: **aoeu(), asdf(), uiae()**
+Pressing the 'asdf' keys toggles between dvorak or neon and us keyboard
+layout.
+
 : **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
@@ -255,14 +273,52 @@ 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.
+
+: **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).
+
+: **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.
+
 : **cl()**
 Changes current directory to the one supplied by argument and lists the files
 in it, including file names starting with ".".
 
+: **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.
+
+: **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.
+
 : **doc()**
 Takes packagename as argument. Sets current working directory to
 /usr/share/doc/<packagename> and prints out a directory listing.
 
+: **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.
@@ -276,6 +332,36 @@ 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!
 
+: **getair()**
+Tries to download, unpack and run AIR (imaging software) version 1.2.8.
+
+: **getgizmo()**
+Tries to download and install Gizmo (VoIP software) for Debian.
+
+: **getskype()**
+Tries to download and install Skype (VoIP software) for Debian.
+
+: **getskypebeta()**
+Downloads and installs newer version of Skype.
+
+: **getxlite()**
+Tries to download and unpack X-lite (VoIP software) from counterpath.com into
+~/tmp.
+
+: **git-get-diff()**
+Opens a specific git commitdiff from kernel.org in default browser. Tree is
+chosen by the environment variable GITTREE which defaults to Linus Torvalds'
+kernel tree.
+
+: **git-get-commit()**
+Opens a specific git commit from kernel.org in default browser. The tree to
+fetch from is controlled by the environment variable GITTREE which defaults
+to Linus Torvalds' kernel tree.
+
+: **git-get-plaindiff()**
+Fetches specific git diff from kernel.org. The tree is controlled by the
+environment variable GITTREE which defaults to Linus Torvalds' kernel tree.
+
 : **greph()**
 Searches the zsh command history for a regular expression.
 
@@ -283,6 +369,9 @@ Searches the zsh command history for a regular expression.
 Prints the hexadecimal representation of the number supplied as argument
 (base ten only).
 
+: **hidiff()**
+Outputs highlighted diff; needs highstring(1).
+
 : **is4()**
 Returns true, if zsh version is equal or greater than 4, else false.
 
@@ -328,11 +417,34 @@ directory.
 Creates directory including parent directories, if necessary. Then changes
 current working directory to it.
 
+: **minimal-shell()**
+Spawns a absolute minimal 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.
 
+: **mmake()**
+Runs "make install" and logs the output under ~/.errorlogs/; useful for
+a clean deinstall later.
+
+: **ogg2mp3_192()**
+Recodes an ogg file to mp3 with a bitrate of 192.
+
+: **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.
+
 : **purge()**
 Removes typical temporary files (i. e. files like "*~", ".*~", "#*#", "*.o",
 "a.out", "*.core", "*.cmo", "*.cmi" and ".*.swp") from current directory.
@@ -342,19 +454,44 @@ Asks for confirmation.
 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.
 
+: **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.
+
+: **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 file with the appropriate programs. The
+choice is made along the filename ending.
+
 : **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".
+
+: **smartindent()**
+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,
@@ -382,11 +519,25 @@ standard out.
 : **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.
+
 : **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.
 
+: **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.
+
 
 == ALIASES ==
 //grmlzshrc// comes with a wide array of predefined aliases to ease the user's