Zane C. Bowers-Hadley > Toader > toader-entry

Download:
Toader-1.1.2.tar.gz

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Source  

NAME ^

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

SYNOPSIS ^

toader-entry -a be -e <entry>

toader-entry -a bg -e <entry>

toader-entry -a bs -e <entry> -b <body file>

toader-entry -a create

toader-entry -a fg -e <entry>

toader-entry -a fs -e <entry> -f <from>

toader-entry -a ls

toader-entry -a pa -e <entry> -F <file>

toader-entry -a pe -e <entry> -F <file>

toader-entry -a pl -e <entry>

toader-entry -a pr -e <entry> -F <file>

toader-entry -a rc [-p] -e <entry>

toader-entry -a render -e <entry>

toader-entry -a rg -e <entry>

toader-entry -a rm -e <entry>

toader-entry -a rp -e <entry>

toader-entry -a rs -e <entry> -r <renderer>

toader-entry -a sg -e <entry>

toader-entry -a ss -e <entry> -s <summary>

toader-entry -a summary

toader-entry -a tg -e <entry>

toader-entry -a ts -e <entry> -t <title>

SWITCHES ^

-a <action>

The specified action to perform.

-b <body file>

The body file to use.

-f <from>

The author's email address.

-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.

-S <summary template>

The template to use for the summary.

-t <title>

The title for the new entry.

ACTIONS ^

be

Edits the body of the specified entry.

Required switches...

    -e <entry>

bg

Prints the body of the specified entry.

bs

Sets the body of the specified entry.

Required switches...

    -b <body file>
    -e <entry>

create

Creates a new entry and print the new entry name.

fg

Gets the author/from.

Required switches...

    -e <entry>

fs

Sets the author/from.

Required switches...

    -e <entry>
    -f <from>

ls

Lists the entries in the specified entry.

pa

Adds a subpart.

Required switches...

    -e <entry>
    -F <file>

pe

Extracts the subparts.

Required switches...

    -e <entry>
    -F <directory>

pl

List the subparts.

pr

Removes a subpart.

Required switches...

    -e <entry>
    -F <file>

rm

Removes the specified entry.

Required switches...

    -e <entry>

rp

Prints the raw directory.

Required switches...

    -e <entry>
    -r <renderer>

rc

Checks if the content of a entry can be rendered.

Optional switches...

    -e <entry>
    -p

render

Renders the entry.

Optional switches...

    -e <entry>

rg

Gets the renderer.

rs

Sets the renderer.

Required switches...

    -e <entry>
    -r <renderer>

sg

Gets the summary

Required switches...

    -e <entry>

ss

Sets the summary.

Required switches...

    -e <entry>
    -s <summary>

ts

Sets the title.

Required switches...

    -e <entry>
    -r <title>

tg

Gets the title.

Required switches...

    -e <entry>
    -r <title>

Environmental Variables: ^

Toader_outputdir

The output directory to use.

Toader_from

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

Toader_entry_summary

The formatting for the display of the summary of the entries.

Entry Summary Formatting: ^

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

    $id - This is the entry ID.
    $from - This is the author.
    $title - This is the entry title.
    $renderer - This is the renderer to use.
    $summary - This is the entry summary.

AUTHOR ^

Copyright (c) 2013, 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-entry - A tool for manipulating a Toader entry.

syntax highlighting: