Differences

This shows you the differences between two versions of the page.

Link to this comparison view

commands:builtin:return [2015/11/16 04:43] (current)
thebonsai created
Line 1: Line 1:
 +====== The return builtin command ======
 +
 +===== Synopsis =====
 +<​code>​return [N]</​code>​
 +
 +===== Description =====
 +The ''​return''​ command returns from a shell function.
 +
 +If ''​N''​ is given, the return code to the caller is set to ''​N''​. If not, the returned status the the status of the most recently executed command (i.e. ''​$?''​).
 +
 +==== Options ====
 +There are no options.
 +
 +
 +==== Exit status ====
 +
 +If everything is okay, the ''​return''​ command doesn'​t come back. If it comes back, there was a problem in doing the return.
 +
 +^Status ​ ^Reason ​ ^
 +|1     ​|''​return''​ was called while not being in a shell function or sourced file  |
 +
 +
 +===== Examples =====
 +
 +
 +===== Portability considerations =====
 +
 +===== See also =====
 +  * [[commands:​builtin:​exit|The exit builtin command]]
 +  * [[dict:​terms:​exit_status|The exit status]]