bin/sh/bltin/echo.1

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