Fix a number of typos in manual pages and user-visible messages.
[dragonfly.git] / share / man / man9 / VOP_FSYNC.9
CommitLineData
984263bc
MD
1.\" Copyright (c) 1996 Doug Rabson
2.\"
3.\" All rights reserved.
4.\"
5.\" This program is free software.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\" notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\" notice, this list of conditions and the following disclaimer in the
14.\" documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD: src/share/man/man9/VOP_FSYNC.9,v 1.6.2.2 2001/12/17 11:30:18 ru Exp $
28.\"
c29aa0c5 29.Dd October 8, 2014
984263bc 30.Dt VOP_FSYNC 9
fb5b3747 31.Os
984263bc
MD
32.Sh NAME
33.Nm VOP_FSYNC
34.Nd flush filesystem buffers for a file
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.Ft int
c29aa0c5 39.Fn VOP_FSYNC "struct vnode *vp" "int waitfor" "int flags"
984263bc
MD
40.Sh DESCRIPTION
41This call flushes any dirty filesystem buffers for the file.
42It is used to implement the
43.Xr sync 2
44and
45.Xr fsync 2
46system calls.
47.Pp
48Its arguments are:
49.Bl -tag -width waitfor
50.It Ar vp
c29aa0c5 51the vnode of the file.
984263bc 52.It Ar waitfor
a0f71436 53whether the function should do data, meta-data updates or be full-synchronous.
c29aa0c5
AHJ
54.It Ar flags
55are additional flags to be passed to the filesystem specific
56.Xr fsync 2
57function.
984263bc
MD
58.El
59.Pp
60The argument
61.Fa waitfor
c29aa0c5 62can use the following flags:
a0f71436
AHJ
63.Bl -tag -width ".Dv MNT_NOWAIT"
64.It Dv MNT_NOWAIT
1ef3b4ca 65is for an asynchronous data pass and a meta-data pass as well.
a0f71436 66.It Dv MNT_LAZY
c29aa0c5 67means a limited amount of data from dirty buffers and a full meta-data synchronization pass.
a0f71436
AHJ
68.It Dv MNT_WAIT
69will make
70.Xr syncer 4
71try to do a full synchronization pass.
72That is, a meta-data pass and multiple data passes.
c29aa0c5
AHJ
73.El
74.Pp
75The argument
76.Fa flags
77is to specify additional flags passed to the filesystem specific
78.Xr fsync 2
79call.
a0f71436
AHJ
80The only supported flag at the moment is
81.Dv VOP_FSYNC_SYSCALL
82which indicates the file synchronization was requested from userland.
984263bc
MD
83.Sh RETURN VALUES
84Zero is returned if the call is successful, otherwise an appropriate
85error code is returned.
984263bc
MD
86.Sh ERRORS
87.Bl -tag -width Er
88.It Bq Er ENOSPC
89The filesystem is full.
90.It Bq Er EDQUOT
91Quota exceeded.
92.El
93.Sh SEE ALSO
4f5ee564 94.Xr syncer 4 ,
984263bc
MD
95.Xr vnode 9
96.Sh AUTHORS
97This man page was written by
98.An Doug Rabson .