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