Home > Articles > Operating Systems, Server > Linux/UNIX/Open Source

Variables and Parameters in the Korn Shell

Learn how you can use variables and parameters in Korn shell to store values. You will also see how the Korn shell supports data types and arrays.
This chapter is from the book

Variables
Special Parameters
Variable Expansion
Array Variables
Compound Variables
Quoting

Variables and parameters are used by the Korn shell to store values. Like other high-level programming languages, the Korn shell supports data types and arrays. This is a major difference with the Bourne, C shell, and other scripting languages, which have no concept of data types.

The Korn shell supports four data types: string, integer, float, and array. If a data type is not explicitly defined, the Korn shell will assume that the variable is a string.

By default, all variables are global in scope. However, it is possible to declare a local variable within a function. This is discussed in more detail later in this chapter.

Variables

Korn shell variable names can begin with an alphabetic (a–Z) or underscore character, followed by one or more alphanumeric (a–Z, 0–9) or underscore characters. Other variable names that contain only digits (0–9) or special characters (!, @, #, %, *, ?, $) are reserved for special parameters set directly by the Korn shell.

To assign a value to a variable, you can simply name the variable and set it to a value. For example, to assign abc to variable X:

$ X=abc 

The typeset command can also be used to assign values, but unless you are setting attributes, it's a lot more work for nothing. If a value is not given, the variable is set to null. Here, X is reassigned the null value:

$ X= 

This is not the same as being undefined. As we'll see later, accessing the value of an undefined variable may return an error, while accessing the value of a null variable returns the null value.

Accessing Variable Values

To access the value of a variable, precede the name with the $ character. There can be no space between $ and the variable name. In this example, CBIN is set to /usr/ccs/bin.

$ CBIN=/usr/ccs/bin 

Table 3.1. Assigning Values to Variables

variable=

declare variable and set it to null

typeset variable=

declare variable and set it to null

variable=value

assign value to variable

typeset variable=value

assign value to variable

Now you can just type $CBIN instead of the long pathname:

$ cd $CBIN 
   $ pwd 
   /usr/ccs/bin 

Here is a new command to go along with this concept: print. It displays its arguments on your terminal, just like echo.

$ print Hello world! 
   Hello world! 

Here we use print to display the value of CBIN:

$ print $CBIN 
   /usr/ccs/bin 

Variable Attributes

Korn shell variables can have one or more attributes that specify their internal representation, access or scope, or the way they are displayed. This concept is similar to a data type in other high-level programming languages, except that in the Korn shell it is not as restrictive. Variables can be set to integer type for faster arithmetic operations, read-only so that the value cannot be changed, left/right justified for formatting purposes, and more. To assign a value and/or attribute to a Korn shell variable, use the following format with the typeset command:

typeset –attribute variable=value 

or

typeset –attribute variable 

Except for readonly, variable attributes can be set before, during, or after assignment. Functionally it makes no difference. Just remember that the attribute has precedence over the value. This means that if you change the attribute after a value has been assigned, the value may be affected.

Lowercase (–l) and Uppercase (–u) Attributes

These attributes cause the variable values to be changed to lower or uppercase. For example, the lowercase attribute and uppercase value ASPD are assigned to variable MYSYS:

$ typeset —l MYSYS=ASPD 

Despite the fact that MYSYS was assigned uppercase ASPD, when accessed, the value is displayed in lowercase:

$ print $MYSYS 
   aspd 

This is because the attribute affects the variable value, regardless of the assignment. Variable attributes can also be changed after assignment. If we wanted to display variable MYSYS in uppercase, we could just reset the attribute:

$ typeset —u MYSYS 
   $ print $MYSYS 
   ASPD 

Table 3.2. Assigning Values/Attributes to Variables

typeset – attribute variable=value

assign attribute and value to variable

typeset –attribute variable

assign attribute to variable

typeset +attribute variable

remove attribute from variable

Readonly (–r) Attribute

Once the readonly attribute is set, a variable cannot be assigned another value. Here, we use it to set up a restricted PATH:

$ typeset —r PATH=/usr/rbin 

If there is an attempt to reset PATH, an error message is generated:

$ PATH=$PATH:/usr/bin: 
   /bin/ksh: PATH: is read only 

We'll come back to this in a few pages. Unlike other variable attributes, once the readonly attribute is set, it cannot be removed.

The readonly command can also be used to specify a readonly variable.

Integer (–i) Attribute

The integer attribute (–i) is used to explicitly declare integer variables. Although it is not necessary to set this attribute when assigning integer values, there are some benefits to it. We'll cover this later in Chapter 6. In the meantime, NUM is set to an integer-type variable and assigned a value:

$ typeset —i NUM=1 
   $ print $NUM 
   1 

We could also assign NUM the number of users on the system using command substitution like this:

$ typeset —i NUM=$(who | wc —l) 
   $ print $NUM 
   3 

There is one restriction on integer variables. Once a variable is set to integer type, it can't be assigned a non-integer value:

$ typeset —i NUM=abc 
   /bin/ksh: NUM: bad number 

Float (–E, –F) Attribute

The float attributes (–E, –F) are used to declare float variables. The –E is used to specify the number of significant digits, while –F is used to specify the precision. We'll cover this later in Chapter 6. In the following example, X is set to a float variable and assigned a value using both formats:

$ typeset —E5 X=123.456 
   $ print $X 
   123.46 
   $ typeset —F5 X=123.456 
   $ print $X 
   123.45600 

The float command can also be used to declare a float variable, but does not allow for specifying the precision.

Right (–R) and Left (–L) Justify Attributes

The right and left justify attributes cause variable values to be justified within their width and are be used to format data. Here, variables A and B are set to right-justify with a field width of 7 characters. Notice that integer values are used, even though the integer attribute is not set.

$ typeset —R7 A=10 B=10000 
   $ print :$A: 
   :     10: 
   $ print :$B: 
   :     10000: 

If the field width is not large enough for the variable assignment, the value gets truncated. Variable X is assigned a seven-character wide value, but the field width is set to 3, so the first four characters are lost:

$ typeset —R3 X=ABCDEFG 
   $ print $X 
   EFG 

If a field width is not given, then it is set with the first variable assignment. Variable Y is assigned a three-character wide value, so the field width is set to 3.

$ typeset —L Y=ABC 
   $ print $Y 
   ABC 

Without explicitly resetting the field width, a subsequent assignment would be restricted to a three-character wide value:

$ Y=ZYXWVUT 
   $ print $Y 
   ZYX 

Autoexport (–x) Attribute

This is another useful attribute. It allows you to set and export a variable in one command. Instead of

$ typeset X=abc 
   $ export X 

you can do this:

$ typeset —x X=abc 

We could use this attribute to add the /lbin directory to the PATH variable and export it all in one command:

$ typeset —x PATH=$PATH:/lbin 

Table 3.3. Some Variable Attributes

typeset –i var

Set the type of var to be integer

typeset –l var

Set var to lower case

typeset –L var

Left justify var; the field width is specified by the first assignment

typeset –Ln var

Left justify var; set field width to n

typeset –LZn var

Left justify var; set field width to n and strip leading zeros

typeset –r var

Set var to be readonly (same as the readonly command)

typeset –R var

Right justify var; the field width is specified by the first assignment

typeset –Rn var

Right justify var; set field width to n

typeset –RZn var

Right justify var; set field width to n and fill with leading zeros

typeset –t var

Set the user-defined attribute for var. This has no meaning to the Korn shell.

typeset –u var

Set var to upper case

typeset –x var

Automatically export var to the environment (same as the export command)

typeset –Z var

Same as typeset –RZ

Removing Variable Attributes

Except for readonly, variable attributes are removed with the typeset +attribute command. Assuming that the integer attribute was set on the NUM variable, we could remove it like this:

$ typeset +i NUM 

and then reassign it a non-integer value:

$ NUM=abc 

Once the readonly attribute is set, it cannot be removed. When we try to do this with the PATH variable that was previously set, we get an error message:

$ typeset +r PATH 
   /bin/ksh: PATH:  is read only 

The only way to reassign a readonly variable is to unset it first, then assign a value from scratch.

Multiple Attributes

Multiple attributes can also be assigned to variables. This command sets the integer and autoexport attributes for TMOUT:

$ typeset —ix TMOUT=3000 

To set and automatically export ORACLE_SID to uppercase prod:

$ typeset —ux ORACLE_SID=prod 
   $ print $ORACLE_SID 
   PROD 

Obviously, some attributes like left and right justify are mutually exclusive, so they shouldn't be set together.

Checking Variable Attributes

Attributes of Korn shell variables are listed using the typeset – attribute command. For example, to list all the integer type variables and their values:

$ typeset —i 
   ERRNO=0 
   MAILCHECK=600 
   PPID=177 
   RANDOM=22272 
   SECONDS=4558 
   TMOUT=0 

To list only the names of variables with a specific attribute, use the typeset + attribute command.

More with Variables

You can do other things with variables, such as assign them the value of another variable, the output of a command, or even the contents of a file. Here Y is assigned the value of variable X:

$ X=$HOME 
   $ Y=$X 
   $ print $Y 
   /home/anatole 

Variables can be assigned command output using this format:

variable=$(command) 

or

variable=`command` 

The second format is provided for compatibility with the Bourne shell. Here, UCSC is set to its internet ID by assigning the output of the grep and cut commands:

$ UCSC=$(grep UCSC /etc/hosts | cut —f1 —d" ") 
   $ print $UCSC 
   128.114.129.1 

Variables can also be assigned the contents of files like this:

variable=$(<file) 

or

variable=`cat file` 

The first format is equivalent to variable=$(cat file). The second format is much slower, but is provided for compatibility with the Bourne shell. Here, the FSYS variable is set to the contents of the /etc/fstab file:

$ FSYS=$(</etc/fstab) 
   $ print $FSYS 
   /dev/roota / /dev/rootg /usr 

Notice that the entries were displayed all on one line, instead of each on separate lines as in the file. We'll talk about this in the Quoting section later in this chapter.

A nameref variable is a synonym for another variable and will always have the same value as its associated variable They are created using the following formats:

nameref nameref_variable=variable 

or

typeset n nameref_variable=variable 

For example:

$ X=abc 
   $ nameref Y=X 
   $ print $X 
   abc 
   $ print $Y 
   abc 

Unsetting Variables

Variable definitions are removed using the unset command. The TMOUT variable is not being used, so let's unset it:

$ unset TMOUT 

Now to check and see:

$ print $TMOUT 
   
   $ 

This is not the same as being set to null. As we'll see later in this chapter, variable expansion may be performed differently, depending on whether the variable value is set to null.

Unsetting either the base or nameref variable will unset both variables.

$ unset Y 
   $ print $X 
   
   $ print $Y 
   
   $ 

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020