source: xas/trunk/templates/program.pm @ 1f7fb7c704e27b311427c5e6e34839af55d3bd25

Revision 1f7fb7c704e27b311427c5e6e34839af55d3bd25, 1.8 KB checked in by Kevin L. Esteb <kevin@…>, 19 months ago (diff)

updated documentation

  • Property mode set to 100644
Line 
1package XAS::Apps:: ;
2
3our $VERSION = '0.01';
4
5use XAS::Class
6  debug   => 0,
7  version => $VERSION,
8  base    => 'XAS::Lib::App',
9;
10
11# ----------------------------------------------------------------------
12# Public Methods
13# ----------------------------------------------------------------------
14
15sub setup {
16    my $self = shift;
17
18}
19
20sub main {
21    my $self = shift;
22
23    $self->setup();
24   
25}
26
27sub options {
28    my $self = shift;
29
30    return {};
31
32}
33
34# ----------------------------------------------------------------------
35# Private Methods
36# ----------------------------------------------------------------------
37
381;
39
40__END__
41
42=head1 NAME
43
44XAS::Apps::xxxx - A class for the XAS environment
45
46=head1 SYNOPSIS
47
48 use XAS::Apps::xxxx ;
49
50 my $app = XAS::Apps::xxxx->new(
51     -throws   => 'changeme',
52     -priority => 'low',
53     -facility => 'system',
54 );
55
56 exit $app->run;
57
58=head1 DESCRIPTION
59
60=head1 CONFIGURATION
61
62The configuration file uses the familiar Windows .ini format. It has the
63following stanza.
64
65 [xxxx: xxxx]
66 property = value
67
68Where the section header "xxxx:" may have addtional qualifiers and repeated
69as many times as needed. These qualifiers must be unique.
70
71The following properties may be used.
72
73=over 4
74
75=item B<property>
76
77=back
78
79=head1 METHODS
80
81=head2 setup
82
83This method will configure the process.
84
85=head2 main
86
87This method will start the processing.
88
89=head2 options
90
91This method provides these additonal cli options.
92
93=over 4
94
95=back
96
97=head1 SEE ALSO
98
99=over 4
100
101=item L<XAS|XAS>
102
103=back
104
105=head1 AUTHOR
106
107Kevin L. Esteb, E<lt>kevin@kesteb.usE<gt>
108
109=head1 COPYRIGHT AND LICENSE
110
111Copyright (c) 2012-2019 Kevin L. Esteb
112
113This is free software; you can redistribute it and/or modify it under
114the terms of the Artistic License 2.0. For details, see the full text
115of the license at http://www.perlfoundation.org/artistic_license_2_0.
116
117=cut
Note: See TracBrowser for help on using the repository browser.