source: xas/trunk/templates/procedure.sh @ 1f7fb7c704e27b311427c5e6e34839af55d3bd25

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

updated documentation

  • Property mode set to 100644
Line 
1#!/usr/bin/perl
2# ============================================================================
3#
4# TITLE:
5#
6# FACILITY:    XAS
7#
8# ABSTRACT:
9#
10# ENVIRONMENT: The XAS Middleware Environment
11#
12# PARAMETERS:
13#              --help         prints out a helpful help message
14#              --debug        toggles debug output
15#              --alerts       toggles alert notification
16#              --manual       prints out the procedures manual
17#              --version      prints out the procedures version
18#              --priority     change the alerts priority
19#              --facility     change the alerts facility
20#              --log-file     name of the log file
21#              --log-type     toggles the log type
22#              --log-facility changes the log facility to use
23#
24# RETURNS:
25#              0 - success
26#              1 - failure
27#
28# Version      Author                                              Date
29# -------      ----------------------------------------------      -----------
30# 0.01         Kevin Esteb                                         02-Apr-2009
31#
32# ============================================================================
33#
34
35#use lib "../lib";
36use XAS::Apps::xxxx;
37
38main: {
39
40    my $app = XAS::Apps::xxxx->new(
41        -throws   => 'changeme',
42        -facility => 'systems',
43        -priority => 'low',
44    );
45
46    exit $app->run();
47
48}
49
50__END__
51
52=head1 NAME
53
54changeme - the great new changeme procedure
55
56=head1 SYNOPSIS
57
58changeme [--help] [--debug] [--manual] [--version]
59
60 options:
61   --help         outputs simple help text
62   --debug        toogles debugging output
63   --alerts       toogles alert notifications
64   --manual       outputs the procedures manual
65   --version      outputs the apps version
66   --facility     change the alerts facility
67   --priority     change the alerts priority
68   --log-file     name of the log file
69   --log-type     toggles the log type
70   --log-facility changes the log facility
71
72=head1 DESCRIPTION
73
74This procedure is a simple template to help write standardized procedures.
75
76=head1 CONFIGURATION
77
78Please refer to L<XAS::Apps::xxxx|XAS::Apps::xxxx> for configuration file
79information.
80
81=head1 OPTIONS AND ARGUMENTS
82
83=over 4
84
85=item B<--help>
86
87Displays a simple help message.
88
89=item B<--debug>
90
91Turns on debbuging.
92
93=item B<--alerts>
94
95Togggles alert notification.
96
97=item B<--manual>
98
99The complete documentation.
100
101=item B<--version>
102
103Prints out the apps version
104
105=item B<--facility>
106
107This changs the alerts facility, It overrides the defaults.
108
109=item B<--priority>
110
111This changes the alerts priority. It overrides the defaults.
112
113=item B<--log-type>
114
115Toggles the log type. Defaults to 'console'. Can be 'console', 'file',
116'json' or 'syslog'.
117
118=item B<--log-file>
119
120Optional logfile. When specified the log type is set to 'file'.
121
122=item B<--log-facility>
123
124Toggles the log facilty. Defaults to 'local6'. This follows syslog
125convention.
126
127=back
128
129=head1 EXIT CODES
130
131 0 - success
132 1 - failure
133
134=head1 SEE ALSO
135
136=over 4
137
138=item L<XAS|XAS>
139
140=back
141
142=head1 AUTHOR
143
144Kevin L. Esteb, E<lt>kevin@kesteb.usE<gt>
145
146=head1 COPYRIGHT AND LICENSE
147
148Copyright (c) 2012-2019 Kevin L. Esteb
149
150This is free software; you can redistribute it and/or modify it under
151the terms of the Artistic License 2.0. For details, see the full text
152of the license at http://www.perlfoundation.org/artistic_license_2_0.
153
154=cut
Note: See TracBrowser for help on using the repository browser.