Dialog: An Introductory Tutorial
The preceding examples were somewhat unrealistic; dialog is normally used within a shell script to do some real work. Let's look at a simple but useful application. I use the following script to back up my home directory to floppy disk on a regular basis:
#!/bin/sh # Backup all files under home directory to a single # floppy # Display message with option to cancel dialog --title "Backup" --msgbox "Time for backup \ of home directory. \ Insert formatted 3-1/2\" floppy and press <Enter> \ to start backup or \ <Esc> to cancel." 10 50 # Return status of non-zero indicates cancel if [ "$?" != "0" ] then dialog --title "Backup" --msgbox "Backup was \ canceled at your request." 10 50 else dialog --title "Backup" --infobox "Backup in \ process..." 10 50 cd ~ # Backup using tar; redirect any errors to a # temporary file # For multi-disk support, you can use the # -M option to tar tar -czf /dev/fd1 . >|/tmp/ERRORS$$ 2>&1 # zero status indicates backup was successful if [ "$?" = "0" ] then dialog --title "Backup" --msgbox "Backup \ completed successfully." 10 50 # Mark script with current date and time touch ~/.backup else # Backup failed, display error log dialog --title "Backup" --msgbox "Backup failed \ -- Press <Enter> to see error log." 10 50 dialog --title "Error Log" --textbox /tmp/ERRORS$$ 22 72 fi fi rm -f /tmp/ERRORS$$ clear
To run this automatically, I put these lines in my .profile file to call the backup script on login if more than 3 days has elapsed since the last backup was made:
# do a backup if enough time has elapsed find ~/.backup -mtime +3 -exec ~/.backup \;
The sound driver for the Linux kernel uses a program called “configure” to prompt the user for sound configuration options. It generates a C header file based on the chosen options. A replacement based on dialog could offer some advantages, such as a more professional appearance and the ability to select options randomly from menus rather than as a linear sequence of questions.
Due to time and space constraints, I only present a partial (but functional) implementation of a sound driver configuration script. This could quite easily be extended to fully replace the current configure program.
The complete script is shown in as Listing 1. I'd like to explain it using a top down approach, which means reading the listing starting from the bottom.
The last part of the script is a while loop which simply calls the shell function main_menu repeatedly. Above that is the code to implement the main menu. We present the user with three choices, and redirect the selection to a file. One of three shell functions is then called, based on the user's choice.
The most important menu in this script is the next one, the config_menu function. Again we present the user with a number of choices. Note that in this case there is an option which returns the user back to the main menu.
Continuing to read our listing backwards, we come to the select_cards function. The kernel supports multiple sound cards, so here we use a checklist to present the user with the available choices. The command “on_off” is a utility function that will be shown later; it returns the string “on” if its parameters are equal, otherwise it returns “off”. This is the form that the checklist menu requires. Note that the return status of the command is checked. If the user selects “cancel” from the menu then the return status is non-zero and we return immediately without making any changes. Otherwise, we set appropriate variables to indicate which sound cards have been enabled.
The next function, as we read our listing backwards, it the function view_summary. This uses the textbox type to display a file containing information on the currently selected options. We first build up the data in the file before displaying it.
Our next function is select_dma. Here the user must make one of four mutually exclusive options, so we use the a radio list. If you try this example yourself, be aware that the radiolist type was added in dialog version 0.4; if you have an older version then you will have to make do with a checklist.
Up above, the routine select_irq uses very similar code to allow the user to select the final option in our configuration utility.
The purpose of this script is to generate a C language header file defining the compile options for the kernel sound driver. The “save” function does this. Notice how a dialog box is displayed while the save is in progress.
Above that we see the on_off function alluded to previously. This avoids some repetitive code in the script.
Finally, we see the clean_up routine which allows the user to exit from the script. At the top of the script some default values are defined for the configuration options and the temporary filename to use.
The configuration utility still needs a few enhancements to replace the existing program, including more kernel options and error checking, but the example does function and gives a feel for what can be done with dialog. I encourage you to type it in and try it.