.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Parse::Netstat 3pm" .TH Parse::Netstat 3pm "2023-01-15" "perl v5.36.0" "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.150 of Parse::Netstat (from Perl distribution Parse-Netstat), released on 2022\-12\-04. .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_code, $reason, $payload, \e%result_meta] .Ve .PP Parse the output of \*(L"netstat\*(R" command. .PP This utility 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 utility 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_code) is an integer containing HTTP-like status code (200 means \s-1OK,\s0 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like \*(L"\s-1OK\*(R"\s0 if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how \s-1HTTP\s0 response headers provide additional metadata. .PP Return value: (any) .SH "HOMEPAGE" .IX Header "HOMEPAGE" Please visit the project's homepage at . .SH "SOURCE" .IX Header "SOURCE" Source repository is at . .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 .SH "CONTRIBUTOR" .IX Header "CONTRIBUTOR" Steven Haryanto .SH "CONTRIBUTING" .IX Header "CONTRIBUTING" To contribute, you can send patches by email/via \s-1RT,\s0 or send pull requests on GitHub. .PP Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: .PP .Vb 1 \& % prove \-l .Ve .PP If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla\- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2022, 2017, 2015, 2014, 2012, 2011 by perlancar . .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. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .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.