INDEXMAKER(1) mrtg
INDEXMAKER(1)
NAME
indexmaker
- Creates index files for mrtg web sites (mrtg-2.9.17)
# 注释 ：indexmaker 用于建立 mrtg 的
index 页面
# 补充 ：mrtg 也可以只靠 mrtg.cfg
就生成图表，但这样需要
# 知道某个 Target 生成的 HTML
文件的名称，比较麻烦。
# 所以 indexmaker
就建立了一个总的页面，在该页面上就可以看到所有被监测的 Target
# 再通过点击某个 Target 的图表来进一步获取该
Target 的对应的 HTML 文件
SYNOPSIS
indexmaker [options] regexp mrtg.cfg [other.cfg ...]
# 注释 ：indexmaker 的格式是
：indexmaker [options] regexp mrtg.cfg [other.cfg...]
# 从上面可以看出 indexmaker
可以读取多个配置文件来生成 index 文件。
OPTIONS
--output=filename set output filename (default:
stdout)
# 注释
：--output= 设置 indexmaker 的输出，默认是输出到屏幕上
--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
--title=text set title of generated index file
--bodyopt=text set body tag options
--pagetop=text insert
this text between and
...
--columns=number show graphs in a table with x columns (default:
2)
# 注释
：--columns= 设置 index 页面要分成多少列，默认是2列。也就是一行显示2个图表
--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)
# 注释
：--sort= 表示按照什么顺序来排列图表
#
可选的方式有 title 、name、descr、original （默认，就是按照 Target 在 mrtg.cfg
中出现的顺序）
--enumerate add a sequence
number to the title of each graph
# 注释 ：--enumerate 表示为每个图表增加一个序号
--width=number set width of graphs (default: not set)
--height=number
--show=day pick which graph to show in the index (default)
--show=week
--show=month
--show=year
--show=none
--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
# 注释
：--section= 设置在每张图表上显示的信息。
# 可选的有
：h1、title、name、descr、portname
--rrdviewer=path path to rrdviewer (default: /cgi-bin/14all.cgi)
--prefix=path path from the location of the index.html to the
graphs
DESCRIPTION
Indexmaker can
create web pages which display the status of an array of
mrtg
interface status pages.
--output filename
set
output filename (default: stdout)
--filter
(title|pagetop|name)(=~|!~)regexp
Several filters may get set.
Each filter can match agains the con-
tents of a specific section
of the mrtg config file. Name refers to
the bit in square brackets
(option[name]: bla).
Depending on the match operator
chosen (=~ or !~) the match will be
positive or
negative.
Note that some shells consider !
a special character. It may be
necessary to type \!~
instead.
--title text
Set title
of generated index file (default: regexp)
--bodyopt text
The
value of this argument gets appended to the tag. This
allows to set document colors. By default this option is set to
bgcolor="#ffffff"
text="#000000" link="#000000" vlink="#000000" alink="#000000"
--columns number
Display graphs in a table with number columns (default: 2)
--sort
title|name|descr|original
Sort the graphs in the page either by
title, by name, by interface
description, or leave them as
is.
--enumerate
Add a
sequence number to the title of each graph
--width number
Set
width of graphs
--height number
Set
the height of the graphs
--show
day|week|month|year|none
Select which graph to show in the index
page. You can supress
images completely with
--show=none.
--section
h1|title|name|description|portname
Select what to use as the title
for each graph in the page. h1 is
the H1 section from pagetop,
title is the graph title, name is the
bit in square brackets
(option[name]: bla), and descr or descrip-
tion is the text from
the Description field of the PageTop (the
Cisco description text
if it's available, otherwise just the inter-
face description).
portname is the "Port Name:" from pagetop.
--rrdviewer path
If
you have set the LogFormat: rrdtool 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)
--prefix path
By
default we assume that the file generated by indexmaker is
stored in WorkDir. If you want to store it somewhere else,
specify how to reach WorkDir 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.
AUTHOR
Tobias
Oetiker <>
LICENSE
GNU
General Public License
COPYRIGHT
2000-2001 Tobias Oetiker <>
3rd Berkeley Distribution
2.9.17 INDEXMAKER(1)
