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