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