lib/libc/stdio/printf_l.3

   1 .\" Copyright (c) 2012 Isabell Long <issyl0@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd April 7, 2012
  28 .Dt PRINTF_L 3
  29 .Os
  30 .Sh NAME
  31 .Nm printf_l ,
  32 .Nm asprintf_l ,
  33 .Nm fprintf_l ,
  34 .Nm snprintf_l ,
  35 .Nm sprintf_l ,
  36 .Nm vasprintf_l ,
  37 .Nm vfprintf_l ,
  38 .Nm vprintf_l ,
  39 .Nm vsnprintf_l ,
  40 .Nm vsprintf_l
  41 .Nd formatted output conversion
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdio.h
  46 .Ft int
  47 .Fn printf_l "locale_t loc" "const char * restrict format" "..."
  48 .Ft int
  49 .Fn asprintf_l "char **ret" "locale_t loc" "const char * format" "..."
  50 .Ft int
  51 .Fn fprintf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "..."
  52 .Ft int
  53 .Fn snprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" "..."
  54 .Ft int
  55 .Fn sprintf_l "char * restrict str" "locale_t loc" "const char * restrict format" "..."
  56 .Ft int
  57 .Fn vasprintf_l "char **ret" "locale_t loc" "const char *format" "va_list ap"
  58 .Ft int
  59 .Fn vfprintf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "va_list ap"
  60 .Ft int
  61 .Fn vprintf_l "locale_t loc" "const char * restrict format" "va_list ap"
  62 .Ft int
  63 .Fn vsnprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" "va_list ap"
  64 .Ft int
  65 .Fn vsprintf_l "char * restrict str" "locale_t loc" "const char * restrict format" "va_list ap"
  66 .Sh DESCRIPTION
  67 The above functions are used to convert formatted output in the locale
  68 .Fa loc .
  69 They behave in the same way as the versions without the _l suffix, but use
  70 the specified locale rather than the global or per-thread locale.
  71 See the specific manual pages for more information.
  72 .Sh SEE ALSO
  73 .Xr printf 3 ,
  74 .Xr xlocale 3
  75 .Sh STANDARDS
  76 These functions do not conform to any specific standard so they should be
  77 considered as non-portable local extensions.
  78 .Sh HISTORY
  79 These functions first appeared in Darwin and were first implemented in
  80 .Fx 9.1 .