INDEXMAKER(1)

🌸 NAME 🌸

indexmaker — creates index files for mrtg web sites (this is the mrtg-2.17.10 manual, bestie 💖)

🦋 SYNOPSIS 🦋

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

✨ OPTIONS ✨

• --output=filename — sets the output filename (default: stdout). no file? it just screams into your terminal 💅
• --filter title=~regexp — hand-pick targets by matching a regexp against their titles
• --filter pagetop=~regexp — hand-pick targets by matching a regexp against pagetop
• --filter name=~regexp — hand-pick targets by matching a regexp against name
• --addhead=text — drops this text in between </TITLE> and </HEAD>
• --title=text — sets the title of the generated index file
• --subtitle=text — adds a subtitle to the generated index file, cute
• --bodyopt=text — sets the body tag options
• --headlevel=number — uses <Hnumber> at the top of the page (default: 1)
• --pagetop=text — inserts this text between <BODY> and <H1>...</H1>
• --pageend=text — inserts this text after the main body
• --pagetopend=text — uses this text for pagetop or pageend if undefined
• --nolegend — do not add the Mrtg legend at the end of the page
• --columns=number — shows graphs in a table with x columns (default: 2)
• --perhost — shows graphs of the same host on a row
• --compact — tries to make a vertically more compact page
• --optlog — logs the used command line in the page (default: log)
• --sort=title — sorts graphs by title
• --sort=name — sorts graphs by their name
• --sort=descr — sorts graphs by their description
• --sort=original — leaves them as is (default)
• --enumerate — adds a sequence number to the title of each graph
• --picfirst — places pictures before text (default: text first)
• --width=number — sets the width of graphs (default: not set)
• --height=number — sets the height of graphs
• --sidebyside — places text / pictures side by side (default: above/below)
• --bold — uses bold text (default: bold)
• --clicktext — makes the text link to the inner page (like the image)
• --show=day — picks which graph to show in the index (default)
• --show=week — same but the week one
• --show=month — same but the month one
• --show=year — same but the year one
• --show=none — shows literally no graph, images fully suppressed
• --section=h1 — uses the h1 tag from pagetop as the section heading (default)
• --section=title — uses the title as section headings for graphs
• --section=name — uses the graph name as section heading
• --section=descr — uses the graph description as section heading
• --section=ifname — uses the interface name (ifName) as section heading
• --section=portname — uses the port name entry in pagetop as section heading
• --sectionhost — tries to prepend the host to the section heading if it's missing
• --rrdviewer=path — path to rrdviewer (default: /cgi-bin/14all.cgi)
• --icondir=path — path to icondir
• --prefix=path — path from the location of the index.html to the graphs
• --headeradd=string — adds string to the html page header
• --autoprefix — tries to set the prefix automatically
• --<opt>-file=file — reads the string argument for option <opt> from a file

💫 DESCRIPTION 💫

okay so the whole vibe here is: Indexmaker can create web pages which display the status of an array of mrtg interface status pages. iconic behavior honestly 👑

• --output filename — sets the output filename (default: stdout)
• --filter (title|pagetop|name)(=~|!~)regexp — you can set several filters, like stack them up. each filter can match against the contents 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 you pick (=~ or !~), the match will be positive or negative.

heads up bestie: some shells treat ! as a special character 😭 you may need to type \!~ instead.

• --title text — sets the title of the generated index file (default: regexp)
• --bodyopt text — the value of this argument gets appended to the <BODY> tag. this lets you set document colors. by default this option is set to:

bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000"

• --columns number — displays graphs in a table with number columns (default: 2)
• --sort title|name|descr|original — sorts the graphs in the page either by title, by name, by interface description, or leaves them as is.
• --enumerate — adds a sequence number to the title of each graph
• --width number — sets the width of graphs
• --height number — sets the height of the graphs
• --show day|week|month|year|none — selects which graph to show in the index page. you can suppress images completely with --show=none. periodt.
• --section h1|title|name|description|portname — selects 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 description is the text from the Description field of the PageTop (the Cisco description text if it's available, otherwise just the interface description). portname is the "Port Name:" from pagetop.
• --sectionhost — extracts the hostname from the target line (this does not work if the target is a mathematical expression). prepends the hostname (and a colon) to the section if it's not already there.
• --rrdviewer path — if you've set the LogFormat: rrdtool property in the mrtg.cfg file, the index will take that into account. the only thing you have to 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 the path separator, since this will be used in urls. speaking of which — you can even enter a whole url. slay 🌈
• --autoprefix path — requires --output. tries to generate the prefix automatically by comparison of the path to the output file set with --output and the Htmldir set in the configuration files. particularly useful when multiple configuration files are specified, with different Htmldir settings.
• --optlog — default is logging the command line in the generated page; suppress it with --nooptlog. useful if the commandline contains a complex --pagetop=string which could confuse simple browsers.
• --someoption-file filename — for any someoption which takes a string as parameter, you can read the string from a file by adding <-file> to the option keyword. the whole content of the file will be read and used as the string. the file must exist.

👑 AUTHOR 👑

Tobias Oetiker <tobi@oetiker.ch> — the main character who wrote this fr fr

📜 LICENSE 📜

GNU General Public License

🎀 COPYRIGHT 🎀

2000-2001 Tobias Oetiker <tobi@oetiker.ch>

and that's the whole thing bestie 💖 this was INDEXMAKER(1) from mrtg 2.17.10, dated 2022-01-19 — go make some index files, you got this 🫶✨