If you program for the shell frequently, sooner or later you will have to create a select menu, which usually requires several lines of code – unless you use smenu. Smenu reduces the menu's script to a single line. A number of parameters allow you to adapt the design and to simplify your work a little.

The source code for smenu is available on its project page [1], which contains installation instructions, as well as some useful tips. The smenu wiki [2] contains links to two YouTube videos that demonstrate the practical use of the program. The README file provides a structured overview of smenu's options [1].

Basic Function

In smenu's simplest form, a command's output is passed via pipe to the smenu command. For example, <command> | smenu displays a selection on a single line. To create a line-by-line menu, use <command> | smenu -c (Figure 1).

Figure 1: Pipe command output to smenu and leave it to the program to prepare the output in the form of a single-line menu.

For a freely defined menu, transfer the selection options using the echo command. However, the examples in Figure 2 only show the most rudimentary form: It doesn't make sense to use the tool without variables.

Figure 2: If you want to enter the selection options with your own text, use the echo command.

1 lists the most important call options for smenu. Press Enter to select a menu option, and press Q to exit the menu without selecting. To search within the selection, use the forward slash (/) in the open menu and then enter the search term.

When the search completes, the cursor stops at the first hit, and the background appears blue instead of black. If you wait seven seconds, the software reverts back and waits for your next input. Typically, the selection results from the data obtained via the pipe.

Script Use

To use the result of the selection, apply command substitution, as shown in Listing 1, line 1 (current syntax) and line 2 (obsolete syntax). Listing 2 and Listing 3 show two functional examples, and Figure 3 shows their usage.

VARIABLE=$([COMMAND] | smenu)
VARIABLE=`[COMMAND] | smenu`

#!/bin/sh
a=$(echo "1 first \n 2 second \n 3 third \n" | smenu -c)
echo "input value: $a"

#!/bin/sh
b=$(ls *.txt | smenu -c)
echo "Selected file: $b"

Figure 3: Listings 2 and 3 show simple scripts that demonstrate how you can easily create a menu for your software with smenu.

#!/bin/sh
clear
a=$(ls -1 *.txt | smenu -n3 -c -m "Select file:")
echo "Selected file: $a"

#!/bin/sh
clear
a=$(ls -1 *.txt | smenu -n3 -c -m "Select file:" -t2)
echo "Selected file: $a"

#!/bin/sh
clear
a=$(ls -1 *.txt | smenu -n5 -T: -c -m "Select file(s) (mark with [T]):")
echo "Selected file(s): $a"

#!/bin/sh
clear
a=$(ls -1 | smenu -n5 -c  -e [m][4] -m "Select file: ")
echo "Selected file: $a"

#!/bin/sh
clear
a=$(ls -1 | smenu -n5 -c  -i [t][x][t] -m "Select file: ")
echo "Selected file: $a"

Listing 2 demonstrates how to establish a selection with explanations. The end-of-line symbol (newline), which you represent with an escape sequence (\n), serves as a separator between the entries. Within an entry, the space serves as a separator between fields. The result adopted in the variable is the value from the first column. Smenu only inverts the current value of the variable on the screen, not the full line.

Listing 3 shows just how easily users can select a file interactively.

Improvements

Figure 4 shows a small menu, which already has some additional features. If the list of entries reaches a certain number of lines, a green scrollbar appears.

Figure 4: The green scrollbar shows that there are more items from which to choose.

If you limit the number of visible lines to three with -n3, the bar appears as soon as the length of the list exceeds this value. Use the -m "<text>" option to specify the heading. Listing 4 shows the corresponding code.

Look at the scrollbar in Figure 4 more closely: If you reach the start or the end of the selection, the arrow symbol appears. The arrows indicate more entries in the respective directions.

If you need a selection with multiple columns, type the number of columns using the -t option (Listing 5). Figure 5 shows the result on the terminal screen. If you want to expand the line content to the terminal's full width, use the -w option.

Figure 5: If necessary, distribute the data for the selection to multiple columns.