aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTony Solomonik <tony.solomonik@gmail.com>2024-01-23 15:21:59 +0200
committerTony Solomonik <tony.solomonik@gmail.com>2024-01-31 18:18:51 +0200
commited3e6f5cdae5e8ded22af0a0884174eeabfe6bca (patch)
treeb24855cc996f6fa7e1f703b87a47f4b796954ed5
parent41950c154dc667625fb3fa437b95f5abcc1cc6bb (diff)
downloadliburing-ed3e6f5cdae5e8ded22af0a0884174eeabfe6bca.tar.gz
man/io_uring_prep_ftruncate: Add the new ftruncate command
Signed-off-by: Tony Solomonik <tony.solomonik@gmail.com>
-rw-r--r--man/io_uring_prep_ftruncate.348
1 files changed, 48 insertions, 0 deletions
diff --git a/man/io_uring_prep_ftruncate.3 b/man/io_uring_prep_ftruncate.3
new file mode 100644
index 00000000..c49ad5b0
--- /dev/null
+++ b/man/io_uring_prep_ftruncate.3
@@ -0,0 +1,48 @@
+.\" Copyright (C) 2024 Tony Solomonik <tony.solomonik@gmail.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_ftruncate 3 "January 23, 2024" "liburing-2.6" "liburing Manual"
+.SH NAME
+io_uring_prep_ftruncate \- prepare an ftruncate request
+.SH SYNOPSIS
+.nf
+.B #include <liburing.h>
+.PP
+.BI "void io_uring_prep_ftruncate(struct io_uring_sqe *" sqe ","
+.BI " int " fd ","
+.BI " loff_t " len ");"
+.fi
+.SH DESCRIPTION
+.PP
+The
+.BR io_uring_prep_ftruncate (3)
+function prepares an ftruncate request. The submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+that should get truncated to the length indicated by the
+.I len
+argument.
+
+.SH RETURN VALUE
+None
+.SH ERRORS
+The CQE
+.I res
+field will contain the result of the operation. See the related man page for
+details on possible values. Note that where synchronous system calls will return
+.B -1
+on failure and set
+.I errno
+to the actual error value, io_uring never uses
+.IR errno .
+Instead it returns the negated
+.I errno
+directly in the CQE
+.I res
+field.
+.SH SEE ALSO
+.BR io_uring_get_sqe (3),
+.BR io_uring_submit (3),
+.BR ftruncate (2),