Merge remote-tracking branch 'origin/vendor/LIBRESSL'
[dragonfly.git] / bin / sync / sync.8
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. 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.8      8.1 (Berkeley) 5/31/93
29 .\" $FreeBSD: src/bin/sync/sync.8,v 1.8.2.5 2002/08/16 04:34:05 trhodes Exp $
30 .\" $DragonFly: src/bin/sync/sync.8,v 1.2 2003/06/17 04:22:50 dillon Exp $
31 .\"
32 .Dd May 31, 1993
33 .Dt SYNC 8
34 .Os
35 .Sh NAME
36 .Nm sync
37 .Nd force completion of pending disk writes (flush cache)
38 .Sh SYNOPSIS
39 .Nm
40 .Sh DESCRIPTION
41 The
42 .Nm
43 utility
44 can be called to ensure that all disk writes have been completed before the
45 processor is halted in a way not suitably done by
46 .Xr reboot 8
47 or
48 .Xr halt 8 .
49 Generally, it is preferable to use
50 .Xr reboot 8
51 or
52 .Xr halt 8
53 to shut down the system,
54 as they may perform additional actions
55 such as resynchronizing the hardware clock
56 and flushing internal caches before performing a final
57 .Nm .
58 .Pp
59 The
60 .Nm
61 utility utilizes the
62 .Xr sync 2
63 function call.
64 .Sh SEE ALSO
65 .Xr fsync 2 ,
66 .Xr sync 2 ,
67 .Xr syncer 4 ,
68 .Xr halt 8 ,
69 .Xr reboot 8
70 .Sh HISTORY
71 A
72 .Nm
73 utility appeared in
74 .At v4 .