bin/echo/echo.1

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  45 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
  46 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved
  47 .\"
  48 .TH ECHO 1 "Apr 14, 2016"
  49 .SH NAME
  50 echo \- echo arguments
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 \fB/usr/bin/echo\fR [\fIstring\fR]...
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .LP
  59 The \fBecho\fR utility writes its arguments, separated by BLANKs and terminated
  60 by a NEWLINE, to the standard output. If there are no arguments, only the
  61 NEWLINE character is written.
  62 .sp
  63 .LP
  64 \fBecho\fR is useful for producing diagnostics in command files, for sending
  65 known data into a pipe, and for displaying the contents of environment
  66 variables.
  67 .sp
  68 .LP
  69 The C shell, the Korn shell, and the Bourne shell all have \fBecho\fR built-in
  70 commands, which, by default, is invoked if the user calls \fBecho\fR without a
  71 full pathname. See \fBshell_builtins\fR(1). \fBsh\fR's \fBecho\fR, \fBksh\fR's
  72 \fBecho\fR, \fBksh93\fR's \fBecho\fR, and \fB/usr/bin/echo\fR understand the
  73 back-slashed escape characters, except that \fBsh\fR's \fBecho\fR does not
  74 understand \fB\ea\fR as the alert character. In addition, \fBksh\fR's and
  75 \fBksh93\fR's \fBecho\fR does not have an \fB-n\fR option.
  76 \fBcsh\fR's \fBecho\fR, on the other hand, has an
  77 \fB-n\fR option, but does not understand the back-slashed escape characters.
  78 .SH OPERANDS
  79 .LP
  80 The following operand is supported:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fIstring\fR\fR
  85 .ad
  86 .RS 10n
  87 A string to be written to standard output. If any operand is "\fB-n\fR", it is
  88 treated as a string, not an option. The following character sequences is
  89 recognized within any of the arguments:
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB\ea\fR\fR
  94 .ad
  95 .RS 8n
  96 Alert character.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB\eb\fR\fR
 103 .ad
 104 .RS 8n
 105 Backspace.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB\ec\fR\fR
 112 .ad
 113 .RS 8n
 114 Print line without new-line. All characters following the \fB\ec\fR in the
 115 argument are ignored.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB\ef\fR\fR
 122 .ad
 123 .RS 8n
 124 Form-feed.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB\en\fR\fR
 131 .ad
 132 .RS 8n
 133 New-line.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fB\er\fR\fR
 140 .ad
 141 .RS 8n
 142 Carriage return.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB\et\fR\fR
 149 .ad
 150 .RS 8n
 151 Tab.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB\ev\fR\fR
 158 .ad
 159 .RS 8n
 160 Vertical tab.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB\e\e\fR\fR
 167 .ad
 168 .RS 8n
 169 Backslash.
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fB\e0\fR\fIn\fR\fR
 176 .ad
 177 .RS 8n
 178 Where \fIn\fR is the 8-bit character whose \fBASCII\fR code is the 1-, 2- or
 179 3-digit octal number representing that character.
 180 .RE
 181
 182 .RE
 183
 184 .SH USAGE
 185 .LP
 186 Portable applications should not use \fB-n\fR (as the first argument) or escape
 187 sequences.
 188
 189 New applications are encouraged to use \fBprintf\fR instead of \fBecho\fR.
 190 .SH EXAMPLES
 191 .LP
 192 \fBExample 1 \fRFinding how far below root your current directory is located
 193 .sp
 194 .LP
 195 You can use \fBecho\fR to determine how many subdirectories below the root
 196 directory (\fB/\fR) is your current directory, as follows:
 197
 198 .RS +4
 199 .TP
 200 .ie t \(bu
 201 .el o
 202 Echo your current-working-directory's full pathname.
 203 .RE
 204 .RS +4
 205 .TP
 206 .ie t \(bu
 207 .el o
 208 Pipe the output through \fBtr\fR to translate the path's embedded
 209 slash-characters into space-characters.
 210 .RE
 211 .RS +4
 212 .TP
 213 .ie t \(bu
 214 .el o
 215 Pipe that output through \fBwc\fR \fB-w\fR for a count of the names in your
 216 path.
 217 .sp
 218 .in +2
 219 .nf
 220 example% \fB/usr/bin/echo $PWD | tr '/' ' ' | wc -w\fR
 221 .fi
 222 .in -2
 223 .sp
 224
 225 .RE
 226 .sp
 227 .LP
 228 See \fBtr\fR(1) and \fBwc\fR(1) for their functionality.
 229
 230 .sp
 231 .LP
 232 Below are the different flavors for echoing a string without a NEWLINE:
 233 .LP
 234 \fBExample 2 \fR/usr/bin/echo
 235 .sp
 236 .in +2
 237 .nf
 238 example% \fB/usr/bin/echo "$USER's current directory is $PWD\ec"\fR
 239 .fi
 240 .in -2
 241 .sp
 242
 243 .LP
 244 \fBExample 3 \fRsh/ksh shells
 245 .sp
 246 .in +2
 247 .nf
 248 example$ \fBecho "$USER's current directory is $PWD\ec"\fR
 249 .fi
 250 .in -2
 251 .sp
 252
 253 .LP
 254 \fBExample 4 \fRcsh shell
 255 .sp
 256 .in +2
 257 .nf
 258 example% \fBecho -n "$USER's current directory is $PWD"\fR
 259 .fi
 260 .in -2
 261 .sp
 262
 263 .SH ENVIRONMENT VARIABLES
 264 .LP
 265 See \fBenviron\fR(5) for descriptions of the following environment variables
 266 that affect the execution of \fBecho\fR: \fBLANG\fR, \fBLC_ALL\fR,
 267 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 268
 269 .SH EXIT STATUS
 270 .LP
 271 The following error values are returned:
 272 .sp
 273 .ne 2
 274 .na
 275 \fB\fB0\fR\fR
 276 .ad
 277 .RS 6n
 278 Successful completion.
 279 .RE
 280
 281 .sp
 282 .ne 2
 283 .na
 284 \fB\fB>0\fR\fR
 285 .ad
 286 .RS 6n
 287 An error occurred.
 288 .RE
 289
 290 .SH ATTRIBUTES
 291 .LP
 292 See \fBattributes\fR(5) for descriptions of the following attributes:
 293 .sp
 294
 295 .sp
 296 .TS
 297 box;
 298 c | c
 299 l | l .
 300 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 301 _
 302 CSI     Enabled
 303 _
 304 Interface Stability     Committed
 305 _
 306 Standard        See \fBstandards\fR(5).
 307 .TE
 308
 309 .SH SEE ALSO
 310 .LP
 311 \fBksh93\fR(1), \fBprintf\fR(1), \fBshell_builtins\fR(1), \fBtr\fR(1),
 312 \fBwc\fR(1), \fBecho\fR(1B), \fBascii\fR(5), \fBattributes\fR(5),
 313 \fBenviron\fR(5), \fBstandards\fR(5)
 314 .SH NOTES
 315 .LP
 316 When representing an 8-bit character by using the escape convention
 317 \fB\e0\fR\fIn\fR, the \fIn\fR must \fBalways\fR be preceded by the digit zero
 318 (\fB0\fR).
 319 .sp
 320 .LP
 321 For example, typing: \fBecho 'WARNING:\e\|07'\fR prints the phrase
 322 \fBWARNING:\fR and sounds the "bell" on your terminal. The use of single (or
 323 double) quotes (or two backslashes) is required to protect the "\|\e" that
 324 precedes the "07".
 325 .sp
 326 .LP
 327 Following the \fB\e0\fR, up to three digits are used in constructing the octal
 328 output character. If, following the \fB\e0\fR\fIn\fR, you want to echo
 329 additional digits that are not part of the octal representation, you must use
 330 the full 3-digit \fIn\fR. For example, if you want to echo "ESC 7" you must use
 331 the three digits "033" rather than just the two digits "33" after the
 332 \fB\e\|0\fR\&.
 333 .sp
 334 .in +2
 335 .nf
 336 2 digits         Incorrect:      echo "\e0337" | od -xc
 337                  produces:       df0a                     (hex)
 338                                  337                      (ascii)
 339 3 digits         Correct:        echo "\e00337" | od -xc
 340                  produces:       lb37 0a00                (hex)
 341                                  033 7                    (ascii)
 342 .fi
 343 .in -2
 344 .sp
 345
 346 .sp
 347 .LP
 348 For the octal equivalents of each character, see \fBascii\fR(5).