.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::Route 3pm"
.TH Net::Route 3pm "2016-06-30" "perl v5.22.2" "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"
Net::Route \- Portable interface to the routing table
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    use Net::Route::Table;
\&    my $table_ref = Net::Route::Table\->from_system();
\&    my $route_ref = $table_ref\->default_route();
\&    print "Default gateway: ", $route_ref\->gateway(), "\en";
.Ve
.SH "VERSION"
.IX Header "VERSION"
Version 0.02, \f(CW$Revision:\fR 372 $
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "The Net::Route Module"
.IX Subsection "The Net::Route Module"
Every \s-1OS\s0 provides its custom interface to the routing table: Linux' \f(CW\*(C`route\*(C'\fR
utility is different from \s-1BSD\s0's \f(CW\*(C`route show\*(C'\fR, from Windows' \f(CW\*(C`route print\*(C'\fR,
etc. Parsing all these different output styles in an (otherwise portable)
script can quickly become inconvenient.
.PP
Net::Route abstracts the system specifics and provides a single, portable
interface.
.SS "The Net::Route Class"
.IX Subsection "The Net::Route Class"
Net::Route objects represent single entries from a Net::Route::Table.
.SH "INTERFACE"
.IX Header "INTERFACE"
This documents Net::Route as a class. To know how to use the module, refer
to the synopsis or Net::Route::Table (the entry point from a
user perspective).
.SS "Object Methods"
.IX Subsection "Object Methods"
\fI\fIdestination()\fI\fR
.IX Subsection "destination()"
.PP
\fI\fIgateway()\fI\fR
.IX Subsection "gateway()"
.PP
\fI\fImetric()\fI\fR
.IX Subsection "metric()"
.PP
\fI\fIinterface()\fI\fR
.IX Subsection "interface()"
.PP
\fI\fIis_active()\fI\fR
.IX Subsection "is_active()"
.PP
\fI\fIis_dynamic()\fI\fR
.IX Subsection "is_dynamic()"
.SH "INSTALLING DEPENDENCIES ON SUN SOLARIS SYSTEMS WITH GCC"
.IX Header "INSTALLING DEPENDENCIES ON SUN SOLARIS SYSTEMS WITH GCC"
The perl interpreter shipped with Solaris was compiled with Sun's proprietary C
compiler, and therefore attempts to compile \s-1XS\s0 modules with the same tool and
options. However, Solaris comes by default with the \s-1GNU C\s0 Compiler (\f(CW\*(C`gcc\*(C'\fR)
only, which has its own set of incompatible command-line arguments. Mixing
these two to compile \f(CW\*(C`XS\*(C'\fR Perl modules doesn't work.
.PP
Therefore, when you need to install \s-1CPAN\s0 modules (such as Net::Route's
dependencies) which make use of \f(CW\*(C`XS\*(C'\fR (C code) on a system without the Sun C
Compiler, you have to use the wrapper script provided by Sun which will invoke
\&\f(CW\*(C`gcc\*(C'\fR correctly (replace \f(CW\*(C`Module\*(C'\fR as needed):
.PP
.Vb 1
\&  /usr/perl5/bin/perlgcc \-MCPAN \-e \*(Aqinstall Module\*(Aq.
.Ve
.SH "STATUS AND ROADMAP"
.IX Header "STATUS AND ROADMAP"
Please refer to the Changes file for a detailed history.
.SS "0.01 \- First Public Release"
.IX Subsection "0.01 - First Public Release"
Net::Route meets our goals for a first public release:
.IP "\(bu" 4
It can list all routes
.IP "\(bu" 4
It can get the default route
.IP "\(bu" 4
It can provide the most common characteristics of routes
.IP "\(bu" 4
It is portable on Linux, Solaris and Windows
.PP
Net::Route is used in other 
Straton \s-1IT \s0(<http://en.straton\-it.fr/>) software, such as
Cancerbero 0.7 (<http://en.straton\-it.fr/open\-source/cancerbero\-07>) and
Confdump/Sys (<http://confdump.sourceforge.net/>).
.SS "0.xx \- Community Releases"
.IX Subsection "0.xx - Community Releases"
These releases will include features and bugfixes suggested, reported and/or
contributed by the community. For example:
.IP "\(bu" 4
Differentiating between \f(CW\*(C`Net::Route\*(C'\fR\-as\-a\-class and \f(CW\*(C`Net::Route\*(C'\fR\-as\-a\-module
.IP "\(bu" 4
Support for more operating systems
.IP "\(bu" 4
Getting rid of \s-1CPAN\s0 dependencies that are troublesome to install on some
platforms.
.IP "\(bu" 4
Your idea (<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net\-Route>) here...
.PP
The \s-1API\s0 might change somewhat, if necessary.
.SS "1.0 \- \s-1API\s0 Freeze"
.IX Subsection "1.0 - API Freeze"
When appropriate (according to the user reports), we will freeze the interface
and release version 1.0.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-net\-route at rt.cpan.org\*(C'\fR,
or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net\-Route>. I will be
notified, and then you'll automatically be notified of progress on your bug as
I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Net::Route
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net\-Route>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Net\-Route>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Net\-Route>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Net\-Route>
.SH "AUTHOR"
.IX Header "AUTHOR"
Created by Alexandre Storoz, \f(CW\*(C`<astoroz@straton\-it.fr>\*(C'\fR
.PP
Maintained by Thomas Equeter, \f(CW\*(C`<tequeter@straton\-it.fr>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (C) 2009 Straton \s-1IT.\s0
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.