How to get dialog box input directed to a variable?
:D I can't explain it!!! If you can understand what they are saying in Advanced Bash-Scripting Guide: Chapter 20. I/O Redirection, write a new answer and I will give you 50rep:
exec 3>&1; result=$(dialog --inputbox test 0 0 2>&1 1>&3); exitcode=$?; exec 3>&-; echo $result $exitcode;
Reference: Dialog in bash is not grabbing variables correctly
^ answer from @Sneetsher (Jul 4, 2014)
As requested, I will try to explain what this snippet is doing line by line.
Note that I will simplify it by omitting all the ;
semicolons at the line ends, because they're not necessary if we write one command per line.
I/O - Streams:
First, you need to understand the communication streams. There are 10 streams, numbered from 0 to 9:
Stream 0 ("STDIN"):
"Standard input", the default input stream to read data from the keyboard.Stream 1 ("STDOUT"):
"Standard output", the default output stream used to show normal text in the terminal.Stream 2 ("STDERR"): "Standard error", the default output stream used to display errors or other text for special purposes in the terminal.
Streams 3-9:
Additional, freely usable streams. They're not used by default and do not exist until something attempts to use them.
Note that all "streams" are internally represented by file descriptors in /dev/fd
(which is a symbolic link to /proc/self/fd
which contains another symbolic link for every stream... it's a bit complicated and not important for their behaviour, so I stop here.). The standard streams also have /dev/stdin
, /dev/stdout
and /dev/stderr
(which are symbolic links again, etc...).
The script:
-
exec 3>&1
The Bash built-in
exec
can be used to apply a stream redirection to the shell, that means it affects all following commands. For more info, runhelp exec
in your terminal.In this special case, the stream 3 gets redirected to stream 1 (STDOUT), that means everything we send to stream 3 later will appear in our terminal as if it was normally printed to STDOUT.
-
result=$(dialog --inputbox test 0 0 2>&1 1>&3)
This line consists of many parts and syntactical structures:
result=$(...)
This structure executes the command in the brackets and assigns the output (STDOUT) to the bash variableresult
. It's readable through$result
. All this is described somehow in the veeeery looongman bash
.dialog --inputbox TEXT HEIGHT WIDTH
This command shows a TUI box with the given TEXT, a text input field and two buttons OK and CANCEL. If OK gets selected, the command exits with status 0 and prints the entered text to STDERR, if CANCEL gets selected, it will exit with code 1 and print nothing. For more info, readman dialog
.-
2>&1 1>&3
These are two redirection commands. They will be interpreted from right to left:1>&3
redirects the command's stream 1 (STDOUT) to the custom stream 3.2>&1
redirects afterwards the command's stream 2 (STDERR) to stream 1 (STDOUT).That means that everything the command prints to STDOUT now appears in stream 3, while everything that was intended to show up on STDERR now gets redirected to STDOUT.
So the entire line displays a text prompt (on STDOUT, which got redirected to stream 3, which the shell again redirects back to STDOUT in the end - see the
exec 3>&1
command) and assigns the entered data (returned through STDERR, then redirected to STDOUT) to the Bash variableresult
. -
exitcode=$?
This code retrieves the previously executed command's exit code (here from
dialog
) through the reserved Bash variable$?
(always holds the last exit code) and simply stores it in our own Bash variableexitcode
. It can be read through$exitcode
again. You can search for more info on this inman bash
, but that might take a while... -
exec 3>&-
The Bash built-in
exec
can be used to apply a stream redirection to the shell, that means it affects all following commands. For more info, runhelp exec
in your terminal.In this special case, the stream 3 gets redirected to "stream -", which just means it should be closed. Data sent to stream 3 will not get redirected anywhere any more from now on.
-
echo $result $exitcode
This simple
echo
command (more info onman echo
) just prints the content of the two Bash variablesresult
andexitcode
to the STDOUT. As we have no explicit or implicit stream redirections here any more, they will really appear on STDOUT and therefore simply get displayed in the terminal. What a miracle! ;-)
Summary:
First, we set the shell up to redirect everything we send to the custom stream 3 back to STDOUT, so that it shows up in our terminal.
Then we run the dialog
command, redirect its original STDOUT to our custom stream 3, because it needs to get displayed in the end, but we temporarily need to use the STDOUT stream for something else.
We redirect the original STDERR of the command, where the dialogue window's user input gets returned, to STDOUT afterwards.
Now we can capture the STDOUT (which holds the redirected data from STDERR) and store it in our variable $result
. It contains the wanted user input now!
We also want the dialog
command's exit code, which shows us whether OK or CANCEL was clicked. This value is presented in the reserved Bash variable $?
and we just copy it to our own variable $exitcode
.
After that we close stream 3 again, as we don't need it any more, to stop further redirections of it.
Finally, we normally output the contents of both variables $result
(the user input of the dialogue window) and $exitcode
(0 for OK, 1 for CANCEL) to the terminal.
Using dialog's own tools: --output-fd flag
If you read man page for dialog, there is option --output-fd
, which allows you to explicitly set where the output goes (STDOUT 1 , STDERR 2), instead of by default going to STDERR.
Bellow you can see me running sample dialog
command , with explicitly stating that output must go to file descriptor 1, which allows me to save it into MYVAR.
MYVAR=$(dialog --inputbox "THIS OUTPUT GOES TO FD 1" 25 25 --output-fd 1)
Using named pipes
Alternative approach which has a lot of hidden potential, is to use something known as named pipe.
#!/bin/bash
mkfifo /tmp/namedPipe1 # this creates named pipe, aka fifo
# to make sure the shell doesn't hang, we run redirection
# in background, because fifo waits for output to come out
dialog --inputbox "This is an input box with named pipe" 40 40 2> /tmp/namedPipe1 &
# release contents of pipe
OUTPUT="$( cat /tmp/namedPipe1 )"
echo "This is the output " $OUTPUT
# clean up
rm /tmp/namedPipe1
A more in-depth overview of user.dz's answer with alternate approach
The original answer by user.dz and ByteCommander's explanation of that both provide a good solution and overview of what it does. However, I believe a deeper analysis could be beneficial to explain why it works.
First of all, it is important to understand two things: what is the problem we're trying to solve and what are the underlying workings of shell mechanisms with which we're dealing. The task is to capture output of a command via command substitution. Under simplistic overview that everyone knows, command substitutions capture the stdout
of a command and let it be reused by something else. In this case, the result=$(...)
part should save the output of whatever command is designated by ...
into a variable called result
.
Underneath the hood, command substitution is actually implemented as pipe, where there is a child process (the actual command that runs) and reading process (which saves output to variable). This is evident with a simple trace of system calls. Notice that file descriptor 3 is the read end of the pipe, while 4 is the write end. For the child process of echo
, which writes to its stdout
- the file descriptor 1, that file descriptor is actually copy of file descriptor 4, which is the write-end of the pipe.
Notice that stderr
isn't playing a role here, simply because it's a pipe connecting stdout
only.
$ strace -f -e pipe,dup2,write,read bash -c 'v=$(echo "X")'
...
pipe([3, 4]) = 0
strace: Process 6200 attached
[pid 6199] read(3, <unfinished ...>
[pid 6200] dup2(4, 1) = 1
[pid 6200] write(1, "X\n", 2 <unfinished ...>
[pid 6199] <... read resumed> "X\n", 128) = 2
[pid 6200] <... write resumed> ) = 2
[pid 6199] read(3, "", 128) = 0
[pid 6200] +++ exited with 0 +++
--- SIGCHLD {si_signo=SIGCHLD, si_code=CLD_EXITED, si_pid=6200, si_uid=1000, si_status=0, si_utime=0, si_stime=0} ---
+++ exited with 0 +++
Let's go back to the original answer for a second. Since now we know that dialog
writes the TUI box to stdout
, answer to stderr
, and within command substitution stdout
gets piped somewhere else, we already have part of the solution - we need to rewire file descriptors in such way that stderr
will be piped to the reader process. This is the 2>&1
part of the answer. However, what do we do with TUI box ?
That's where file descriptor 3 comes in. The dup2()
syscall allows us to duplicate file descriptors, making them effectively refer to the same place, yet we can manipulate them separately. File descriptors of processes that have controlling terminal attached actually point to specific terminal device. This is evident if you do
$ ls -l /proc/self/fd
total 0
lrwx------ 1 user1 user1 64 Aug 20 10:30 0 -> /dev/pts/5
lrwx------ 1 user1 user1 64 Aug 20 10:30 1 -> /dev/pts/5
lrwx------ 1 user1 user1 64 Aug 20 10:30 2 -> /dev/pts/5
lr-x------ 1 user1 user1 64 Aug 20 10:30 3 -> /proc/6424/fd
where /dev/pts/5
is my current pseudo-terminal device. Thus, if we can somehow save this destination, we can still write the TUI box onto terminal screen. That's what exec 3>&1
does. When you call a command with redirection command > /dev/null
for example, the shell passes it's stdout file descriptor and then uses dup2()
to write that file descriptor to /dev/null
. The exec
command performs something similar to dup2()
file descriptors for the whole shell session, thus making any command inherit already redirected file descriptor. Same with exec 3>&1
. The file descriptor 3
will now refer to/point to the controlling terminal, and any command that runs in that shell session will know about it.
So when result=$(dialog --inputbox test 0 0 2>&1 1>&3);
occurs, the shell creates a pipe for dialog to write, but also 2>&1
will first make the command's file descriptor 2 be duplicated onto the write file descriptor of that pipe (thus making output go to read end of the pipe and into the variable), while file descriptor 1 will be duplicated onto 3. This will make file descriptor 1 still refer to the controlling terminal, and the TUI dialog will show up on the screen.
Now, there's actually a short-hand for the current controlling terminal of the process, which is /dev/tty
. Thus, the solution can be simplified without use of file descriptors, simply into:
result=$(dialog --inputbox test 0 0 2>&1 1>/dev/tty);
echo "$result"
Key things to remember:
- file descriptors are inherited from shell by each command
- command substitution is implemented as pipe
- duplicated file descriptors will refer to same place as original one, but we can manipulate each file descriptor separately
See also
- When would you use additional file descriptor ?
- Significance of arrows symbols in duplicating/closing file descriptors under bash
:D I can't explain it!!! If you can understand what they are saying in the reference:Advanced Bash-Scripting Guide: Chapter 20. I/O Redirection, write a new answer and I will give you 50rep
Bounty was given, for explanation see ByteCommander's answer. :) This is a part of the history.
exec 3>&1;
result=$(dialog --inputbox test 0 0 2>&1 1>&3);
exitcode=$?;
exec 3>&-;
echo $result $exitcode;
Source: Dialog in bash is not grabbing variables correctly
Reference:Advanced Bash-Scripting Guide: Chapter 20. I/O Redirection