indexmaker.1
上传用户:shbosideng
上传日期:2013-05-04
资源大小:1555k
文件大小:11k
源码类别:

SNMP编程

开发平台:

C/C++

  1. ." Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
  2. ."
  3. ." Standard preamble:
  4. ." ========================================================================
  5. .de Sh " Subsection heading
  6. .br
  7. .if t .Sp
  8. .ne 5
  9. .PP
  10. fB\$1fR
  11. .PP
  12. ..
  13. .de Sp " Vertical space (when we can't use .PP)
  14. .if t .sp .5v
  15. .if n .sp
  16. ..
  17. .de Vb " Begin verbatim text
  18. .ft CW
  19. .nf
  20. .ne \$1
  21. ..
  22. .de Ve " End verbatim text
  23. .ft R
  24. .fi
  25. ..
  26. ." Set up some character translations and predefined strings.  *(-- will
  27. ." give an unbreakable dash, *(PI will give pi, *(L" will give a left
  28. ." double quote, and *(R" will give a right double quote.  | will give a
  29. ." real vertical bar.  *(C+ will give a nicer C++.  Capital omega is used to
  30. ." do unbreakable dashes and therefore won't be available.  *(C` and *(C'
  31. ." expand to `' in nroff, nothing in troff, for use with C<>.
  32. .tr (*W-|(bv*(Tr
  33. .ds C+ Cv'-.1v'h'-1p's-2+h'-1p'+s0v'.1v'h'-1p'
  34. .ie n {
  35. .    ds -- (*W-
  36. .    ds PI pi
  37. .    if (n(.H=4u)&(1m=24u) .ds -- (*Wh'-12u'(*Wh'-12u'-" diablo 10 pitch
  38. .    if (n(.H=4u)&(1m=20u) .ds -- (*Wh'-12u'(*Wh'-8u'-"  diablo 12 pitch
  39. .    ds L" ""
  40. .    ds R" ""
  41. .    ds C` ""
  42. .    ds C' ""
  43. 'br}
  44. .el{
  45. .    ds -- |(em|
  46. .    ds PI (*p
  47. .    ds L" ``
  48. .    ds R" ''
  49. 'br}
  50. ."
  51. ." If the F register is turned on, we'll generate index entries on stderr for
  52. ." titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53. ." entries marked with X<> in POD.  Of course, you'll have to process the
  54. ." output yourself in some meaningful fashion.
  55. .if nF {
  56. .    de IX
  57. .    tm Index:\$1t\n%t"\$2"
  58. ..
  59. .    nr % 0
  60. .    rr F
  61. .}
  62. ."
  63. ." For nroff, turn off justification.  Always turn off hyphenation; it makes
  64. ." way too many mistakes in technical documents.
  65. .hy 0
  66. .if n .na
  67. ."
  68. ." Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69. ." Fear.  Run.  Save yourself.  No user-serviceable parts.
  70. .    " fudge factors for nroff and troff
  71. .if n {
  72. .    ds #H 0
  73. .    ds #V .8m
  74. .    ds #F .3m
  75. .    ds #[ f1
  76. .    ds #] fP
  77. .}
  78. .if t {
  79. .    ds #H ((1u-(\\n(.fu%2u))*.13m)
  80. .    ds #V .6m
  81. .    ds #F 0
  82. .    ds #[ &
  83. .    ds #] &
  84. .}
  85. .    " simple accents for nroff and troff
  86. .if n {
  87. .    ds ' &
  88. .    ds ` &
  89. .    ds ^ &
  90. .    ds , &
  91. .    ds ~ ~
  92. .    ds /
  93. .}
  94. .if t {
  95. .    ds ' \k:h'-(\n(.wu*8/10-*(#H)''h"|\n:u"
  96. .    ds ` \k:h'-(\n(.wu*8/10-*(#H)'`h'|\n:u'
  97. .    ds ^ \k:h'-(\n(.wu*10/11-*(#H)'^h'|\n:u'
  98. .    ds , \k:h'-(\n(.wu*8/10)',h'|\n:u'
  99. .    ds ~ \k:h'-(\n(.wu-*(#H-.1m)'~h'|\n:u'
  100. .    ds / \k:h'-(\n(.wu*8/10-*(#H)'z(slh'|\n:u'
  101. .}
  102. .    " troff and (daisy-wheel) nroff accents
  103. .ds : \k:h'-(\n(.wu*8/10-*(#H+.1m+*(#F)'v'-*(#V'z.h'.2m+*(#F'.h'|\n:u'v'*(#V'
  104. .ds 8 h'*(#H'(*bh'-*(#H'
  105. .ds o \k:h'-(\n(.wu+w'(de'u-*(#H)/2u'v'-.3n'*(#[z(dev'.3n'h'|\n:u'*(#]
  106. .ds d- h'*(#H'(pdh'-w'~'u'v'-.25m'f2(hyfPv'.25m'h'-*(#H'
  107. .ds D- D\k:h'-w'D'u'v'-.11m'z(hyv'.11m'h'|\n:u'
  108. .ds th *(#[v'.3m's+1Is-1v'-.3m'h'-(w'I'u*2/3)'s-1os+1*(#]
  109. .ds Th *(#[s+2Is-2h'-w'I'u*3/5'v'-.3m'ov'.3m'*(#]
  110. .ds ae ah'-(w'a'u*4/10)'e
  111. .ds Ae Ah'-(w'A'u*4/10)'E
  112. .    " corrections for vroff
  113. .if v .ds ~ \k:h'-(\n(.wu*9/10-*(#H)'s-2u~ds+2h'|\n:u'
  114. .if v .ds ^ \k:h'-(\n(.wu*10/11-*(#H)'v'-.4m'^v'.4m'h'|\n:u'
  115. .    " for low resolution devices (crt and lpr)
  116. .if n(.H>23 .if n(.V>19 
  117. {
  118. .    ds : e
  119. .    ds 8 ss
  120. .    ds o a
  121. .    ds d- dh'-1'(ga
  122. .    ds D- Dh'-1'(hy
  123. .    ds th o'bp'
  124. .    ds Th o'LP'
  125. .    ds ae ae
  126. .    ds Ae AE
  127. .}
  128. .rm #[ #] #H #V #F C
  129. ." ========================================================================
  130. ."
  131. .IX Title "INDEXMAKER 1"
  132. .TH INDEXMAKER 1 "2006-02-03" "2.13.2" "mrtg"
  133. .SH "NAME"
  134. indexmaker - Creates index files for mrtg web sites (mrtg-2.13.2)
  135. .SH "SYNOPSIS"
  136. .IX Header "SYNOPSIS"
  137. indexmaker [options] mrtg.cfg [other.cfg ...]
  138. .SH "OPTIONS"
  139. .IX Header "OPTIONS"
  140. .Vb 1
  141. & --output=filename   set output filename (default: stdout)
  142. .Ve
  143. .PP
  144. .Vb 3
  145. & --filter title=~regexp  select targets by matching regexp against titles
  146. & --filter pagetop=~regexp  select targets by matching regexp against pagetop
  147. & --filter name=~regexp  select targets by matchin regexp against name
  148. .Ve
  149. .PP
  150. .Vb 9
  151. & --addhead=text      insert this text between </TITLE> and </HEAD>
  152. & --title=text        set title of generated index file
  153. & --subtitle=text     add a subtitle to the generated index file
  154. & --bodyopt=text      set body tag options
  155. & --headlevel=number  use <Hnumber> at top of page (default: 1)
  156. & --pagetop=text      insert this text between <BODY> and <H1>...</H1>
  157. & --pageend=text      insert this text after the main body
  158. & --pagetopend=text   use this text for pagetop or pageend if undefined
  159. & --nolegend          do not add the Mrtg legend at the end of the page
  160. .Ve
  161. .PP
  162. .Vb 4
  163. & --columns=number    show graphs in a table with x columns (default: 2)
  164. & --perhost           show graphs of the same host on a row
  165. & --compact           try to make a vertically more compact page
  166. & --optlog            log the used command line in the page (default: log)
  167. .Ve
  168. .PP
  169. .Vb 4
  170. & --sort=title        sort graphs by title
  171. & --sort=name         sort graphs by their name
  172. & --sort=descr        sort graphs by their description
  173. & --sort=original     leave as is (default)
  174. .Ve
  175. .PP
  176. .Vb 1
  177. & --enumerate         add a sequence number to the title of each graph
  178. .Ve
  179. .PP
  180. .Vb 6
  181. & --picfirst          place pictures before text (default: text first)
  182. & --width=number      set width of graphs (default: not set)
  183. & --height=number
  184. & --sidebyside        place text / pictures side by side (default: above/below)
  185. & --bold              use bold text (default: bold)
  186. & --clicktext         make the text link to the inner page (like the image)
  187. .Ve
  188. .PP
  189. .Vb 5
  190. & --show=day          pick which graph to show in the index (default)
  191. & --show=week
  192. & --show=month
  193. & --show=year
  194. & --show=none
  195. .Ve
  196. .PP
  197. .Vb 6
  198. & --section=h1        h1 tag from pagetop as section heading (default)
  199. & --section=title     title as section headings for graphs
  200. & --section=name      graph name as section heading
  201. & --section=descr     graph description as section heading
  202. & --section=portname  port name entry in pagetop as section heading
  203. & --sectionhost       Try to prepend the host to the section heading if missing
  204. .Ve
  205. .PP
  206. .Vb 5
  207. & --rrdviewer=path    path to rrdviewer (default: /cgi-bin/14all.cgi)
  208. & --icondir=path      path to icondir
  209. & --prefix=path       path from the location of the index.html to the graphs
  210. & --headeradd=string  add string to the html page header
  211. & --autoprefix        try to set prefix automatically
  212. .Ve
  213. .PP
  214. .Vb 1
  215. & --<opt>-file=file   read string argument for option <opt> from file
  216. .Ve
  217. .SH "DESCRIPTION"
  218. .IX Header "DESCRIPTION"
  219. &fBIndexmakerfR can create web pages which display the status of an
  220. array of mrtg interface status pages.
  221. .IP "fB--outputfR fIfilenamefR" 4
  222. .IX Item "--output filename"
  223. set output filename (default: stdout)
  224. .IP "fB--filterfR (fBtitlefR|fBpagetopfR|fBnamefR)(fB=~fR|fB!~fR)fIregexpfR" 4
  225. .IX Item "--filter (title|pagetop|name)(=~|!~)regexp"
  226. Several filters may get set.  Each filter can match agains the contents
  227. of a specific section of the mrtg config file. fBNamefR refers to the
  228. bit in square brackets (option[name]: bla).
  229. .Sp
  230. Depending on the match operator chosen (fB=~fR or fB!~fR) the match will be
  231. positive or negative.
  232. .Sp
  233. Note that some shells consider fB!fR a special character.  It may be
  234. necessary to type fBe!~fR instead.
  235. .IP "fB--titlefR fItextfR" 4
  236. .IX Item "--title text"
  237. Set title of generated index file (default: regexp)
  238. .IP "fB--bodyoptfR fItextfR" 4
  239. .IX Item "--bodyopt text"
  240. The value of this argument gets appended to
  241. the <s-1BODYs0> tag. This allows to set document colors.
  242. By default this option is set to
  243. .Sp
  244. .Vb 1
  245. & bgcolor="#ffffff" text="#000000" link="#000000" vlink="#000000" alink="#000000"
  246. .Ve
  247. .IP "fB--columnsfR fInumberfR" 4
  248. .IX Item "--columns number"
  249. Display graphs in a table with fInumberfR columns (default: 2)
  250. .IP "fB--sortfR fBtitlefR|fBnamefR|fBdescrfR|fBoriginalfR" 4
  251. .IX Item "--sort title|name|descr|original"
  252. Sort the graphs in the page either by fBtitlefR, by fBnamefR, by interface
  253. &fBdescrfRiption, or leave them as is.
  254. .IP "fB--enumeratefR" 4
  255. .IX Item "--enumerate"
  256. Add a sequence number to the title of each graph
  257. .IP "fB--widthfR fInumberfR" 4
  258. .IX Item "--width number"
  259. Set width of graphs
  260. .IP "fB--heightfR fInumberfR" 4
  261. .IX Item "--height number"
  262. Set the height of the graphs
  263. .IP "fB--showfR fBdayfR|fBweekfR|fBmonthfR|fByearfR|fBnonefR" 4
  264. .IX Item "--show day|week|month|year|none"
  265. Select which graph to show in the index page. You can supress images
  266. completely with fB--show=nonefR.
  267. .IP "fB--sectionfR fBh1fR|fBtitlefR|fBnamefR|fBdescriptionfR|fBportnamefR" 4
  268. .IX Item "--section h1|title|name|description|portname"
  269. Select what to use as the title for each graph in the page.  fBh1fR is
  270. the H1 section from pagetop, fBtitlefR is the graph title, fBnamefR is
  271. the bit in square brackets (option[name]: bla), and fBdescrfR or
  272. &fBdescriptionfR is the text from the Description field of the PageTop
  273. (the Cisco description text if it's available, otherwise just the
  274. interface description). fBportnamefR is the f(CW*(C`Port Name:*(C'fR from pagetop.
  275. .IP "fB--sectionhostfR" 4
  276. .IX Item "--sectionhost"
  277. Extract the hostname from the target line (this does not work if the 
  278. target is a mathematial expression). Prepend the hostname (and a colon)
  279. to the section if not already present.
  280. .IP "fB--rrdviewerfR fIpathfR" 4
  281. .IX Item "--rrdviewer path"
  282. If you have set the fBLogFormat: rrdtoolfR property in the mrtg.cfg
  283. file, the index will take this into account. The only thing you must
  284. tell it is the path to your grapher cgi. (default: /cgi-bin/14all.cgi)
  285. .IP "fB--prefixfR fIpathfR" 4
  286. .IX Item "--prefix path"
  287. By  default we assume    that  the file generated by indexmaker is stored in
  288. &fIWorkDirfR.  If you want to  store it somewhere   else, specify how to reach
  289. &fIWorkDirfR  from  the place where the Index is stored. Note that you have to
  290. use '/' as path separator as this will be used in urls. Speaking of which,
  291. you can even enter a whole url.
  292. .IP "fB--autoprefixfR fIpathfR" 4
  293. .IX Item "--autoprefix path"
  294. Requires --output.
  295. Try to generate the prefix automatically by comparision of the path to the
  296. output file set with --output and the Htmldir set in the configuration files.
  297. Particulary useful when multiple configuration files are specified, with
  298. different Htmldir settings.
  299. .IP "fB--optlogfR" 4
  300. .IX Item "--optlog"
  301. Default is logging in the generated page the command line, suppress with
  302. &--nooptlog . Useful if the commandline contains a complex --pagetop=string
  303. which could confuse simple browsers.
  304. .IP "fB--someoption-filefR fIfilenamefR" 4
  305. .IX Item "--someoption-file filename"
  306. For any someoption which takes a fIstringfR as parameter you can read the
  307. string from a file by adding <-file> to the option keyword. The whole 
  308. content of the file will be read and used as the fIstringfR. The file must
  309. exist.
  310. .SH "AUTHOR"
  311. .IX Header "AUTHOR"
  312. Tobias Oetiker <tobi@oetiker.ch>
  313. .SH "LICENSE"
  314. .IX Header "LICENSE"
  315. &s-1GNUs0 General Public License
  316. .SH "COPYRIGHT"
  317. .IX Header "COPYRIGHT"
  318. 2000-2001 Tobias Oetiker <tobi@oetiker.ch>