.\" -*- 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 "FLICKR_MAKE_STORED_CONFIG 1p" .TH FLICKR_MAKE_STORED_CONFIG 1p 2024-03-02 "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 flickr_make_stored_config \- script to assist with testing and using the Flickr::API .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& flickr_make_stored_config \-\-config_out=Config\-File_to_build [\-\-config_in=file \-\-consumer_key=...] .Ve .SH OPTIONS .IX Header "OPTIONS" .SS Required: .IX Subsection "Required:" .IP "\fB\-\-config_out\fR points to where to create the stored Flickr config file" 5 .IX Item "--config_out points to where to create the stored Flickr config file" .SS Optional: .IX Subsection "Optional:" .PD 0 .IP "\fB\-\-config_in\fR points to the optional input config file to use as a base for the \fI\-\-config_out\fR file you are creating." 5 .IX Item "--config_in points to the optional input config file to use as a base for the --config_out file you are creating." .IP "\fB\-\-api_type\fR either \fIflickr\fR for the original, but deprecated, Flickr authentication OR \fIoauth\fR for the OAuth authentication. it defaults to \fIoauth\fR" 5 .IX Item "--api_type either flickr for the original, but deprecated, Flickr authentication OR oauth for the OAuth authentication. it defaults to oauth" .PD \&\fIFor Flickr Auth\fR .IP "\fB\-\-api_key\fR The api key when used with Flickr authentication \fIrequired for testing\fR \fB\-\-key\fR still works to maintain compatibility with Flickr::API 1.10 and before, but it is saved as api_key." 5 .IX Item "--api_key The api key when used with Flickr authentication required for testing --key still works to maintain compatibility with Flickr::API 1.10 and before, but it is saved as api_key." .PD 0 .IP "\fB\-\-secret\fR The api secret when used with Flickr authentication \fIrequired for testing\fR \fB\-\-secret\fR still works to maintain compatibility with Flickr::API 1.10 and before, but it is saved as api_secret." 5 .IX Item "--secret The api secret when used with Flickr authentication required for testing --secret still works to maintain compatibility with Flickr::API 1.10 and before, but it is saved as api_secret." .IP "\fB\-\-frob\fR The frob used in Flickr authentication" 5 .IX Item "--frob The frob used in Flickr authentication" .IP "\fB\-\-token\fR The auth token can be either a Flickr or OAuth Access token used with Flickr authentication" 5 .IX Item "--token The auth token can be either a Flickr or OAuth Access token used with Flickr authentication" .PD \&\fIFor OAuth\fR .IP "\fB\-\-consumer_key\fR The api key when used with OAuth authentication \fIrequired for testing\fR" 5 .IX Item "--consumer_key The api key when used with OAuth authentication required for testing" .PD 0 .IP "\fB\-\-consumer_secret\fR The api secret when used with OAuth authentication \fIrequired for testing\fR" 5 .IX Item "--consumer_secret The api secret when used with OAuth authentication required for testing" .IP "\fB\-\-callback\fR The callback uri for use in OAuth authentication" 5 .IX Item "--callback The callback uri for use in OAuth authentication" .IP "\fB\-\-token_secret\fR The OAuth access token secret" 5 .IX Item "--token_secret The OAuth access token secret" .IP "\fB\-\-help\fR as expected" 5 .IX Item "--help as expected" .IP \fB\-\-usage\fR 5 .IX Item "--usage" .IP \fB\-\-man\fR 5 .IX Item "--man" .PD .SH DESCRIPTION .IX Header "DESCRIPTION" This script is a lightweight method to assemble the required arguments for using the Flickr::API. It can be used to assemble the configuration(s) needed for the \fBmake test\fR portion of installation. It does not \fIuse Flickr::API;\fR and sticks to modules from perl core so that it can be used prior to\-\- and perhaps in conjunction with\-\- installation and testing of the Flickr::API module. .PP When you \fBmake test\fR, add the environment variable MAKETEST_OAUTH_CFG, MAKETEST_FLICKR_CFG or both; each pointing to the configuration file you specified. The command should look something like: .PP .Vb 1 \& make test MAKETEST_OAUTH_CFG=/home/myusername/test\-flickr\-oauth.cfg .Ve .PP or .PP .Vb 1 \& make test MAKETEST_FLICKR_CFG=/home/myusername/test\-flickrs\-auth.cfg .Ve .PP or .PP .Vb 2 \& make test MAKETEST_FLICKR_CFG=/home/myusername/test\-flickrs\-auth.cfg \e \& MAKETEST_OAUTH_CFG=/home/myusername/test\-flickr\-oauth.cfg .Ve .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright (c) 2015\-2016, Louis B. Moore \f(CW\*(C`\*(C'\fR. .PP This program is released under the Artistic License 2.0 by The Perl Foundation. .SH "SEE ALSO" .IX Header "SEE ALSO" The README in the Flickr::API distribution.