Libc-997.1.1.tar.gz

[apple/libc.git] / stdio / FreeBSD / printf.3

diff --git a/stdio/FreeBSD/printf.3 b/stdio/FreeBSD/printf.3
index a14c8feff0f58c2023fa44aa9dbcadecc822c584..031d7f7c20d9ebae3ba2519f68a26705c7e168bd 100644 (file)
--- a/stdio/FreeBSD/printf.3
+++ b/stdio/FreeBSD/printf.3
@@ -13,10 +13,6 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.

-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.

 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.


@@ -34,14 +30,14 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)printf.3   8.1 (Berkeley) 6/4/93
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)printf.3   8.1 (Berkeley) 6/4/93

-.\" $FreeBSD: src/lib/libc/stdio/printf.3,v 1.58 2004/10/16 16:00:01 stefanf Exp $
+.\" $FreeBSD: src/lib/libc/stdio/printf.3,v 1.64 2009/12/02 07:51:25 brueffer Exp $

 .\"
 .\"

-.Dd October 16, 2004
+.Dd December 2, 2009

 .Dt PRINTF 3
 .Os
 .Sh NAME
 .Dt PRINTF 3
 .Os
 .Sh NAME

-.Nm printf , fprintf , sprintf , snprintf , asprintf ,
-.Nm vprintf , vfprintf, vsprintf , vsnprintf , vasprintf
+.Nm printf , fprintf , sprintf , snprintf , asprintf , dprintf ,
+.Nm vprintf , vfprintf, vsprintf , vsnprintf , vasprintf, vdprintf

 .Nd formatted output conversion
 .Sh LIBRARY
 .Lb libc
 .Nd formatted output conversion
 .Sh LIBRARY
 .Lb libc


@@ -57,6 +53,8 @@
 .Fn snprintf "char * restrict str" "size_t size" "const char * restrict format" ...
 .Ft int
 .Fn asprintf "char **ret" "const char *format" ...
 .Fn snprintf "char * restrict str" "size_t size" "const char * restrict format" ...
 .Ft int
 .Fn asprintf "char **ret" "const char *format" ...

+.Ft int
+.Fn dprintf "int fd" "const char * restrict format" ...

 .In stdarg.h
 .Ft int
 .Fn vprintf "const char * restrict format" "va_list ap"
 .In stdarg.h
 .Ft int
 .Fn vprintf "const char * restrict format" "va_list ap"


@@ -68,6 +66,8 @@
 .Fn vsnprintf "char * restrict str" "size_t size" "const char * restrict format" "va_list ap"
 .Ft int
 .Fn vasprintf "char **ret" "const char *format" "va_list ap"
 .Fn vsnprintf "char * restrict str" "size_t size" "const char * restrict format" "va_list ap"
 .Ft int
 .Fn vasprintf "char **ret" "const char *format" "va_list ap"

+.Ft int
+.Fn vdprintf "int fd" "const char * restrict format" "va_list ap"

 .Sh DESCRIPTION
 The
 .Fn printf
 .Sh DESCRIPTION
 The
 .Fn printf


@@ -87,13 +87,17 @@ and
 .Fn vfprintf
 write output to the given output
 .Fa stream ;
 .Fn vfprintf
 write output to the given output
 .Fa stream ;

+.Fn dprintf
+and
+.Fn vdprintf
+write output to the given file descriptor;

 .Fn sprintf ,
 .Fn snprintf ,
 .Fn vsprintf ,
 and
 .Fn vsnprintf
 write to the character string
 .Fn sprintf ,
 .Fn snprintf ,
 .Fn vsprintf ,
 and
 .Fn vsnprintf
 write to the character string

-.Fa str ;
+.Fa s ;

 and
 .Fn asprintf
 and
 and
 .Fn asprintf
 and


@@ -101,6 +105,12 @@ and
 dynamically allocate a new string with
 .Xr malloc 3 .
 .Pp
 dynamically allocate a new string with
 .Xr malloc 3 .
 .Pp

+Extended locale versions of these functions are documented in
+.Xr printf_l 3 .
+See
+.Xr xlocale 3
+for more information.
+.Pp

 These functions write the output under the control of a
 .Fa format
 string that specifies how subsequent arguments
 These functions write the output under the control of a
 .Fa format
 string that specifies how subsequent arguments


@@ -117,7 +127,7 @@ except for
 and
 .Fn vsnprintf ,
 which return the number of characters that would have been printed if the
 and
 .Fn vsnprintf ,
 which return the number of characters that would have been printed if the

-.Fa size
+.Fa n

 were unlimited
 (again, not including the final
 .Ql \e0 ) .
 were unlimited
 (again, not including the final
 .Ql \e0 ) .


@@ -149,14 +159,14 @@ and
 .Fn vsnprintf
 functions
 will write at most
 .Fn vsnprintf
 functions
 will write at most

-.Fa size Ns \-1
+.Fa n Ns \-1

 of the characters printed into the output string
 (the
 of the characters printed into the output string
 (the

-.Fa size Ns 'th
+.Fa n Ns \'th

 character then gets the terminating
 .Ql \e0 ) ;
 if the return value is greater than or equal to the
 character then gets the terminating
 .Ql \e0 ) ;
 if the return value is greater than or equal to the

-.Fa size
+.Fa n

 argument, the string was too short
 and some of the printed characters were discarded.
 The output is always null-terminated.
 argument, the string was too short
 and some of the printed characters were discarded.
 The output is always null-terminated.


@@ -167,7 +177,11 @@ and
 .Fn vsprintf
 functions
 effectively assume an infinite
 .Fn vsprintf
 functions
 effectively assume an infinite

-.Fa size .
+.Fa n .
+.Pp
+For those routines that write to a user-provided character string,
+that string and the format strings should not overlap, as the
+behavior is undefined.

 .Pp
 The format string is composed of zero or more directives:
 ordinary
 .Pp
 The format string is composed of zero or more directives:
 ordinary


@@ -211,8 +225,7 @@ conversions, this option has no effect.
 For
 .Cm o
 conversions, the precision of the number is increased to force the first
 For
 .Cm o
 conversions, the precision of the number is increased to force the first

-character of the output string to a zero (except if a zero value is printed
-with an explicit precision of zero).
+character of the output string to a zero.

 For
 .Cm x
 and
 For
 .Cm x
 and


@@ -287,6 +300,20 @@ the non-monetary separator returned by
 .Xr localeconv 3 .
 .El
 .It
 .Xr localeconv 3 .
 .El
 .It

+An optional separator character (
+.Cm \ , | \;  | \ : | _
+) used for separating multiple values when printing an AltiVec or SSE vector,
+or other multi-value unit.
+.Pp
+NOTE: This is an extension to the
+.Fn printf
+specification.
+Behaviour of these values for
+.Fn printf 
+is only defined for operating systems conforming to the 
+AltiVec Technology Programming Interface Manual.
+(At time of writing this includes only Mac OS X 10.2 and later.)
+.It

 An optional decimal digit string specifying a minimum field width.
 If the converted value has fewer characters than the field width, it will
 be padded with spaces on the left (or right, if the left-adjustment
 An optional decimal digit string specifying a minimum field width.
 If the converted value has fewer characters than the field width, it will
 be padded with spaces on the left (or right, if the left-adjustment


@@ -379,6 +406,34 @@ conversion:
 .It Sy Modifier Ta Cm c Ta Cm s
 .It Cm l No (ell) Ta Vt wint_t Ta Vt "wchar_t *"
 .El
 .It Sy Modifier Ta Cm c Ta Cm s
 .It Cm l No (ell) Ta Vt wint_t Ta Vt "wchar_t *"
 .El

+.Pp
+The AltiVec Technology Programming Interface Manual also defines five additional length modifiers
+which can be used (in place of the conventional length modifiers) for the printing of AltiVec or SSE vectors:
+.Bl -tag -compact
+.It Cm v
+Treat the argument as a vector value, unit length will be determined by the conversion
+specifier (default = 16 8-bit units for all integer conversions, 
+4 32-bit units for floating point conversions).
+.It Cm vh, hv
+Treat the argument as a vector of 8 16-bit units.
+.It Cm vl, lv
+Treat the argument as a vector of 4 32-bit units.
+.El
+.Pp
+NOTE: The vector length specifiers are extensions to the
+.Fn printf
+specification.
+Behaviour of these values for
+.Fn printf 
+is only defined for operating systems conforming to the 
+AltiVec Technology Programming Interface Manual.
+(At time of writing this includes only Mac OS X 10.2 and later.)
+.Pp
+As a further extension, for SSE2 64-bit units:
+.Bl -tag -compact
+.It Cm vll, llv
+Treat the argument as a vector of 2 64-bit units.
+.El

 .It
 A character that specifies the type of conversion to be applied.
 .El
 .It
 A character that specifies the type of conversion to be applied.
 .El


@@ -553,7 +608,7 @@ to separate the mantissa and exponent.
 Note that there may be multiple valid ways to represent floating-point
 numbers in this hexadecimal format.
 For example,
 Note that there may be multiple valid ways to represent floating-point
 numbers in this hexadecimal format.
 For example,

-.Li 0x3.24p+0 , 0x6.48p-1
+.Li 0x1.92p+1 , 0x3.24p+0 , 0x6.48p-1 ,

 and
 .Li 0xc.9p-2
 are all equivalent.
 and
 .Li 0xc.9p-2
 are all equivalent.


@@ -775,6 +830,29 @@ for later interpolation by
 Always use the proper secure idiom:
 .Pp
 .Dl "snprintf(buffer, sizeof(buffer), \*q%s\*q, string);"
 Always use the proper secure idiom:
 .Pp
 .Dl "snprintf(buffer, sizeof(buffer), \*q%s\*q, string);"

+.Sh COMPATIBILITY
+The conversion formats
+.Cm \&%D , \&%O ,
+and
+.Cm %U
+are not standard and
+are provided only for backward compatibility.
+The effect of padding the
+.Cm %p
+format with zeros (either by the
+.Cm 0
+flag or by specifying a precision), and the benign effect (i.e., none)
+of the
+.Cm #
+flag on
+.Cm %n
+and
+.Cm %p
+conversions, as well as other
+nonsensical combinations such as
+.Cm %Ld ,
+are not standard; such combinations
+should be avoided.

 .Sh ERRORS
 In addition to the errors documented for the
 .Xr write 2
 .Sh ERRORS
 In addition to the errors documented for the
 .Xr write 2


@@ -789,15 +867,12 @@ Insufficient storage space is available.
 .El
 .Sh SEE ALSO
 .Xr printf 1 ,
 .El
 .Sh SEE ALSO
 .Xr printf 1 ,

+.Xr printf_l 3 ,

 .Xr fmtcheck 3 ,
 .Xr scanf 3 ,
 .Xr setlocale 3 ,
 .Xr fmtcheck 3 ,
 .Xr scanf 3 ,
 .Xr setlocale 3 ,

+.Xr stdarg 3 ,

 .Xr wprintf 3
 .Xr wprintf 3

-.Rs
-.%T "The FreeBSD Security Architecture"
-.Re
-(See
-.Pa "/usr/share/doc/{to be determined}" . )

 .Sh STANDARDS
 Subject to the caveats noted in the
 .Sx BUGS
 .Sh STANDARDS
 Subject to the caveats noted in the
 .Sx BUGS


@@ -819,7 +894,13 @@ With the same reservation, the
 and
 .Fn vsnprintf
 functions conform to
 and
 .Fn vsnprintf
 functions conform to

-.St -isoC-99 .
+.St -isoC-99 ,
+while
+.Fn dprintf
+and
+.Fn vdprintf
+conform to
+.St -p1003.1-2008 .

 .Sh HISTORY
 The functions
 .Fn asprintf
 .Sh HISTORY
 The functions
 .Fn asprintf


@@ -837,30 +918,13 @@ from
 .An Todd C. Miller Aq Todd.Miller@courtesan.com
 for
 .Ox 2.3 .
 .An Todd C. Miller Aq Todd.Miller@courtesan.com
 for
 .Ox 2.3 .

-.Sh BUGS
-The conversion formats
-.Cm \&%D , \&%O ,
-and
-.Cm %U
-are not standard and
-are provided only for backward compatibility.
-The effect of padding the
-.Cm %p
-format with zeros (either by the
-.Cm 0
-flag or by specifying a precision), and the benign effect (i.e., none)
-of the
-.Cm #
-flag on
-.Cm %n
+The
+.Fn dprintf

 and
 and

-.Cm %p
-conversions, as well as other
-nonsensical combinations such as
-.Cm %Ld ,
-are not standard; such combinations
-should be avoided.
-.Pp
+.Fn vdprintf
+functions were added in
+.Fx 8.0 .
+.Sh BUGS

 The
 .Nm
 family of functions do not correctly handle multibyte characters in the
 The
 .Nm
 family of functions do not correctly handle multibyte characters in the