.\" Automatically generated by Pod::Man 4.14 (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 .. .\" 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 .. .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 "Pandoc::Release 3pm" .TH Pandoc::Release 3pm "2023-01-06" "perl v5.36.0" "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" Pandoc::Release \- get pandoc releases from GitHub .SH "SYNOPSIS" .IX Header "SYNOPSIS" From command line: .PP .Vb 2 \& # print latest release name \& perl \-MPandoc::Release \-E \*(Aqsay latest\->{name}\*(Aq \& \& # download latest release unless already in ~/.pandoc/bin \& perl \-MPandoc::Release \-E \*(Aqlatest\->download\*(Aq \& \& # download specific release and create symlink ~/.pandoc/bin/pandoc \& perl \-MPandoc::Release \-E \*(Aqget("2.7.3")\->download\->symlink\*(Aq .Ve .PP In Perl code: .PP .Vb 1 \& use Pandoc::Release; \& \& my $release = get(\*(Aq2.1.3\*(Aq); # get a specific release \& my $latest = latest; # get a latest release \& \& # get multiple releases \& my @releases = list( since => \*(Aq2.0\*(Aq, verbose => 1 ); \& foreach my $release (@releases) { \& \& # print version number \& say $release\->{tag_name}; \& \& # download Debian package and executable \& $release\->download( dir => \*(Aq./deb\*(Aq, bin => \*(Aq./bin\*(Aq ); \& } \& \& # download executable and use as temporary Pandoc object: \& my $pandoc = get(\*(Aq2.1.3)\->download( bin => \*(Aq./bin\*(Aq ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This utility module fetches information about pandoc releases via GitHub \s-1API.\s0 On Debian-bases systems, this module can update and switch locally installed pandoc versions if you add directory \f(CW\*(C`~/.pandoc/bin\*(C'\fR to your \f(CW$PATH\fR. .PP See pandoc-version for a command line script that makes use of this module. .SH "FUNCTIONS" .IX Header "FUNCTIONS" All functions are exported by default. .ie n .SS "get( $version, %options )" .el .SS "get( \f(CW$version\fP, \f(CW%options\fP )" .IX Subsection "get( $version, %options )" Get a specific release by its version or die if the given version does not exist. Returns data as returned by GitHub releases \s-1API:\s0 . .ie n .SS "list( %options )" .el .SS "list( \f(CW%options\fP )" .IX Subsection "list( %options )" Get a list of all pandoc releases, optionally \f(CW\*(C`since\*(C'\fR some version or within a version \f(CW\*(C`range\*(C'\fR such as \f(CW\*(C`!=1.16, <=1.17\*(C'\fR or \f(CW\*(C`==2.1.2\*(C'\fR. See \&\*(L"Version Ranges\*(R" in CPAN::Meta::Spec for possible values. Option \f(CW\*(C`verbose\*(C'\fR will print URLs before each request. Option \f(CW\*(C`limit\*(C'\fR limits the maximum number of releases to be returned. .ie n .SS "latest( %options )" .el .SS "latest( \f(CW%options\fP )" .IX Subsection "latest( %options )" Get the latest release, optionally \f(CW\*(C`since\*(C'\fR some version or within a version \&\f(CW\*(C`range\*(C'\fR. Equivalent to method \f(CW\*(C`list\*(C'\fR with option \f(CW\*(C`limit => 1\*(C'\fR. .SH "METHODS" .IX Header "METHODS" .ie n .SS "download( %options )" .el .SS "download( \f(CW%options\fP )" .IX Subsection "download( %options )" Download the Debian release file for some architecture (e.g. \f(CW\*(C`amd64\*(C'\fR) Pandoc executables is then extracted to directory \f(CW\*(C`bin\*(C'\fR named by pandoc version number (e.g. \f(CW\*(C`pandoc\-2.1.2\*(C'\fR). Skips downloading if an executable of this name is already found there. Returns a Pandoc instance if \f(CW\*(C`bin\*(C'\fR is not false or Pandoc::Version otherwise. Additional options: .IP "dir" 4 .IX Item "dir" Where to download release files to. A temporary directory is used by default. .IP "arch" 4 .IX Item "arch" System architecture, detected with \f(CW\*(C`dpkg \-\-print\-architecture\*(C'\fR by default. .IP "bin" 4 .IX Item "bin" Where to extract pandoc binary to. By default set to \f(CW\*(C`~/.pandoc/bin\*(C'\fR on Unix (see Pandoc function \f(CW\*(C`pandoc_data_dir\*(C'\fR). Extraction of executables can be disabled by setting \f(CW\*(C`bin\*(C'\fR to a false value. .IP "symlink" 4 .IX Item "symlink" Create a symlink to the executable. This is just a shortcut for calling function \&\f(CW\*(C`symlink\*(C'\fR of Pandoc: .Sp .Vb 2 \& $release\->download( verbose => $v )\->symlink( $l, verbose => $v ) \& $release\->download( verbose => $v, symlink => $l ) # equivalent .Ve .SH "COMMON OPTIONS" .IX Header "COMMON OPTIONS" .IP "verbose" 4 .IX Item "verbose" Print what's going on (disabled by default). .IP "token" 4 .IX Item "token" GitHub token to avoid rate limiting. .SH "SEE ALSO" .IX Header "SEE ALSO" Pandoc::Version .PP