man3/printf.3

   1 .\" Copyright (c) 1999 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" Earlier versions of this page influenced the present text.
   4 .\" It was derived from a Berkeley page with version
   5 .\"       @(#)printf.3    6.14 (Berkeley) 7/30/91
   6 .\" converted for Linux by faith@cs.unc.edu, updated by
   7 .\" Helmut.Geyer@iwr.uni-heidelberg.de, agulbra@troll.no and Bruno Haible.
   8 .\"
   9 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
  10 .\" This is free documentation; you can redistribute it and/or
  11 .\" modify it under the terms of the GNU General Public License as
  12 .\" published by the Free Software Foundation; either version 2 of
  13 .\" the License, or (at your option) any later version.
  14 .\"
  15 .\" The GNU General Public License's references to "object code"
  16 .\" and "executables" are to be interpreted as the output of any
  17 .\" document formatting or typesetting system, including
  18 .\" intermediate and printed output.
  19 .\"
  20 .\" This manual is distributed in the hope that it will be useful,
  21 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 .\" GNU General Public License for more details.
  24 .\"
  25 .\" You should have received a copy of the GNU General Public
  26 .\" License along with this manual; if not, see
  27 .\" <http://www.gnu.org/licenses/>.
  28 .\" %%%LICENSE_END
  29 .\"
  30 .\" 1999-11-25 aeb - Rewritten, using SUSv2 and C99.
  31 .\" 2000-07-26 jsm28@hermes.cam.ac.uk - three small fixes
  32 .\" 2000-10-16 jsm28@hermes.cam.ac.uk - more fixes
  33 .\"
  34 .TH PRINTF 3  2019-03-06 "GNU" "Linux Programmer's Manual"
  35 .SH NAME
  36 printf, fprintf, dprintf, sprintf, snprintf, vprintf, vfprintf, vdprintf,
  37 vsprintf, vsnprintf \- formatted output conversion
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <stdio.h>
  41 .PP
  42 .BI "int printf(const char *" format ", ...);"
  43 .BI "int fprintf(FILE *" stream ", const char *" format ", ...);"
  44 .BI "int dprintf(int " fd ", const char *" format ", ...);"
  45 .BI "int sprintf(char *" str ", const char *" format ", ...);"
  46 .BI "int snprintf(char *" str ", size_t " size ", const char *" format ", ...);"
  47
  48 .B #include <stdarg.h>
  49 .PP
  50 .BI "int vprintf(const char *" format ", va_list " ap );
  51 .BI "int vfprintf(FILE *" stream ", const char *" format ", va_list " ap );
  52 .BI "int vdprintf(int " fd ", const char *" format ", va_list " ap );
  53 .BI "int vsprintf(char *" str ", const char *" format ", va_list " ap );
  54 .BI "int vsnprintf(char *" str ", size_t " size ", const char *" format \
  55 ", va_list " ap );
  56 .fi
  57 .PP
  58 .in -4n
  59 Feature Test Macro Requirements for glibc (see
  60 .BR feature_test_macros (7)):
  61 .in
  62 .PP
  63 .ad l
  64 .BR snprintf (),
  65 .BR vsnprintf ():
  66 .RS 4
  67 _XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE ||
  68     || /* Glibc versions <= 2.19: */ _BSD_SOURCE
  69 .RE
  70 .PP
  71 .BR dprintf (),
  72 .BR vdprintf ():
  73 .PD 0
  74 .RS 4
  75 .TP 4
  76 Since glibc 2.10:
  77 _POSIX_C_SOURCE\ >=\ 200809L
  78 .TP
  79 Before glibc 2.10:
  80 _GNU_SOURCE
  81 .RE
  82 .ad
  83 .PD
  84 .SH DESCRIPTION
  85 The functions in the
  86 .BR printf ()
  87 family produce output according to a
  88 .I format
  89 as described below.
  90 The functions
  91 .BR printf ()
  92 and
  93 .BR vprintf ()
  94 write output to
  95 .IR stdout ,
  96 the standard output stream;
  97 .BR fprintf ()
  98 and
  99 .BR vfprintf ()
 100 write output to the given output
 101 .IR stream ;
 102 .BR sprintf (),
 103 .BR snprintf (),
 104 .BR vsprintf ()
 105 and
 106 .BR vsnprintf ()
 107 write to the character string
 108 .IR str .
 109 .PP
 110 The function
 111 .BR dprintf ()
 112 is the same as
 113 .BR fprintf ()
 114 except that it outputs to a file descriptor,
 115 .IR fd ,
 116 instead of to a
 117 .I stdio
 118 stream.
 119 .PP
 120 The functions
 121 .BR snprintf ()
 122 and
 123 .BR vsnprintf ()
 124 write at most
 125 .I size
 126 bytes (including the terminating null byte (\(aq\e0\(aq)) to
 127 .IR str .
 128 .PP
 129 The functions
 130 .BR vprintf (),
 131 .BR vfprintf (),
 132 .BR vdprintf (),
 133 .BR vsprintf (),
 134 .BR vsnprintf ()
 135 are equivalent to the functions
 136 .BR printf (),
 137 .BR fprintf (),
 138 .BR dprintf (),
 139 .BR sprintf (),
 140 .BR snprintf (),
 141 respectively, except that they are called with a
 142 .I va_list
 143 instead of a variable number of arguments.
 144 These functions do not call the
 145 .I va_end
 146 macro.
 147 Because they invoke the
 148 .I va_arg
 149 macro, the value of
 150 .I ap
 151 is undefined after the call.
 152 See
 153 .BR stdarg (3).
 154 .PP
 155 All of these functions write the output under the control of a
 156 .I format
 157 string that specifies how subsequent arguments (or arguments accessed via
 158 the variable-length argument facilities of
 159 .BR stdarg (3))
 160 are converted for output.
 161 .PP
 162 C99 and POSIX.1-2001 specify that the results are undefined if a call to
 163 .BR sprintf (),
 164 .BR snprintf (),
 165 .BR vsprintf (),
 166 or
 167 .BR vsnprintf ()
 168 would cause copying to take place between objects that overlap
 169 (e.g., if the target string array and one of the supplied input arguments
 170 refer to the same buffer).
 171 See NOTES.
 172 .SS Format of the format string
 173 The format string is a character string, beginning and ending
 174 in its initial shift state, if any.
 175 The format string is composed of zero or more directives: ordinary
 176 characters (not
 177 .BR % ),
 178 which are copied unchanged to the output stream;
 179 and conversion specifications, each of which results in fetching zero or
 180 more subsequent arguments.
 181 Each conversion specification is introduced by
 182 the character
 183 .BR % ,
 184 and ends with a
 185 .IR "conversion specifier" .
 186 In between there may be (in this order) zero or more
 187 .IR flags ,
 188 an optional minimum
 189 .IR "field width" ,
 190 an optional
 191 .I precision
 192 and an optional
 193 .IR "length modifier" .
 194 .PP
 195 The arguments must correspond properly (after type promotion) with the
 196 conversion specifier.
 197 By default, the arguments are used in the order
 198 given, where each \(aq*\(aq (see
 199 .I "Field width"
 200 and
 201 .I Precision
 202 below) and each conversion specifier asks for the next
 203 argument (and it is an error if insufficiently many arguments are given).
 204 One can also specify explicitly which argument is taken,
 205 at each place where an argument is required, by writing "%m$" instead
 206 of \(aq%\(aq and "*m$" instead of \(aq*\(aq,
 207 where the decimal integer \fIm\fP denotes
 208 the position in the argument list of the desired argument, indexed starting
 209 from 1.
 210 Thus,
 211 .PP
 212 .in +4n
 213 .EX
 214 printf("%*d", width, num);
 215 .EE
 216 .in
 217 .PP
 218 and
 219 .PP
 220 .in +4n
 221 .EX
 222 printf("%2$*1$d", width, num);
 223 .EE
 224 .in
 225 .PP
 226 are equivalent.
 227 The second style allows repeated references to the
 228 same argument.
 229 The C99 standard does not include the style using \(aq$\(aq,
 230 which comes from the Single UNIX Specification.
 231 If the style using
 232 \(aq$\(aq is used, it must be used throughout for all conversions taking an
 233 argument and all width and precision arguments, but it may be mixed
 234 with "%%" formats, which do not consume an argument.
 235 There may be no
 236 gaps in the numbers of arguments specified using \(aq$\(aq; for example, if
 237 arguments 1 and 3 are specified, argument 2 must also be specified
 238 somewhere in the format string.
 239 .PP
 240 For some numeric conversions a radix character ("decimal point") or
 241 thousands' grouping character is used.
 242 The actual character used
 243 depends on the
 244 .B LC_NUMERIC
 245 part of the locale.
 246 (See
 247 .BR setlocale (3).)
 248 The POSIX locale
 249 uses \(aq.\(aq as radix character, and does not have a grouping character.
 250 Thus,
 251 .PP
 252 .in +4n
 253 .EX
 254     printf("%\(aq.2f", 1234567.89);
 255 .EE
 256 .in
 257 .PP
 258 results in "1234567.89" in the POSIX locale, in "1234567,89" in the
 259 nl_NL locale, and in "1.234.567,89" in the da_DK locale.
 260 .SS Flag characters
 261 The character % is followed by zero or more of the following flags:
 262 .TP
 263 .B #
 264 The value should be converted to an "alternate form".
 265 For
 266 .B o
 267 conversions, the first character of the output string is made zero
 268 (by prefixing a 0 if it was not zero already).
 269 For
 270 .B x
 271 and
 272 .B X
 273 conversions, a nonzero result has the string "0x" (or "0X" for
 274 .B X
 275 conversions) prepended to it.
 276 For
 277 .BR a ,
 278 .BR A ,
 279 .BR e ,
 280 .BR E ,
 281 .BR f ,
 282 .BR F ,
 283 .BR g ,
 284 and
 285 .B G
 286 conversions, the result will always contain a decimal point, even if no
 287 digits follow it (normally, a decimal point appears in the results of those
 288 conversions only if a digit follows).
 289 For
 290 .B g
 291 and
 292 .B G
 293 conversions, trailing zeros are not removed from the result as they would
 294 otherwise be.
 295 For other conversions, the result is undefined.
 296 .TP
 297 .B \&0
 298 The value should be zero padded.
 299 For
 300 .BR d ,
 301 .BR i ,
 302 .BR o ,
 303 .BR u ,
 304 .BR x ,
 305 .BR X ,
 306 .BR a ,
 307 .BR A ,
 308 .BR e ,
 309 .BR E ,
 310 .BR f ,
 311 .BR F ,
 312 .BR g ,
 313 and
 314 .B G
 315 conversions, the converted value is padded on the left with zeros rather
 316 than blanks.
 317 If the
 318 .B \&0
 319 and
 320 .B \-
 321 flags both appear, the
 322 .B \&0
 323 flag is ignored.
 324 If a precision is given with a numeric conversion
 325 .RB ( d ,
 326 .BR i ,
 327 .BR o ,
 328 .BR u ,
 329 .BR x ,
 330 and
 331 .BR X ),
 332 the
 333 .B \&0
 334 flag is ignored.
 335 For other conversions, the behavior is undefined.
 336 .TP
 337 .B \-
 338 The converted value is to be left adjusted on the field boundary.
 339 (The default is right justification.)
 340 The converted value is padded on the right with blanks, rather
 341 than on the left with blanks or zeros.
 342 A
 343 .B \-
 344 overrides a
 345 .B \&0
 346 if both are given.
 347 .TP
 348 .B \(aq \(aq
 349 (a space) A blank should be left before a positive number
 350 (or empty string) produced by a signed conversion.
 351 .TP
 352 .B +
 353 A sign (+ or \-) should always be placed before a number produced by a signed
 354 conversion.
 355 By default, a sign is used only for negative numbers.
 356 A
 357 .B +
 358 overrides a space if both are used.
 359 .PP
 360 The five flag characters above are defined in the C99 standard.
 361 The Single UNIX Specification specifies one further flag character.
 362 .TP
 363 .B \(aq
 364 For decimal conversion
 365 .RB ( i ,
 366 .BR d ,
 367 .BR u ,
 368 .BR f ,
 369 .BR F ,
 370 .BR g ,
 371 .BR G )
 372 the output is to be grouped with thousands' grouping characters
 373 if the locale information indicates any.
 374 (See
 375 .BR setlocale (3).)
 376 Note that many versions of
 377 .BR gcc (1)
 378 cannot parse this option and will issue a warning.
 379 (SUSv2 did not
 380 include \fI%\(aqF\fP, but SUSv3 added it.)
 381 .PP
 382 glibc 2.2 adds one further flag character.
 383 .TP
 384 .B I
 385 For decimal integer conversion
 386 .RB ( i ,
 387 .BR d ,
 388 .BR u )
 389 the output uses the locale's alternative output digits, if any.
 390 For example, since glibc 2.2.3 this will give Arabic-Indic digits
 391 in the Persian ("fa_IR") locale.
 392 .\" outdigits keyword in locale file
 393 .SS Field width
 394 An optional decimal digit string (with nonzero first digit) specifying
 395 a minimum field width.
 396 If the converted value has fewer characters
 397 than the field width, it will be padded with spaces on the left
 398 (or right, if the left-adjustment flag has been given).
 399 Instead of a decimal digit string one may write "*" or "*m$"
 400 (for some decimal integer \fIm\fP) to specify that the field width
 401 is given in the next argument, or in the \fIm\fP-th argument, respectively,
 402 which must be of type
 403 .IR int .
 404 A negative field width is taken as a \(aq\-\(aq flag followed by a
 405 positive field width.
 406 In no case does a nonexistent or small field width cause truncation of a
 407 field; if the result of a conversion is wider than the field width, the
 408 field is expanded to contain the conversion result.
 409 .SS Precision
 410 An optional precision, in the form of a period (\(aq.\(aq)  followed by an
 411 optional decimal digit string.
 412 Instead of a decimal digit string one may write "*" or "*m$"
 413 (for some decimal integer \fIm\fP) to specify that the precision
 414 is given in the next argument, or in the \fIm\fP-th argument, respectively,
 415 which must be of type
 416 .IR int .
 417 If the precision is given as just \(aq.\(aq, the precision is taken to
 418 be zero.
 419 A negative precision is taken as if the precision were omitted.
 420 This gives the minimum number of digits to appear for
 421 .BR d ,
 422 .BR i ,
 423 .BR o ,
 424 .BR u ,
 425 .BR x ,
 426 and
 427 .B X
 428 conversions, the number of digits to appear after the radix character for
 429 .BR a ,
 430 .BR A ,
 431 .BR e ,
 432 .BR E ,
 433 .BR f ,
 434 and
 435 .B F
 436 conversions, the maximum number of significant digits for
 437 .B g
 438 and
 439 .B G
 440 conversions, or the maximum number of characters to be printed from a
 441 string for
 442 .B s
 443 and
 444 .B S
 445 conversions.
 446 .SS Length modifier
 447 Here, "integer conversion" stands for
 448 .BR d ,
 449 .BR i ,
 450 .BR o ,
 451 .BR u ,
 452 .BR x ,
 453 or
 454 .B X
 455 conversion.
 456 .TP
 457 .B hh
 458 A following integer conversion corresponds to a
 459 .I signed char
 460 or
 461 .I unsigned char
 462 argument, or a following
 463 .B n
 464 conversion corresponds to a pointer to a
 465 .I signed char
 466 argument.
 467 .TP
 468 .B h
 469 A following integer conversion corresponds to a
 470 .I short int
 471 or
 472 .I unsigned short int
 473 argument, or a following
 474 .B n
 475 conversion corresponds to a pointer to a
 476 .I short int
 477 argument.
 478 .TP
 479 .B l
 480 (ell) A following integer conversion corresponds to a
 481 .I long int
 482 or
 483 .I unsigned long int
 484 argument, or a following
 485 .B n
 486 conversion corresponds to a pointer to a
 487 .I long int
 488 argument, or a following
 489 .B c
 490 conversion corresponds to a
 491 .I wint_t
 492 argument, or a following
 493 .B s
 494 conversion corresponds to a pointer to
 495 .I wchar_t
 496 argument.
 497 .TP
 498 .B ll
 499 (ell-ell).
 500 A following integer conversion corresponds to a
 501 .I long long int
 502 or
 503 .I unsigned long long int
 504 argument, or a following
 505 .B n
 506 conversion corresponds to a pointer to a
 507 .I long long int
 508 argument.
 509 .TP
 510 .B q
 511 A synonym for
 512 .BR ll .
 513 This is a nonstandard extension, derived from BSD;
 514 avoid its use in new code.
 515 .TP
 516 .B L
 517 A following
 518 .BR a ,
 519 .BR A ,
 520 .BR e ,
 521 .BR E ,
 522 .BR f ,
 523 .BR F ,
 524 .BR g ,
 525 or
 526 .B G
 527 conversion corresponds to a
 528 .I long double
 529 argument.
 530 (C99 allows %LF, but SUSv2 does not.)
 531 .TP
 532 .B j
 533 A following integer conversion corresponds to an
 534 .I intmax_t
 535 or
 536 .I uintmax_t
 537 argument, or a following
 538 .B n
 539 conversion corresponds to a pointer to an
 540 .I intmax_t
 541 argument.
 542 .TP
 543 .B z
 544 A following integer conversion corresponds to a
 545 .I size_t
 546 or
 547 .I ssize_t
 548 argument, or a following
 549 .B n
 550 conversion corresponds to a pointer to a
 551 .I size_t
 552 argument.
 553 .TP
 554 .B Z
 555 A nonstandard synonym for
 556 .BR z
 557 that predates the appearance of
 558 .BR z .
 559 Do not use in new code.
 560 .TP
 561 .B t
 562 A following integer conversion corresponds to a
 563 .I ptrdiff_t
 564 argument, or a following
 565 .B n
 566 conversion corresponds to a pointer to a
 567 .I ptrdiff_t
 568 argument.
 569 .PP
 570 SUSv3 specifies all of the above,
 571 except for those modifiers explicitly noted as being nonstandard extensions.
 572 SUSv2 specified only the length modifiers
 573 .B h
 574 (in
 575 .BR hd ,
 576 .BR hi ,
 577 .BR ho ,
 578 .BR hx ,
 579 .BR hX ,
 580 .BR hn )
 581 and
 582 .B l
 583 (in
 584 .BR ld ,
 585 .BR li ,
 586 .BR lo ,
 587 .BR lx ,
 588 .BR lX ,
 589 .BR ln ,
 590 .BR lc ,
 591 .BR ls )
 592 and
 593 .B L
 594 (in
 595 .BR Le ,
 596 .BR LE ,
 597 .BR Lf ,
 598 .BR Lg ,
 599 .BR LG ).
 600 .PP
 601 As a nonstandard extension, the GNU implementations treats
 602 .B ll
 603 and
 604 .B L
 605 as synonyms, so that one can, for example, write
 606 .BR llg
 607 (as a synonym for the standards-compliant
 608 .RB Lg )
 609 and
 610 .BR Ld
 611 (as a synonym for the standards compliant
 612 .BR lld ).
 613 Such usage is nonportable.
 614 .\"
 615 .SS Conversion specifiers
 616 A character that specifies the type of conversion to be applied.
 617 The conversion specifiers and their meanings are:
 618 .TP
 619 .BR d ", " i
 620 The
 621 .I int
 622 argument is converted to signed decimal notation.
 623 The precision, if any, gives the minimum number of digits
 624 that must appear; if the converted value requires fewer digits, it is
 625 padded on the left with zeros.
 626 The default precision is 1.
 627 When 0 is printed with an explicit precision 0, the output is empty.
 628 .TP
 629 .BR o ", " u ", " x ", " X
 630 The
 631 .I "unsigned int"
 632 argument is converted to unsigned octal
 633 .RB ( o ),
 634 unsigned decimal
 635 .RB ( u ),
 636 or unsigned hexadecimal
 637 .RB ( x
 638 and
 639 .BR X )
 640 notation.
 641 The letters
 642 .B abcdef
 643 are used for
 644 .B x
 645 conversions; the letters
 646 .B ABCDEF
 647 are used for
 648 .B X
 649 conversions.
 650 The precision, if any, gives the minimum number of digits
 651 that must appear; if the converted value requires fewer digits, it is
 652 padded on the left with zeros.
 653 The default precision is 1.
 654 When 0 is printed with an explicit precision 0, the output is empty.
 655 .TP
 656 .BR e ", " E
 657 The
 658 .I double
 659 argument is rounded and converted in the style
 660 .RB [\-]d \&. ddd e \(+-dd
 661 where there is one digit before the decimal-point character and the number
 662 of digits after it is equal to the precision; if the precision is missing,
 663 it is taken as 6; if the precision is zero, no decimal-point character
 664 appears.
 665 An
 666 .B E
 667 conversion uses the letter
 668 .B E
 669 (rather than
 670 .BR e )
 671 to introduce the exponent.
 672 The exponent always contains at least two
 673 digits; if the value is zero, the exponent is 00.
 674 .TP
 675 .BR f ", " F
 676 The
 677 .I double
 678 argument is rounded and converted to decimal notation in the style
 679 .RB [\-]ddd \&. ddd,
 680 where the number of digits after the decimal-point character is equal to
 681 the precision specification.
 682 If the precision is missing, it is taken as
 683 6; if the precision is explicitly zero, no decimal-point character appears.
 684 If a decimal point appears, at least one digit appears before it.
 685 .IP
 686 (SUSv2 does not know about
 687 .B F
 688 and says that character string representations for infinity and NaN
 689 may be made available.
 690 SUSv3 adds a specification for
 691 .BR F .
 692 The C99 standard specifies "[\-]inf" or "[\-]infinity"
 693 for infinity, and a string starting with "nan" for NaN, in the case of
 694 .B f
 695 conversion, and "[\-]INF" or "[\-]INFINITY" or "NAN" in the case of
 696 .B F
 697 conversion.)
 698 .TP
 699 .BR g ", " G
 700 The
 701 .I double
 702 argument is converted in style
 703 .B f
 704 or
 705 .B e
 706 (or
 707 .B F
 708 or
 709 .B E
 710 for
 711 .B G
 712 conversions).
 713 The precision specifies the number of significant digits.
 714 If the precision is missing, 6 digits are given; if the precision is zero,
 715 it is treated as 1.
 716 Style
 717 .B e
 718 is used if the exponent from its conversion is less than \-4 or greater
 719 than or equal to the precision.
 720 Trailing zeros are removed from the
 721 fractional part of the result; a decimal point appears only if it is
 722 followed by at least one digit.
 723 .TP
 724 .BR a ", " A
 725 (C99; not in SUSv2, but added in SUSv3)
 726 For
 727 .B a
 728 conversion, the
 729 .I double
 730 argument is converted to hexadecimal notation (using the letters abcdef)
 731 in the style
 732 .RB [\-] 0x h \&. hhhh p \(+-;
 733 for
 734 .B A
 735 conversion the prefix
 736 .BR 0X ,
 737 the letters ABCDEF, and the exponent separator
 738 .B P
 739 is used.
 740 There is one hexadecimal digit before the decimal point,
 741 and the number of digits after it is equal to the precision.
 742 The default precision suffices for an exact representation of the value
 743 if an exact representation in base 2 exists
 744 and otherwise is sufficiently large to distinguish values of type
 745 .IR double .
 746 The digit before the decimal point is unspecified for nonnormalized
 747 numbers, and nonzero but otherwise unspecified for normalized numbers.
 748 .TP
 749 .B c
 750 If no
 751 .B l
 752 modifier is present, the
 753 .I int
 754 argument is converted to an
 755 .IR "unsigned char" ,
 756 and the resulting character is written.
 757 If an
 758 .B l
 759 modifier is present, the
 760 .I wint_t
 761 (wide character) argument is converted to a multibyte sequence by a call
 762 to the
 763 .BR wcrtomb (3)
 764 function, with a conversion state starting in the initial state, and the
 765 resulting multibyte string is written.
 766 .TP
 767 .B s
 768 If no
 769 .B l
 770 modifier is present: the
 771 .I "const char\ *"
 772 argument is expected to be a pointer to an array of character type (pointer
 773 to a string).
 774 Characters from the array are written up to (but not
 775 including) a terminating null byte (\(aq\e0\(aq);
 776 if a precision is specified, no more than the number specified
 777 are written.
 778 If a precision is given, no null byte need be present;
 779 if the precision is not specified, or is greater than the size of the
 780 array, the array must contain a terminating null byte.
 781 .IP
 782 If an
 783 .B l
 784 modifier is present: the
 785 .I "const wchar_t\ *"
 786 argument is expected to be a pointer to an array of wide characters.
 787 Wide characters from the array are converted to multibyte characters
 788 (each by a call to the
 789 .BR wcrtomb (3)
 790 function, with a conversion state starting in the initial state before
 791 the first wide character), up to and including a terminating null
 792 wide character.
 793 The resulting multibyte characters are written up to
 794 (but not including) the terminating null byte.
 795 If a precision is
 796 specified, no more bytes than the number specified are written, but
 797 no partial multibyte characters are written.
 798 Note that the precision
 799 determines the number of
 800 .I bytes
 801 written, not the number of
 802 .I wide characters
 803 or
 804 .IR "screen positions" .
 805 The array must contain a terminating null wide character, unless a
 806 precision is given and it is so small that the number of bytes written
 807 exceeds it before the end of the array is reached.
 808 .TP
 809 .B C
 810 (Not in C99 or C11, but in SUSv2, SUSv3, and SUSv4.)
 811 Synonym for
 812 .BR lc .
 813 Don't use.
 814 .TP
 815 .B S
 816 (Not in C99 or C11, but in SUSv2, SUSv3, and SUSv4.)
 817 Synonym for
 818 .BR ls .
 819 Don't use.
 820 .TP
 821 .B p
 822 The
 823 .I "void\ *"
 824 pointer argument is printed in hexadecimal (as if by
 825 .B %#x
 826 or
 827 .BR %#lx ).
 828 .TP
 829 .B n
 830 The number of characters written so far is stored into the integer
 831 pointed to by the corresponding argument.
 832 That argument shall be an
 833 .IR "int\ *" ,
 834 or variant whose size matches the (optionally)
 835 supplied integer length modifier.
 836 No argument is converted.
 837 (This specifier is not supported by the bionic C library.)
 838 The behavior is undefined if the conversion specification includes
 839 any flags, a field width, or a precision.
 840 .TP
 841 .B m
 842 (Glibc extension; supported by uClibc and musl.)
 843 Print output of
 844 .IR strerror(errno) .
 845 No argument is required.
 846 .TP
 847 .B %
 848 A \(aq%\(aq is written.
 849 No argument is converted.
 850 The complete conversion
 851 specification is \(aq%%\(aq.
 852 .SH RETURN VALUE
 853 Upon successful return, these functions return the number of characters
 854 printed (excluding the null byte used to end output to strings).
 855 .PP
 856 The functions
 857 .BR snprintf ()
 858 and
 859 .BR vsnprintf ()
 860 do not write more than
 861 .I size
 862 bytes (including the terminating null byte (\(aq\e0\(aq)).
 863 If the output was truncated due to this limit, then the return value
 864 is the number of characters (excluding the terminating null byte)
 865 which would have been written to the final string if enough space
 866 had been available.
 867 Thus, a return value of
 868 .I size
 869 or more means that the output was truncated.
 870 (See also below under NOTES.)
 871 .PP
 872 If an output error is encountered, a negative value is returned.
 873 .SH ATTRIBUTES
 874 For an explanation of the terms used in this section, see
 875 .BR attributes (7).
 876 .TS
 877 allbox;
 878 lbw23 lb lb
 879 l l l.
 880 Interface       Attribute       Value
 881 T{
 882 .BR printf (),
 883 .BR fprintf (),
 884 .br
 885 .BR sprintf (),
 886 .BR snprintf (),
 887 .br
 888 .BR vprintf (),
 889 .BR vfprintf (),
 890 .br
 891 .BR vsprintf (),
 892 .BR vsnprintf ()
 893 T}      Thread safety   MT-Safe locale
 894 .TE
 895 .sp 1
 896 .SH CONFORMING TO
 897 .BR fprintf (),
 898 .BR printf (),
 899 .BR sprintf (),
 900 .BR vprintf (),
 901 .BR vfprintf (),
 902 .BR vsprintf ():
 903 POSIX.1-2001, POSIX.1-2008, C89, C99.
 904 .PP
 905 .BR snprintf (),
 906 .BR vsnprintf ():
 907 POSIX.1-2001, POSIX.1-2008, C99.
 908 .PP
 909 The
 910 .BR dprintf ()
 911 and
 912 .BR vdprintf ()
 913 functions were originally GNU extensions that were later standardized
 914 in POSIX.1-2008.
 915 .PP
 916 Concerning the return value of
 917 .BR snprintf (),
 918 SUSv2 and C99 contradict each other: when
 919 .BR snprintf ()
 920 is called with
 921 .IR size =0
 922 then SUSv2 stipulates an unspecified return value less than 1,
 923 while C99 allows
 924 .I str
 925 to be NULL in this case, and gives the return value (as always)
 926 as the number of characters that would have been written in case
 927 the output string has been large enough.
 928 POSIX.1-2001 and later align their specification of
 929 .BR snprintf ()
 930 with C99.
 931 .\" .PP
 932 .\" Linux libc4 knows about the five C standard flags.
 933 .\" It knows about the length modifiers \fBh\fP, \fBl\fP, \fBL\fP,
 934 .\" and the conversions
 935 .\" \fBc\fP, \fBd\fP, \fBe\fP, \fBE\fP, \fBf\fP, \fBF\fP,
 936 .\" \fBg\fP, \fBG\fP, \fBi\fP, \fBn\fP, \fBo\fP, \fBp\fP,
 937 .\" \fBs\fP, \fBu\fP, \fBx\fP, and \fBX\fP,
 938 .\" where \fBF\fP is a synonym for \fBf\fP.
 939 .\" Additionally, it accepts \fBD\fP, \fBO\fP, and \fBU\fP as synonyms
 940 .\" for \fBld\fP, \fBlo\fP, and \fBlu\fP.
 941 .\" (This is bad, and caused serious bugs later, when
 942 .\" support for \fB%D\fP disappeared.)
 943 .\" No locale-dependent radix character,
 944 .\" no thousands' separator, no NaN or infinity, no "%m$" and "*m$".
 945 .\" .PP
 946 .\" Linux libc5 knows about the five C standard flags and the \(aq flag,
 947 .\" locale, "%m$" and "*m$".
 948 .\" It knows about the length modifiers \fBh\fP, \fBl\fP, \fBL\fP,
 949 .\" \fBZ\fP, and \fBq\fP, but accepts \fBL\fP and \fBq\fP
 950 .\" both for \fIlong double\fP and for \fIlong long int\fP (this is a bug).
 951 .\" It no longer recognizes \fBF\fP, \fBD\fP, \fBO\fP, and \fBU\fP,
 952 .\" but adds the conversion character
 953 .\" .BR m ,
 954 .\" which outputs
 955 .\" .IR strerror(errno) .
 956 .\" .PP
 957 .\" glibc 2.0 adds conversion characters \fBC\fP and \fBS\fP.
 958 .PP
 959 glibc 2.1 adds length modifiers \fBhh\fP, \fBj\fP, \fBt\fP, and \fBz\fP
 960 and conversion characters \fBa\fP and \fBA\fP.
 961 .PP
 962 glibc 2.2 adds the conversion character \fBF\fP with C99 semantics,
 963 and the flag character \fBI\fP.
 964 .SH NOTES
 965 Some programs imprudently rely on code such as the following
 966 .PP
 967     sprintf(buf, "%s some further text", buf);
 968 .PP
 969 to append text to
 970 .IR buf .
 971 However, the standards explicitly note that the results are undefined
 972 if source and destination buffers overlap when calling
 973 .BR sprintf (),
 974 .BR snprintf (),
 975 .BR vsprintf (),
 976 and
 977 .BR vsnprintf ().
 978 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=7075
 979 Depending on the version of
 980 .BR gcc (1)
 981 used, and the compiler options employed, calls such as the above will
 982 .B not
 983 produce the expected results.
 984 .PP
 985 The glibc implementation of the functions
 986 .BR snprintf ()
 987 and
 988 .BR vsnprintf ()
 989 conforms to the C99 standard, that is, behaves as described above,
 990 since glibc version 2.1.
 991 Until glibc 2.0.6, they would return \-1
 992 when the output was truncated.
 993 .\" .SH HISTORY
 994 .\" UNIX V7 defines the three routines
 995 .\" .BR printf (),
 996 .\" .BR fprintf (),
 997 .\" .BR sprintf (),
 998 .\" and has the flag \-, the width or precision *, the length modifier l,
 999 .\" and the conversions doxfegcsu, and also D,O,U,X as synonyms for ld,lo,lu,lx.
1000 .\" This is still true for 2.9.1BSD, but 2.10BSD has the flags
1001 .\" #, + and <space> and no longer mentions D,O,U,X.
1002 .\" 2.11BSD has
1003 .\" .BR vprintf (),
1004 .\" .BR vfprintf (),
1005 .\" .BR vsprintf (),
1006 .\" and warns not to use D,O,U,X.
1007 .\" 4.3BSD Reno has the flag 0, the length modifiers h and L,
1008 .\" and the conversions n, p, E, G, X (with current meaning)
1009 .\" and deprecates D,O,U.
1010 .\" 4.4BSD introduces the functions
1011 .\" .BR snprintf ()
1012 .\" and
1013 .\" .BR vsnprintf (),
1014 .\" and the length modifier q.
1015 .\" FreeBSD also has functions
1016 .\" .BR asprintf ()
1017 .\" and
1018 .\" .BR vasprintf (),
1019 .\" that allocate a buffer large enough for
1020 .\" .BR sprintf ().
1021 .\" In glibc there are functions
1022 .\" .BR dprintf ()
1023 .\" and
1024 .\" .BR vdprintf ()
1025 .\" that print to a file descriptor instead of a stream.
1026 .SH BUGS
1027 Because
1028 .BR sprintf ()
1029 and
1030 .BR vsprintf ()
1031 assume an arbitrarily long string, callers must be careful not to overflow
1032 the actual space; this is often impossible to assure.
1033 Note that the length
1034 of the strings produced is locale-dependent and difficult to predict.
1035 Use
1036 .BR snprintf ()
1037 and
1038 .BR vsnprintf ()
1039 instead (or
1040 .BR asprintf (3)
1041 and
1042 .BR vasprintf (3)).
1043 .\" .PP
1044 .\" Linux libc4.[45] does not have a
1045 .\" .BR snprintf (),
1046 .\" but provides a libbsd that contains an
1047 .\" .BR snprintf ()
1048 .\" equivalent to
1049 .\" .BR sprintf (),
1050 .\" that is, one that ignores the
1051 .\" .I size
1052 .\" argument.
1053 .\" Thus, the use of
1054 .\" .BR snprintf ()
1055 .\" with early libc4 leads to serious security problems.
1056 .PP
1057 Code such as
1058 .BI printf( foo );
1059 often indicates a bug, since
1060 .I foo
1061 may contain a % character.
1062 If
1063 .I foo
1064 comes from untrusted user input, it may contain \fB%n\fP, causing the
1065 .BR printf ()
1066 call to write to memory and creating a security hole.
1067 .\" .PP
1068 .\" Some floating-point conversions under early libc4
1069 .\" caused memory leaks.
1070 .SH EXAMPLE
1071 To print
1072 .I Pi
1073 to five decimal places:
1074 .PP
1075 .in +4n
1076 .EX
1077 #include <math.h>
1078 #include <stdio.h>
1079 fprintf(stdout, "pi = %.5f\en", 4 * atan(1.0));
1080 .EE
1081 .in
1082 .PP
1083 To print a date and time in the form "Sunday, July 3, 10:02",
1084 where
1085 .I weekday
1086 and
1087 .I month
1088 are pointers to strings:
1089 .PP
1090 .in +4n
1091 .EX
1092 #include <stdio.h>
1093 fprintf(stdout, "%s, %s %d, %.2d:%.2d\en",
1094         weekday, month, day, hour, min);
1095 .EE
1096 .in
1097 .PP
1098 Many countries use the day-month-year order.
1099 Hence, an internationalized version must be able to print
1100 the arguments in an order specified by the format:
1101 .PP
1102 .in +4n
1103 .EX
1104 #include <stdio.h>
1105 fprintf(stdout, format,
1106         weekday, month, day, hour, min);
1107 .EE
1108 .in
1109 .PP
1110 where
1111 .I format
1112 depends on locale, and may permute the arguments.
1113 With the value:
1114 .PP
1115 .in +4n
1116 .EX
1117 "%1$s, %3$d. %2$s, %4$d:%5$.2d\en"
1118 .EE
1119 .in
1120 .PP
1121 one might obtain "Sonntag, 3. Juli, 10:02".
1122 .PP
1123 To allocate a sufficiently large string and print into it
1124 (code correct for both glibc 2.0 and glibc 2.1):
1125 .PP
1126 .EX
1127 #include <stdio.h>
1128 #include <stdlib.h>
1129 #include <stdarg.h>
1130
1131 char *
1132 make_message(const char *fmt, ...)
1133 {
1134     int size = 0;
1135     char *p = NULL;
1136     va_list ap;
1137
1138     /* Determine required size */
1139
1140     va_start(ap, fmt);
1141     size = vsnprintf(p, size, fmt, ap);
1142     va_end(ap);
1143
1144     if (size < 0)
1145         return NULL;
1146
1147     size++;             /* For '\e0' */
1148     p = malloc(size);
1149     if (p == NULL)
1150         return NULL;
1151
1152     va_start(ap, fmt);
1153     size = vsnprintf(p, size, fmt, ap);
1154     va_end(ap);
1155
1156     if (size < 0) {
1157         free(p);
1158         return NULL;
1159     }
1160
1161     return p;
1162 }
1163 .EE
1164 .PP
1165 If truncation occurs in glibc versions prior to 2.0.6, this is treated as an
1166 error instead of being handled gracefully.
1167 .SH SEE ALSO
1168 .BR printf (1),
1169 .BR asprintf (3),
1170 .BR puts (3),
1171 .BR scanf (3),
1172 .BR setlocale (3),
1173 .BR strfromd (3),
1174 .BR wcrtomb (3),
1175 .BR wprintf (3),
1176 .BR locale (5)