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  variables  whose  names are specified shall be given the readonly attribute. The values of variables
       with the readonly attribute cannot be changed by subsequent assignment, nor can those variables be  unset
       by  the  unset  utility.  If the name of a variable is followed by =word, then the value of that variable
       shall be set to word.

       The readonly special built-in shall support the Base Definitions volume of  POSIX.1‐2017,  Section12.2,
       UtilitySyntaxGuidelines.

       When  -p  is  specified,  readonly  writes  to  the standard output the names and values of all read-only
       variables, in the following format:

           "readonly %s=%s\n", <name>, <value>

       if name is set, and

           "readonly %s\n", <name>

       if name is unset.

       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 readonly attribute-setting results in a
       shell execution environment in which:

        1. Variables with values at the time they were output do not have the readonly attribute set.

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

       When no arguments are given, the results are unspecified.

Environment Variables

       None.

Examples

       readonly HOME PWD

Exit Status

        0    All name operands were successfully marked readonly.

       >0    At  least  one  name  could  not  be  marked  readonly, or the -p option was specified and an error
             occurred.

Extended Description

       None.

Future Directions

       None.

Input Files

       None.

Name

       readonly — set the readonly attribute for variables

Operands

       See the DESCRIPTION.

Options

       See the DESCRIPTION.

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

       Some historical shells preserve the readonly  attribute  across  separate  invocations.  This  volume  of
       POSIX.1‐2017 allows this behavior, but does not require it.

       The  -p  option allows portable access to the values that can be saved and then later restored using, for
       example, a dot script. Also see the RATIONALE for export for a description  of  the  no-argument  and  -p
       output cases and a related example.

       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.

See Also

Section2.14, SpecialBuilt-InUtilities

       The Base Definitions volume of POSIX.1‐2017, Section12.2, UtilitySyntaxGuidelines

Stderr

       The standard error shall be used only for diagnostic messages.

Stdin

       Not used.

Stdout

       See the DESCRIPTION.

Synopsis

       readonly name[=word]...

       readonly -p

See Also