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 .\" $DragonFly: src/bin/sh/bltin/echo.1,v 1.2 2003/06/17 04:22:50 dillon Exp $
  39 .\"
  40 .Dd May 4, 1995
  41 .Dt ECHO 1
  42 .Os
  43 .Sh NAME
  44 .Nm echo
  45 .Nd produce message in a shell script
  46 .Sh SYNOPSIS
  47 .Nm
  48 .Op Fl n | Fl e
  49 .Ar args...
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility prints its arguments on the standard output, separated by spaces.
  54 Unless the
  55 .Fl n
  56 option is present, a newline is output following the arguments.
  57 The
  58 .Fl e
  59 option causes
  60 .Nm
  61 to treat the escape sequences specially, as described in the following
  62 paragraph.
  63 The
  64 .Fl e
  65 option is the default, and is provided solely for compatibility with
  66 other systems.
  67 Only one of the options
  68 .Fl n
  69 and
  70 .Fl e
  71 may be given.
  72 .Pp
  73 If any of the following sequences of characters is encountered during
  74 output, the sequence is not output.  Instead, the specified action is
  75 performed:
  76 .Bl -tag -width indent
  77 .It Li \eb
  78 A backspace character is output.
  79 .It Li \ec
  80 Subsequent output is suppressed.  This is normally used at the end of the
  81 last argument to suppress the trailing newline that
  82 .Nm
  83 would otherwise output.
  84 .It Li \ef
  85 Output a form feed.
  86 .It Li \en
  87 Output a newline character.
  88 .It Li \er
  89 Output a carriage return.
  90 .It Li \et
  91 Output a (horizontal) tab character.
  92 .It Li \ev
  93 Output a vertical tab.
  94 .It Li \e0 Ns Ar digits
  95 Output the character whose value is given by zero to three digits.
  96 If there are zero digits, a
  97 .Dv NUL
  98 character is output.
  99 .It Li \e\e
 100 Output a backslash.
 101 .El
 102 .Sh HINTS
 103 Remember that backslash is special to the shell and needs to be escaped.
 104 To output a message to standard error, say
 105 .Pp
 106 .D1  echo message >&2
 107 .Sh BUGS
 108 The octal character escape mechanism
 109 .Pq Li \e0 Ns Ar digits
 110 differs from the
 111 C language mechanism.
 112 .Pp
 113 There is no way to force
 114 .Nm
 115 to treat its arguments literally, rather than interpreting them as
 116 options and escape sequences.