1INDEXMAKER(1)                        mrtg                        INDEXMAKER(1)
2
3
4

NAME

6       indexmaker - Creates index files for mrtg web sites (mrtg-2.15.1)
7

SYNOPSIS

9       indexmaker [options] mrtg.cfg [other.cfg ...]
10

OPTIONS

12        --output=filename   set output filename (default: stdout)
13
14        --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
18        --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
28        --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
33        --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
38        --enumerate         add a sequence number to the title of each graph
39
40        --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
47        --show=day          pick which graph to show in the index (default)
48        --show=week
49        --show=month
50        --show=year
51        --show=none
52
53        --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
60        --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
66        --<opt>-file=file   read string argument for option <opt> from file
67

DESCRIPTION

69       Indexmaker can create web pages which display the status of an array of
70       mrtg interface status pages.
71
72       --output filename
73           set output filename (default: stdout)
74
75       --filter (titlepagetopname)(=~!~)regexp
76           Several filters may get set.  Each filter can match agains the con‐
77           tents of a specific section of the mrtg config file. Name refers to
78           the bit in square brackets (option[name]: bla).
79
80           Depending on the match operator chosen (=~ or !~) the match will be
81           positive or negative.
82
83           Note that some shells consider ! a special character.  It may be
84           necessary to type \!~ instead.
85
86       --title text
87           Set title of generated index file (default: regexp)
88
89       --bodyopt text
90           The value of this argument gets appended to the <BODY> tag. This
91           allows to set document colors.  By default this option is set to
92
93            bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000"
94
95       --columns number
96           Display graphs in a table with number columns (default: 2)
97
98       --sort titlenamedescroriginal
99           Sort the graphs in the page either by title, by name, by interface
100           description, or leave them as is.
101
102       --enumerate
103           Add a sequence number to the title of each graph
104
105       --width number
106           Set width of graphs
107
108       --height number
109           Set the height of the graphs
110
111       --show dayweekmonthyearnone
112           Select which graph to show in the index page. You can supress
113           images completely with --show=none.
114
115       --section h1titlenamedescriptionportname
116           Select what to use as the title for each graph in the page.  h1 is
117           the H1 section from pagetop, title is the graph title, name is the
118           bit in square brackets (option[name]: bla), and descr or descrip‐
119           tion is the text from the Description field of the PageTop (the
120           Cisco description text if it's available, otherwise just the inter‐
121           face description). portname is the "Port Name:" from pagetop.
122
123       --sectionhost
124           Extract the hostname from the target line (this does not work if
125           the target is a mathematial expression). Prepend the hostname (and
126           a colon) to the section if not already present.
127
128       --rrdviewer path
129           If you have set the LogFormat: rrdtool property in the mrtg.cfg
130           file, the index will take this into account. The only thing you
131           must tell it is the path to your grapher cgi. (default:
132           /cgi-bin/14all.cgi)
133
134       --prefix path
135           By  default we assume    that  the file generated by indexmaker is
136           stored in WorkDir.  If you want to  store it somewhere   else,
137           specify how to reach WorkDir  from  the place where the Index is
138           stored. Note that you have to use '/' as path separator as this
139           will be used in urls. Speaking of which, you can even enter a whole
140           url.
141
142       --autoprefix path
143           Requires --output.  Try to generate the prefix automatically by
144           comparision of the path to the output file set with --output and
145           the Htmldir set in the configuration files.  Particulary useful
146           when multiple configuration files are specified, with different
147           Htmldir settings.
148
149       --optlog
150           Default is logging in the generated page the command line, suppress
151           with --nooptlog . Useful if the commandline contains a complex
152           --pagetop=string which could confuse simple browsers.
153
154       --someoption-file filename
155           For any someoption which takes a string as parameter you can read
156           the string from a file by adding <-file> to the option keyword. The
157           whole content of the file will be read and used as the string. The
158           file must exist.
159

AUTHOR

161       Tobias Oetiker <tobi@oetiker.ch>
162

LICENSE

164       GNU General Public License
165
167       2000-2001 Tobias Oetiker <tobi@oetiker.ch>
168
169
170
1712.15.1                            2007-02-01                     INDEXMAKER(1)
Impressum