.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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 (.Sh), 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 "Spork::Config 3pm" .TH Spork::Config 3pm "2005-03-25" "perl v5.10.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" Spork::Config \- Spork Configuration Class .SH "SETTINGS" .IX Header "SETTINGS" This is a list of all the current configuration options in alphabetical order: .IP "\(bu" 4 author_email .Sp The presentation author's email address. .IP "\(bu" 4 author_name .Sp The presentation author's full name. .IP "\(bu" 4 author_webpage .Sp The presentation author's webpage. .IP "\(bu" 4 auto_scrolldown .Sp When a multipart slide is too long for the display, force it to scroll all the way down when you link to it. .IP "\(bu" 4 banner_bgcolor .Sp Background color for the banner boxes at the top and bottom of each slide. .IP "\(bu" 4 character_encoding .Sp I18N character encoding. You probably want 'utf\-8'. .IP "\(bu" 4 copyright_string .Sp A copyright message to be displayed on each slide. .IP "\(bu" 4 download_method .Sp Which program to use when downloading images. Possible values are: .Sp .Vb 3 \& wget \- default \& curl \& lwp .Ve .IP "\(bu" 4 file_base .Sp A path to prepend to any relative file path provided to the \f(CW\*(C`> directive. .IP "\(bu" 4 file_base .Sp A path to prepend to any relative file path provided to the \f(CW\*(C`> directive. .IP "\(bu" 4 formatter_class .Sp Perl module to be used for slides formatting. You probably won't change this unless you are up to the task of writing your own custom formatter. .IP "\(bu" 4 image_width .Sp This is the default width that all images in your slideshow will be scaled to. .IP "\(bu" 4 link_index .Sp Text for link to index page. .IP "\(bu" 4 link_next .Sp Text for link to next page. .IP "\(bu" 4 link_previous .Sp Text for link to previous page. .IP "\(bu" 4 logo_image .Sp A small image to put at the bottom of each slide. You can leave this value empty if you don't have a logo. .IP "\(bu" 4 mouse_controls .Sp If this is turned off, clicking on the page will not advance the screen. This is useful if you like to use the mouse to hilight things on the page. .IP "\(bu" 4 show_controls .Sp If this is turned off, the control links (previous, index, next) will not display. .IP "\(bu" 4 slides_directory .Sp The directory where all your slides will be written to when you do \f(CW\*(C`spork \&\-make\*(C'\fR. .IP "\(bu" 4 slides_file .Sp The name of the file that you write all of your slides in. .IP "\(bu" 4 start_command .Sp The command that gets executed when you type \f(CW\*(C`spork \-make\*(C'\fR. .IP "\(bu" 4 template_class .Sp The Perl module that is used for template processing. This module also contains the default templates that are used. Possible values are: .Sp .Vb 3 \& Spork::Template::TT2 (Template Toolkit \- default) \& Spork::Template::Mason (HTML::Mason \- by Dave Rolsky) \& Spork::Template::Simple (Simplistic version with no dependencies) .Ve .IP "\(bu" 4 template_directory .Sp The directory where spork writes all its templates during \f(CW\*(C`spork \-make\*(C'\fR. Templates will only be written if this directory does not exist. So to force templates to be upgraded, delete this directory. .Sp This directory should be listed in \f(CW\*(C`template_path\*(C'\fR. .IP "\(bu" 4 template_path .Sp A list of template directories to be used by the template processing class. .SH "AUTHOR" .IX Header "AUTHOR" Brian Ingerson .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2004, 2005. Brian Ingerson. All rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP See http://www.perl.com/perl/misc/Artistic.html