Blame doc/indexmaker.txt

Packit 667938
INDEXMAKER(1)                        mrtg                        INDEXMAKER(1)
Packit 667938
Packit 667938
Packit 667938
Packit 667938
N?NA?AM?ME?E
Packit 667938
       indexmaker - Creates index files for mrtg web sites (mrtg-2.17.7)
Packit 667938
Packit 667938
S?SY?YN?NO?OP?PS?SI?IS?S
Packit 667938
       indexmaker [options] mrtg.cfg [other.cfg ...]
Packit 667938
Packit 667938
O?OP?PT?TI?IO?ON?NS?S
Packit 667938
        --output=filename   set output filename (default: stdout)
Packit 667938
Packit 667938
        --filter title=~regexp  select targets by matching regexp against titles
Packit 667938
        --filter pagetop=~regexp  select targets by matching regexp against pagetop
Packit 667938
        --filter name=~regexp  select targets by matchin regexp against name
Packit 667938
Packit 667938
        --addhead=text      insert this text between </TITLE> and </HEAD>
Packit 667938
        --title=text        set title of generated index file
Packit 667938
        --subtitle=text     add a subtitle to the generated index file
Packit 667938
        --bodyopt=text      set body tag options
Packit 667938
        --headlevel=number  use <Hnumber> at top of page (default: 1)
Packit 667938
        --pagetop=text      insert this text between <BODY> and 

...

Packit 667938
        --pageend=text      insert this text after the main body
Packit 667938
        --pagetopend=text   use this text for pagetop or pageend if undefined
Packit 667938
        --nolegend          do not add the Mrtg legend at the end of the page
Packit 667938
Packit 667938
        --columns=number    show graphs in a table with x columns (default: 2)
Packit 667938
        --perhost           show graphs of the same host on a row
Packit 667938
        --compact           try to make a vertically more compact page
Packit 667938
        --optlog            log the used command line in the page (default: log)
Packit 667938
Packit 667938
        --sort=title        sort graphs by title
Packit 667938
        --sort=name         sort graphs by their name
Packit 667938
        --sort=descr        sort graphs by their description
Packit 667938
        --sort=original     leave as is (default)
Packit 667938
Packit 667938
        --enumerate         add a sequence number to the title of each graph
Packit 667938
Packit 667938
        --picfirst          place pictures before text (default: text first)
Packit 667938
        --width=number      set width of graphs (default: not set)
Packit 667938
        --height=number
Packit 667938
        --sidebyside        place text / pictures side by side (default: above/below)
Packit 667938
        --bold              use bold text (default: bold)
Packit 667938
        --clicktext         make the text link to the inner page (like the image)
Packit 667938
Packit 667938
        --show=day          pick which graph to show in the index (default)
Packit 667938
        --show=week
Packit 667938
        --show=month
Packit 667938
        --show=year
Packit 667938
        --show=none
Packit 667938
Packit 667938
        --section=h1        h1 tag from pagetop as section heading (default)
Packit 667938
        --section=title     title as section headings for graphs
Packit 667938
        --section=name      graph name as section heading
Packit 667938
        --section=descr     graph description as section heading
Packit 667938
        --section=ifname    interface name (ifName) as section heading
Packit 667938
        --section=portname  port name entry in pagetop as section heading
Packit 667938
        --sectionhost       Try to prepend the host to the section heading if missing
Packit 667938
Packit 667938
        --rrdviewer=path    path to rrdviewer (default: /cgi-bin/14all.cgi)
Packit 667938
        --icondir=path      path to icondir
Packit 667938
        --prefix=path       path from the location of the index.html to the graphs
Packit 667938
        --headeradd=string  add string to the html page header
Packit 667938
        --autoprefix        try to set prefix automatically
Packit 667938
Packit 667938
        --<opt>-file=file   read string argument for option <opt> from file
Packit 667938
Packit 667938
D?DE?ES?SC?CR?RI?IP?PT?TI?IO?ON?N
Packit 667938
       I?In?nd?de?ex?xm?ma?ak?ke?er?r can create web pages which display the status of an array of
Packit 667938
       mrtg interface status pages.
Packit 667938
Packit 667938
       -?--?-o?ou?ut?tp?pu?ut?t _?f_?i_?l_?e_?n_?a_?m_?e
Packit 667938
           set output filename (default: stdout)
Packit 667938
Packit 667938
       -?--?-f?fi?il?lt?te?er?r (t?ti?it?tl?le?e|p?pa?ag?ge?et?to?op?p|n?na?am?me?e)(=?=~?~|!?!~?~)_?r_?e_?g_?e_?x_?p
Packit 667938
           Several filters may get set.  Each filter can match agains the
Packit 667938
           contents of a specific section of the mrtg config file. N?Na?am?me?e refers
Packit 667938
           to the bit in square brackets (option[name]: bla).
Packit 667938
Packit 667938
           Depending on the match operator chosen (=?=~?~ or !?!~?~) the match will be
Packit 667938
           positive or negative.
Packit 667938
Packit 667938
           Note that some shells consider !?! a special character.  It may be
Packit 667938
           necessary to type \?\!?!~?~ instead.
Packit 667938
Packit 667938
       -?--?-t?ti?it?tl?le?e _?t_?e_?x_?t
Packit 667938
           Set title of generated index file (default: regexp)
Packit 667938
Packit 667938
       -?--?-b?bo?od?dy?yo?op?pt?t _?t_?e_?x_?t
Packit 667938
           The value of this argument gets appended to the <BODY> tag. This
Packit 667938
           allows you to set document colors.  By default this option is set
Packit 667938
           to
Packit 667938
Packit 667938
            bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000"
Packit 667938
Packit 667938
       -?--?-c?co?ol?lu?um?mn?ns?s _?n_?u_?m_?b_?e_?r
Packit 667938
           Display graphs in a table with _?n_?u_?m_?b_?e_?r columns (default: 2)
Packit 667938
Packit 667938
       -?--?-s?so?or?rt?t t?ti?it?tl?le?e|n?na?am?me?e|d?de?es?sc?cr?r|o?or?ri?ig?gi?in?na?al?l
Packit 667938
           Sort the graphs in the page either by t?ti?it?tl?le?e, by n?na?am?me?e, by interface
Packit 667938
           d?de?es?sc?cr?ription, or leave them as is.
Packit 667938
Packit 667938
       -?--?-e?en?nu?um?me?er?ra?at?te?e
Packit 667938
           Add a sequence number to the title of each graph
Packit 667938
Packit 667938
       -?--?-w?wi?id?dt?th?h _?n_?u_?m_?b_?e_?r
Packit 667938
           Set width of graphs
Packit 667938
Packit 667938
       -?--?-h?he?ei?ig?gh?ht?t _?n_?u_?m_?b_?e_?r
Packit 667938
           Set the height of the graphs
Packit 667938
Packit 667938
       -?--?-s?sh?ho?ow?w d?da?ay?y|w?we?ee?ek?k|m?mo?on?nt?th?h|y?ye?ea?ar?r|n?no?on?ne?e
Packit 667938
           Select which graph to show in the index page. You can supress
Packit 667938
           images completely with -?--?-s?sh?ho?ow?w=?=n?no?on?ne?e.
Packit 667938
Packit 667938
       -?--?-s?se?ec?ct?ti?io?on?n h?h1?1|t?ti?it?tl?le?e|n?na?am?me?e|d?de?es?sc?cr?ri?ip?pt?ti?io?on?n|p?po?or?rt?tn?na?am?me?e
Packit 667938
           Select what to use as the title for each graph in the page.  h?h1?1 is
Packit 667938
           the H1 section from pagetop, t?ti?it?tl?le?e is the graph title, n?na?am?me?e is the
Packit 667938
           bit in square brackets (option[name]: bla), and d?de?es?sc?cr?r or
Packit 667938
           d?de?es?sc?cr?ri?ip?pt?ti?io?on?n is the text from the Description field of the PageTop
Packit 667938
           (the Cisco description text if it's available, otherwise just the
Packit 667938
           interface description). p?po?or?rt?tn?na?am?me?e is the "Port Name:" from pagetop.
Packit 667938
Packit 667938
       -?--?-s?se?ec?ct?ti?io?on?nh?ho?os?st?t
Packit 667938
           Extract the hostname from the target line (this does not work if
Packit 667938
           the target is a mathematial expression). Prepend the hostname (and
Packit 667938
           a colon) to the section if not already present.
Packit 667938
Packit 667938
       -?--?-r?rr?rd?dv?vi?ie?ew?we?er?r _?p_?a_?t_?h
Packit 667938
           If you have set the L?Lo?og?gF?Fo?or?rm?ma?at?t:?: r?rr?rd?dt?to?oo?ol?l property in the mrtg.cfg
Packit 667938
           file, the index will take this into account. The only thing you
Packit 667938
           must tell it is the path to your grapher cgi. (default:
Packit 667938
           /cgi-bin/14all.cgi)
Packit 667938
Packit 667938
       -?--?-p?pr?re?ef?fi?ix?x _?p_?a_?t_?h
Packit 667938
           By  default we assume    that  the file generated by indexmaker is
Packit 667938
           stored in _?W_?o_?r_?k_?D_?i_?r.  If you want to  store it somewhere   else,
Packit 667938
           specify how to reach _?W_?o_?r_?k_?D_?i_?r  from  the place where the Index is
Packit 667938
           stored. Note that you have to use '/' as path separator as this
Packit 667938
           will be used in urls. Speaking of which, you can even enter a whole
Packit 667938
           url.
Packit 667938
Packit 667938
       -?--?-a?au?ut?to?op?pr?re?ef?fi?ix?x _?p_?a_?t_?h
Packit 667938
           Requires --output.  Try to generate the prefix automatically by
Packit 667938
           comparision of the path to the output file set with --output and
Packit 667938
           the Htmldir set in the configuration files.  Particulary useful
Packit 667938
           when multiple configuration files are specified, with different
Packit 667938
           Htmldir settings.
Packit 667938
Packit 667938
       -?--?-o?op?pt?tl?lo?og?g
Packit 667938
           Default is logging in the generated page the command line, suppress
Packit 667938
           with --nooptlog . Useful if the commandline contains a complex
Packit 667938
           --pagetop=string which could confuse simple browsers.
Packit 667938
Packit 667938
       -?--?-s?so?om?me?eo?op?pt?ti?io?on?n-?-f?fi?il?le?e _?f_?i_?l_?e_?n_?a_?m_?e
Packit 667938
           For any someoption which takes a _?s_?t_?r_?i_?n_?g as parameter you can read
Packit 667938
           the string from a file by adding <-file> to the option keyword. The
Packit 667938
           whole content of the file will be read and used as the _?s_?t_?r_?i_?n_?g. The
Packit 667938
           file must exist.
Packit 667938
Packit 667938
A?AU?UT?TH?HO?OR?R
Packit 667938
       Tobias Oetiker <tobi@oetiker.ch>
Packit 667938
Packit 667938
L?LI?IC?CE?EN?NS?SE?E
Packit 667938
       GNU General Public License
Packit 667938
Packit 667938
C?CO?OP?PY?YR?RI?IG?GH?HT?T
Packit 667938
       2000-2001 Tobias Oetiker <tobi@oetiker.ch>
Packit 667938
Packit 667938
Packit 667938
Packit 667938
2.17.7                            2018-07-13                     INDEXMAKER(1)