bash-hackers-wiki/docs/commands/builtin/return.md

# The return builtin command

## Synopsis

    return [N]

## 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

-   [The exit builtin command](../../commands/builtin/exit.md)
-   [The exit status](../../dict/exit_status.md)
Convert all builtin commands to Markdown 2023-07-05 10:53:12 +02:00			`# The return builtin command`

			`## Synopsis`

			`return [N]`

			`## 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`

format(docs): remove escaped t's 2024-03-30 20:09:26 +01:00			If everything is okay, the `return` command doesn't come back. If it
Convert all builtin commands to Markdown 2023-07-05 10:53:12 +02:00			`comes back, there was a problem in doing the return.`

Updated table formatting, call-outs, html comments, improper escapes. 2024-10-08 06:00:17 +02:00			`\|Status\|Reason\|`
			`\|-\|-\|`
			\|1\|`return` was called while not being in a shell function or sourced file\|
Convert all builtin commands to Markdown 2023-07-05 10:53:12 +02:00
			`## Examples`

			`## Portability considerations`

			`## See also`

Fix hyperlinks of markdown pages at depth 3 find docs/ -depth 3 -name '.md' \| xargs grep '(./' -l \| \ xargs -I{} \ sed -i '' \ -e 's%(/\([^/#).][^/#).]\)/\([^/#).][^/#).]\)\(.md\)\{0\})%(../../\1/\2.md)%g' \ -e 's%(/\([^/#).][^/#).]\)/\([^/#).][^/#).]\)#\([a-zA-Z_-][0-9a-zA-Z_-]\))%(../../\1/\2.md#\3)%g' \ -e 's%(/\([^/#).][^/#).]\)/\([^/#).][^/#).]\)/\([^/#).][^/#).]\)\(.md\)\{0\})%(../../\1/\2/\3.md)%g' \ -e 's%(/\([^/#).][^/#).]\)/\([^/#).][^/#).]\)/\([^/#).][^/#).]\)#\([a-zA-Z_-][0-9a-zA-Z_-]\))%(../../\1/\2/\3.md#\4)%g' \ -e 's%](\([^:.>)#][^:.>)#]\))%](../../\1.md)%g' \ -e 's%](\([^:.>)#][^:.>)#]\)#\([^:.>)#][^:.>)#]*\))%](../../\1.md#\2)%g' \ {} Related to https://github.com/flokoe/bash-hackers-wiki/issues/10 2024-01-29 02:07:56 +01:00			`- [The exit builtin command](../../commands/builtin/exit.md)`
Fix "relative links target not found" warnings 2024-04-02 23:19:23 +02:00			`- [The exit status](../../dict/exit_status.md)`