lib/libc/sys/fsync.2

   1 .\" Copyright (c) 1983, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)fsync.2     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/fsync.2,v 1.6.2.8 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/fsync.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt FSYNC 2
  38 .Os
  39 .Sh NAME
  40 .Nm fsync
  41 .Nd "synchronise changes to a file"
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft int
  47 .Fn fsync "int fd"
  48 .Sh DESCRIPTION
  49 .Fn Fsync
  50 causes all modified data and attributes of
  51 .Fa fd
  52 to be moved to a permanent storage device.
  53 This normally results in all in-core modified copies
  54 of buffers for the associated file to be written to a disk.
  55 .Pp
  56 .Fn Fsync
  57 should be used by programs that require a file to be
  58 in a known state, for example, in building a simple transaction
  59 facility.
  60 .Sh RETURN VALUES
  61 .Rv -std fsync
  62 .Sh ERRORS
  63 The
  64 .Fn fsync
  65 fails if:
  66 .Bl -tag -width Er
  67 .It Bq Er EBADF
  68 .Fa fd
  69 is not a valid descriptor.
  70 .It Bq Er EINVAL
  71 .Fa fd
  72 refers to a socket, not to a file.
  73 .It Bq Er EIO
  74 An I/O error occurred while reading from or writing to the file system.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr sync 2 ,
  78 .Xr syncer 4 ,
  79 .Xr sync 8
  80 .Sh HISTORY
  81 The
  82 .Fn fsync
  83 function call appeared in
  84 .Bx 4.2 .