usr.bin/printf/printf.1

   1 .\" Copyright (c) 1989, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)printf.1    8.1 (Berkeley) 6/6/93
  36 .\" $FreeBSD: src/usr.bin/printf/printf.1,v 1.8.2.7 2002/07/15 07:37:49 keramida Exp $
  37 .\"
  38 .Dd June 6, 1993
  39 .Dt PRINTF 1
  40 .Os
  41 .Sh NAME
  42 .Nm printf
  43 .Nd formatted output
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Ar format Op Ar arguments  ...
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility formats and prints its arguments, after the first, under control
  51 of the
  52 .Ar format  .
  53 The
  54 .Ar format
  55 is a character string which contains three types of objects: plain characters,
  56 which are simply copied to standard output, character escape sequences which
  57 are converted and copied to the standard output, and format specifications,
  58 each of which causes printing of the next successive
  59 .Ar argument  .
  60 .Pp
  61 The
  62 .Ar arguments
  63 after the first are treated as strings if the corresponding format is
  64 either
  65 .Cm c , b
  66 or
  67 .Cm s ;
  68 otherwise it is evaluated as a C constant, with the following extensions:
  69 .Pp
  70 .Bl -bullet -offset indent -compact
  71 .It
  72 A leading plus or minus sign is allowed.
  73 .It
  74 If the leading character is a single or double quote, the value is the
  75 .Tn ASCII
  76 code of the next character.
  77 .El
  78 .Pp
  79 The format string is reused as often as necessary to satisfy the
  80 .Ar arguments  .
  81 Any extra format specifications are evaluated with zero or the null
  82 string.
  83 .Pp
  84 Character escape sequences are in backslash notation as defined in the
  85 .St -ansiC ,
  86 with extensions.
  87 The characters and their meanings
  88 are as follows:
  89 .Pp
  90 .Bl -tag -width Ds -offset indent -compact
  91 .It Cm \ea
  92 Write a <bell> character.
  93 .It Cm \eb
  94 Write a <backspace> character.
  95 .It Cm \ec
  96 Ignore remaining characters in this string.
  97 .It Cm \ef
  98 Write a <form-feed> character.
  99 .It Cm \en
 100 Write a <new-line> character.
 101 .It Cm \er
 102 Write a <carriage return> character.
 103 .It Cm \et
 104 Write a <tab> character.
 105 .It Cm \ev
 106 Write a <vertical tab> character.
 107 .It Cm \e\'
 108 Write a <single quote> character.
 109 .It Cm \e\e
 110 Write a backslash character.
 111 .It Cm \e Ns Ar num
 112 .It Cm \e0 Ns Ar num
 113 Write an 8-bit character whose
 114 .Tn ASCII
 115 value is the 1-, 2-, or 3-digit
 116 octal number
 117 .Ar num .
 118 .El
 119 .Pp
 120 Each format specification is introduced by the percent character
 121 (``%'').
 122 The remainder of the format specification includes,
 123 in the following order:
 124 .Bl -tag -width Ds
 125 .It "Zero or more of the following flags:"
 126 .Bl -tag -width Ds
 127 .It Cm #
 128 A `#' character
 129 specifying that the value should be printed in an ``alternate form''.
 130 For
 131 .Cm c , d ,
 132 and
 133 .Cm s ,
 134 formats, this option has no effect.  For the
 135 .Cm o
 136 formats the precision of the number is increased to force the first
 137 character of the output string to a zero.  For the
 138 .Cm x
 139 .Pq Cm X
 140 format, a non-zero result has the string
 141 .Li 0x
 142 .Pq Li 0X
 143 prepended to it.  For
 144 .Cm e , E , f , g ,
 145 and
 146 .Cm G ,
 147 formats, the result will always contain a decimal point, even if no
 148 digits follow the point (normally, a decimal point only appears in the
 149 results of those formats if a digit follows the decimal point).  For
 150 .Cm g
 151 and
 152 .Cm G
 153 formats, trailing zeros are not removed from the result as they
 154 would otherwise be;
 155 .It Cm \&\-
 156 A minus sign `\-' which specifies
 157 .Em left adjustment
 158 of the output in the indicated field;
 159 .It Cm \&+
 160 A `+' character specifying that there should always be
 161 a sign placed before the number when using signed formats.
 162 .It Sq \&\ \&
 163 A space specifying that a blank should be left before a positive number
 164 for a signed format.  A `+' overrides a space if both are used;
 165 .It Cm \&0
 166 A zero `0' character indicating that zero-padding should be used
 167 rather than blank-padding.  A `\-' overrides a `0' if both are used;
 168 .El
 169 .It "Field Width:"
 170 An optional digit string specifying a
 171 .Em field width ;
 172 if the output string has fewer characters than the field width it will
 173 be blank-padded on the left (or right, if the left-adjustment indicator
 174 has been given) to make up the field width (note that a leading zero
 175 is a flag, but an embedded zero is part of a field width);
 176 .It Precision:
 177 An optional period,
 178 .Sq Cm \&.\& ,
 179 followed by an optional digit string giving a
 180 .Em precision
 181 which specifies the number of digits to appear after the decimal point,
 182 for
 183 .Cm e
 184 and
 185 .Cm f
 186 formats, or the maximum number of characters to be printed
 187 from a string; if the digit string is missing, the precision is treated
 188 as zero;
 189 .It Format:
 190 A character which indicates the type of format to use (one of
 191 .Cm diouxXfwEgGcsb ) .
 192 .El
 193 .Pp
 194 A field width or precision may be
 195 .Sq Cm \&*
 196 instead of a digit string.
 197 In this case an
 198 .Ar argument
 199 supplies the field width or precision.
 200 .Pp
 201 The format characters and their meanings are:
 202 .Bl -tag -width Fl
 203 .It Cm diouXx
 204 The
 205 .Ar argument
 206 is printed as a signed decimal (d or i), unsigned octal, unsigned decimal,
 207 or unsigned hexadecimal (X or x), respectively.
 208 .It Cm f
 209 The
 210 .Ar argument
 211 is printed in the style `[\-]ddd.ddd' where the number of d's
 212 after the decimal point is equal to the precision specification for
 213 the argument.
 214 If the precision is missing, 6 digits are given; if the precision
 215 is explicitly 0, no digits and no decimal point are printed.
 216 .It Cm eE
 217 The
 218 .Ar argument
 219 is printed in the style
 220 .Cm e
 221 .Sm off
 222 .Sq Op - Ar d.ddd No \(+- Ar dd
 223 .Sm on
 224 where there
 225 is one digit before the decimal point and the number after is equal to
 226 the precision specification for the argument; when the precision is
 227 missing, 6 digits are produced.
 228 An upper-case E is used for an `E' format.
 229 .It Cm gG
 230 The
 231 .Ar argument
 232 is printed in style
 233 .Cm f
 234 or in style
 235 .Cm e
 236 .Pq Cm E
 237 whichever gives full precision in minimum space.
 238 .It Cm c
 239 The first character of
 240 .Ar argument
 241 is printed.
 242 .It Cm s
 243 Characters from the string
 244 .Ar argument
 245 are printed until the end is reached or until the number of characters
 246 indicated by the precision specification is reached; however if the
 247 precision is 0 or missing, all characters in the string are printed.
 248 .It Cm b
 249 As for
 250 .Cm s ,
 251 but interpret character escapes in backslash notation in the string
 252 .Ar argument .
 253 .It Cm \&%
 254 Print a `%'; no argument is used.
 255 .El
 256 .Pp
 257 The decimal point
 258 character is defined in the program's locale (category
 259 .Dv LC_NUMERIC ) .
 260 .Pp
 261 In no case does a non-existent or small field width cause truncation of
 262 a field; padding takes place only if the specified field width exceeds
 263 the actual width.
 264 .Sh DIAGNOSTICS
 265 .Ex -std
 266 .Sh COMPATIBILITY
 267 The traditional
 268 .Bx
 269 behavior of converting arguments of numeric formats not beginning
 270 with a digit to the
 271 .Tn ASCII
 272 code of the first character is not supported.
 273 .Sh SEE ALSO
 274 .Xr echo 1 ,
 275 .Xr printf 3
 276 .Sh STANDARDS
 277 The
 278 .Nm
 279 command is expected to be compatible with the
 280 .St -p1003.2
 281 specification.
 282 .Sh HISTORY
 283 The
 284 .Nm
 285 command appeared in
 286 .Bx 4.3 Reno .
 287 It is modeled
 288 after the standard library function,
 289 .Xr printf 3 .
 290 .Sh BUGS
 291 Since the floating point numbers are translated from
 292 .Tn ASCII
 293 to floating-point and
 294 then back again, floating-point precision may be lost.
 295 .Pp
 296 .Tn ANSI
 297 hexadecimal character constants were deliberately not provided.
 298 .Pp
 299 The escape sequence \e000 is the string terminator.  When present in the
 300 .Ar format ,
 301 the
 302 .Ar format
 303 will be truncated at the \e000 character.