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