usr/src/man/man1/print.1

   1 '\" te
   2 .\" Copyright (c) 2008 Sun Microsystems, Inc. - All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH PRINT 1 "Mar 27, 2008"
   9 .SH NAME
  10 print \- shell built-in function to output characters to the screen or window
  11 .SH SYNOPSIS
  12 .SS "ksh"
  13 .LP
  14 .nf
  15 \fBprint\fR [\fB-Rnprsu\fR [\fIn\fR]] [\fIarg\fR]...
  16 .fi
  17
  18 .SS "ksh93"
  19 .LP
  20 .nf
  21 \fBprint\fR [\fB-Renprs\fR] [\fB-f\fR \fIformat\fR] [\fB-u\fR \fIfd\fR] [\fIstring\fR...]
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .SS "ksh"
  26 .sp
  27 .LP
  28 The shell output mechanism. When no options are specified, or when an option
  29 followed by \fB\&'\fR a \fB\(mi\fR is specified, or when just \fB-\fR is
  30 specified, the arguments are printed on standard output as described by
  31 \fBecho\fR(1).
  32 .SS "ksh93"
  33 .sp
  34 .LP
  35 By default, \fBprint\fR writes each string operand to standard output and
  36 appends a NEWLINE character.
  37 .sp
  38 .LP
  39 Unless, the \fB-r\fR, \fB-R\fR, or \fB-f\fR option is speciifed, each \fB\e\fR
  40 character in each string operand is processed specially as follows:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB\ea\fR\fR
  45 .ad
  46 .RS 8n
  47 Alert character.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fB\eb\fR\fR
  54 .ad
  55 .RS 8n
  56 Backspace character.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB\ec\fR\fR
  63 .ad
  64 .RS 8n
  65 Terminate output without appending NEWLINE. The remaining string operands are
  66 ignored.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB\eE\fR\fR
  73 .ad
  74 .RS 8n
  75 Escape character (\fBASCII\fR octal \fB033\fR).
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB\ef\fR\fR
  82 .ad
  83 .RS 8n
  84 FORM FEED character.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB\en\fR\fR
  91 .ad
  92 .RS 8n
  93 NEWLINE character.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fB\et\fR\fR
 100 .ad
 101 .RS 8n
 102 Tab character.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB\ev\fR\fR
 109 .ad
 110 .RS 8n
 111 Vertical tab character.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB\e\e\fR\fR
 118 .ad
 119 .RS 8n
 120 Backslash character.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fB\e0\fR\fIx\fR\fR
 127 .ad
 128 .RS 8n
 129 The 8-bit character whose \fBASCII\fR code is the \fB1\fR-, \fB2\fR-, or
 130 \fB3\fR-digit octal number \fIx\fR.
 131 .RE
 132
 133 .SH OPTIONS
 134 .SS "ksh"
 135 .sp
 136 .LP
 137 The following options are supported by \fBksh\fR:
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB-n\fR\fR
 142 .ad
 143 .RS 12n
 144 Suppresses \fBnew-line\fR from being added to the output.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB-r\fR\fB-R\fR\fR
 151 .ad
 152 .RS 12n
 153 Raw mode. Ignore the escape conventions of \fBecho\fR. The \fB-R\fR option
 154 prints all subsequent arguments and options other than \fB-n\fR.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB-p\fR\fR
 161 .ad
 162 .RS 12n
 163 Cause the arguments to be written onto the pipe of the process spawned with
 164 \fB|&\fR instead of standard output.
 165 .RE
 166
 167 .sp
 168 .ne 2
 169 .na
 170 \fB\fB-s\fR\fR
 171 .ad
 172 .RS 12n
 173 Cause the arguments to be written onto the history file instead of standard
 174 output.
 175 .RE
 176
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fB-u\fR [ \fIn\fR ]\fR
 181 .ad
 182 .RS 12n
 183 Specify a one digit file descriptor unit number \fIn\fR on which the output is
 184 placed. The default is 1.
 185 .RE
 186
 187 .SS "ksh93"
 188 .sp
 189 .LP
 190 The following options are supported by \fBksh93\fR:
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fB-e\fR \fI\fR\fR
 195 .ad
 196 .RS 13n
 197 Unless \fB-f\fR is specified, process \fB\e\fR sequences in each string operand
 198 as described above. This is the default behavior.
 199 .sp
 200 If both \fB-e\fR and \fB-r\fR are specified, the last one specified is the one
 201 that is used.
 202 .RE
 203
 204 .sp
 205 .ne 2
 206 .na
 207 \fB\fB-f\fR \fIformat\fR\fR
 208 .ad
 209 .RS 13n
 210 Write the string arguments using the format string \fIformat\fR and do not
 211 append a NEWLINE. See \fBprintf\fR(1) for details on how to specify format.
 212 .sp
 213 When the \fB-f\fR option is specified and there are more string operands than
 214 format specifiers, the format string is reprocessed from the beginning. If
 215 there are fewer string operands than format specifiers, then outputting ends at
 216 the first unneeded format specifier.
 217 .RE
 218
 219 .sp
 220 .ne 2
 221 .na
 222 \fB\fB-n\fR\fR
 223 .ad
 224 .RS 13n
 225 Do not append a NEWLINE character to the output.
 226 .RE
 227
 228 .sp
 229 .ne 2
 230 .na
 231 \fB\fB-p\fR\fR
 232 .ad
 233 .RS 13n
 234 Write to the current co-process instead of standard output.
 235 .RE
 236
 237 .sp
 238 .ne 2
 239 .na
 240 \fB\fB-r\fR\fR
 241 .ad
 242 .br
 243 .na
 244 \fB\fB-R\fR\fR
 245 .ad
 246 .RS 13n
 247 Do not process \fB\e\fR sequences in each string operand as described above.
 248 .sp
 249 If both \fB-e\fR and \fB-r\fR are specified, the last one specified is the one
 250 that is used.
 251 .RE
 252
 253 .sp
 254 .ne 2
 255 .na
 256 \fB\fB-s\fR\fR
 257 .ad
 258 .RS 13n
 259 Write the output as an entry in the shell history file instead of standard
 260 output.
 261 .RE
 262
 263 .sp
 264 .ne 2
 265 .na
 266 \fB\fB-u\fR \fIfd\fR\fR
 267 .ad
 268 .RS 13n
 269 Write to file descriptor number \fIfd\fR instead of standard output. The
 270 default value is \fB1\fR.
 271 .RE
 272
 273 .SH EXIT STATUS
 274 .sp
 275 .LP
 276 The following exit values are returned:
 277 .sp
 278 .ne 2
 279 .na
 280 \fB\fB0\fR\fR
 281 .ad
 282 .RS 6n
 283 Successful completion.
 284 .RE
 285
 286 .sp
 287 .ne 2
 288 .na
 289 \fB\fB>0\fR\fR
 290 .ad
 291 .RS 6n
 292 Output file is not open for writing.
 293 .RE
 294
 295 .SH SEE ALSO
 296 .sp
 297 .LP
 298 \fBecho\fR(1), \fBksh\fR(1), \fBksh93\fR(1), \fBprintf\fR(1),
 299 \fBattributes\fR(5)