[thirdparty/util-linux.git] / misc-utils / fincore.1

.\" Copyright 2017 Red Hat, Inc.
.\"
.\" This file may be copied under the terms of the GNU Public License.
.TH FINCORE 1 "March 2017" "util-linux" "User Commands"
.SH NAME
fincore \- count pages of file contents in core
.SH SYNOPSIS
.B fincore
[options]
.I file ...
.SH DESCRIPTION
.B fincore
counts pages of file contents being resident in memory (in core), and reports
the numbers.  If an error occurs during counting, then an error message is
printed to the stderr and
.B fincore
continues processing the rest of files listed in a command line.

The default output is subject to change.  So whenever possible, you should
avoid using default outputs in your scripts.  Always explicitly define expected
columns by using
.B \-\-output
.I columns-list
in environments where a stable output is required.
.SH OPTIONS
.TP
.BR \-n , " \-\-noheadings"
Do not print a header line in status output.
.TP
.BR \-b , " \-\-bytes"
Print the SIZE column in bytes rather than in a human-readable format.
.TP
.BR \-o , " \-\-output \fIlist\fP"
Define output columns.  See the \fB\-\-help\fP output to get a list of the
currently supported columns. The default list of columns may be extended if \fIlist\fP is
specified in the format \fI+list\fP.
.TP
.BR \-r , " \-\-raw"
Produce output in raw format.  All potentially unsafe characters are hex-escaped
(\\x<code>).
.TP
.BR \-J , " \-\-json"
Use JSON output format.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help text and exit.
.SH AUTHORS
.MT yamato@\:redhat.com
Masatake YAMATO
.ME
.SH "SEE ALSO"
.BR mincore (2),
.BR getpagesize (2),
.BR getconf (1p)
.SH AVAILABILITY
The fincore command is part of the util-linux package and is available from
.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
Linux Kernel Archive
.UE .
Commit	Line	Data
	1	.\" Copyright 2017 Red Hat, Inc.
	2	.\"
	3	.\" This file may be copied under the terms of the GNU Public License.
	4	.TH FINCORE 1 "March 2017" "util-linux" "User Commands"
	5	.SH NAME
	6	fincore \- count pages of file contents in core
	7	.SH SYNOPSIS
	8	.B fincore
	9	[options]
	10	.I file ...
	11	.SH DESCRIPTION
	12	.B fincore
	13	counts pages of file contents being resident in memory (in core), and reports
	14	the numbers. If an error occurs during counting, then an error message is
	15	printed to the stderr and
	16	.B fincore
	17	continues processing the rest of files listed in a command line.
	18
	19	The default output is subject to change. So whenever possible, you should
	20	avoid using default outputs in your scripts. Always explicitly define expected
	21	columns by using
	22	.B \-\-output
	23	.I columns-list
	24	in environments where a stable output is required.
	25	.SH OPTIONS
	26	.TP
	27	.BR \-n , " \-\-noheadings"
	28	Do not print a header line in status output.
	29	.TP
	30	.BR \-b , " \-\-bytes"
	31	Print the SIZE column in bytes rather than in a human-readable format.
	32	.TP
	33	.BR \-o , " \-\-output \fIlist\fP"
	34	Define output columns. See the \fB\-\-help\fP output to get a list of the
	35	currently supported columns. The default list of columns may be extended if \fIlist\fP is
	36	specified in the format \fI+list\fP.
	37	.TP
	38	.BR \-r , " \-\-raw"
	39	Produce output in raw format. All potentially unsafe characters are hex-escaped
	40	(\\x<code>).
	41	.TP
	42	.BR \-J , " \-\-json"
	43	Use JSON output format.
	44	.TP
	45	\fB\-V\fR, \fB\-\-version\fR
	46	Display version information and exit.
	47	.TP
	48	\fB\-h\fR, \fB\-\-help\fR
	49	Display help text and exit.
	50	.SH AUTHORS
	51	.MT yamato@\:redhat.com
	52	Masatake YAMATO
	53	.ME
	54	.SH "SEE ALSO"
	55	.BR mincore (2),
	56	.BR getpagesize (2),
	57	.BR getconf (1p)
	58	.SH AVAILABILITY
	59	The fincore command is part of the util-linux package and is available from
	60	.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
	61	Linux Kernel Archive
	62	.UE .