indexmaker.1
上传用户:shbosideng
上传日期:2013-05-04
资源大小:1555k
文件大小:11k
- ." Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
- ."
- ." Standard preamble:
- ." ========================================================================
- .de Sh " Subsection heading
- .br
- .if t .Sp
- .ne 5
- .PP
- fB\$1fR
- .PP
- ..
- .de Sp " Vertical space (when we can't use .PP)
- .if t .sp .5v
- .if n .sp
- ..
- .de Vb " Begin verbatim text
- .ft CW
- .nf
- .ne \$1
- ..
- .de Ve " End verbatim text
- .ft R
- .fi
- ..
- ." Set up some character translations and predefined strings. *(-- will
- ." give an unbreakable dash, *(PI will give pi, *(L" will give a left
- ." double quote, and *(R" will give a right double quote. | will give a
- ." real vertical bar. *(C+ will give a nicer C++. Capital omega is used to
- ." do unbreakable dashes and therefore won't be available. *(C` and *(C'
- ." expand to `' in nroff, nothing in troff, for use with C<>.
- .tr (*W-|(bv*(Tr
- .ds C+ Cv'-.1v'h'-1p's-2+h'-1p'+s0v'.1v'h'-1p'
- .ie n {
- . ds -- (*W-
- . ds PI pi
- . if (n(.H=4u)&(1m=24u) .ds -- (*Wh'-12u'(*Wh'-12u'-" diablo 10 pitch
- . if (n(.H=4u)&(1m=20u) .ds -- (*Wh'-12u'(*Wh'-8u'-" diablo 12 pitch
- . ds L" ""
- . ds R" ""
- . ds C` ""
- . ds C' ""
- 'br}
- .el{
- . ds -- |(em|
- . ds PI (*p
- . ds L" ``
- . ds R" ''
- 'br}
- ."
- ." If the F register is turned on, we'll generate index entries on stderr for
- ." titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
- ." entries marked with X<> in POD. Of course, you'll have to process the
- ." output yourself in some meaningful fashion.
- .if nF {
- . de IX
- . tm Index:\$1t\n%t"\$2"
- ..
- . nr % 0
- . rr F
- .}
- ."
- ." For nroff, turn off justification. Always turn off hyphenation; it makes
- ." way too many mistakes in technical documents.
- .hy 0
- .if n .na
- ."
- ." Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
- ." Fear. Run. Save yourself. No user-serviceable parts.
- . " fudge factors for nroff and troff
- .if n {
- . ds #H 0
- . ds #V .8m
- . ds #F .3m
- . ds #[ f1
- . ds #] fP
- .}
- .if t {
- . ds #H ((1u-(\\n(.fu%2u))*.13m)
- . ds #V .6m
- . ds #F 0
- . ds #[ &
- . ds #] &
- .}
- . " simple accents for nroff and troff
- .if n {
- . ds ' &
- . ds ` &
- . ds ^ &
- . ds , &
- . ds ~ ~
- . ds /
- .}
- .if t {
- . ds ' \k:h'-(\n(.wu*8/10-*(#H)''h"|\n:u"
- . ds ` \k:h'-(\n(.wu*8/10-*(#H)'`h'|\n:u'
- . ds ^ \k:h'-(\n(.wu*10/11-*(#H)'^h'|\n:u'
- . ds , \k:h'-(\n(.wu*8/10)',h'|\n:u'
- . ds ~ \k:h'-(\n(.wu-*(#H-.1m)'~h'|\n:u'
- . ds / \k:h'-(\n(.wu*8/10-*(#H)'z(slh'|\n:u'
- .}
- . " troff and (daisy-wheel) nroff accents
- .ds : \k:h'-(\n(.wu*8/10-*(#H+.1m+*(#F)'v'-*(#V'z.h'.2m+*(#F'.h'|\n:u'v'*(#V'
- .ds 8 h'*(#H'(*bh'-*(#H'
- .ds o \k:h'-(\n(.wu+w'(de'u-*(#H)/2u'v'-.3n'*(#[z(dev'.3n'h'|\n:u'*(#]
- .ds d- h'*(#H'(pdh'-w'~'u'v'-.25m'f2(hyfPv'.25m'h'-*(#H'
- .ds D- D\k:h'-w'D'u'v'-.11m'z(hyv'.11m'h'|\n:u'
- .ds th *(#[v'.3m's+1Is-1v'-.3m'h'-(w'I'u*2/3)'s-1os+1*(#]
- .ds Th *(#[s+2Is-2h'-w'I'u*3/5'v'-.3m'ov'.3m'*(#]
- .ds ae ah'-(w'a'u*4/10)'e
- .ds Ae Ah'-(w'A'u*4/10)'E
- . " corrections for vroff
- .if v .ds ~ \k:h'-(\n(.wu*9/10-*(#H)'s-2u~ds+2h'|\n:u'
- .if v .ds ^ \k:h'-(\n(.wu*10/11-*(#H)'v'-.4m'^v'.4m'h'|\n:u'
- . " for low resolution devices (crt and lpr)
- .if n(.H>23 .if n(.V>19
- {
- . ds : e
- . ds 8 ss
- . ds o a
- . ds d- dh'-1'(ga
- . ds D- Dh'-1'(hy
- . ds th o'bp'
- . ds Th o'LP'
- . ds ae ae
- . ds Ae AE
- .}
- .rm #[ #] #H #V #F C
- ." ========================================================================
- ."
- .IX Title "INDEXMAKER 1"
- .TH INDEXMAKER 1 "2006-02-03" "2.13.2" "mrtg"
- .SH "NAME"
- indexmaker - Creates index files for mrtg web sites (mrtg-2.13.2)
- .SH "SYNOPSIS"
- .IX Header "SYNOPSIS"
- indexmaker [options] mrtg.cfg [other.cfg ...]
- .SH "OPTIONS"
- .IX Header "OPTIONS"
- .Vb 1
- & --output=filename set output filename (default: stdout)
- .Ve
- .PP
- .Vb 3
- & --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
- .Ve
- .PP
- .Vb 9
- & --addhead=text insert this text between </TITLE> and </HEAD>
- & --title=text set title of generated index file
- & --subtitle=text add a subtitle to the generated index file
- & --bodyopt=text set body tag options
- & --headlevel=number use <Hnumber> at top of page (default: 1)
- & --pagetop=text insert this text between <BODY> and <H1>...</H1>
- & --pageend=text insert this text after the main body
- & --pagetopend=text use this text for pagetop or pageend if undefined
- & --nolegend do not add the Mrtg legend at the end of the page
- .Ve
- .PP
- .Vb 4
- & --columns=number show graphs in a table with x columns (default: 2)
- & --perhost show graphs of the same host on a row
- & --compact try to make a vertically more compact page
- & --optlog log the used command line in the page (default: log)
- .Ve
- .PP
- .Vb 4
- & --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)
- .Ve
- .PP
- .Vb 1
- & --enumerate add a sequence number to the title of each graph
- .Ve
- .PP
- .Vb 6
- & --picfirst place pictures before text (default: text first)
- & --width=number set width of graphs (default: not set)
- & --height=number
- & --sidebyside place text / pictures side by side (default: above/below)
- & --bold use bold text (default: bold)
- & --clicktext make the text link to the inner page (like the image)
- .Ve
- .PP
- .Vb 5
- & --show=day pick which graph to show in the index (default)
- & --show=week
- & --show=month
- & --show=year
- & --show=none
- .Ve
- .PP
- .Vb 6
- & --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
- & --sectionhost Try to prepend the host to the section heading if missing
- .Ve
- .PP
- .Vb 5
- & --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 add string to the html page header
- & --autoprefix try to set prefix automatically
- .Ve
- .PP
- .Vb 1
- & --<opt>-file=file read string argument for option <opt> from file
- .Ve
- .SH "DESCRIPTION"
- .IX Header "DESCRIPTION"
- &fBIndexmakerfR can create web pages which display the status of an
- array of mrtg interface status pages.
- .IP "fB--outputfR fIfilenamefR" 4
- .IX Item "--output filename"
- set output filename (default: stdout)
- .IP "fB--filterfR (fBtitlefR|fBpagetopfR|fBnamefR)(fB=~fR|fB!~fR)fIregexpfR" 4
- .IX Item "--filter (title|pagetop|name)(=~|!~)regexp"
- Several filters may get set. Each filter can match agains the contents
- of a specific section of the mrtg config file. fBNamefR refers to the
- bit in square brackets (option[name]: bla).
- .Sp
- Depending on the match operator chosen (fB=~fR or fB!~fR) the match will be
- positive or negative.
- .Sp
- Note that some shells consider fB!fR a special character. It may be
- necessary to type fBe!~fR instead.
- .IP "fB--titlefR fItextfR" 4
- .IX Item "--title text"
- Set title of generated index file (default: regexp)
- .IP "fB--bodyoptfR fItextfR" 4
- .IX Item "--bodyopt text"
- The value of this argument gets appended to
- the <s-1BODYs0> tag. This allows to set document colors.
- By default this option is set to
- .Sp
- .Vb 1
- & bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000"
- .Ve
- .IP "fB--columnsfR fInumberfR" 4
- .IX Item "--columns number"
- Display graphs in a table with fInumberfR columns (default: 2)
- .IP "fB--sortfR fBtitlefR|fBnamefR|fBdescrfR|fBoriginalfR" 4
- .IX Item "--sort title|name|descr|original"
- Sort the graphs in the page either by fBtitlefR, by fBnamefR, by interface
- &fBdescrfRiption, or leave them as is.
- .IP "fB--enumeratefR" 4
- .IX Item "--enumerate"
- Add a sequence number to the title of each graph
- .IP "fB--widthfR fInumberfR" 4
- .IX Item "--width number"
- Set width of graphs
- .IP "fB--heightfR fInumberfR" 4
- .IX Item "--height number"
- Set the height of the graphs
- .IP "fB--showfR fBdayfR|fBweekfR|fBmonthfR|fByearfR|fBnonefR" 4
- .IX Item "--show day|week|month|year|none"
- Select which graph to show in the index page. You can supress images
- completely with fB--show=nonefR.
- .IP "fB--sectionfR fBh1fR|fBtitlefR|fBnamefR|fBdescriptionfR|fBportnamefR" 4
- .IX Item "--section h1|title|name|description|portname"
- Select what to use as the title for each graph in the page. fBh1fR is
- the H1 section from pagetop, fBtitlefR is the graph title, fBnamefR is
- the bit in square brackets (option[name]: bla), and fBdescrfR or
- &fBdescriptionfR is the text from the Description field of the PageTop
- (the Cisco description text if it's available, otherwise just the
- interface description). fBportnamefR is the f(CW*(C`Port Name:*(C'fR from pagetop.
- .IP "fB--sectionhostfR" 4
- .IX Item "--sectionhost"
- Extract the hostname from the target line (this does not work if the
- target is a mathematial expression). Prepend the hostname (and a colon)
- to the section if not already present.
- .IP "fB--rrdviewerfR fIpathfR" 4
- .IX Item "--rrdviewer path"
- If you have set the fBLogFormat: rrdtoolfR 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)
- .IP "fB--prefixfR fIpathfR" 4
- .IX Item "--prefix path"
- By default we assume that the file generated by indexmaker is stored in
- &fIWorkDirfR. If you want to store it somewhere else, specify how to reach
- &fIWorkDirfR 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.
- .IP "fB--autoprefixfR fIpathfR" 4
- .IX Item "--autoprefix path"
- Requires --output.
- Try to generate the prefix automatically by comparision of the path to the
- output file set with --output and the Htmldir set in the configuration files.
- Particulary useful when multiple configuration files are specified, with
- different Htmldir settings.
- .IP "fB--optlogfR" 4
- .IX Item "--optlog"
- Default is logging in the generated page the command line, suppress with
- &--nooptlog . Useful if the commandline contains a complex --pagetop=string
- which could confuse simple browsers.
- .IP "fB--someoption-filefR fIfilenamefR" 4
- .IX Item "--someoption-file filename"
- For any someoption which takes a fIstringfR 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 fIstringfR. The file must
- exist.
- .SH "AUTHOR"
- .IX Header "AUTHOR"
- Tobias Oetiker <tobi@oetiker.ch>
- .SH "LICENSE"
- .IX Header "LICENSE"
- &s-1GNUs0 General Public License
- .SH "COPYRIGHT"
- .IX Header "COPYRIGHT"
- 2000-2001 Tobias Oetiker <tobi@oetiker.ch>