LoginHelp/GuideAbout TracPreferences
WikiTimelineRoadmapBrowse SourceView TicketsNew TicketSearchDownloads

source: check_dir/check_dir.pod @ 1254

Revision 1254, 4.3 KB checked in by corti, 3 years ago (diff)

Fixed documentation, spec file not yet OK

Line 
1################################################################################
2# File version information:
3# $Id: check_updates.pod 1249 2011-05-25 08:27:23Z corti $
4# $Revision: 1249 $
5# $HeadURL: https://svn.id.ethz.ch/nagios_plugins/check_updates/check_updates.pod $
6# $Date: 2011-05-25 10:27:23 +0200 (Wed, 25 May 2011) $
7################################################################################
8
9=pod
10
11=head1 NAME
12
13C<check_dir> - a Nagios plugin to monitor the number of files in one or
14more directories.
15
16=head1 DESCRIPTION
17
18check_dir is a Nagios plugin to monitor the number of files in one or
19more directories.
20
21=head1 VERSION
22
23Version 3.0.0
24
25=head1 SYNOPSIS
26
27 check_dir  --dir=dirname --critical=critical --warning=warning
28            [--recursive] [--verbose]
29            [--version|--help]
30
31 Mandatory arguments:
32  --dir,-d        dirname    specify directory (can be repeated)
33  --critical,-c   critical   specify the critical number (or range)
34                             of files
35  --warning,-w    warning    specify warning threshold (range) for
36                             the number of files
37
38 Options:
39  --recursive,-r             perform recursive traversal
40  --version,V                print version number
41  --verbose,-v               be more verbose (can be repeated)
42
43=head1 REQUIRED ARGUMENTS
44
45--dir, --critical and --warning
46
47=head1 OPTIONS
48
49    --dir,-d            directory to check (mandatory, can be repeated)
50
51    --critical,-c       critical number (or range) of files (mandatory)
52
53    --warning,-w        warning threshold (range) for the number of
54                        files (mandatory)
55
56    --help,-h,-?        this help screen
57
58    --recursive,-r      include subdirectories
59   
60    --verbose,-v        increase verbosity (can be repeated)
61
62    --version,-V        prints version information
63
64=head1 EXAMPLE
65
66check_dir --dir=/tmp --dir=/var/tmp --critical=1000 --warning=800
67
68check_dir will check if both the /tmp and /var/tmp have less than 800,
69respectively 1000 files
70
71=head1 DIAGNOSTICS
72
73You can specify multiple --verbose options to increase the program
74verbosity.
75
76=head1 EXIT STATUS
77
780 if OK, 1 in case of a warning, 2 in case of a critical status and 3
79in case of an unkown problem
80
81=head1 DEPENDENCIES
82
83check_dir depends on
84
85=over 4
86
87=item * English
88
89=item * Getopt::Long
90
91=item * Nagios::Plugin
92
93=item * Nagios::Plugin::Getopt
94
95=item * Nagios::Plugin::Range
96
97=item * Nagios::Plugin::Threshold
98
99=item * version
100
101=back
102
103=head1 CONFIGURATION
104
105=head1 INCOMPATIBILITIES
106
107None reported.
108
109=head1 SEE ALSO
110
111Nagios documentation
112
113=head1 BUGS AND LIMITATIONS
114
115No bugs have been reported.
116
117Please report any bugs or feature requests to matteo.corti@id.ethz.ch,
118or through the web interface at
119https://svn.id.ethz.ch/trac/bd_webhosting/newticket
120
121=head1 AUTHOR
122
123Matteo Corti <matteo.corti@id.ethz.ch>
124
125=head1 LICENSE AND COPYRIGHT
126
127Copyright (c) 2007, ETH Zurich.
128
129This module is free software; you can redistribute it and/or modify it
130under the terms of GNU general public license (gpl) version 3.
131See the LICENSE file for details.
132
133=head1 DISCLAIMER OF WARRANTY
134
135BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
136FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
137WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
138PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
139EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
140IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
141PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
142SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME
143THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
144
145IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
146WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
147REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
148TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
149CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
150SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
151RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
152FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
153SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
154DAMAGES.
155
156=head1 ACKNOWLEDGMENTS
157
Note: See TracBrowser for help on using the repository browser.
 

Wichtiger Hinweis:
Diese Website wird in älteren Versionen von Netscape ohne graphische Elemente dargestellt. Die Funktionalität der Website ist aber trotzdem gewährleistet. Wenn Sie diese Website regelmässig benutzen, empfehlen wir Ihnen, auf Ihrem Computer einen aktuellen Browser zu installieren. Weitere Informationen finden Sie auf
folgender Seite.

Important Note:
The content in this site is accessible to any browser or Internet device, however, some graphics will display correctly only in the newer versions of Netscape. To get the most out of our site we suggest you upgrade to the newer browser.
More information

 
© 2005 ETH Zürich | Imprint | 26.09.2007 | Version 0.12
top