lib/libc/sys/sync.2

   1 .\" Copyright (c) 1980, 1991, 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 .\"     @(#)sync.2      8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt SYNC 2
  33 .Os
  34 .Sh NAME
  35 .Nm sync
  36 .Nd "schedule file system updates"
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft void
  42 .Fn sync void
  43 .Sh DESCRIPTION
  44 The
  45 .Fn sync
  46 system call forces a write of dirty (modified) buffers
  47 in the block buffer cache out
  48 to disk.
  49 The kernel keeps this information in core to reduce
  50 the number of disk I/O transfers required by the system.
  51 As information in the cache is lost after a system crash, a
  52 .Fn sync
  53 system call is issued
  54 frequently
  55 by the user process
  56 .Xr syncer 4
  57 (about every 30 seconds).
  58 .Pp
  59 The
  60 .Xr fsync 2
  61 system call
  62 may be used to synchronize individual file descriptor
  63 attributes.
  64 .Sh SEE ALSO
  65 .Xr fsync 2 ,
  66 .Xr syncer 4 ,
  67 .Xr sync 8
  68 .Sh HISTORY
  69 The
  70 .Fn sync
  71 function appeared in
  72 .At v6 .
  73 .Sh BUGS
  74 The
  75 .Fn sync
  76 system call
  77 may return before the buffers are completely flushed.