RETURN(1)                  POSIX Programmer's Manual                 RETURN(1)



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

NNAAMMEE
       return -- return from a function or dot script

SSYYNNOOPPSSIISS
       return [[_n]]

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

OOPPTTIIOONNSS
       None.

OOPPEERRAANNDDSS
       See the DESCRIPTION.

SSTTDDIINN
       Not used.

IINNPPUUTT FFIILLEESS
       None.

EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS
       None.

AASSYYNNCCHHRROONNOOUUSS EEVVEENNTTSS
       Default.

SSTTDDOOUUTT
       Not used.

SSTTDDEERRRR
       The standard error shall be used only for diagnostic messages.

OOUUTTPPUUTT FFIILLEESS
       None.

EEXXTTEENNDDEEDD DDEESSCCRRIIPPTTIIOONN
       None.

EEXXIITT SSTTAATTUUSS
       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 _r_e_t_u_r_n is executed
       in a _t_r_a_p action, the last command is considered to be the command that
       executed immediately preceding the _t_r_a_p action.

CCOONNSSEEQQUUEENNCCEESS OOFF EERRRROORRSS
       Default.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

EEXXAAMMPPLLEESS
       None.

RRAATTIIOONNAALLEE
       The behavior of _r_e_t_u_r_n when not in a function or _d_o_t 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
       _e_x_i_t.

       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 _e_x_i_t.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _S_e_c_t_i_o_n _2_._9_._5, _F_u_n_c_t_i_o_n _D_e_f_i_n_i_t_i_o_n _C_o_m_m_a_n_d, _S_e_c_t_i_o_n _2_._1_4, _S_p_e_c_i_a_l
       _B_u_i_l_t_-_I_n _U_t_i_l_i_t_i_e_s, _d_o_t

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                            RETURN(1)
