Zane C. Bowers-Hadley > Toader-0.4.0 > toader-page

Download:
Toader-0.4.0.tar.gz

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Source   Latest Release: Toader-1.1.2

NAME ^

toader-page - A tool for manipulating a Toader page.

SYNOPSIS ^

toader-page -a be -n <page>

toader-page -a bg -n <page>

toader-page -a bs -n <page> -b <body file>

toader-page -a create -n <page>

toader-page -a fg -n <page>

toader-page -a fs -n <page> -f <from>

toader-page -a ls

toader-page -a pa -n <page> -F <file>

toader-page -a pe -n <page> -F <file>

toader-page -a pl -n <page>

toader-page -a pr -n <page> -F <file>

toader-page -a rp -n <page>

toader-page -a sg -n <page>

toader-page -a ss -n <page> -s <summary>

toader-page -a rc [-p] -n <page>

toader-page -a render -n <page>

toader-page -a rg -n <page>

toader-page -a rs -n <page> -r <renderer>

toader-page -a summary

toader-page -a sg -p <page>

toader-page -a ss -p <page> -s <summary>

SWITCHES ^

-a <action>

The specified action to perform.

-b <body file>

The body file to use.

-F <file>

The file to use, file part to remove, or directory to extract them to.

-p

Print the rendered content.

-r <renderer>

The renderer to use.

-s <summary>

The summary to use.

ACTIONS ^

be

Edits the body of the page.

Required switches...

        -n <name>

bg

Prints the body of the page.

Required switches...

        -n <name>

bs

Sets the body of the page.

Required switches...

    -b <body file>
        -n <name>

fg

Gets the author/from for the page.

Required switches...

        -n <name>

fs

Sets the author/from for the page.

Required switches...

    -f <from>
        -n <name>

ls

List the pages.

pa

Adds a subpart.

Required switches...

    -F <file>
        -n <name>

pe

Extracts the subparts.

Required switches...

    -F <directory>
        -n <name>

pl

List the subparts.

Required switches...

        -n <name>

pr

Removes a subpart.

Required switches...

    -F <file>
        -n <name>

rp

Prints the raw page.

Required switches...

        -n <name>
    -r <renderer>

sg

Gets the summary

Required switches...

        -n <name>

ss

Sets the summary.

Required switches...

        -n <name>
    -s <summary>

summary

Print a summary of the pages.

rc

Checks if the content of a entry can be rendered.

Requires switches...

        -n <name>

Optional switches...

    -p

render

Renders the page.

Required switches...

        -n <name>

rg

Gets the renderer.

Required switches...

        -n <name>

rs

Sets the renderer.

Required switches...

        -n <name>
    -r <renderer>

Environmental Variables: ^

Toader_from

The author's email address. Overrode by -f.

Toader_outputdir

The output directory to use.

Page Summary Formatting: ^

The page summary is a Text::Template template. The default is '[$name] - [$from] - [$summary]' The delimiters are '[' and ']' and the variables are as below.

    $from - This is the author.
    $name - This is the name for a page.
    $renderer - This is the renderer to use.
    $summary - This is the page summary.

AUTHOR ^

Copyright (c) 2011, Zame C. Bowers-Hadley <vvelox@vvelox.net>

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS` OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

OSNAMES ^

unix

README ^

toader-page - A tool for manipulating a Toader page.

syntax highlighting: