freebsd-dev/bin/echo/echo.1

.\"-
.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)echo.1	8.1 (Berkeley) 7/22/93
.\" $FreeBSD$
.\"
.Dd October 5, 2016
.Dt ECHO 1
.Os
.Sh NAME
.Nm echo
.Nd write arguments to the standard output
.Sh SYNOPSIS
.Nm
.Op Fl n
.Op Ar string ...
.Sh DESCRIPTION
The
.Nm
utility writes any specified operands, separated by single blank
.Pq Ql "\ "
characters and followed by a newline
.Pq Ql \en
character, to the standard
output.
.Pp
The following option is available:
.Bl -tag -width flag
.It Fl n
Do not print the trailing newline character.
.El
.Pp
The end-of-options marker
.Fl Fl
is not recognized and written literally.
.Pp
The newline may also be suppressed by appending
.Ql \ec
to the end of the string, as is done
by iBCS2 compatible systems.
Note that the
.Fl n
option as well as the effect of
.Ql \ec
are implementation-defined in
.St -p1003.1-2001
as amended by Cor.\& 1-2002.
For portability,
.Nm
should only be used if the first argument does not start with a hyphen
.Pq Ql "-"
and does not contain any backslashes
.Pq Ql "\e" .
If this is not sufficient,
.Xr printf 1
should be used.
.Pp
Most shells provide a builtin
.Nm
command which tends to differ from this utility
in the treatment of options and backslashes.
Consult the
.Xr builtin 1
manual page.
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr printf 1 ,
.Xr sh 1
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001
as amended by Cor.\& 1-2002.
.Sh HISTORY
The
.Nm
command appeared in
.At v2 .
/*- or .\"- or #- to begin license clauses. 2005-01-10 08:39:26 +00:00			`.\"-`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.\" Copyright (c) 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the Institute of Electrical and Electronics Engineers, Inc.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)echo.1 8.1 (Berkeley) 7/22/93`
$Id$ -> $FreeBSD$ 1999-08-27 23:15:48 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.\"`
Add history section for echo(1) Sourced using the draft copy of the second edition manual http://www.tuhs.org/Archive/PDP-11/Distributions/research/1972_stuff/unix_2nd_edition_manual.pdf PR: 211785 Approved by: bcr (mentor) MFC after: 5 days Differential Revision: https://reviews.freebsd.org/D8104 2016-10-05 19:16:55 +00:00			`.Dd October 5, 2016`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Dt ECHO 1`
			`.Os`
			`.Sh NAME`
			`.Nm echo`
			`.Nd write arguments to the standard output`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 11:39:41 +00:00			`.Nm`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Op Fl n`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Op Ar string ...`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Sh DESCRIPTION`
			`The`
Correct use of .Nm. Add rcsid. 1998-05-13 07:39:11 +00:00			`.Nm`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`utility writes any specified operands, separated by single blank`
			`.Pq Ql "\ "`
			`characters and followed by a newline`
			`.Pq Ql \en`
			`character, to the standard`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`output.`
			`.Pp`
			`The following option is available:`
			`.Bl -tag -width flag`
			`.It Fl n`
Note that -n and \c are implementation-defined as per TC1 to POSIX 2001. Approved by: re@ (bmah) MFC after: 3 days 2003-05-08 17:47:28 +00:00			`Do not print the trailing newline character.`
echo(1): Clarify portability and mention literal "--" handling. MFC after: 1 week 2010-11-12 22:43:40 +00:00			`.El`
			`.Pp`
			`The end-of-options marker`
			`.Fl Fl`
			`is not recognized and written literally.`
			`.Pp`
			`The newline may also be suppressed by appending`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Ql \ec`
			`to the end of the string, as is done`
Well, it would appear that the "ayes" have it (though by a slim margin). Apply my \c changes to echo. It should also be noted that this is: A) going into 2.2, not 2.1 B) a functional no-op unless you actually use it! 1995-08-31 17:25:55 +00:00			`by iBCS2 compatible systems.`
echo(1): Clarify portability and mention literal "--" handling. MFC after: 1 week 2010-11-12 22:43:40 +00:00			`Note that the`
			`.Fl n`
			`option as well as the effect of`
Note that -n and \c are implementation-defined as per TC1 to POSIX 2001. Approved by: re@ (bmah) MFC after: 3 days 2003-05-08 17:47:28 +00:00			`.Ql \ec`
			`are implementation-defined in`
			`.St -p1003.1-2001`
Mechanically kill hard sentence breaks. 2004-07-02 21:04:19 +00:00			`as amended by Cor.\& 1-2002.`
echo(1): Clarify portability and mention literal "--" handling. MFC after: 1 week 2010-11-12 22:43:40 +00:00			`For portability,`
			`.Nm`
			`should only be used if the first argument does not start with a hyphen`
			`.Pq Ql "-"`
			`and does not contain any backslashes`
			`.Pq Ql "\e" .`
			`If this is not sufficient,`
Note that -n and \c are implementation-defined as per TC1 to POSIX 2001. Approved by: re@ (bmah) MFC after: 3 days 2003-05-08 17:47:28 +00:00			`.Xr printf 1`
echo(1): Clarify portability and mention literal "--" handling. MFC after: 1 week 2010-11-12 22:43:40 +00:00			`should be used.`
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes 1999-09-08 15:40:46 +00:00			`.Pp`
echo(1): Clarify portability and mention literal "--" handling. MFC after: 1 week 2010-11-12 22:43:40 +00:00			`Most shells provide a builtin`
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes 1999-09-08 15:40:46 +00:00			`.Nm`
echo(1): Clarify portability and mention literal "--" handling. MFC after: 1 week 2010-11-12 22:43:40 +00:00			`command which tends to differ from this utility`
			`in the treatment of options and backslashes.`
Correct some hard sentence breaks. Only those surrounding the previous commit and those which cause ugly nroff output have been fixed, since the purpose of the style guideline which they contravene is to reduce the sizes of deltas. Reported by: bde 1999-09-14 11:46:04 +00:00			`Consult the`
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes 1999-09-08 15:40:46 +00:00			`.Xr builtin 1`
			`manual page.`
Add the new standard EXIT STATUS section where appropriate. Sort standard sections in the (documented) preferred order. 2005-01-16 16:41:59 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: utilize the new .Ex macro. 2001-08-15 09:09:47 +00:00			`.Ex -std`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Sh SEE ALSO`
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes 1999-09-08 15:40:46 +00:00			`.Xr builtin 1 ,`
			`.Xr csh 1 ,`
			`.Xr printf 1 ,`
			`.Xr sh 1`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Sh STANDARDS`
			`The`
Correct use of .Nm. Add rcsid. 1998-05-13 07:39:11 +00:00			`.Nm`
Refer to 1003.1-2001 in the Standards section now that TC1 allows the traditional BSD behaviour (-n option) and FreeBSD extensions (\c). 2003-04-12 03:49:28 +00:00			`utility conforms to`
			`.St -p1003.1-2001`
Mechanically kill hard sentence breaks. 2004-07-02 21:04:19 +00:00			`as amended by Cor.\& 1-2002.`
Add history section for echo(1) Sourced using the draft copy of the second edition manual http://www.tuhs.org/Archive/PDP-11/Distributions/research/1972_stuff/unix_2nd_edition_manual.pdf PR: 211785 Approved by: bcr (mentor) MFC after: 5 days Differential Revision: https://reviews.freebsd.org/D8104 2016-10-05 19:16:55 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.At v2 .`