1INDEXMAKER(1) mrtg INDEXMAKER(1)
2
6 indexmaker - Creates index files for mrtg web sites (mrtg-2.17.4)
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 matchin 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=portname port name entry in pagetop as section heading
58 --sectionhost Try to prepend the host to the section heading if missing
59 --rrdviewer=path path to rrdviewer (default: /cgi-bin/14all.cgi)
61 --icondir=path path to icondir
62 --prefix=path path from the location of the index.html to the graphs
63 --headeradd=string add string to the html page header
64 --autoprefix try to set prefix automatically
65 --<opt>-file=file read string argument for option <opt> from file
67
69 Indexmaker can create web pages which display the status of an array of
70 mrtg interface status pages.
71 --output filename
73 set output filename (default: stdout)
74 --filter (title|pagetop|name)(=~|!~)regexp
76 Several filters may get set. Each filter can match agains the
77 contents of a specific section of the mrtg config file. Name refers
78 to the bit in square brackets (option[name]: bla).
79 Depending on the match operator chosen (=~ or !~) the match will be
81 positive or negative.
82 Note that some shells consider ! a special character. It may be
84 necessary to type \!~ instead.
85 --title text
87 Set title of generated index file (default: regexp)
88 --bodyopt text
90 The value of this argument gets appended to the <BODY> tag. This
91 allows you to set document colors. By default this option is set
92 to
93 bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000"
95 --columns number
97 Display graphs in a table with number columns (default: 2)
98 --sort title|name|descr|original
100 Sort the graphs in the page either by title, by name, by interface
101 description, or leave them as is.
102 --enumerate
104 Add a sequence number to the title of each graph
105 --width number
107 Set width of graphs
108 --height number
110 Set the height of the graphs
111 --show day|week|month|year|none
113 Select which graph to show in the index page. You can supress
114 images completely with --show=none.
115 --section h1|title|name|description|portname
117 Select what to use as the title for each graph in the page. h1 is
118 the H1 section from pagetop, title is the graph title, name is the
119 bit in square brackets (option[name]: bla), and descr or
120 description is the text from the Description field of the PageTop
121 (the Cisco description text if it's available, otherwise just the
122 interface description). portname is the "Port Name:" from pagetop.
123 --sectionhost
125 Extract the hostname from the target line (this does not work if
126 the target is a mathematial expression). Prepend the hostname (and
127 a colon) to the section if not already present.
128 --rrdviewer path
130 If you have set the LogFormat: rrdtool property in the mrtg.cfg
131 file, the index will take this into account. The only thing you
132 must tell it is the path to your grapher cgi. (default:
133 /cgi-bin/14all.cgi)
134 --prefix path
136 By default we assume that the file generated by indexmaker is
137 stored in WorkDir. If you want to store it somewhere else,
138 specify how to reach WorkDir from the place where the Index is
139 stored. Note that you have to use '/' as path separator as this
140 will be used in urls. Speaking of which, you can even enter a whole
141 url.
142 --autoprefix path
144 Requires --output. Try to generate the prefix automatically by
145 comparision of the path to the output file set with --output and
146 the Htmldir set in the configuration files. Particulary useful
147 when multiple configuration files are specified, with different
148 Htmldir settings.
149 --optlog
151 Default is logging in the generated page the command line, suppress
152 with --nooptlog . Useful if the commandline contains a complex
153 --pagetop=string which could confuse simple browsers.
154 --someoption-file filename
156 For any someoption which takes a string as parameter you can read
157 the string from a file by adding <-file> to the option keyword. The
158 whole content of the file will be read and used as the string. The
159 file must exist.
160
162 Tobias Oetiker <tobi@oetiker.ch>
163
165 GNU General Public License
166
168 2000-2001 Tobias Oetiker <tobi@oetiker.ch>
1692.17.4 2012-01-12 INDEXMAKER(1)