logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface

Application Usage

       None.

Asynchronous Events

       Default.

Consequences Of Errors

       Default.

       Thefollowingsectionsareinformative.

Description

       The  return  utility  shall  cause the shell to stop executing the current function or dot script. If the
       shell is not currently executing a function or dot script, the results are unspecified.

Environment Variables

       None.

Examples

       None.

Exit Status

       The value of the special parameter '?'  shall be set to n, an unsigned decimal integer, or  to  the  exit
       status of the last command executed if n is not specified. If n is not an unsigned decimal integer, or is
       greater than 255, the results are unspecified. When return is executed in a trap action, the last command
       is considered to be the command that executed immediately preceding the trap action.

Extended Description

       None.

Future Directions

       None.

Input Files

       None.

Name

       return — return from a function or dot script

Operands

       See the DESCRIPTION.

Options

       None.

Output Files

       None.

Prolog

       This  manual  page  is part of the POSIX Programmer's Manual.  The Linux implementation of this interface
       may differ (consult the corresponding Linux manual page for details of Linux behavior), or the  interface
       may not be implemented on Linux.

Rationale

       The  behavior  of  return when not in a function or dot script differs between the System V shell and the
       KornShell. In the System V shell this is an error, whereas in the KornShell, the effect is  the  same  as
       exit.

       The  results  of  returning a number greater than 255 are undefined because of differing practices in the
       various historical implementations. Some shells AND out all but the low-order 8 bits; others allow larger
       values, but not of unlimited size.

       See the discussion of appropriate exit status values under exit.

See Also

Section2.9.5, FunctionDefinitionCommand, Section2.14, SpecialBuilt-InUtilities, dot

Stderr

       The standard error shall be used only for diagnostic messages.

Stdin

       Not used.

Stdout

       Not used.

Synopsis

       return [n]

See Also