hyperreal/wiki.bash-hackers.org
1
0
Fork 0
mirror of https://github.com/rawiriblundell/wiki.bash-hackers.org synced 2024-11-01 08:33:06 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
main
wiki.bash-hackers.org/start.md
Rawiri Blundell 51f5b90080 Correct remaining html-bound links
2023-04-28 11:25:39 +12:00

21 KiB
Raw Permalink Blame History

The Bash Hackers Wiki

This wiki is intended to hold documentation of any kind about GNU Bash. The main motivation was to provide human-readable documentation and information so users aren't forced to read every bit of the Bash manpage - which can be difficult to understand. However, the docs here are not meant as a newbie tutorial.

This wiki and any programs found in this wiki are free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This wiki and its programs are distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

What would YOU like to see here? (outdated and locked, please use the discussions)

Stranger! Feel free to register and comment or edit the contents. There is a Bash Hackers Wiki needs love page that lists some things to do. The registration is only there to prevent SPAM.

Scripting and general information

Code snippets

There is a section that holds small code snippets.

See also some Bash source code excerpts.

How to

Doing specific tasks: concepts, methods, ideas:

Bash syntax and operations

Compound commands

Compound commands overview
Grouping
{ ...; } command grouping
( ... ) command grouping in a subshell
Conditionals
[[ ... ]] conditional expression
if ...; then ...; fi conditional branching
case ... esac pattern-based branching
Loops
for word in ...; do ...; done classic for-loop
for ((x=1; x<=10; x++)); do ...; done C-style for-loop
while ...; do ...; done while loop
until ...; do ...; done until loop
Misc
(( ... )) arithmetic evaluation
select word in ...; do ...; done user selections

Expansions and substitutions

Introduction to expansions and substitutions
{A,B,C} {A..C} Brace expansion
~/ ~root/ Tilde expansion
$FOO ${BAR%.mp3} Parameter expansion
`command` $(command) Command substitution
<(command) >(command) Process substitution
$((1 + 2 + 3)) $[4 + 5 + 6] Arithmetic expansion
Hello <---> Word! Word splitting
/data/*-av/*.mp? Pathname expansion

Builtin Commands

This is a selection of builtin commands and command-like keywords, loosely arranged by their common uses. These are provided directly by the shell, rather than invoked as standalone external commands.

Declaration commands
Commands that set and query attributes/types, and manipulate simple datastructures.		 Alt Type
declare Display or set shell variables or functions along with attributes. typeset builtin
export Display or set shell variables, also giving them the export attribute. typeset -x special builtin
eval Evaluate arguments as shell code. - special builtin
local Declare variables as having function local scope. - builtin
readonly Mark variables or functions as read-only. typeset -r special builtin
unset Unset variables and functions. - special builtin
shift Shift positional parameters - special builtin
I/O
Commands for reading/parsing input, or producing/formatting output of standard streams.		 Alt Type
coproc Co-processes: Run a command in the background with pipes for reading / writing its standard streams. - keyword
echo Create output from arguments. - builtin
mapfile Read lines of input into an array. readarray builtin
printf "advanced echo." - builtin
read Read input into variables or arrays, or split strings into fields using delimiters. - builtin
Configuration and Debugging
Commands that modify shell behavior, change special options, assist in debugging.		 Alt Type
caller Identify/print execution frames. - builtin
set Set the positional parameters and/or set options that affect shell behaviour. - special builtin
shopt set/get some bash-specific shell options. - builtin
Control flow and data processing
Commands that operate on data and/or affect control flow.		 Alt Type
colon "true" null command. true special builtin
dot Source external files. source special builtin
false Fail at doing nothing. - builtin
continue / break continue with or break out of loops. - special builtin
let Arithmetic evaluation simple command. - builtin
return Return from a function with a specified exit status. - special builtin
[ The classic test simple command. test builtin
Process and Job control
Commands related to jobs, signals, process groups, subshells.		 Alt Type
exec Replace the current shell process or set redirections. - special builtin
exit Exit the shell. - special builtin
kill Send a signal to specified process(es) - builtin
trap Set signal handlers or output the current handlers. - special builtin
times Display process times. - special builtin
wait Wait for background jobs and asynchronous lists. - builtin
Alt Type

Dictionary

💡 A list of expressions, words, and their meanings is here.

Links

Official Bash links

Recommended Shell resources

Documentation / Reference

Assorted interesting links

Bash Libraries (needs review)

Contact

Visit us in irc.freenode.net, channel #bash ;-)

If you have critiques or suggestions, please feel free to send a mail using the contact form on the right. Note that there is a simple discussion option below every article.

Please also see the imprint if you have problems with the site and its contents (legality, ...)!

It also would be nice to drop a line when

  • it helped you
  • it didn't help you (something missing / unclear)
  • you like it
  • you don't like it
  • you found mistakes / bugs

Simply: Reader's feedback