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 .\" $FreeBSD: src/lib/libcompat/4.1/cftime.3,v 1.6.2.4 2001/12/17 10:08:28 ru Exp $
  35 .\"
  36 .Dd June 15, 1993
  37 .Dt CFTIME 3
  38 .Os
  39 .Sh NAME
  40 .Nm cftime
  41 .Nm ascftime
  42 .Nd convert date and time to string
  43 .Sh LIBRARY
  44 .Lb libcompat
  45 .Sh SYNOPSIS
  46 .In time.h
  47 .Ft int
  48 .Fn cftime "char *s" "char *format" "const time_t *clock"
  49 .Ft int
  50 .Fn ascftime "char *s" "const char *format" "const struct tm *tmptr"
  51 .Sh DESCRIPTION
  52 .Bf -symbolic
  53 The
  54 .Fn cftime
  55 and
  56 .Fn ascftime
  57 functions are made obsolete by
  58 .Xr strftime 3 .
  59 .Ef
  60 .Pp
  61 Use of the functions
  62 .Fn cftime
  63 and
  64 .Fn ascftime
  65 is strongly deprecated, since there is no way to check for a buffer
  66 overflow condition.
  67 Use
  68 .Xr strftime 3
  69 instead.
  70 .Pp
  71 .Fn Ascftime
  72 is almost identical with
  73 .Xr strftime 3 ,
  74 with the only exception there's no parameter to tell about the
  75 maximal buffer length, and the
  76 .Fa format
  77 parameter defaults to
  78 .Dq %C
  79 if a
  80 .Em NULL
  81 pointer is given.
  82 .Pp
  83 .Fn Cftime
  84 does the same job, but it first invokes
  85 .Xr localtime 3
  86 in order to convert the given
  87 .Fa clock ,
  88 then also performs the conversions as requested by the
  89 .Fa format
  90 argument.
  91 .Sh RETURN VALUES
  92 The
  93 .Fn cftime
  94 and
  95 .Fn ascftime
  96 functions return the number of characters written to the output
  97 buffer
  98 .Fa s ,
  99 not counting the trailing null character.
 100 .Sh SEE ALSO
 101 .Xr localtime 3 ,
 102 .Xr strftime 3