xref: /freebsd/bin/echo/echo.1 (revision ee12faa062c04a49bf6fe4e6867bad8606e2413f)
1.\"-
2.\" Copyright (c) 1990, 1993
3.\"	The Regents of the University of California.  All rights reserved.
4.\"
5.\" This code is derived from software contributed to Berkeley by
6.\" the Institute of Electrical and Electronics Engineers, Inc.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)echo.1	8.1 (Berkeley) 7/22/93
33.\"
34.Dd October 5, 2016
35.Dt ECHO 1
36.Os
37.Sh NAME
38.Nm echo
39.Nd write arguments to the standard output
40.Sh SYNOPSIS
41.Nm
42.Op Fl n
43.Op Ar string ...
44.Sh DESCRIPTION
45The
46.Nm
47utility writes any specified operands, separated by single blank
48.Pq Ql "\ "
49characters and followed by a newline
50.Pq Ql \en
51character, to the standard
52output.
53.Pp
54The following option is available:
55.Bl -tag -width flag
56.It Fl n
57Do not print the trailing newline character.
58.El
59.Pp
60The end-of-options marker
61.Fl Fl
62is not recognized and written literally.
63.Pp
64The newline may also be suppressed by appending
65.Ql \ec
66to the end of the string, as is done
67by iBCS2 compatible systems.
68Note that the
69.Fl n
70option as well as the effect of
71.Ql \ec
72are implementation-defined in
73.St -p1003.1-2001
74as amended by Cor.\& 1-2002.
75For portability,
76.Nm
77should only be used if the first argument does not start with a hyphen
78.Pq Ql "-"
79and does not contain any backslashes
80.Pq Ql "\e" .
81If this is not sufficient,
82.Xr printf 1
83should be used.
84.Pp
85Most shells provide a builtin
86.Nm
87command which tends to differ from this utility
88in the treatment of options and backslashes.
89Consult the
90.Xr builtin 1
91manual page.
92.Sh EXIT STATUS
93.Ex -std
94.Sh SEE ALSO
95.Xr builtin 1 ,
96.Xr csh 1 ,
97.Xr printf 1 ,
98.Xr sh 1
99.Sh STANDARDS
100The
101.Nm
102utility conforms to
103.St -p1003.1-2001
104as amended by Cor.\& 1-2002.
105.Sh HISTORY
106The
107.Nm
108command appeared in
109.At v2 .
110