bin/sh/bltin/echo.1

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Kenneth Almquist.
   6 .\" Copyright 1989 by Kenneth Almquist
   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. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)echo.1      8.2 (Berkeley) 5/4/95
  37 .\" $FreeBSD: src/bin/sh/bltin/echo.1,v 1.7.2.5 2003/01/24 02:37:51 keramida Exp $
  38 .\"
  39 .Dd May 4, 1995
  40 .Dt ECHO 1
  41 .Os
  42 .Sh NAME
  43 .Nm echo
  44 .Nd produce message in a shell script
  45 .Sh SYNOPSIS
  46 .Nm
  47 .Op Fl n | Fl e
  48 .Ar args...
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility prints its arguments on the standard output, separated by spaces.
  53 Unless the
  54 .Fl n
  55 option is present, a newline is output following the arguments.
  56 The
  57 .Fl e
  58 option causes
  59 .Nm
  60 to treat the escape sequences specially, as described in the following
  61 paragraph.
  62 The
  63 .Fl e
  64 option is the default, and is provided solely for compatibility with
  65 other systems.
  66 Only one of the options
  67 .Fl n
  68 and
  69 .Fl e
  70 may be given.
  71 .Pp
  72 If any of the following sequences of characters is encountered during
  73 output, the sequence is not output.  Instead, the specified action is
  74 performed:
  75 .Bl -tag -width indent
  76 .It Li \eb
  77 A backspace character is output.
  78 .It Li \ec
  79 Subsequent output is suppressed.  This is normally used at the end of the
  80 last argument to suppress the trailing newline that
  81 .Nm
  82 would otherwise output.
  83 .It Li \ef
  84 Output a form feed.
  85 .It Li \en
  86 Output a newline character.
  87 .It Li \er
  88 Output a carriage return.
  89 .It Li \et
  90 Output a (horizontal) tab character.
  91 .It Li \ev
  92 Output a vertical tab.
  93 .It Li \e0 Ns Ar digits
  94 Output the character whose value is given by zero to three digits.
  95 If there are zero digits, a
  96 .Dv NUL
  97 character is output.
  98 .It Li \e\e
  99 Output a backslash.
 100 .El
 101 .Sh HINTS
 102 Remember that backslash is special to the shell and needs to be escaped.
 103 To output a message to standard error, say
 104 .Pp
 105 .D1  echo message >&2
 106 .Sh BUGS
 107 The octal character escape mechanism
 108 .Pq Li \e0 Ns Ar digits
 109 differs from the
 110 C language mechanism.
 111 .Pp
 112 There is no way to force
 113 .Nm
 114 to treat its arguments literally, rather than interpreting them as
 115 options and escape sequences.