summaryrefslogtreecommitdiffstats
path: root/misc-utils/fadvise.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--misc-utils/fadvise.1102
-rw-r--r--misc-utils/fadvise.1.adoc68
2 files changed, 170 insertions, 0 deletions
diff --git a/misc-utils/fadvise.1 b/misc-utils/fadvise.1
new file mode 100644
index 0000000..9d26d41
--- /dev/null
+++ b/misc-utils/fadvise.1
@@ -0,0 +1,102 @@
+'\" t
+.\" Title: fadvise
+.\" Author: [see the "AUTHOR(S)" section]
+.\" Generator: Asciidoctor 2.0.20
+.\" Date: 2023-11-21
+.\" Manual: User Commands
+.\" Source: util-linux 2.39.3
+.\" Language: English
+.\"
+.TH "FADVISE" "1" "2023-11-21" "util\-linux 2.39.3" "User Commands"
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.ss \n[.ss] 0
+.nh
+.ad l
+.de URL
+\fI\\$2\fP <\\$1>\\$3
+..
+.als MTO URL
+.if \n[.g] \{\
+. mso www.tmac
+. am URL
+. ad l
+. .
+. am MTO
+. ad l
+. .
+. LINKSTYLE blue R < >
+.\}
+.SH "NAME"
+fadvise \- utility to use the posix_fadvise system call
+.SH "SYNOPSIS"
+.sp
+\fBfadvise\fP [\fB\-a\fP \fIadvice\fP] [\fB\-o\fP \fIoffset\fP] [\fB\-l\fP \fIlength\fP] \fIfilename\fP
+.sp
+\fBfadvise\fP [\fB\-a\fP \fIadvice\fP] [\fB\-o\fP \fIoffset\fP] [\fB\-l\fP \fIlength\fP] \-d \fIfile\-descriptor\fP
+.SH "DESCRIPTION"
+.sp
+\fBfadvise\fP is a simple command wrapping posix_fadvise system call
+that is for predeclaring an access pattern for file data.
+.SH "OPTIONS"
+.sp
+\fB\-d\fP, \fB\-\-fd\fP \fIfile\-descriptor\fP
+.RS 4
+Apply the advice to the file specified with the file descriptor instead
+of open a file specified with a file name.
+.RE
+.sp
+\fB\-a\fP, \fB\-\-advice\fP \fIadvice\fP
+.RS 4
+See the command output with \fB\-\-help\fP option for available values for
+advice. If this option is omitted, "dontneed" is used as default advice.
+.RE
+.sp
+\fB\-o\fP, \fB\-\-offset\fP \fIoffset\fP
+.RS 4
+Specifies the beginning offset of the range, in bytes.
+If this option is omitted, 0 is used as default advice.
+.RE
+.sp
+\fB\-l\fP, \fB\-\-length\fP \fIlength\fP
+.RS 4
+Specifies the length of the range, in bytes.
+If this option is omitted, 0 is used as default advice.
+.RE
+.sp
+\fB\-h\fP, \fB\-\-help\fP
+.RS 4
+Display help text and exit.
+.RE
+.sp
+\fB\-V\fP, \fB\-\-version\fP
+.RS 4
+Print version and exit.
+.RE
+.SH "EXIT STATUS"
+.sp
+\fBfadvise\fP has the following exit status values:
+.sp
+\fB0\fP
+.RS 4
+success
+.RE
+.sp
+\fB1\fP
+.RS 4
+unspecified failure
+.RE
+.SH "AUTHORS"
+.sp
+.MTO "yamato\(atredhat.com" "Masatake YAMATO" ""
+.SH "SEE ALSO"
+.sp
+\fBposix_fadvise\fP(2)
+.SH "REPORTING BUGS"
+.sp
+For bug reports, use the issue tracker at \c
+.URL "https://github.com/util\-linux/util\-linux/issues" "" "."
+.SH "AVAILABILITY"
+.sp
+The \fBfadvise\fP command is part of the util\-linux package which can be downloaded from \c
+.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file
diff --git a/misc-utils/fadvise.1.adoc b/misc-utils/fadvise.1.adoc
new file mode 100644
index 0000000..dffbeaa
--- /dev/null
+++ b/misc-utils/fadvise.1.adoc
@@ -0,0 +1,68 @@
+//po4a: entry man manual
+= fadvise(1)
+:doctype: manpage
+:man manual: User Commands
+:man source: util-linux {release-version}
+:page-layout: base
+:command: fadvise
+
+== NAME
+
+fadvise - utility to use the posix_fadvise system call
+
+== SYNOPSIS
+
+*fadvise* [*-a* _advice_] [*-o* _offset_] [*-l* _length_] _filename_
+
+*fadvise* [*-a* _advice_] [*-o* _offset_] [*-l* _length_] -d _file-descriptor_
+
+== DESCRIPTION
+
+*fadvise* is a simple command wrapping posix_fadvise system call
+that is for predeclaring an access pattern for file data.
+
+== OPTIONS
+
+*-d*, *--fd* _file-descriptor_::
+Apply the advice to the file specified with the file descriptor instead
+of open a file specified with a file name.
+
+*-a*, *--advice* _advice_::
+See the command output with *--help* option for available values for
+advice. If this option is omitted, "dontneed" is used as default advice.
+
+*-o*, *--offset* _offset_::
+Specifies the beginning offset of the range, in bytes.
+If this option is omitted, 0 is used as default advice.
+
+*-l*, *--length* _length_::
+Specifies the length of the range, in bytes.
+If this option is omitted, 0 is used as default advice.
+
+include::man-common/help-version.adoc[]
+
+== EXIT STATUS
+
+*fadvise* has the following exit status values:
+
+*0*::
+success
+*1*::
+unspecified failure
+
+== AUTHORS
+
+mailto:yamato@redhat.com[Masatake YAMATO]
+
+== SEE ALSO
+
+*posix_fadvise*(2)
+
+include::man-common/bugreports.adoc[]
+
+include::man-common/footer.adoc[]
+
+ifdef::translation[]
+include::man-common/translation.adoc[]
+endif::[]
+