.\" Automatically generated by Pod::Man version 1.15 .\" Tue Jun 5 13:09:39 2001 .\" .\" Standard preamble: .\" ====================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Ip \" List item .br .ie \\n(.$>=3 .ne \\$3 .el .ne 3 .IP "\\$1" \\$2 .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used .\" to do unbreakable dashes and therefore won't be available. \*(C` and .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and .\" index entries marked with X<> in POD. Of course, you'll have to process .\" the output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it .\" makes way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. .bd B 3 . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ====================================================================== .\" .IX Title "INDEXMAKER 1" .TH INDEXMAKER 1 "2.9.17" "2001-06-05" "mrtg" .UC .SH "NAME" indexmaker \- Creates index files for mrtg web sites (mrtg-2.9.17) .SH "SYNOPSIS" .IX Header "SYNOPSIS" indexmaker [options] regexp mrtg.cfg [other.cfg ...] .SH "OPTIONS" .IX Header "OPTIONS" .Vb 1 \& --output=filename set output filename (default: stdout) .Ve .Vb 3 \& --filter title=~regexp select targets by matching regexp against titles \& --filter pagetop=~regexp select targets by matching regexp against pagetop \& --filter name=~regexp select targets by matchin regexp against name .Ve .Vb 3 \& --title=text set title of generated index file \& --bodyopt=text set body tag options \& --pagetop=text insert this text between <BODY> and <H1>...</H1> .Ve .Vb 1 \& --columns=number show graphs in a table with x columns (default: 2) .Ve .Vb 4 \& --sort=title sort graphs by title \& --sort=name sort graphs by their name \& --sort=descr sort graphs by their description \& --sort=original leave as is (default) .Ve .Vb 1 \& --enumerate add a sequence number to the title of each graph .Ve .Vb 2 \& --width=number set width of graphs (default: not set) \& --height=number .Ve .Vb 5 \& --show=day pick which graph to show in the index (default) \& --show=week \& --show=month \& --show=year \& --show=none .Ve .Vb 5 \& --section=h1 h1 tag from pagetop as section heading (default) \& --section=title title as section headings for graphs \& --section=name graph name as section heading \& --section=descr graph description as section heading \& --section=portname port name entry in pagetop as section heading .Ve .Vb 2 \& --rrdviewer=path path to rrdviewer (default: /cgi-bin/14all.cgi) \& --prefix=path path from the location of the index.html to the graphs .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBIndexmaker\fR can create web pages which display the status of an array of mrtg interface status pages. .Ip "\fB\*(--output\fR \fIfilename\fR" 4 .IX Item "output filename" set output filename (default: stdout) .Ip "\fB\*(--filter\fR (\fBtitle\fR|\fBpagetop\fR|\fBname\fR)(\fB=~\fR|\fB!~\fR)\fIregexp\fR" 4 .IX Item "filter (title|pagetop|name)(=~|!~)regexp" Several filters may get set. Each filter can match agains the contents of a specific section of the mrtg config file. \fBName\fR refers to the bit in square brackets (option[name]: bla). .Sp Depending on the match operator chosen (\fB=~\fR or \fB!~\fR) the match will be positive or negative. .Sp Note that some shells consider \fB!\fR a special character. It may be necessary to type \fB\e!~\fR instead. .Ip "\fB\*(--title\fR \fItext\fR" 4 .IX Item "title text" Set title of generated index file (default: regexp) .Ip "\fB\*(--bodyopt\fR \fItext\fR" 4 .IX Item "bodyopt text" The value of this argument gets appended to the <\s-1BODY\s0> tag. This allows to set document colors. By default this option is set to .Sp .Vb 1 \& bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000" .Ve .Ip "\fB\*(--columns\fR \fInumber\fR" 4 .IX Item "columns number" Display graphs in a table with \fInumber\fR columns (default: 2) .Ip "\fB\*(--sort\fR \fBtitle\fR|\fBname\fR|\fBdescr\fR|\fBoriginal\fR" 4 .IX Item "sort title|name|descr|original" Sort the graphs in the page either by \fBtitle\fR, by \fBname\fR, by interface \&\fBdescr\fRiption, or leave them as is. .Ip "\fB\*(--enumerate\fR" 4 .IX Item "enumerate" Add a sequence number to the title of each graph .Ip "\fB\*(--width\fR \fInumber\fR" 4 .IX Item "width number" Set width of graphs .Ip "\fB\*(--height\fR \fInumber\fR" 4 .IX Item "height number" Set the height of the graphs .Ip "\fB\*(--show\fR \fBday\fR|\fBweek\fR|\fBmonth\fR|\fByear\fR|\fBnone\fR" 4 .IX Item "show day|week|month|year|none" Select which graph to show in the index page. You can supress images completely with \fB\*(--show=none\fR. .Ip "\fB\*(--section\fR \fBh1\fR|\fBtitle\fR|\fBname\fR|\fBdescription\fR|\fBportname\fR" 4 .IX Item "section h1|title|name|description|portname" Select what to use as the title for each graph in the page. \fBh1\fR is the H1 section from pagetop, \fBtitle\fR is the graph title, \fBname\fR is the bit in square brackets (option[name]: bla), and \fBdescr\fR or \&\fBdescription\fR is the text from the Description field of the PageTop (the Cisco description text if it's available, otherwise just the interface description). \fBportname\fR is the \f(CW\*(C`Port Name:\*(C'\fR from pagetop. .Ip "\fB\*(--rrdviewer\fR \fIpath\fR" 4 .IX Item "rrdviewer path" If you have set the \fBLogFormat: rrdtool\fR property in the mrtg.cfg file, the index will take this into account. The only thing you must tell it is the path to your grapher cgi. (default: /cgi-bin/14all.cgi) .Ip "\fB\*(--prefix\fR \fIpath\fR" 4 .IX Item "prefix path" By default we assume that the file generated by indexmaker is stored in \&\fIWorkDir\fR. If you want to store it somewhere else, specify how to reach \&\fIWorkDir\fR from the place where the Index is stored. Note that you have to use '/' as path separator as this will be used in urls. Speaking of which, you can even enter a whole url. .SH "AUTHOR" .IX Header "AUTHOR" Tobias Oetiker <tobi@oetiker.ch> .SH "LICENSE" .IX Header "LICENSE" \&\s-1GNU\s0 General Public License .SH "COPYRIGHT" .IX Header "COPYRIGHT" 2000\-2001 Tobias Oetiker <tobi@oetiker.ch>