Redirection (computing)

Redirection is usually implemented by placing certain characters between commands.

Typically, the syntax of these characters is as follows, using < to redirect input, and > to redirect output. command > file1 executes {{mono|command}}, placing the output in {{mono|file1}}, as opposed to displaying it at the terminal, which is the usual destination for standard output. This will clobber any existing data in {{mono|file1}}.

Using command < file1 executes {{mono|command}}, with {{mono|file1}} as the source of input, as opposed to the keyboard, which is the usual source for standard input.

command < infile > outfile combines the two capabilities: {{mono|command}} reads from {{mono|infile}} and writes to {{mono|outfile}}

To append output to the end of the file, rather than clobbering it, the >> operator is used: command1 >> file1.

To read from a stream literal (an inline file, passed to the standard input), one can use a here document, using the << operator:

$ tr a-z A-Z << END_TEXT

> one two three

> uno dos tres

> END_TEXT

ONE TWO THREE

UNO DOS TRES

To read from a string, one can use a here string, using the <<< operator: tr a-z A-Z <<< "one two three", or:

$ NUMBERS="one two three"

$ tr a-z A-Z <<< "$NUMBERS"

ONE TWO THREE

Image:Pipeline.svg

Programs can be run together such that one program reads the output from another with no need for an explicit intermediate file. command1 | command2 executes {{mono|command1}}, using its output as the input for {{mono|command2}} (commonly called piping, with the "|" character being known as the "pipe").

The two programs performing the commands may run in parallel with the only storage space being working buffers (Linux allows up to 64K for each buffer) plus whatever work space each command's processing requires. For example, a "sort" command is unable to produce any output until all input records have been read, as the very last record received just might turn out to be first in sorted order. Dr. Alexia Massalin's experimental operating system, Synthesis, would adjust the priority of each task as they ran according to the fullness of their input and output buffers.{{Cite web|url=https://lwn.net/Articles/270081/|title=KHB: Synthesis: An Efficient Implementation of Fundamental Operating Systems Services|website=lwn.net}}

This produces the same end result as using two redirects and a temporary file, as in:

$ command1 > tempfile

$ command2 < tempfile

$ rm tempfile

But here, {{mono|command2}} does not start executing until {{mono|command1}} has finished, and a sufficiently large scratch file is required to hold the intermediate results as well as whatever work space each task required. As an example, although DOS allows the "pipe" syntax, it employs this second approach. Thus, suppose some long-running program "Worker" produces various messages as it works, and that a second program, TimeStamp copies each record from stdin to stdout, prefixed by the system's date and time when the record is received. A sequence such as Worker | TimeStamp > LogFile.txt would produce timestamps only when Worker had finished, merely showing how swiftly its output file could be read and written.

A good example for command piping is combining echo with another command to achieve something interactive in a non-interactive shell, e.g. echo -e 'user\npass' | ftp localhost. This runs the ftp client with input {{mono|user}}, press {{mono|return}}, then {{mono|pass}}.

In casual use, the initial step of a pipeline is often cat or echo, reading from a file or string. This can often be replaced by input indirection or a here string, and use of cat and piping rather than input redirection is known as useless use of cat. For example, the following commands:

$ cat infile | command

$ echo $string | command

$ echo -e 'user\npass' | ftp localhost

can be replaced by:

$ command < infile

$ command <<< $string

$ ftp localhost <<< $'user\npass'

As echo is often a shell-internal command, its use is not as criticized as cat, which is an external command.

In Unix shells derived from the original Bourne shell, the first two actions can be further modified by placing a number (the file descriptor) immediately before the character; this will affect which stream is used for the redirection.{{Cite web|url=https://www.redhat.com/sysadmin/redirect-shell-command-script-output|title=How to redirect shell command output|first=Roberto|last=Nozaki|date=April 21, 2022|website=www.redhat.com}} The Unix standard I/O streams are:{{Cite web|url=https://www.gnu.org/software/bash/manual/html_node/Redirections.html|title=Redirections (Bash Reference Manual)|website=www.gnu.org}}

For example, {{code|lang=bash|1=command 2> file1}} executes {{mono|command}}, directing the standard error stream to {{mono|file1}}.

In shells derived from csh (the C shell), the syntax instead appends the {{mono|&}} (ampersand) character to the redirect characters, thus achieving a similar result. The reason for this is to distinguish between a file named '1' and stdout, i.e. {{code|lang=bash|1=cat file 2>1}} vs {{code|lang=bash|1=cat file 2>&1}}. In the first case, stderr is redirected to a file named '{{mono|1}}' and in the second, stderr is redirected to stdout.

Another useful capability is to redirect one standard file handle to another. The most popular variation is to merge standard error into standard output so error messages can be processed together with (or alternately to) the usual output. For example, {{code|lang=bash|1=find / -name .profile > results 2>&1}} will try to find all files named {{mono|.profile}}. Executed without redirection, it will output hits to stdout and errors (e.g. for lack of privilege to traverse protected directories) to stderr. If standard output is directed to file {{mono|results}}, error messages appear on the console. To see both hits and error messages in file {{mono|results}}, merge stderr (handle 2) into stdout (handle 1) using {{code|2>&1}}.

If the merged output is to be piped into another program, the file merge sequence {{code|2>&1}} must precede the pipe symbol, thus, {{code|lang=bash|1=find / -name .profile 2>&1 {{!}} less}}

A simplified but non-POSIX conforming form of the command, {{code|lang=bash|1=command > file 2>&1}} is (not available in Bourne Shell prior to version 4, final release, or in the standard shell Debian Almquist shell used in Debian/Ubuntu): {{code|lang=bash|1=command &>file}} or {{code|lang=bash|1=command >&file}}.

It is possible to use 2>&1 before ">" but the result is commonly misunderstood.

The rule is that any redirection sets the handle to the output stream independently.

So "2>&1" sets handle 2 to whatever handle 1 points to, which at that point usually is stdout.

Then ">" redirects handle 1 to something else, e.g. a file, but it does not change handle 2, which still points to stdout.

In the following example, standard output is written to file, but errors are redirected from stderr to stdout, i.e. sent to the screen: {{code|lang=bash|1=command 2>&1 > file}}.

To write both errors and standard output to file, the order should be reversed. Standard output would first be redirected to the file, then stderr would additionally be redirected to the stdout handle that has already been changed to point at the file: {{code|lang=bash|1=command > file 2>&1}}.

The redirection and piping tokens can be chained together to create complex commands. For example, sort infile | uniq -c | sort -n > outfile sorts the lines of {{mono|infile}} in lexicographical order, writes unique lines prefixed by the number of occurrences, sorts the resultant output numerically, and places the final output in {{mono|outfile}}.{{Cite web|url=https://www.linux.org/threads/piping-and-redirecting-output-in-the-linux-terminal.43745/|title=Piping and Redirecting Output in the Linux Terminal |website=Linux.org}} This type of construction is used very commonly in shell scripts and batch files.

The standard command {{mono|tee}} can redirect output from a command to several destinations:ls -lrt | tee xyz. This directs the file list output to both standard output and the file {{mono|xyz}}.

• Here-document, a way of specifying text for input in command-line shells
• Shell shoveling
• Command substitution
• Process substitution
• Console redirection

{{Reflist}}

• {{cite journal | last=Feiertag | first=R. J. | last2=Organick | first2=E. I. | title=The Multics input/output system | journal=ACM SIGOPS Operating Systems Review | volume=6 | issue=1/2 | date=1972 | issn=0163-5980 | doi=10.1145/850614.850622 | pages=35–38}}
• {{cite journal | last=Kernighan | first=Brian W. | last2=Morgan | first2=Samuel P. | title=The UNIX Operating System: A Model for Software Design | journal=Science | publisher=American Association for the Advancement of Science | volume=215 | issue=4534 | year=1982 | eissn=00368075 | issn=10959203 | jstor=1687467 | pages=779–783 | url=http://www.jstor.org/stable/1687467 | access-date=2024-04-25}}

• {{man|sh|dup|SUS|duplicate an open file descriptor}}
• [http://www.linfo.org/redirection.html Redirection Definition] by The Linux Information Project (LINFO)
• [http://tldp.org/LDP/abs/html/io-redirection.html I/O Redirection] in [http://tldp.org/ The Linux Documentation Project]
• [https://technet.microsoft.com/en-us/library/bb490982(en-us).aspx Redirection in Windows]
• [http://msdn.microsoft.com/en-us/library/ms682499(VS.85).aspx Creating a Child Process with Redirected Input and Output] in Windows

{{DEFAULTSORT:Redirection (Computing)}}

Category:Articles with example code

Category:DOS technology

Category:Unix software

Category:Unix

Category:Windows administration