Skip to main content

Programmer's Guide: The "set" command in bash

The "set" command in shell allows you to set various shell options and positional parameters. The purpose of this post is to highlight how much this command has been helpful to me in my bash programming. I would not go into much depth about all the possible flag, because you can find many posts and documentation on the internet, like this post by GNU, which cover all the possible options that the "set" command provides. I will mainly focus on two options,

The "set -x" option: 

This option allows us to print commands and their arguments, after they are expanded (interpolated) but before they are executed.

Let us execute a simple hello world programme in bash.


When the programme is executed, we see the entire printf statement being printed before the actual "Hello World!" message is printed. This way, we can check the command that is being executed along with its output.


Setting the flag also expands any variables or arguments (interpolation) and prints them before execution. Furthermore, we can unset the option using "+" sign. 
In the below example, $1 implies that the programme should print 1st argument provided to it. Also, -x option is unset by setting +x.


If we run the code with 1st argument "Bash", observe that it prints Bash in the print statement before actually printing it. Also observe that the printf command is not shown after unsetting the -x option.

The "set -e" option:

This causes the programme to exit immediately if the command being executed returns a non-zero status. This is useful if you want to prevent further, possibly critical, code execution in case a certain command fails.

Continuing with our programme, I have modified the code to cat (print contents) of a file that doesn't exist. I have also "set -e".


The programme execution stops immediately and does not execute the critical section that comes after.


This flag is also useful in debugging a code. If you want to allow execution of certain commands which may cause errors but not allow certain commands whose output is not known, you can prevent termination of code by creating a complex command which returns status-code 0.

In the below code, we can continue execution in case a certain non-critical file doesn't exist, but we must not execute any further if a critical input file is not present.



As can be observed in the above execution, if a temporary file is missing and if we can safely ignore it, we can use "true" value and OR it with the command output to make a complex command whose exit status code is 0. You can read more about "true" value and exit status codes in bash here.
Status code 0 means that the overall command doesn't have any errors and the programme doesn't terminate. But it still terminates if a critical file is not present. So, execution of critical block is prevented which might have caused major issues.

Both these options have helped me tremendously while writing bash scripts. I hope you will find these options useful. Do explore other set options and let me know their uses in comments below.

Comments

  1. -x & -e are helpful flags while debugging shell scripts
    another approach is to use them in command line "bash -x script_name"

    ReplyDelete

Post a Comment

Popular posts from this blog

The Changing Nature of Reality Shows in India

It's been almost two decades since the modern day reality shows started in India. And the nature of these reality shows has changed drastically during this time. "Kaun Banega Crorepati (KBC)" is no longer a show just about knowledge, "Indian Idol" and "Sa Re Ga Ma Pa" are no longer just singing shows. They all have become entertainment shows. This post is an attempt to find out the reasons of this transition, analyze the current nature of these shows and assess their impact. Reasons of this change Competition from TV Serials / Soap Opera TV serials or Soap Opera as it is commonly known is very popular among the Indian masses. India being a country where family ties are very strong, for a long time, the main theme in most popular TV shows has been "family drama". Additionally, there is no dearth of TV channels, actors, producers and the crew. TV show and film production is a major employment generator in India. And so the episodes of serials a...

Local domain name resolution using /etc/hosts

The /etc/hosts file is a powerful mechanism for managing the information about hosts in the local network in the absence of a local DNS server. Setup We have 4 VMs in the local /24 network. The following are the details: vm-1-ubuntu-16-04 - 10.0.1.11 vm-2-ubuntu-16-04 - 10.0.1.12 vm-1-ubuntu-18-04 - 10.0.1.21 vm-2-ubuntu-18-04 - 10.0.1.22 The VMs are reachable via their IP address but not by their hostnames. This is problematic because we have to remember their IP addresses everytime we want to access these hosts. It is would be much simpler to remember and access the servers by their hostnames. For that we need some sort of mapping between the IP addresses and their corresponding host names. There are 3 common ways of achieving this mapping. Setup a DNS server which handles resolution for your local network. Use an existing DNS server of the local Internet Service Provider (ISP) or any other higher level ISP. Note that a public static IP address is required for this s...

Manage system hostname with hostnamectl

This article explains the simplest method to set hostname and Fully Qualified Domain Name (FQDN/fqdn) of any given system using hostnamectl Check that hostnamectl is present on the system by typing it in a shell. You will see output similar to the one given below. In case hostnamectl is not found, it is a good idea to install it. sudo apt update sudo apt install systemd-services Verify the static hostname given above using the following command: Also verify it by checking /etc/hostname file Change the hostname and set the desired hostname by running the following command and authenticating with the password. hostnamectl set-hostname <hostname> Start a new shell session or reconnect to the server to see the change in the hostname Again run above steps to verify that hostname has been changed correctly. Configure FQDN While the above process may suffice to identify the host in the local network, it is not enough when the host is to be identifi...