summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man1p/break.1p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2013/man1p/break.1p')
-rw-r--r--man-pages-posix-2013/man1p/break.1p134
1 files changed, 134 insertions, 0 deletions
diff --git a/man-pages-posix-2013/man1p/break.1p b/man-pages-posix-2013/man1p/break.1p
new file mode 100644
index 0000000..77cf59a
--- /dev/null
+++ b/man-pages-posix-2013/man1p/break.1p
@@ -0,0 +1,134 @@
+'\" et
+.TH BREAK "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.SH 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.
+
+.SH NAME
+break
+\(em exit from for, while, or until loop
+.SH SYNOPSIS
+.LP
+.nf
+break \fB[\fIn\fB]\fR
+.fi
+.SH DESCRIPTION
+The
+.IR break
+utility shall exit from the smallest enclosing
+.BR for ,
+.BR while ,
+or
+.BR until
+loop, if any; or from the
+.IR n th
+enclosing loop if
+.IR n
+is specified. The value of
+.IR n
+is an unsigned decimal integer greater than or equal to 1. The default
+shall be equivalent to
+.IR n =1.
+If
+.IR n
+is greater than the number of enclosing loops, the outermost enclosing
+loop shall be exited. Execution shall continue with the command
+immediately following the loop.
+.SH OPTIONS
+None.
+.SH OPERANDS
+See the DESCRIPTION.
+.SH STDIN
+Not used.
+.SH "INPUT FILES"
+None.
+.SH "ENVIRONMENT VARIABLES"
+None.
+.SH "ASYNCHRONOUS EVENTS"
+Default.
+.SH STDOUT
+Not used.
+.SH STDERR
+The standard error shall be used only for diagnostic messages.
+.SH "OUTPUT FILES"
+None.
+.SH "EXTENDED DESCRIPTION"
+None.
+.SH "EXIT STATUS"
+.IP "\00" 6
+Successful completion.
+.IP >0 6
+The
+.IR n
+value was not an unsigned decimal integer greater than or equal to 1.
+.SH "CONSEQUENCES OF ERRORS"
+Default.
+.LP
+.IR "The following sections are informative."
+.SH "APPLICATION USAGE"
+None.
+.SH EXAMPLES
+.LP
+.nf
+for i in *
+do
+ if test \(mid "$i"
+ then break
+ fi
+done
+.fi
+.SH "RATIONALE"
+In early proposals, consideration was given to expanding the syntax of
+.IR break
+and
+.IR continue
+to refer to a label associated with the appropriate loop as a
+preferable alternative to the
+.IR n
+method. However, this volume of POSIX.1\(hy2008 does reserve the name space of command names
+ending with a
+<colon>.
+It is anticipated that a future implementation could take advantage of
+this and provide something like:
+.sp
+.RS 4
+.nf
+\fB
+outofloop: for i in a b c d e
+do
+ for j in 0 1 2 3 4 5 6 7 8 9
+ do
+ if test \(mir "${i}${j}"
+ then break outofloop
+ fi
+ done
+done
+.fi \fR
+.P
+.RE
+.P
+and that this might be standardized after implementation experience is
+achieved.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "Section 2.14" ", " "Special Built-In Utilities"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, Copyright (C) 2013 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/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 .