.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Icon::FamFamFam::Silk 3pm"
.TH Icon::FamFamFam::Silk 3pm 2024-03-05 "perl v5.38.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
Icon::FamFamFam::Silk \- embed these famous icons in your code
.SH VERSION
.IX Header "VERSION"
0.002001003
.PP
(Version 0.002 of this module and version 1.3 of the icons.)
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use Icon::FamFamFam::Silk;
\& my $wrench = Icon::FamFamFam::Silk\->new(\*(Aqwrench_orange\*(Aq);
\& print $wrench\->base64;
.Ve
.PP
or
.PP
.Vb 2
\& use Icon::FamFamFam::Silk;
\& print Icon::FamFamFam::Silk::base64(\*(Aqwrench_orange\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These methods can be called as functions taking the name of the icon (a string)
as their argument, or can be called as object methods on an instantiated icon
object. (See "SYNOPSIS".)
.ie n .IP """Icon::FamFamFam::Silk\->new($name)""" 4
.el .IP \f(CWIcon::FamFamFam::Silk\->new($name)\fR 4
.IX Item "Icon::FamFamFam::Silk->new($name)"
Returns a blessed icon object.
.ie n .IP """Icon::FamFamFam::Silk\->list""" 4
.el .IP \f(CWIcon::FamFamFam::Silk\->list\fR 4
.IX Item "Icon::FamFamFam::Silk->list"
Returns a list of all the icons.
.ie n .IP """$icon\->name""" 4
.el .IP \f(CW$icon\->name\fR 4
.IX Item "$icon->name"
Returns the name of the icon.
.ie n .IP """$icon\->base64""" 4
.el .IP \f(CW$icon\->base64\fR 4
.IX Item "$icon->base64"
Returns base64\-encoded PNG data.
.ie n .IP """$icon\->raw""" 4
.el .IP \f(CW$icon\->raw\fR 4
.IX Item "$icon->raw"
Returns raw PNG data.
.ie n .IP """$icon\->uri""" 4
.el .IP \f(CW$icon\->uri\fR 4
.IX Item "$icon->uri"
Returns a "data:" URI for the icon.
.ie n .IP """$icon\->attribution_data"" =item ""Icon::FamFamFam::Silk\->attribution_data""" 4
.el .IP "\f(CW$icon\->attribution_data\fR =item \f(CWIcon::FamFamFam::Silk\->attribution_data\fR" 4
.IX Item "$icon->attribution_data =item Icon::FamFamFam::Silk->attribution_data"
Returns a hash of data useful for giving credit to Mark James.
.Sp
This is in a format suitable for passing to HTML::HTML5::Builder's
\&\f(CW\*(C`CREATIVE_COMMONS\*(C'\fR function, should you want to do something like
that.
.SH BUGS
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://famfamfam.com/lab/icons/silk/>.
.SH AUTHOR
.IX Header "AUTHOR"
Icons by Mark James of <http://famfamfam.com/>.
.PP
Module by Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Mark James distributes the icons themselves under the CC-BY 3.0 licence
<http://creativecommons.org/licenses/by/3.0/>. Applications using
Icon::FamFamFam::Silk (even indirectly via another module) must provide
credit. Including a link to <http://famfamfam.com/lab/icons/silk/> in the
documentation of the application is probably sufficient.
.PP
Toby Inkster releases the additional Perl coding into the Public Domain.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.