No specific user configuration
[platform/upstream/bash.git] / examples / INDEX.txt
1 Path    Description     X-Ref
2 ./obashdb       Deprecated sample implementation of a bash debugger     
3
4 ./complete      Shell completion code   
5
6 ./functions     Example functions       
7 ./functions/array-stuff Various array functions (ashift, array_sort, reverse).  
8 ./functions/array-to-string     Convert an array to a string.   
9 ./functions/autoload    An almost ksh-compatible 'autoload' (no lazy load).     ksh
10 ./functions/autoload.v2 An almost ksh-compatible 'autoload' (no lazy load).     ksh
11 ./functions/autoload.v3 A more ksh-compatible 'autoload' (with lazy load).      ksh
12 ./functions/basename    A replacement for basename(1).  basename
13 ./functions/basename2   Fast basename(1) and dirname(1) functions for BASH/SH.  basename, dirname
14 ./functions/coproc.bash Start, control, and end coprocesses.    
15 ./functions/coshell.bash        Control shell coprocesses (see coprocess.bash). 
16 ./functions/coshell.README      README for coshell and coproc.  
17 ./functions/csh-compat  A C-shell compatibility package.        csh
18 ./functions/dirfuncs    Directory manipulation functions from the book 'The Korn Shell'.        
19 ./functions/dirname     A replacement for dirname(1).   dirname
20 ./functions/emptydir    Find out if a directory is empty.       
21 ./functions/exitstat    Display the exit status of processes.   
22 ./functions/external    Like 'command' but FORCES use of external command.      
23 ./functions/fact        Recursive factorial function.   
24 ./functions/fstty       Front end to sync TERM changes to both stty(1) and readline 'bind'.     stty.bash
25 ./functions/func        Print out definitions for functions named by arguments. 
26 ./functions/gethtml     Get a web page from a remote server (wget(1) in bash!). 
27 ./functions/getoptx.bash        getopt function that parses long-named options. 
28 ./functions/inetaddr    Internet address conversion (inet2hex & hex2inet).      
29 ./functions/inpath      Return zero if the argument is in the path and executable.      inpath
30 ./functions/isnum.bash  Test user input on numeric or character value.  
31 ./functions/isnum2      Test user input on numeric values, with floating point. 
32 ./functions/isvalidip   Test user input for valid IP Addresses. 
33 ./functions/jdate.bash  Julian date conversion. 
34 ./functions/jj.bash     Look for running jobs.  
35 ./functions/keep        Try to keep some programs in the foreground and running.        
36 ./functions/ksh-cd      ksh-like 'cd': cd [-LP] [dir [change]]. ksh
37 ./functions/ksh-compat-test     ksh-like arithmetic test replacements.  ksh
38 ./functions/kshenv      Functions and aliases to provide the beginnings of a ksh environment for bash.  ksh
39 ./functions/login       Replace the 'login' and 'newgrp' builtins in old Bourne shells. 
40 ./functions/lowercase   Rename files to lower case.     rename lower
41 ./functions/manpage     Find and print a manual page.   fman
42 ./functions/mhfold      Print MH folders, useful only because folders(1) doesn't print mod date/times.  
43 ./functions/notify.bash Notify when jobs change status. 
44 ./functions/pathfuncs   Path related functions (no_path, add_path, pre-path, del_path). path
45 ./functions/README      README  
46 ./functions/recurse     Recursive directory traverser.  
47 ./functions/repeat2     A clone of C shell builtin 'repeat'.    repeat, csh
48 ./functions/repeat3     A clone of C shell builtin 'repeat'.    repeat, csh
49 ./functions/seq Generate a sequence from m to n, m defaults to 1.       
50 ./functions/seq2        Generate a sequence from m to n, m defaults to 1.       
51 ./functions/shcat       Readline-based pager.   cat, readline pager
52 ./functions/shcat2      Readline-based pagers.  cat, readline pager
53 ./functions/sort-pos-params     Sort the positional parameters. 
54 ./functions/substr      A function to emulate the ancient ksh builtin.  ksh
55 ./functions/substr2     A function to emulate the ancient ksh builtin.  ksh
56 ./functions/term        A shell function to set the terminal type interactively or not. 
57 ./functions/whatis      An implementation of the 10th Edition Unix sh builtin 'whatis(1)' command.      
58 ./functions/whence      An almost-ksh compatible 'whence(1)' command.   
59 ./functions/which       An emulation of 'which(1)' as it appears in FreeBSD.    
60 ./functions/xalias.bash Convert csh alias commands to bash functions.   csh, aliasconv
61 ./functions/xfind.bash  A 'find(1)' clone.      
62
63 ./loadables/    Example loadable replacements   
64 ./loadables/basename.c  Return non-directory portion of pathname.       basename
65 ./loadables/cat.c       cat(1) replacement with no options - the way cat was intended.  cat, readline pager
66 ./loadables/cut.c       cut(1) replacement.     
67 ./loadables/dirname.c   Return directory portion of pathname.   dirname
68 ./loadables/finfo.c     Print file info.        
69 ./loadables/getconf.c   POSIX.2 getconf utility.        
70 ./loadables/getconf.h   Replacement definitions for ones the system doesn't provide.    
71 ./loadables/head.c      Copy first part of files.       
72 ./loadables/hello.c     Obligatory "Hello World" / sample loadable.     
73 ./loadables/id.c        POSIX.2 user identity.  
74 ./loadables/ln.c        Make links.     
75 ./loadables/logname.c   Print login name of current user.       
76 ./loadables/Makefile.in Simple makefile for the sample loadable builtins.       
77 ./loadables/mkdir.c     Make directories.       
78 ./loadables/necho.c     echo without options or argument interpretation.        
79 ./loadables/pathchk.c   Check pathnames for validity and portability.   
80 ./loadables/print.c     Loadable ksh-93 style print builtin.    
81 ./loadables/printenv.c  Minimal builtin clone of BSD printenv(1).
82 ./loadables/push.c      Anyone remember TOPS-20?
83 ./loadables/README      README
84 ./loadables/realpath.c  Canonicalize pathnames, resolving symlinks.
85 ./loadables/rmdir.c     Remove directory.
86 ./loadables/sleep.c     sleep for fractions of a second.
87 ./loadables/strftime.c  Loadable builtin interface to strftime(3).
88 ./loadables/sync.c      Sync the disks by forcing pending filesystem writes to complete.
89 ./loadables/tee.c       Duplicate standard input.
90 ./loadables/template.c  Example template for loadable builtin.
91 ./loadables/truefalse.c True and false builtins.
92 ./loadables/tty.c       Return terminal name.
93 ./loadables/uname.c     Print system information.
94 ./loadables/unlink.c    Remove a directory entry.
95 ./loadables/whoami.c    Print out username of current user.
96
97 ./loadables/perl/       Illustrate how to build a Perl interpreter into bash.   
98
99 ./misc  Miscellaneous   
100 ./misc/aliasconv.bash   Convert csh aliases to bash aliases and functions.      csh, xalias
101 ./misc/aliasconv.sh     Convert csh aliases to bash aliases and functions.      csh, xalias
102 ./misc/cshtobash        Convert csh aliases, environment variables, and variables to bash equivalents.  csh, xalias
103 ./misc/README   README  
104 ./misc/suncmd.termcap   SunView TERMCAP string. 
105
106 ./scripts.noah  Noah Friedman's collection of scripts (updated to bash v2 syntax by Chet Ramey) 
107 ./scripts.noah/aref.bash        Pseudo-arrays and substring indexing examples.  
108 ./scripts.noah/bash.sub.bash    Library functions used by require.bash. 
109 ./scripts.noah/bash_version.bash        A function to slice up $BASH_VERSION.   
110 ./scripts.noah/meta.bash        Enable and disable eight-bit readline input.    
111 ./scripts.noah/mktmp.bash       Make a temporary file with a unique name.       
112 ./scripts.noah/number.bash      A fun hack to translate numerals into English.  
113 ./scripts.noah/PERMISSION       Permissions to use the scripts in this directory.       
114 ./scripts.noah/prompt.bash      A way to set PS1 to some predefined strings.    
115 ./scripts.noah/README   README  
116 ./scripts.noah/remap_keys.bash  A front end to 'bind' to redo readline bindings.        
117 ./scripts.noah/require.bash     Lisp-like require/provide library functions for bash.   
118 ./scripts.noah/send_mail.bash   Replacement SMTP client written in bash.        
119 ./scripts.noah/shcat.bash       Bash replacement for 'cat(1)'.  cat
120 ./scripts.noah/source.bash      Replacement for source that uses current directory.     
121 ./scripts.noah/string.bash      The string(3) functions at the shell level.     
122 ./scripts.noah/stty.bash        Front-end to stty(1) that changes readline bindings too.        fstty
123 ./scripts.noah/y_or_n_p.bash    Prompt for a yes/no/quit answer.        ask
124
125 ./scripts.v2    John DuBois' ksh script collection (converted to bash v2 syntax by Chet Ramey). 
126 ./scripts.v2/arc2tarz   Convert an "arc" archive to a compressed tar archive.   
127 ./scripts.v2/bashrand   Random number generator with upper and lower bounds and optional seed.  random
128 ./scripts.v2/cal2day.bash       Convert a day number to a name. 
129 ./scripts.v2/cdhist.bash        cd replacement with a directory stack added.    
130 ./scripts.v2/corename   Tell what produced a core file. 
131 ./scripts.v2/fman       Fast man(1) replacement.        manpage
132 ./scripts.v2/frcp       Copy files using ftp(1) but with rcp-type command line syntax.  
133 ./scripts.v2/lowercase  Change filenames to lower case. rename lower
134 ./scripts.v2/ncp        A nicer front end for cp(1) (has -i, etc.).     
135 ./scripts.v2/newext     Change the extension of a group of files.       rename
136 ./scripts.v2/nmv        A nicer front end for mv(1) (has -i, etc.).     rename
137 ./scripts.v2/pages      Print specified pages from files.       
138 ./scripts.v2/PERMISSION Permissions to use the scripts in this directory.       
139 ./scripts.v2/pf A pager front end that handles compressed files.        
140 ./scripts.v2/pmtop      Poor man's 'top(1)' for SunOS 4.x and BSD/OS.   
141 ./scripts.v2/README     README  
142 ./scripts.v2/ren        Rename files by changing parts of filenames that match a pattern.       rename
143 ./scripts.v2/rename     Change the names of files that match a pattern. rename
144 ./scripts.v2/repeat     Execute a command multiple times.       repeat
145 ./scripts.v2/shprof     Line profiler for bash scripts. 
146 ./scripts.v2/untar      Unarchive a (possibly compressed) tarfile into a directory.     
147 ./scripts.v2/uudec      Carefully uudecode(1) multiple files.   
148 ./scripts.v2/uuenc      uuencode(1) multiple files.     
149 ./scripts.v2/vtree      Print a visual display of a directory tree.     tree
150 ./scripts.v2/where      Show where commands that match a pattern are.   
151
152 ./scripts       Example scripts 
153 ./scripts/adventure.sh  Text adventure game in bash!    
154 ./scripts/bash-hexdump.sh       hexdump(1) in bash
155 ./scripts/bcsh.sh       Bourne shell cshell-emulator.   csh
156 ./scripts/cat.sh        Readline-based pager.   cat, readline pager
157 ./scripts/center        Center - center a group of lines.       
158 ./scripts/dd-ex.sh      Line editor using only /bin/sh, /bin/dd and /bin/rm.    
159 ./scripts/fixfiles.bash Recurse a tree and fix files containing various "bad" chars.    
160 ./scripts/hanoi.bash    The inevitable Towers of Hanoi in bash. 
161 ./scripts/inpath        Search $PATH for a file the same name as $1; return TRUE if found.      inpath
162 ./scripts/krand.bash    Produces a random number within integer limits. random
163 ./scripts/line-input.bash       Line input routine for GNU Bourne-Again Shell plus terminal-control primitives. 
164 ./scripts/nohup.bash    bash version of 'nohup' command.        
165 ./scripts/precedence    Test relative precedences for '&&' and '||' operators.  
166 ./scripts/randomcard.bash       Print a random card from a card deck.   random
167 ./scripts/README        README  
168 ./scripts/scrollbar     Display scrolling text. 
169 ./scripts/scrollbar2    Display scrolling text. 
170 ./scripts/self-repro    A self-reproducing script (careful!)    
171 ./scripts/showperm.bash Convert ls(1) symbolic permissions into octal mode.     
172 ./scripts/shprompt      Display a prompt and get an answer satisfying certain criteria. ask
173 ./scripts/spin.bash     Display a 'spinning wheel' to show progress.    
174 ./scripts/timeout       Give rsh(1) a shorter timeout.  
175 ./scripts/timeout2      Execute a given command with a timeout.
176 ./scripts/timeout3      Execute a given command with a timeout.
177 ./scripts/vtree2        Display a tree printout of dir in 1k blocks.    tree
178 ./scripts/vtree3        Display a graphical tree printout of dir.       tree
179 ./scripts/vtree3a       Display a graphical tree printout of dir.       tree
180 ./scripts/websrv.sh     A web server in bash!   
181 ./scripts/xterm_title   Print the contents of the xterm title bar.      
182 ./scripts/zprintf       Emulate printf (obsolete since it's now a bash builtin).        
183
184 ./startup-files Example Start-up files. 
185 ./startup-files/Bash_aliases    Some useful aliases (Fox).      
186 ./startup-files/Bash_profile    Sample startup file for bash login shells (Fox).        
187 ./startup-files/bash-profile    Sample startup file for bash login shells (Ramey).      
188 ./startup-files/bashrc  Sample Bourne Again SHell init file (Ramey).    
189 ./startup-files/Bashrc.bfox     Sample Bourne Again SHell init file (Fox).      
190 ./startup-files/README  README  
191
192 ./startup-files/apple   Example Start-up files for Mac OS X.    
193 ./startup-files/apple/aliases   Sample aliases for Mac OS X.    
194 ./startup-files/apple/bash.defaults     Sample User preferences file.
195 ./startup-files/apple/environment       Sample Bourne Again Shell environment file.
196 ./startup-files/apple/login     Sample login wrapper.
197 ./startup-files/apple/logout    Sample logout wrapper.
198 ./startup-files/apple/rc        Sample Bourne Again Shell config file.
199 ./startup-files/apple/README    README