.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Parse::Netstat 3pm"
.TH Parse::Netstat 3pm "2017-11-15" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Parse::Netstat \- Parse the output of "netstat" command
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.14 of Parse::Netstat (from Perl distribution Parse-Netstat), released on 2017\-02\-10.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Parse::Netstat qw(parse_netstat);
\& my $res = parse_netstat(output => join("", \`netstat \-anp\`), flavor=>\*(Aqlinux\*(Aq);
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "parse_netstat"
.IX Subsection "parse_netstat"
Usage:
.PP
.Vb 1
\& parse_netstat(%args) \-> [status, msg, result, meta]
.Ve
.PP
Parse the output of \*(L"netstat\*(R" command.
.PP
This program support several flavors of netstat. The default flavor is \f(CW\*(C`linux\*(C'\fR.
Use \f(CW\*(C`\-\-flavor\*(C'\fR to select which flavor you want.
.PP
Since different flavors provide different fields and same-named fields might
contain data in different format, and also not all kinds of possible output from
a single flavor are supported, please see the sample parse output for each
flavor (in corresponding \f(CW\*(C`Parse::Netstat::*\*(C'\fR per-flavor module) you want to use
and adjust accordingly.
.PP
This function is not exported by default, but exportable.
.PP
Arguments ('*' denotes required arguments):
.IP "\(bu" 4
\&\fBflavor\fR => \fIstr\fR (default: \*(L"linux\*(R")
.Sp
Flavor of netstat.
.IP "\(bu" 4
\&\fBoutput\fR* => \fIstr\fR
.Sp
Output of netstat command.
.Sp
This function only parses program's output. You need to invoke \*(L"netstat\*(R" on your
own.
.IP "\(bu" 4
\&\fBtcp\fR => \fIbool\fR (default: 1)
.Sp
Parse \s-1TCP\s0 connections.
.IP "\(bu" 4
\&\fBudp\fR => \fIbool\fR (default: 1)
.Sp
Parse \s-1UDP\s0 connections.
.IP "\(bu" 4
\&\fBunix\fR => \fIbool\fR (default: 1)
.Sp
Parse Unix socket connections.
.PP
Returns an enveloped result (an array).
.PP
First element (status) is an integer containing \s-1HTTP\s0 status code
(200 means \s-1OK,\s0 4xx caller error, 5xx function error). Second element
(msg) is a string containing error message, or '\s-1OK\s0' if status is
200. Third element (result) is optional, the actual result. Fourth
element (meta) is called result metadata and is optional, a hash
that contains extra information.
.PP
Return value:  (any)
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Parse\-Netstat>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Parse\-Netstat>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Parse\-Netstat>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Parse::Netstat::* for per-flavor notes and sample outputs.
.PP
parse-netstat from App::ParseNetstat is a \s-1CLI\s0 for this module.
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017, 2015, 2014, 2012, 2011 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.