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