grmlzshrc.t2t: More docs of some functions.
[grml-etc-core.git] / doc / grmlzshrc.t2t
index 02d646b..9ca442f 100644 (file)
@@ -243,6 +243,17 @@ user's life.
 Converts plaintext files to HTML using vim. The output is written to
 <filename>.html.
 
+: **agoogle()**
+Searches for USENET postings from authors using google groups.
+
+: **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,10 +266,27 @@ 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).
+
 : **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.
+
 : **doc()**
 Takes packagename as argument. Sets current working directory to
 /usr/share/doc/<packagename> and prints out a directory listing.
@@ -328,11 +356,22 @@ 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.
+
 : **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.
 
+: **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.
@@ -346,15 +385,34 @@ defined in the $PAGER environment variable.
 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".
+
 : **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 +440,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
@@ -395,15 +467,83 @@ life. A few aliases (like those involving //grep// or //ls//) use the option
 implementations of these tools, and will only be used if such an implementation
 is detected.
 
+: **acp** (//apt-cache policy//)
+With no arguments prints out the priorities of each source. If a package name
+is given, it displays detailed information about the priority selection of the
+package.
+
+: **acs** (//apt-cache search//)
+Searches debian package lists for the regular expression provided as argument.
+The search includes package names and descriptions. Prints out name and short
+description of matching packages.
+
+: **acsh** (//apt-cache show//)
+Shows the package records for the packages provided as arguments.
+
+: **adg** (//apt-get dist-upgrade//)
+Performs an upgrade of all installed packages. Also tries to automatically
+handle changing dependencies with new versions of packages. As this may change
+the install status of (or even remove) installed packages, it is potentially
+dangerous to use dist-upgrade; invoked by sudo, if necessary.
+
+: **ag** (//apt-get upgrade//)
+Downloads and installs the newest versions of all packages currently installed
+on the system. Under no circumstances are currently installed packages removed,
+or packages not already installed retrieved and installed. New versions of
+currently installed packages that cannot be upgraded without changing the install
+status of another package will be left at their current version. An update must
+be performed first (see au below); run by sudo, if necessary.
+
+: **agi** (//apt-get install//)
+Downloads and installs or upgrades the packages given on the command line.
+If a hyphen is appended to the package name, the identified package will be
+removed if it is installed. Similarly a plus sign can be used to designate a
+package to install. This may be useful to override decisions made by apt-get's
+conflict resolution system.
+A specific version of a package can be selected for installation by following
+the package name with an equals and the version of the package to select. This
+will cause that version to be located and selected for install. Alternatively a
+specific distribution can be selected by following the package name with a slash
+and the version of the distribution or the Archive name (stable, testing, unstable).
+Gets invoked by sudo, if user id is not 0.
+
+: **ati** (//aptitude install//)
+Aptitude is a terminal-based package manager with a command line mode similar to
+apt-get (see agi above); invoked by sudo, if necessary.
+
+: **au** (//apt-get update//)
+Resynchronizes the package index files from their sources. The indexes of
+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.
+
 : **da** (//du -sch//)
 Prints the summarized disk usage of the arguments as well as a grand total
 in human readable format.
 
+: **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.
@@ -421,10 +561,38 @@ 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.
+
+: **grml-version** (//cat /etc/grml_version//)
+Prints version of running grml.
+
 : **http** (//python -m SimpleHTTPServer//)
 Basic HTTP server implemented in python. Listens on port 8000/tcp and
 serves current directory. Implements GET and HEAD methods.
 
+: **insecscp** (//scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
+scp with possible man-in-the-middle attack enabled. This is convenient, if the targets
+host key changes frequently, for example on virtualized test- or development-systems.
+To be used only inside trusted networks, of course.
+
+: **insecssh** (//ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"//)
+ssh with possible man-in-the-middle attack enabled
+(for an explanation see insecscp above).
+
+: **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.
+
+: **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.
+
 : **l** (//ls -lF --color=auto//)
 Lists files in long output format with indicator for filetype appended
 to filename. If the terminal supports it, with colored output.
@@ -433,6 +601,13 @@ to filename. If the terminal supports it, with colored output.
 Lists files in long colored output format. Including file names
 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
@@ -441,15 +616,15 @@ if available. Includes file names starting with "." except "." and
 : **ll** (//ls -l --color=auto//)
 Lists files in long colored output format.
 
-: **j** (//jobs -l//)
-Prints status of jobs in the current shell session in long format.
-
 : **ls** (//ls -b -CF --color=auto//)
 Lists directory printing octal escapes for nongraphic characters.
 Entries are listed by columns and an indicator for file type is appended
 to each file name. Additionally the output is colored, if the terminal
 supports it.
 
+: **lsa** (//ls -a .*(.)//)
+Lists dot files in current working directory.
+
 : **lsbig** (//ls -flh *(.OL[1,10])//)
 Displays the ten biggest files (long and human readable output format).
 
@@ -459,12 +634,19 @@ Shows directories.
 : **lse** (//ls -d *(/^F)//)
 Shows empty directories.
 
+: **lsl** (//ls -l *(@)//)
+Lists symbolic links in current directory.
+
 : **lsnew** (//ls -rl *(D.om[1,10])//)
 Displays the ten newest files (long output format).
 
 : **lsold** (//ls -rtlh *(D.om[1,10])//)
 Displays the ten oldest files (long output format).
 
+: **lss** (//ls -l *(s,S,t)//)
+Lists files in current directory that have the setuid, setgid or sticky bit
+set.
+
 : **lssmall** (//ls -Srl *(.oL[1,10])//)
 Displays the ten smallest files (long output format).
 
@@ -478,6 +660,11 @@ Lists only executable files.
 : **md** (//mkdir -p//)
 Creates directory including parent directories, if necessary
 
+: **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.
+
 : **screen** (///usr/bin/screen -c ${HOME}/.screenrc//)
 If invoking user is root, starts screen session with /etc/grml/screenrc
 as config file. If invoked by a regular user, start a screen session
@@ -499,6 +686,42 @@ anybody else.
 Grants read, write and execute permission of a file to the owner and
 read-only plus execute permission to anybody else.
 
+: **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.
+
+: **tiny** (//echo -en [ escape sequence ]//)
+Sets tiny xterm font
+("-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15") using escape
+sequence.
+
+: **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.
+
+: **?** (//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