lib/libcompat/4.1/cftime.3

   1 .\"
   2 .\" Copyright (c) 1994, 1995 Joerg Wunsch
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" This program is free software.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  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 Joerg Wunsch
  19 .\" 4. The name of the developer may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  24 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  25 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  26 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  28 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  32 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .\"
  35 .\" $FreeBSD: src/lib/libcompat/4.1/cftime.3,v 1.6.2.4 2001/12/17 10:08:28 ru Exp $
  36 .\"
  37 .Dd June 15, 1993
  38 .Os
  39 .Dt CFTIME 3
  40 .Sh NAME
  41 .Nm cftime
  42 .Nm ascftime
  43 .Nd convert date and time to string
  44 .Sh LIBRARY
  45 .Lb libcompat
  46 .Sh SYNOPSIS
  47 .In time.h
  48 .Ft int
  49 .Fn cftime "char *s" "char *format" "const time_t *clock"
  50 .Ft int
  51 .Fn ascftime "char *s" "const char *format" "const struct tm *tmptr"
  52 .Sh DESCRIPTION
  53 .Bf -symbolic
  54 The
  55 .Fn cftime
  56 and
  57 .Fn ascftime
  58 functions are made obsolete by
  59 .Xr strftime 3 .
  60 .Ef
  61 .Pp
  62 Use of the functions
  63 .Fn cftime
  64 and
  65 .Fn ascftime
  66 is strongly deprecated, since there is no way to check for a buffer
  67 overflow condition.
  68 Use
  69 .Xr strftime 3
  70 instead.
  71 .Pp
  72 .Fn Ascftime
  73 is almost identical with
  74 .Xr strftime 3 ,
  75 with the only exception there's no parameter to tell about the
  76 maximal buffer length, and the
  77 .Fa format
  78 parameter defaults to
  79 .Dq %C
  80 if a
  81 .Em NULL
  82 pointer is given.
  83 .Pp
  84 .Fn Cftime
  85 does the same job, but it first invokes
  86 .Xr localtime 3
  87 in order to convert the given
  88 .Fa clock ,
  89 then also performs the conversions as requested by the
  90 .Fa format
  91 argument.
  92 .Sh RETURN VALUES
  93 The
  94 .Fn cftime
  95 and
  96 .Fn ascftime
  97 functions return the number of characters written to the output
  98 buffer
  99 .Fa s ,
 100 not counting the trailing null character.
 101 .Sh SEE ALSO
 102 .Xr localtime 3 ,
 103 .Xr strftime 3