.\" -*- 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 "MetaCPAN::Client::Pod 3pm" .TH MetaCPAN::Client::Pod 3pm 2024-03-24 "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 MetaCPAN::Client::Pod \- A Pod object .SH VERSION .IX Header "VERSION" version 2.031001 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& use strict; \& use warnings; \& use MetaCPAN::Client; \& \& my $pod = MetaCPAN::Client\->new\->pod(\*(AqMoo\*(Aq); \& \& print $pod\->html; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" A MetaCPAN pod entity object. .SH ATTRIBUTES .IX Header "ATTRIBUTES" .SS request .IX Subsection "request" A MetaCPAN::Client::Request object (created in MetaCPAN::Client) .SS name .IX Subsection "name" The name of the module (probably always the value passed to the \fBpod()\fR method) .SS url_prefix .IX Subsection "url_prefix" Prefix to be passed through the url_prefix query parameter to the 'pod' endpoint .SS x_pod .IX Subsection "x_pod" The raw pod extracted from the file. .SS html .IX Subsection "html" Formatted as an HTML chunk (No ...) .SS x_markdown .IX Subsection "x_markdown" Converted to Markdown. .SS plain .IX Subsection "plain" Formatted as plain text. .PP Get the plaintext version of the documentation .PP .Vb 2 \& $pod = MetaCPAN::Client\->new\->pod( "MetaCPAN::Client" ); \& print $pod\->plain; .Ve .SH AUTHORS .IX Header "AUTHORS" .IP \(bu 4 Sawyer X .IP \(bu 4 Mickey Nasriachi .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2016 by Sawyer X. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.