summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man1p/readonly.1p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2013/man1p/readonly.1p')
-rw-r--r--man-pages-posix-2013/man1p/readonly.1p164
1 files changed, 164 insertions, 0 deletions
diff --git a/man-pages-posix-2013/man1p/readonly.1p b/man-pages-posix-2013/man1p/readonly.1p
new file mode 100644
index 0000000..f00a71a
--- /dev/null
+++ b/man-pages-posix-2013/man1p/readonly.1p
@@ -0,0 +1,164 @@
+'\" et
+.TH READONLY "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
+readonly
+\(em set the readonly attribute for variables
+.SH SYNOPSIS
+.LP
+.nf
+readonly name\fB[\fR=\fIword\fB]\fR...
+.P
+readonly\fR \(mip
+.fi
+.SH DESCRIPTION
+The variables whose
+.IR name s
+are specified shall be given the
+.IR readonly
+attribute. The values of variables with the
+.IR readonly
+attribute cannot be changed by subsequent assignment, nor can those
+variables be unset by the
+.IR unset
+utility. If the name of a variable is followed by =\c
+.IR word ,
+then the value of that variable shall be set to
+.IR word .
+.P
+The
+.IR readonly
+special built-in shall support the Base Definitions volume of POSIX.1\(hy2008,
+.IR "Section 12.2" ", " "Utility Syntax Guidelines".
+.P
+When
+.BR \(mip
+is specified,
+.IR readonly
+writes to the standard output the names and values of all read-only
+variables, in the following format:
+.sp
+.RS 4
+.nf
+\fB
+"readonly %s=%s\en", <\fIname\fR>, <\fIvalue\fR>
+.fi \fR
+.P
+.RE
+.P
+if
+.IR name
+is set, and
+.sp
+.RS 4
+.nf
+\fB
+"readonly %s\en", <\fIname\fR>
+.fi \fR
+.P
+.RE
+.P
+if
+.IR name
+is unset.
+.P
+The shell shall format the output, including the proper use of quoting,
+so that it is suitable for reinput to the shell as commands that
+achieve the same value and
+.IR readonly
+attribute-setting results in a shell execution environment in which:
+.IP " 1." 4
+Variables with values at the time they were output do not have the
+.IR readonly
+attribute set.
+.IP " 2." 4
+Variables that were unset at the time they were output do not have a
+value at the time at which the saved output is reinput to the shell.
+.P
+When no arguments are given, the results are unspecified.
+.SH OPTIONS
+See the DESCRIPTION.
+.SH OPERANDS
+See the DESCRIPTION.
+.SH STDIN
+Not used.
+.SH "INPUT FILES"
+None.
+.SH "ENVIRONMENT VARIABLES"
+None.
+.SH "ASYNCHRONOUS EVENTS"
+Default.
+.SH STDOUT
+See the DESCRIPTION.
+.SH STDERR
+The standard error shall be used only for diagnostic messages.
+.SH "OUTPUT FILES"
+None.
+.SH "EXTENDED DESCRIPTION"
+None.
+.SH "EXIT STATUS"
+Zero.
+.SH "CONSEQUENCES OF ERRORS"
+Default.
+.LP
+.IR "The following sections are informative."
+.SH "APPLICATION USAGE"
+None.
+.SH EXAMPLES
+.LP
+.nf
+readonly HOME PWD
+.fi
+.SH "RATIONALE"
+Some historical shells preserve the
+.IR readonly
+attribute across separate invocations. This volume of POSIX.1\(hy2008 allows this behavior,
+but does not require it.
+.P
+The
+.BR \(mip
+option allows portable access to the values that can be saved and then
+later restored using, for example, a
+.IR dot
+script. Also see the RATIONALE for
+.IR "\fIexport\fR\^"
+for a description of the no-argument and
+.BR \(mip
+output cases and a related example.
+.P
+Read-only functions were considered, but they were omitted as not being
+historical practice or particularly useful. Furthermore, functions must
+not be read-only across invocations to preclude ``spoofing''
+(spoofing is the term for the practice of creating a program that acts
+like a well-known utility with the intent of subverting the real intent
+of the user) of administrative or security-relevant (or
+security-conscious) shell scripts.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "Section 2.14" ", " "Special Built-In Utilities"
+.P
+The Base Definitions volume of POSIX.1\(hy2008,
+.IR "Section 12.2" ", " "Utility Syntax Guidelines"
+.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 .