.\" 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 "Net::SSH::AuthorizedKey::Base 3pm"
.TH Net::SSH::AuthorizedKey::Base 3pm "2018-06-01" "perl v5.26.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::SSH::AuthorizedKey::Base \- Virtual Base Class for ssh keys
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # Documentation to understand methods shared
\&    # by all parsers. Not for direct use.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is the key parser base class, offering methods common to all
parsers. Don't use it directly, but read the documentation below to
see what functionality all parsers offer.
.IP "\fIerror()\fR" 4
.IX Item "error()"
If a parser fails for any reason, it will leave a textual description of
the error that threw it off. This methods retrieves the error text.
.IP "\fIoptions()\fR" 4
.IX Item "options()"
.PD 0
.IP "\fIkey()\fR" 4
.IX Item "key()"
.PD
The actual content of the key, either a big number in case of ssh\-1 or
a base64\-encoded string for ssh\-2.
.IP "\fItype()\fR" 4
.IX Item "type()"
Type of a key. (Somewhat redundant, as you could also check what subclass
a key is of). Either set to \f(CW"ssh\-1"\fR or \f(CW"ssh\-2"\fR.
.IP "\fIemail()\fR" 4
.IX Item "email()"
Identical with \fIcomment()\fR.
.IP "\fIcomment()\fR" 4
.IX Item "comment()"
Identical with \fIemail()\fR. This is the text that follows in the authorized_keys
file after the key content. Mostly used for emails and host names.
.SH "LEGALESE"
.IX Header "LEGALESE"
Copyright 2005\-2009 by Mike Schilli, all rights reserved.
This program is free software, you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
2005, Mike Schilli <m@perlmeister.com>