fdstat.1

.\"                                      Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2017 Marco <marcoafalmeida@gmail.com>,
.\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH fdstat 1 "2017"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
fdstat \- Report file descriptor statistics
.SH SYNOPSIS
\fBfdstat\fP [OPTION...] [INTERVAL [COUNT]]
.SH DESCRIPTION
.B fdstat
reports the number of files descriptors allocated by each process.
.PP
The information is collected from the \fI/proc\fP filesystem,
therefore an open file may be a regular file, a directory, a block
special file, a character special file, an executing text reference, a
library, a stream or a network file (Internet socket, NFS file or UNIX
domain socket).
.P
Each report provides information gathered at the time of execution.
.P
The \fIinterval\fP parameter specifies the amount of time in seconds
between each report. The \fIcount\fP parameter can be specified in
conjunction with the \fIinterval\fP parameter. If the \fIcount\fP
parameter is specified, the value of \fIcount\fP determines the number
of reports generated at \fIinterval\fP seconds apart. If the
\fIinterval\fP parameter is specified without the \fIcount\fP
parameter, the \fBfdstat\fP command generates reports continuously.
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
.TP
.B -c, --cmdline
Output the command line instead of the PID.
.TP
.B -j, --json
Produce JSON output.
.TP
.B -s, --summary
Display only totals (allocated and maximum).
.TP
.B -v, --verbose
Produce verbose output.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-V, \-\-version
Show version of program.
.SH AUTHOR
Marco Almeida <marcoafalmeida@gmail.com>
.SH SEE ALSO
.BR free(1),
.BR iostat(1),
.BR mpstat(1),
.BR pidstat(1),
.BR ps(1),
.BR sar(1),
.BR top(1),
.BR vmstat(1).
.P
.IR https://github.com/marcoalmeida/fdstat