GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SPORK::CONFIG (3)

.ds Aq ’

NAME

Spork::Config - Spork Configuration Class

CONTENTS

SETTINGS

This is a list of all the current configuration options in alphabetical order:
o author_email

The presentation author’s email address.

o author_name

The presentation author’s full name.

o author_webpage

The presentation author’s webpage.

o auto_scrolldown

When a multipart slide is too long for the display, force it to scroll all the way down when you link to it.

o banner_bgcolor

Background color for the banner boxes at the top and bottom of each slide.

o character_encoding

I18N character encoding. You probably want ’utf-8’.

o copyright_string

A copyright message to be displayed on each slide.

o download_method

Which program to use when downloading images. Possible values are:



    wget - default
    curl
    lwp



o file_base

A path to prepend to any relative file path provided to the <file<... >> directive.

o file_base

A path to prepend to any relative file path provided to the <file<... >> directive.

o formatter_class

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.

o image_width

This is the default width that all images in your slideshow will be scaled to.

o link_index

Text for link to index page.

o link_next

Text for link to next page.

o link_previous

Text for link to previous page.

o logo_image

A small image to put at the bottom of each slide. You can leave this value empty if you don’t have a logo.

o mouse_controls

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.

o show_controls

If this is turned off, the control links (previous, index, next) will not display.

o slides_directory

The directory where all your slides will be written to when you do spork -make.

o slides_file

The name of the file that you write all of your slides in.

o start_command

The command that gets executed when you type spork -make.

o template_class

The Perl module that is used for template processing. This module also contains the default templates that are used. Possible values are:



    Spork::Template::TT2    (Template Toolkit - default)
    Spork::Template::Mason  (HTML::Mason - by Dave Rolsky)
    Spork::Template::Simple (Simplistic version with no dependencies)



o template_directory

The directory where spork writes all its templates during spork -make. Templates will only be written if this directory does not exist. So to force templates to be upgraded, delete this directory.

This directory should be listed in template_path.

o template_path

A list of template directories to be used by the template processing class.

AUTHOR

Brian Ingerson <INGY@cpan.org>

COPYRIGHT

Copyright (c) 2004, 2005. Brian Ingerson. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SPORK::CONFIG (3) 2005-03-25

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.