Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / locale / wcsftime.3
blob76493521add136b5a89c122d8223808526efd610
1 .\" $NetBSD: wcsftime.3,v 1.1 2005/03/30 10:15:12 wiz Exp $
2 .\"
3 .\" Copyright (c) 2002 Tim J. Robbins
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: /repoman/r/ncvs/src/lib/libc/locale/wcsftime.3,v 1.2 2002/11/29 17:35:09 ru Exp $
28 .\"
29 .Dd September 8, 2002
30 .Dt WCSFTIME 3
31 .Os
32 .Sh NAME
33 .Nm wcsftime
34 .Nd "convert date and time to a wide-character string"
35 .Sh LIBRARY
36 .Lb libc
37 .Sh SYNOPSIS
38 .In wchar.h
39 .Ft size_t
40 .Fo wcsftime
41 .Fa "wchar_t * restrict wcs" "size_t maxsize"
42 .Fa "const wchar_t * restrict format" "const struct tm * restrict timeptr"
43 .Fc
44 .Sh DESCRIPTION
45 The
46 .Fn wcsftime
47 function is equivalent to the
48 .Fn strftime
49 function except for the types of its arguments
50 and the return value indicating the number of wide characters.
51 Refer to
52 .Xr strftime 3
53 for a detailed description.
54 .Sh COMPATIBILITY
55 Some early implementations of
56 .Fn wcsftime
57 had a
58 .Fa format
59 argument with type
60 .Vt "const char *"
61 instead of
62 .Vt "const wchar_t *" .
63 .Sh SEE ALSO
64 .Xr strftime 3
65 .Sh STANDARDS
66 The
67 .Fn wcsftime
68 function conforms to
69 .St -isoC-99 .