1INDEXMAKER(1) mrtg INDEXMAKER(1)
2
6 indexmaker - Creates index files for mrtg web sites (mrtg-2.17.10)
7
9 indexmaker [options] mrtg.cfg [other.cfg ...]
10
12 --output=filename set output filename (default: stdout)
13 --filter title=~regexp select targets by matching regexp against titles
15 --filter pagetop=~regexp select targets by matching regexp against pagetop
16 --filter name=~regexp select targets by matching regexp against name
17 --addhead=text insert this text between </TITLE> and </HEAD>
19 --title=text set title of generated index file
20 --subtitle=text add a subtitle to the generated index file
21 --bodyopt=text set body tag options
22 --headlevel=number use <Hnumber> at top of page (default: 1)
23 --pagetop=text insert this text between <BODY> and <H1>...</H1>
24 --pageend=text insert this text after the main body
25 --pagetopend=text use this text for pagetop or pageend if undefined
26 --nolegend do not add the Mrtg legend at the end of the page
27 --columns=number show graphs in a table with x columns (default: 2)
29 --perhost show graphs of the same host on a row
30 --compact try to make a vertically more compact page
31 --optlog log the used command line in the page (default: log)
32 --sort=title sort graphs by title
34 --sort=name sort graphs by their name
35 --sort=descr sort graphs by their description
36 --sort=original leave as is (default)
37 --enumerate add a sequence number to the title of each graph
39 --picfirst place pictures before text (default: text first)
41 --width=number set width of graphs (default: not set)
42 --height=number
43 --sidebyside place text / pictures side by side (default: above/below)
44 --bold use bold text (default: bold)
45 --clicktext make the text link to the inner page (like the image)
46 --show=day pick which graph to show in the index (default)
48 --show=week
49 --show=month
50 --show=year
51 --show=none
52 --section=h1 h1 tag from pagetop as section heading (default)
54 --section=title title as section headings for graphs
55 --section=name graph name as section heading
56 --section=descr graph description as section heading
57 --section=ifname interface name (ifName) as section heading
58 --section=portname port name entry in pagetop as section heading
59 --sectionhost Try to prepend the host to the section heading if missing
60 --rrdviewer=path path to rrdviewer (default: /cgi-bin/14all.cgi)
62 --icondir=path path to icondir
63 --prefix=path path from the location of the index.html to the graphs
64 --headeradd=string add string to the html page header
65 --autoprefix try to set prefix automatically
66 --<opt>-file=file read string argument for option <opt> from file
68
70 Indexmaker can create web pages which display the status of an array of
71 mrtg interface status pages.
72 --output filename
74 set output filename (default: stdout)
75 --filter (title|pagetop|name)(=~|!~)regexp
77 Several filters may get set. Each filter can match against the
78 contents of a specific section of the mrtg config file. Name refers
79 to the bit in square brackets (option[name]: bla).
80 Depending on the match operator chosen (=~ or !~) the match will be
82 positive or negative.
83 Note that some shells consider ! a special character. It may be
85 necessary to type \!~ instead.
86 --title text
88 Set title of generated index file (default: regexp)
89 --bodyopt text
91 The value of this argument gets appended to the <BODY> tag. This
92 allows you to set document colors. By default this option is set
93 to
94 bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000"
96 --columns number
98 Display graphs in a table with number columns (default: 2)
99 --sort title|name|descr|original
101 Sort the graphs in the page either by title, by name, by interface
102 description, or leave them as is.
103 --enumerate
105 Add a sequence number to the title of each graph
106 --width number
108 Set width of graphs
109 --height number
111 Set the height of the graphs
112 --show day|week|month|year|none
114 Select which graph to show in the index page. You can suppress
115 images completely with --show=none.
116 --section h1|title|name|description|portname
118 Select what to use as the title for each graph in the page. h1 is
119 the H1 section from pagetop, title is the graph title, name is the
120 bit in square brackets (option[name]: bla), and descr or
121 description is the text from the Description field of the PageTop
122 (the Cisco description text if it's available, otherwise just the
123 interface description). portname is the "Port Name:" from pagetop.
124 --sectionhost
126 Extract the hostname from the target line (this does not work if
127 the target is a mathematical expression). Prepend the hostname (and
128 a colon) to the section if not already present.
129 --rrdviewer path
131 If you have set the LogFormat: rrdtool property in the mrtg.cfg
132 file, the index will take this into account. The only thing you
133 must tell it is the path to your grapher cgi. (default:
134 /cgi-bin/14all.cgi)
135 --prefix path
137 By default we assume that the file generated by indexmaker is
138 stored in WorkDir. If you want to store it somewhere else,
139 specify how to reach WorkDir from the place where the Index is
140 stored. Note that you have to use '/' as path separator as this
141 will be used in urls. Speaking of which, you can even enter a whole
142 url.
143 --autoprefix path
145 Requires --output. Try to generate the prefix automatically by
146 comparison of the path to the output file set with --output and the
147 Htmldir set in the configuration files. Particularly useful when
148 multiple configuration files are specified, with different Htmldir
149 settings.
150 --optlog
152 Default is logging in the generated page the command line, suppress
153 with --nooptlog . Useful if the commandline contains a complex
154 --pagetop=string which could confuse simple browsers.
155 --someoption-file filename
157 For any someoption which takes a string as parameter you can read
158 the string from a file by adding <-file> to the option keyword. The
159 whole content of the file will be read and used as the string. The
160 file must exist.
161
163 Tobias Oetiker <tobi@oetiker.ch>
164
166 GNU General Public License
167
169 2000-2001 Tobias Oetiker <tobi@oetiker.ch>
1702.17.10 2022-01-19 INDEXMAKER(1)