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

Shell Programming Functions

  • Print
  • + Share This
By encapsulating common functionality into easy to manage units called shell functions, you can simplify your scripts, making them easier to maintain. This chapter shows you how to use shell functions in your scripts.

See all Sams Teach Yourself on InformIT Programming Tutorials.

This chapter is from the book

Shell functions provide a way of mapping a name to a list of commands. Functions are similar to subroutines and procedures in other programming languages. You can also think of them as miniature shell scripts, complete with exit codes and arguments. The main difference between a script and a function is that a new instance of the shell is started for a shell script, whereas functions run in the current instance of the shell.

This chapter is divided into the following two sections:

  • Using functions

  • Understanding scope, recursion, return codes, and data sharing

The first section introduces the syntax for defining functions and illustrates their use, whereas the second section covers more advanced topics relating to the interaction of scripts and functions.

Using Functions

Functions are defined as follows:

name () { list ; }

Here, name is the name of the function and list is a list of commands. The list of commands, list, is referred to as the body of the function. The parentheses, ( and ), that follow name are required.

The job of a function is to bind name to list, so that whenever name is specified list is executed. When a function is defined, list is not executed; the shell parses list to ensure that there are no syntax errors and stores name in its list of commands. The following example illustrates a basic function definition:

lsl() { ls –l ; }

Here you define the function lsl and specify list as ls –l.

An alternative form of function definition is available in ksh, bash, and zsh:

function name { list ; }

Here, name is the name of the function and list is the list of commands to be executed. This form of function definition is not available in the Bourne shell. Scripts that need to be ported to older systems should not use this form for function definition.

Executing Functions

You can execute or call a function that has been defined by specifying its name. For example, you can execute the function lsl, defined in the previous example, as follows:

$ lsl

This causes the shell to execute the body of the function, in this case the command ls –l, and output the result. The output will be similar to the following:

total 6
drwxrwxrwt  3 root wheel 512 Oct 29 08:59 ./
drwxr-xr-x 25 root wheel 512 Oct 29 00:02 ../
drwxrwxrwt  2 root wheel 512 Nov 3 17:49 vi.recover/

Functions are normally defined on the command line or within a script. Once defined, the function acts as a valid command in all the sub-shells started by that shell or script. For example, if you enter the command:

$ lsl() { ls –l ; }

The function lsl becomes a valid command name that can be accessed by specifying lsl. It is accessible in sub-shells as well:

$ ( lsl )
total 6
drwxrwxrwt  3 root wheel 512 Oct 29 08:59 ./
drwxr-xr-x 25 root wheel 512 Oct 29 00:02 ../
drwxrwxrwt  2 root wheel 512 Nov 3 17:49 vi.recover/

A function defined in a script is accessible within that script and any sub-shells started by that script. For example, consider the following script:

#!/bin/sh
lsl() { ls –l ; }
cd "$1" && lsl

The function lsl is only available in that script.

Arguments

Just as you can execute commands with arguments, you can also execute functions with arguments. The general syntax for invoking a function is as follows:

name arg1 ... argN

Here, name is the name of the function and arg1 ... argN are the arguments to the function. The arguments specified to a function are accessed in the same way as arguments specified to a shell script; the individual arguments are available as $1, $2, and so on, whereas the set of all the arguments is available as $@.

The following function illustrates the use of individual arguments:

printMsg () { echo "$1: $2" ; }

This function uses echo to print a message with a colon, :, which separates the first two arguments when it's executed as follows:

printMsg Error Failed

the output is

Error: Failed

As defined, this function can handle only two arguments; it ignores all the others. In order to make the function a bit more useful, it needs to be able to handle an arbitrary number of arguments. Because all of the arguments specified to a function are available in the variable $@, you can use it as follows:

printMsg() {
  PREFIX="$1"
  shift 
  echo "$PREFIX: $@"
}

Here, you have redefined the function printMsg. It saves its first argument in $PREFIX and then uses echo to print the message in the desired format. You use shift to remove the first argument from $@ before calling echo. Now you can execute the function with any number of arguments and the message will be printed properly. For example, if printMsg is executed as follows:

printMsg Info All Quiet on the Western Front

the output is

Info: All Quiet on the Western Front

Function Chaining

Function chaining is the process of calling a function from another function. The following script illustrates function chaining:

#!/bin/sh

orange () {
  echo "Now in orange"
  banana          # call func2()
}

banana () {
  echo "Now in banana"
}

orange

This script defines two functions, orange and banana, and then executes orange. The first function, orange, outputs a message and then calls the function banana. The second function, banana, just outputs a message. The output from this script is

Now in orange
Now in banana

Common Errors

Two common errors with declaring and using functions are

  • Omitting the parentheses, (), in a function definition.

  • Specifying the parentheses, (), in a function invocation.

The following example illustrates the first type of error:

lsl { ls -l ; }

Here, the parentheses are missing after lsl. This is an invalid function definition and will result in an error message similar to the following:

sh: syntax error: '}' unexpected

The following command illustrates the second type of error:

$ lsl()

Here, the function lsl is executed along with the parentheses, (). This will not work because the shell interprets it as a redefinition of the function with the name lsl. Usually such an invocation results in a prompt similar to the following:

>

This is a prompt produced by the shell when it expects you to provide more input. The input it expects is the body of the function lsl.

Aliases Versus Functions

An alias is an abbreviation or an alternative name, usually mnemonic, for a command. Aliases were first introduced in csh and were later adopted by ksh, bash, and zsh. They are not supported in the Bourne shell.

Aliases are defined using the alias command:

alias name="cmd"

Here name is the name of the alias and cmd is the command to execute when name is specified. Aliases are similar to functions in that they associate a command with a name. Two key differences are

  • In an alias, cmd cannot be a compound command or a list.

  • In an alias, there is no way to manipulate the argument list ($@).

Due to their limited capabilities, aliases are not commonly used in shell programs. They are discussed here for the sake of completeness.

As an example, the following command defines the alias lsl and specifies that the command ls –l should be executed when the command lsl is specified:

alias lsl="ls –l"

This alias is equivalent to the function:

lsl () { ls –l "$@" ; }

A common use for aliases is to specify a default set of options to a command. For example, say you have the following alias:

alias ls="ls –a"

When the ls command is given, the shell executes ls –a instead of plain ls without options. It is possible to mimic this behavior with a function such as:

name () { path "$@" ; }

Here, name is the name of the command to be "aliased" and path is the fully qualified path to the command. For example, the following function is equivalent to the alias given in the previous example:

ls () { /bin/ls –a "$@" ; }

Unalias

Once an alias has been defined, it can be unset using the unalias command:

unalias name

Here, name is the name of the alias to be unset. For example, the following command unsets the alias lsl:

unalias lsl

Unsetting Functions

Once a function has been defined, it can be undefined via the unset command:

unset name

Here, name is the name of the function you want to unset. For example, the following command unsets the previously defined function lsl():

unset lsl

After a function has been unset it cannot be executed.

  • + Share This
  • 🔖 Save To Your Account

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