usr/src/man/man1/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 and \fB/usr/ucb/echo\fR, on the other hand, have an
  77 \fB-n\fR option, but do not understand the back-slashed escape characters.
  78 \fBsh\fR and \fBksh\fR determine whether \fB/usr/ucb/echo\fR is found first in
  79 the \fBPATH\fR and, if so, they adapt the behavior of the \fBecho\fR builtin to
  80 match \fB/usr/ucb/echo\fR.
  81 .SH OPERANDS
  82 .LP
  83 The following operand is supported:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fIstring\fR\fR
  88 .ad
  89 .RS 10n
  90 A string to be written to standard output. If any operand is "\fB-n\fR", it is
  91 treated as a string, not an option. The following character sequences is
  92 recognized within any of the arguments:
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fB\ea\fR\fR
  97 .ad
  98 .RS 8n
  99 Alert character.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB\eb\fR\fR
 106 .ad
 107 .RS 8n
 108 Backspace.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fB\ec\fR\fR
 115 .ad
 116 .RS 8n
 117 Print line without new-line. All characters following the \fB\ec\fR in the
 118 argument are ignored.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB\ef\fR\fR
 125 .ad
 126 .RS 8n
 127 Form-feed.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fB\en\fR\fR
 134 .ad
 135 .RS 8n
 136 New-line.
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fB\er\fR\fR
 143 .ad
 144 .RS 8n
 145 Carriage return.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fB\et\fR\fR
 152 .ad
 153 .RS 8n
 154 Tab.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB\ev\fR\fR
 161 .ad
 162 .RS 8n
 163 Vertical tab.
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fB\e\e\fR\fR
 170 .ad
 171 .RS 8n
 172 Backslash.
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fB\e0\fR\fIn\fR\fR
 179 .ad
 180 .RS 8n
 181 Where \fIn\fR is the 8-bit character whose \fBASCII\fR code is the 1-, 2- or
 182 3-digit octal number representing that character.
 183 .RE
 184
 185 .RE
 186
 187 .SH USAGE
 188 .LP
 189 Portable applications should not use \fB-n\fR (as the first argument) or escape
 190 sequences.
 191 .sp
 192 .LP
 193 The \fBprintf\fR(1) utility can be used portably to emulate any of the
 194 traditional behaviors of the \fBecho\fR utility as follows:
 195 .RS +4
 196 .TP
 197 .ie t \(bu
 198 .el o
 199 The Solaris 2.6 operating environment or compatible version's
 200 \fB/usr/bin/echo\fR is equivalent to:
 201 .sp
 202 .in +2
 203 .nf
 204 \fBprintf "%b\en" "$*"\fR
 205 .fi
 206 .in -2
 207 .sp
 208
 209 .RE
 210 .RS +4
 211 .TP
 212 .ie t \(bu
 213 .el o
 214 The \fB/usr/ucb/echo\fR is equivalent to:
 215 .sp
 216 .in +2
 217 .nf
 218 if [ "X$1" = "X-n" ]
 219
 220 then
 221
 222         shift
 223
 224         printf "%s" "$*"
 225
 226 else
 227
 228         printf "%s\en" "$*"
 229
 230 fi
 231 .fi
 232 .in -2
 233
 234 .RE
 235 .sp
 236 .LP
 237 New applications are encouraged to use \fBprintf\fR instead of \fBecho\fR.
 238 .SH EXAMPLES
 239 .LP
 240 \fBExample 1 \fRFinding how far below root your current directory is located
 241 .sp
 242 .LP
 243 You can use \fBecho\fR to determine how many subdirectories below the root
 244 directory (\fB/\fR) is your current directory, as follows:
 245
 246 .RS +4
 247 .TP
 248 .ie t \(bu
 249 .el o
 250 Echo your current-working-directory's full pathname.
 251 .RE
 252 .RS +4
 253 .TP
 254 .ie t \(bu
 255 .el o
 256 Pipe the output through \fBtr\fR to translate the path's embedded
 257 slash-characters into space-characters.
 258 .RE
 259 .RS +4
 260 .TP
 261 .ie t \(bu
 262 .el o
 263 Pipe that output through \fBwc\fR \fB-w\fR for a count of the names in your
 264 path.
 265 .sp
 266 .in +2
 267 .nf
 268 example% \fB/usr/bin/echo $PWD | tr '/' ' ' | wc -w\fR
 269 .fi
 270 .in -2
 271 .sp
 272
 273 .RE
 274 .sp
 275 .LP
 276 See \fBtr\fR(1) and \fBwc\fR(1) for their functionality.
 277
 278 .sp
 279 .LP
 280 Below are the different flavors for echoing a string without a NEWLINE:
 281 .LP
 282 \fBExample 2 \fR/usr/bin/echo
 283 .sp
 284 .in +2
 285 .nf
 286 example% \fB/usr/bin/echo "$USER's current directory is $PWD\ec"\fR
 287 .fi
 288 .in -2
 289 .sp
 290
 291 .LP
 292 \fBExample 3 \fRsh/ksh shells
 293 .sp
 294 .in +2
 295 .nf
 296 example$ \fBecho "$USER's current directory is $PWD\ec"\fR
 297 .fi
 298 .in -2
 299 .sp
 300
 301 .LP
 302 \fBExample 4 \fRcsh shell
 303 .sp
 304 .in +2
 305 .nf
 306 example% \fBecho -n "$USER's current directory is $PWD"\fR
 307 .fi
 308 .in -2
 309 .sp
 310
 311 .LP
 312 \fBExample 5 \fR/usr/ucb/echo
 313 .sp
 314 .in +2
 315 .nf
 316 example% \fB/usr/ucb/echo -n "$USER's current directory is $PWD"\fR
 317 .fi
 318 .in -2
 319 .sp
 320
 321 .SH ENVIRONMENT VARIABLES
 322 .LP
 323 See \fBenviron\fR(5) for descriptions of the following environment variables
 324 that affect the execution of \fBecho\fR: \fBLANG\fR, \fBLC_ALL\fR,
 325 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 326
 327 .SH EXIT STATUS
 328 .LP
 329 The following error values are returned:
 330 .sp
 331 .ne 2
 332 .na
 333 \fB\fB0\fR\fR
 334 .ad
 335 .RS 6n
 336 Successful completion.
 337 .RE
 338
 339 .sp
 340 .ne 2
 341 .na
 342 \fB\fB>0\fR\fR
 343 .ad
 344 .RS 6n
 345 An error occurred.
 346 .RE
 347
 348 .SH ATTRIBUTES
 349 .LP
 350 See \fBattributes\fR(5) for descriptions of the following attributes:
 351 .sp
 352
 353 .sp
 354 .TS
 355 box;
 356 c | c
 357 l | l .
 358 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 359 _
 360 CSI     Enabled
 361 _
 362 Interface Stability     Committed
 363 _
 364 Standard        See \fBstandards\fR(5).
 365 .TE
 366
 367 .SH SEE ALSO
 368 .LP
 369 \fBksh93\fR(1), \fBprintf\fR(1), \fBshell_builtins\fR(1), \fBtr\fR(1),
 370 \fBwc\fR(1), \fBecho\fR(1B), \fBascii\fR(5), \fBattributes\fR(5),
 371 \fBenviron\fR(5), \fBstandards\fR(5)
 372 .SH NOTES
 373 .LP
 374 When representing an 8-bit character by using the escape convention
 375 \fB\e0\fR\fIn\fR, the \fIn\fR must \fBalways\fR be preceded by the digit zero
 376 (\fB0\fR).
 377 .sp
 378 .LP
 379 For example, typing: \fBecho 'WARNING:\e\|07'\fR prints the phrase
 380 \fBWARNING:\fR and sounds the "bell" on your terminal. The use of single (or
 381 double) quotes (or two backslashes) is required to protect the "\|\e" that
 382 precedes the "07".
 383 .sp
 384 .LP
 385 Following the \fB\e0\fR, up to three digits are used in constructing the octal
 386 output character. If, following the \fB\e0\fR\fIn\fR, you want to echo
 387 additional digits that are not part of the octal representation, you must use
 388 the full 3-digit \fIn\fR. For example, if you want to echo "ESC 7" you must use
 389 the three digits "033" rather than just the two digits "33" after the
 390 \fB\e\|0\fR\&.
 391 .sp
 392 .in +2
 393 .nf
 394 2 digits         Incorrect:      echo "\e0337" | od -xc
 395                  produces:       df0a                     (hex)
 396                                  337                      (ascii)
 397 3 digits         Correct:        echo "\e00337" | od -xc
 398                  produces:       lb37 0a00                (hex)
 399                                  033 7                    (ascii)
 400 .fi
 401 .in -2
 402 .sp
 403
 404 .sp
 405 .LP
 406 For the octal equivalents of each character, see \fBascii\fR(5).