Big update of Clearadm
[clearscm.git] / clearadm / readme.cgi
1 #!/usr/local/bin/perl
2
3 =pod
4
5 =head1 NAME $RCSfile: readme.cgi,v $
6
7 Display the README file
8
9 =head1 VERSION
10
11 =over
12
13 =item Author
14
15 Andrew DeFaria <Andrew@ClearSCM.com>
16
17 =item Revision
18
19 $Revision: 1.2 $
20
21 =item Created:
22
23 Mon Oct 25 11:10:47 PDT 2008
24
25 =item Modified:
26
27 $Date: 2011/02/14 14:54:19 $
28
29 =back
30
31 =head1 DESCRIPTION
32
33 This script displays the README file
34
35 =cut
36
37 use strict;
38 use warnings;
39
40 use FindBin;
41 use Getopt::Long;
42
43 use CGI qw (:standard *table start_Tr end_Tr);
44 use CGI::Carp 'fatalsToBrowser';
45
46 use lib "$FindBin::Bin/lib", "$FindBin::Bin/../lib";
47
48 use ClearadmWeb;
49 use Display;
50 use Utils;
51
52 # Main
53 GetOptions (
54   'usage'        => sub { Usage },
55   'verbose'      => sub { set_verbose },
56   'debug'        => sub { set_debug },
57 ) or Usage "Invalid parameter";
58
59 # Announce ourselves
60 verbose "$ClearadmWeb::APPNAME V$ClearadmWeb::VERSION";
61
62 heading;
63
64 display '<pre><blockquote>';
65
66 display h1 {class => 'center'}, "$ClearadmWeb::APPNAME: README";
67
68 display $_
69   foreach (ReadFile 'README');
70
71 display '</pre></blockquote>';
72
73 footing;
74
75 =pod
76
77 =head1 CONFIGURATION AND ENVIRONMENT
78
79 DEBUG: If set then $debug is set to this level.
80
81 VERBOSE: If set then $verbose is set to this level.
82
83 TRACE: If set then $trace is set to this level.
84
85 =head1 DEPENDENCIES
86
87 =head2 Perl Modules
88
89 L<CGI|CGI.html>
90
91 L<CGI::Carp|CGI::Carp>
92
93 L<FindBin>
94
95 L<Getopt::Long|Getopt::Long>
96
97 =head2 ClearSCM Perl Modules
98
99 =begin man 
100
101  Display
102  Utils
103
104 =end man
105
106 =begin html
107
108 <blockquote>
109 <a href="http://clearscm.com/php/scm_man.php?file=clearadm/lib/ClearadmWeb.pm">ClearadmWeb</a><br>
110 <a href="http://clearscm.com/php/scm_man.php?file=lib/Display.pm">Display</a><br>
111 <a href="http://clearscm.com/php/scm_man.php?file=lib/Utils.pm">Utils</a><br>
112 </blockquote>
113
114 =end html
115
116 =head1 BUGS AND LIMITATIONS
117
118 There are no known bugs in this script
119
120 Please report problems to Andrew DeFaria <Andrew@ClearSCM.com>.
121
122 =head1 LICENSE AND COPYRIGHT
123
124 Copyright (c) 2010, ClearSCM, Inc. All rights reserved.
125
126 =cut