#!perl

# Note: This script is a CLI interface to Riap function /Parse/Netstat/parse_netstat
# and generated automatically using Dist::Zilla::Plugin::Rinci::ScriptFromFunc version 0.03

our $DATE = '2014-12-01'; # DATE
our $VERSION = '0.10'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any -prefer_lite=>1;

Perinci::CmdLine::Any->new(
    url => "/Parse/Netstat/parse_netstat",
)->run;

# ABSTRACT: Parse the output of "netstat" command
# PODNAME: parse-netstat

__END__

=pod

=encoding UTF-8

=head1 NAME

parse-netstat - Parse the output of "netstat" command

=head1 VERSION

This document describes version 0.10 of parse-netstat (from Perl distribution App-ParseNetstat), released on 2014-12-01.

=head1 SYNOPSIS

 % parse-netstat [options] <output>

=head1 DESCRIPTION

This program support several flavors of netstat. The default flavor is C<linux>.
See C<--flavor> on how to set flavor.

Since different flavors provide different fields and same-named fields might
contain data in different format, please see the sample parse output for each
flavor you want to support and adjust accordingly.

=head1 OPTIONS

C<*> marks required options.

=head2 Common options

=over

=item B<--config-path>=I<s>

Set path to configuration file.

Can be specified multiple times.

=item B<--config-profile>=I<s>

Set configuration profile to use.

=item B<--format>=I<s>

Set output format.

=item B<--help>, B<-h>, B<-?>

Show help message.

=item B<--json>

Set output format to json.

=item B<--no-config>

Do not use any configuration file.

=item B<--version>, B<-v>

Show program version.

=back

=head2 Options

=over

=item B<--flavor>=I<s>

Flavor of netstat.

Default value:

 "linux"

Valid values:

 ["linux", "solaris", "freebsd", "win32"]

For Linux, it supports the output of `netstat -an` or `netstat -anp`.

For FreeBSD, it supports `netstat` or `netstat -an`.

For Solaris, it supports `netstat`.

For Windows, it supports `netstat` or `netstat -an` or `netstat -anp`.


=item B<--no-tcp>

=item B<--no-udp>

=item B<--no-unix>

=item B<--output>=I<s>*

Output of netstat command.

This function only parses program's output. You need to invoke "netstat" on your
own.


=back

=head1 FILES

B</etc/parse-netstat.conf>

B<~/parse-netstat.conf>

=head1 COMPLETION

This script has shell tab completion capability with support for several shells.

=head2 bash

To activate bash completion for this script, put:

 complete -C parse-netstat parse-netstat

in your bash startup (e.g. C<~/.bashrc>). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

You can also install L<App::BashCompletionProg> which makes it easy to add completion for Perinci::CmdLine-based scripts. After you install the module and put C<. ~/.bash-complete-prog> (or C<. /etc/bash-complete-prog>), you can just run C<bash-completion-prog> and the C<complete> command will be added to your C<~/.bash-completion-prog>. Your next shell session will then recognize tab completion for the command.

=head2 fish

To activate fish completion for this script, execute:

 begin; set -lx COMP_SHELL fish; set -lx COMP_MODE gen_command; parse-netstat; end > $HOME/.config/fish/completions/parse-netstat.fish

Or if you want to install globally, you can instead write the generated script to C</etc/fish/completions/parse-netstat.fish> or C</usr/share/fish/completions/parse-netstat.fish>. The exact path might be different on your system. Please check your C<fish_complete_path> variable.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete parse-netstat 'p/*/`parse-netstat`/'

in your tcsh startup (e.g. C<~/.tcshrc>). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

=head2 zsh

To activate zsh completion for this script, put:

 _parse_netstat() { read -l; local cl="$REPLY"; read -ln; local cp="$REPLY"; reply=(`COMP_SHELL=zsh COMP_LINE="$cl" COMP_POINT="$cp" parse-netstat`) }

 compctl -K _parse_netstat parse-netstat

in your zsh startup (e.g. C<~/.zshrc>). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-ParseNetstat>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-ParseNetstat>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-ParseNetstat>

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.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut
