.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "Icon::FamFamFam::Silk 3pm" .TH Icon::FamFamFam::Silk 3pm "2011-10-11" "perl v5.14.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 \*(L"\s-1SYNOPSIS\s0\*(R".) .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 \s-1PNG\s0 data. .ie n .IP """$icon\->raw""" 4 .el .IP "\f(CW$icon\->raw\fR" 4 .IX Item "$icon->raw" Returns raw \s-1PNG\s0 data. .ie n .IP """$icon\->uri""" 4 .el .IP "\f(CW$icon\->uri\fR" 4 .IX Item "$icon->uri" Returns a \*(L"data:\*(R" \s-1URI\s0 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 . .SH "SEE ALSO" .IX Header "SEE ALSO" . .SH "AUTHOR" .IX Header "AUTHOR" Icons by Mark James of . .PP Module by Toby Inkster . .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" Mark James distributes the icons themselves under the CC-BY 3.0 licence . Applications using Icon::FamFamFam::Silk (even indirectly via another module) must provide credit. Including a link to 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" \&\s-1THIS\s0 \s-1PACKAGE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R" \s-1AND\s0 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0 \&\s-1WARRANTIES\s0, \s-1INCLUDING\s0, \s-1WITHOUT\s0 \s-1LIMITATION\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0 \&\s-1MERCHANTIBILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.