1 .\" Copyright (c) 1990, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Chris Torek and the American National Standards Committee X3,
6 .\" on Information Processing Systems.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\" must display the following acknowledgement:
18 .\" This product includes software developed by the University of
19 .\" California, Berkeley and its contributors.
20 .\" 4. Neither the name of the University nor the names of its contributors
21 .\" may be used to endorse or promote products derived from this software
22 .\" without specific prior written permission.
24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .\" @(#)printf.3 8.1 (Berkeley) 6/4/93
37 .\" $FreeBSD: src/lib/libc/stdio/printf.3,v 1.58 2004/10/16 16:00:01 stefanf Exp $
53 .Nd formatted output conversion
61 .Fa "const char *format" ...
65 .Fa "FILE *restrict stream"
66 .Fa "const char *restrict format" ...
70 .Fa "const char *restrict format" ...
74 .Fa "char *restrict s"
76 .Fa "const char *restrict format" ...
80 .Fa "char *restrict s"
81 .Fa "const char *restrict format" ...
88 .Fa "const char *format"
93 .Fa "FILE *restrict stream"
94 .Fa "const char *restrict format"
99 .Fa "const char *restrict format"
104 .Fa "char *restrict s"
106 .Fa "const char *restrict format"
111 .Fa "char *restrict s"
112 .Fa "const char *restrict format"
118 family of functions produces output according to a
128 the standard output stream;
132 write output to the given output
139 write to the character string
145 dynamically allocate a new string with
148 Extended locale versions of these functions are documented in
152 for more information.
154 These functions write the output under the control of a
156 string that specifies how subsequent arguments
157 (or arguments accessed via the variable-length argument facilities of
159 are converted for output.
161 These functions return the number of characters printed
162 (not including the trailing
164 used to end output to strings) or a negative value if an output error occurs,
169 which return the number of characters that would have been printed if the
172 (again, not including the final
182 to be a pointer to a buffer sufficiently large to hold the formatted string.
183 This pointer should be passed to
185 to release the allocated storage when it is no longer needed.
186 If sufficient space cannot be allocated,
190 will return \-1 and set
203 of the characters printed into the output string
206 character then gets the terminating
208 if the return value is greater than or equal to the
210 argument, the string was too short
211 and some of the printed characters were discarded.
212 The output is always null-terminated.
219 effectively assume an infinite
222 For those routines that write to a user-provided character string,
223 that string and the format strings should not overlap, as the
224 behavior is undefined.
226 The format string is composed of zero or more directives:
231 which are copied unchanged to the output stream;
232 and conversion specifications, each of which results
233 in fetching zero or more subsequent arguments.
234 Each conversion specification is introduced by
238 The arguments must correspond properly (after type promotion)
239 with the conversion specifier.
242 the following appear in sequence:
245 An optional field, consisting of a decimal digit string followed by a
247 specifying the next argument to access.
248 If this field is not provided, the argument following the last
249 argument accessed will be used.
250 Arguments are numbered starting at
252 If unaccessed arguments in the format string are interspersed with ones that
253 are accessed the results will be indeterminate.
255 Zero or more of the following flags:
256 .Bl -tag -width ".So \ Sc (space)"
258 The value should be converted to an
261 .Cm c , d , i , n , p , s ,
264 conversions, this option has no effect.
267 conversions, the precision of the number is increased to force the first
268 character of the output string to a zero (except if a zero value is printed
269 with an explicit precision of zero).
274 conversions, a non-zero result has the string
280 conversions) prepended to it.
282 .Cm a , A , e , E , f , F , g ,
285 conversions, the result will always contain a decimal point, even if no
286 digits follow it (normally, a decimal point appears in the results of
287 those conversions only if a digit follows).
292 conversions, trailing zeros are not removed from the result as they
294 .It So Cm 0 Sc (zero)
296 For all conversions except
298 the converted value is padded on the left with zeros rather than blanks.
299 If a precision is given with a numeric conversion
300 .Cm ( d , i , o , u , i , x ,
307 A negative field width flag;
308 the converted value is to be left adjusted on the field boundary.
311 conversions, the converted value is padded on the right with blanks,
312 rather than on the left with blanks or zeros.
318 .It So "\ " Sc (space)
319 A blank should be left before a positive number
320 produced by a signed conversion
321 .Cm ( a , A , d , e , E , f , F , g , G ,
325 A sign must always be placed before a
326 number produced by a signed conversion.
329 overrides a space if both are used.
335 or the integral portion of a floating point conversion
339 should be grouped and separated by thousands using
340 the non-monetary separator returned by
344 An optional separator character (
345 .Cm \ , | \; | \ : | _
346 ) used for separating multiple values when printing an AltiVec or SSE vector,
347 or other multi-value unit.
349 NOTE: This is an extension to the
352 Behaviour of these values for
354 is only defined for operating systems conforming to the
355 AltiVec Technology Programming Interface Manual.
356 (At time of writing this includes only Mac OS X 10.2 and later.)
358 An optional decimal digit string specifying a minimum field width.
359 If the converted value has fewer characters than the field width, it will
360 be padded with spaces on the left (or right, if the left-adjustment
361 flag has been given) to fill out
364 An optional precision, in the form of a period
367 optional digit string.
368 If the digit string is omitted, the precision is taken as zero.
369 This gives the minimum number of digits to appear for
370 .Cm d , i , o , u , x ,
373 conversions, the number of digits to appear after the decimal-point for
374 .Cm a , A , e , E , f ,
377 conversions, the maximum number of significant digits for
381 conversions, or the maximum number of characters to be printed from a
386 An optional length modifier, that specifies the size of the argument.
387 The following length modifiers are valid for the
388 .Cm d , i , n , o , u , x ,
392 .Bl -column ".Cm q Em (deprecated)" ".Vt signed char" ".Vt unsigned long long" ".Vt long long *"
393 .It Sy Modifier Ta Cm d , i Ta Cm o , u , x , X Ta Cm n
394 .It Cm hh Ta Vt "signed char" Ta Vt "unsigned char" Ta Vt "signed char *"
395 .It Cm h Ta Vt short Ta Vt "unsigned short" Ta Vt "short *"
396 .It Cm l No (ell) Ta Vt long Ta Vt "unsigned long" Ta Vt "long *"
397 .It Cm ll No (ell ell) Ta Vt "long long" Ta Vt "unsigned long long" Ta Vt "long long *"
398 .It Cm j Ta Vt intmax_t Ta Vt uintmax_t Ta Vt "intmax_t *"
399 .It Cm t Ta Vt ptrdiff_t Ta (see note) Ta Vt "ptrdiff_t *"
400 .It Cm z Ta (see note) Ta Vt size_t Ta (see note)
401 .It Cm q Em (deprecated) Ta Vt quad_t Ta Vt u_quad_t Ta Vt "quad_t *"
407 modifier, when applied to a
411 conversion, indicates that the argument is of an unsigned type
412 equivalent in size to a
416 modifier, when applied to a
420 conversion, indicates that the argument is of a signed type equivalent in
423 Similarly, when applied to an
425 conversion, it indicates that the argument is a pointer to a signed type
426 equivalent in size to a
429 The following length modifier is valid for the
430 .Cm a , A , e , E , f , F , g ,
434 .Bl -column ".Sy Modifier" ".Cm a , A , e , E , f , F , g , G"
435 .It Sy Modifier Ta Cm a , A , e , E , f , F , g , G
436 .It Cm l No (ell) Ta Vt double
437 (ignored, same behavior as without it)
438 .It Cm L Ta Vt "long double"
441 The following length modifier is valid for the
446 .Bl -column ".Sy Modifier" ".Vt wint_t" ".Vt wchar_t *"
447 .It Sy Modifier Ta Cm c Ta Cm s
448 .It Cm l No (ell) Ta Vt wint_t Ta Vt "wchar_t *"
451 The AltiVec Technology Programming Interface Manual also defines five additional length modifiers
452 which can be used (in place of the conventional length modifiers) for the printing of AltiVec or SSE vectors:
455 Treat the argument as a vector value, unit length will be determined by the conversion
456 specifier (default = 16 8-bit units for all integer conversions,
457 4 32-bit units for floating point conversions).
459 Treat the argument as a vector of 8 16-bit units.
461 Treat the argument as a vector of 4 32-bit units.
464 NOTE: The vector length specifiers are extensions to the
467 Behaviour of these values for
469 is only defined for operating systems conforming to the
470 AltiVec Technology Programming Interface Manual.
471 (At time of writing this includes only Mac OS X 10.2 and later.)
473 As a further extension, for SSE2 64-bit units:
476 Treat the argument as a vector of 2 64-bit units.
479 A character that specifies the type of conversion to be applied.
482 A field width or precision, or both, may be indicated by
485 or an asterisk followed by one or more decimal digits and a
491 argument supplies the field width or precision.
492 A negative field width is treated as a left adjustment flag followed by a
493 positive field width; a negative precision is treated as though it were
495 If a single format directive mixes positional
497 and non-positional arguments, the results are undefined.
499 The conversion specifiers and their meanings are:
500 .Bl -tag -width ".Cm diouxX"
504 (or appropriate variant) argument is converted to signed decimal
512 or unsigned hexadecimal
521 conversions; the letters
526 The precision, if any, gives the minimum number of digits that must
527 appear; if the converted value requires fewer digits, it is padded on
532 argument is converted to signed decimal, unsigned octal, or unsigned
533 decimal, as if the format had been
538 These conversion characters are deprecated, and will eventually disappear.
542 argument is rounded and converted in the style
544 .Oo \- Oc Ar d Li \&. Ar ddd Li e \\*[Pm] Ar dd
546 where there is one digit before the
547 decimal-point character
548 and the number of digits after it is equal to the precision;
549 if the precision is missing,
550 it is taken as 6; if the precision is
551 zero, no decimal-point character appears.
554 conversion uses the letter
558 to introduce the exponent.
559 The exponent always contains at least two digits; if the value is zero,
563 .Cm a , A , e , E , f , F , g ,
566 conversions, positive and negative infinity are represented as
570 respectively when using the lowercase conversion character, and
574 respectively when using the uppercase conversion character.
575 Similarly, NaN is represented as
577 when using the lowercase conversion, and
579 when using the uppercase conversion.
583 argument is rounded and converted to decimal notation in the style
585 .Oo \- Oc Ar ddd Li \&. Ar ddd ,
587 where the number of digits after the decimal-point character
588 is equal to the precision specification.
589 If the precision is missing, it is taken as 6; if the precision is
590 explicitly zero, no decimal-point character appears.
591 If a decimal point appears, at least one digit appears before it.
595 argument is converted in style
606 The precision specifies the number of significant digits.
607 If the precision is missing, 6 digits are given; if the precision is zero,
611 is used if the exponent from its conversion is less than \-4 or greater than
612 or equal to the precision.
613 Trailing zeros are removed from the fractional part of the result; a
614 decimal point appears only if it is followed by at least one digit.
618 argument is rounded and converted to hexadecimal notation in the style
620 .Oo \- Oc Li 0x Ar h Li \&. Ar hhhp Oo \\*[Pm] Oc Ar d ,
622 where the number of digits after the hexadecimal-point character
623 is equal to the precision specification.
624 If the precision is missing, it is taken as enough to represent
625 the floating-point number exactly, and no rounding occurs.
626 If the precision is zero, no hexadecimal-point character appears.
629 is a literal character
631 and the exponent consists of a positive or negative sign
632 followed by a decimal number representing an exponent of 2.
635 conversion uses the prefix
643 to represent the hex digits, and the letter
647 to separate the mantissa and exponent.
649 Note that there may be multiple valid ways to represent floating-point
650 numbers in this hexadecimal format.
652 .Li 0x3.24p+0 , 0x6.48p-1
656 The format chosen depends on the internal representation of the
657 number, but the implementation guarantees that the length of the
658 mantissa will be minimized.
659 Zeroes are always represented with a mantissa of 0 (preceded by a
661 if appropriate) and an exponent of
672 argument is converted to an
673 .Vt "unsigned char" ,
674 and the resulting character is written.
678 (ell) modifier is used, the
680 argument shall be converted to a
682 and the (potentially multi-byte) sequence representing the
683 single wide character is written, including any shift sequences.
684 If a shift sequence is used, the shift state is also restored
685 to the original state after the character.
695 argument is expected to be a pointer to an array of character type (pointer
697 Characters from the array are written up to (but not including)
701 if a precision is specified, no more than the number specified are
703 If a precision is given, no null character
704 need be present; if the precision is not specified, or is greater than
705 the size of the array, the array must contain a terminating
711 (ell) modifier is used, the
713 argument is expected to be a pointer to an array of wide characters
714 (pointer to a wide string).
715 For each wide character in the string, the (potentially multi-byte)
716 sequence representing the
717 wide character is written, including any shift sequences.
718 If any shift sequence is used, the shift state is also restored
719 to the original state after the string.
720 Wide characters from the array are written up to (but not including)
724 if a precision is specified, no more than the number of bytes specified are
725 written (including shift sequences).
726 Partial characters are never written.
727 If a precision is given, no null character
728 need be present; if the precision is not specified, or is greater than
729 the number of bytes required to render the multibyte representation of
730 the string, the array must contain a terminating wide
736 pointer argument is printed in hexadecimal (as if by
741 The number of characters written so far is stored into the
742 integer indicated by the
744 (or variant) pointer argument.
745 No argument is converted.
750 No argument is converted.
751 The complete conversion specification
757 character is defined in the program's locale (category
760 In no case does a non-existent or small field width cause truncation of
761 a numeric field; if the result of a conversion is wider than the field
763 field is expanded to contain the conversion result.
765 To print a date and time in the form
766 .Dq Li "Sunday, July 3, 10:02" ,
771 are pointers to strings:
772 .Bd -literal -offset indent
774 fprintf(stdout, "%s, %s %d, %.2d:%.2d\en",
775 weekday, month, day, hour, min);
779 to five decimal places:
780 .Bd -literal -offset indent
783 fprintf(stdout, "pi = %.5f\en", 4 * atan(1.0));
786 To allocate a 128 byte string and print into it:
787 .Bd -literal -offset indent
791 char *newfmt(const char *fmt, ...)
795 if ((p = malloc(128)) == NULL)
798 (void) vsnprintf(p, 128, fmt, ap);
803 .Sh SECURITY CONSIDERATIONS
808 functions are easily misused in a manner which enables malicious users
809 to arbitrarily change a running program's functionality through
810 a buffer overflow attack.
815 assume an infinitely long string,
816 callers must be careful not to overflow the actual space;
817 this is often hard to assure.
818 For safety, programmers should use the
824 foo(const char *arbitrary_string, const char *and_another)
830 * This first sprintf is bad behavior. Do not use sprintf!
832 sprintf(onstack, "%s, %s", arbitrary_string, and_another);
835 * The following two lines demonstrate better use of
838 snprintf(onstack, sizeof(onstack), "%s, %s", arbitrary_string,
848 family of functions are also easily misused in a manner
849 allowing malicious users to arbitrarily change a running program's
850 functionality by either causing the program
851 to print potentially sensitive data
852 .Dq "left on the stack" ,
853 or causing it to generate a memory fault or bus error
854 by dereferencing an invalid pointer.
857 can be used to write arbitrary data to potentially carefully-selected
859 Programmers are therefore strongly advised to never pass untrusted strings
862 argument, as an attacker can put format specifiers in the string
863 to mangle your stack,
864 leading to a possible security hole.
865 This holds true even if the string was built using a function like
867 as the resulting string may still contain user-supplied conversion specifiers
868 for later interpolation by
871 Always use the proper secure idiom:
873 .Dl "snprintf(buffer, sizeof(buffer), \*q%s\*q, string);"
875 In addition to the errors documented for the
879 family of functions may fail if:
882 An invalid wide character code was encountered.
884 Insufficient storage space is available.
895 Subject to the caveats noted in the
910 With the same reservation, the
921 first appeared in the
924 These were implemented by
925 .An Peter Wemm Aq peter@FreeBSD.org
928 but were later replaced with a different implementation
930 .An Todd C. Miller Aq Todd.Miller@courtesan.com
934 The conversion formats
939 are provided only for backward compatibility.
940 The effect of padding the
942 format with zeros (either by the
944 flag or by specifying a precision), and the benign effect (i.e., none)
951 conversions, as well as other
952 nonsensical combinations such as
954 are not standard; such combinations
959 family of functions do not correctly handle multibyte characters in the