1.\" 2.\" Copyright (c) 2006, Stefan Walter 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 9.\" * Redistributions of source code must retain the above 10.\" copyright notice, this list of conditions and the 11.\" following disclaimer. 12.\" * Redistributions in binary form must reproduce the 13.\" above copyright notice, this list of conditions and 14.\" the following disclaimer in the documentation and/or 15.\" other materials provided with the distribution. 16.\" * The names of contributors to this software may not be 17.\" used to endorse or promote products derived from this 18.\" software without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 24.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 31.\" DAMAGE. 32.\" 33.\" 34.\" CONTRIBUTORS 35.\" Stef Walter <stef@memberwebs.com> 36.\" 37.Dd August, 2006 38.Dt rrdbot-create 8 39.Os rrdbot 40.Sh NAME 41.Nm rddbot-create 42.Nd create the RRD files for 43.Xr rrdbotd 8 44to write values to. 45.Sh SYNOPSIS 46.Nm 47.Op Fl nv 48.Op Fl c Ar confdir 49.Op Fl w Ar workdir 50.Nm 51.Fl V 52.Sh DESCRIPTION 53.Xr rrdbotd 8 54is an SNMP polling daemon. It writes out the polled values to an 55.Xr rrdtool 1 56database. The 57.Nm 58tool can create those RRD files for you. 59.Pp 60.Nm 61uses configuration files, one per RRD, to determine where and how to do its 62work. Details of these files and which settings to put in them are found in the 63.Xr rrdbot.conf 5 64manual under the CREATE SECTION heading. 65.Pp 66By default th RRD files are created in the default work directory (see the FILE 67LOCATIONS section below). Files that already exist are not overwritten or 68modified in any way. 69.Pp 70You can use the 71.Fl n 72option to see the 73.Xr rrdtool 1 74commands that would be executed. This is useful if you want to customize the 75commands before running them. 76.Sh OPTIONS 77The options are as follows. 78.Bl -tag -width Fl 79.It Fl c Ar confdir 80The directory in which configuration files are stored. See below for info 81on the various file locations. 82.It Fl n 83Rather than create the files, print the 84.Xr rrdtool 1 85commands that would be used to create the files. 86.It Fl v 87Print verbose messages. 88.It Fl V 89Prints the version of 90.Nm 91and the locations of the configuration files, RRD files etc. 92.It Fl w Ar workdir 93The default directory where to look for RRD files. See below for info on 94the various file locations. 95.El 96.Sh FILE LOCATIONS 97To determine the default location for the configuration files and RRD files 98run this command: 99.Bd -literal -offset indent 100# rrdbotd -V 101.Ed 102.Pp 103The configuration files for SNMP pollers are laid out in a directory tree, 104with one file per RRD. Subdirectories can be used to organize the 105configuration files. The contents of the configuration files are described 106in 107.Xr rrdbot.conf 5 . 108.Pp 109By default the RRD files mirror the directory structure and names of the 110configuration files, with an 111.Pa .rrd 112extension appended to the filename. 113.Pp 114For example if your configuration files are in a structure like the following: 115.Bd -literal -offset indent 116/usr/local/etc/rrdbot/ 117 gateways/ 118 gateway-load.conf 119 gateway-traffic.conf 120 temperature/ 121 inside-temperature.conf 122 outside-temperature.conf 123 machine-load.conf 124.Ed 125.Pp 126Then the default RRD files would be in a similar directory structure: 127.Bd -literal -offset indent 128/var/db/rrdbot/ 129 gateways/ 130 gateway-load.conf.rrd 131 gateway-traffic.conf.rrd 132 temperature/ 133 inside-temperature.conf.rrd 134 outside-temperature.conf.rrd 135 machine-load.conf.rrd 136.Ed 137.Pp 138The default location for an RRD file can be overridden by using the 139.Ar rrd 140option in the configuration file. 141.Sh SEE ALSO 142.Xr rrdbotd 8 , 143.Xr rrdbot.conf 5 , 144.Xr rrdbot-get 1 , 145.Xr rrdtool 1 146.Sh AUTHOR 147.An Stef Walter Aq stef@memberwebs.com 148