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

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 "MRTG-UNIX-GUIDE 1"
  132. .TH MRTG-UNIX-GUIDE 1 "2006-02-03" "2.13.2" "mrtg"
  133. .SH "NAME"
  134. mrtg-unix-guide - Instructions for running MRTG 2.13.2 on a Unix Box
  135. .SH "DESCRIPTION"
  136. .IX Header "DESCRIPTION"
  137. &s-1MRTGs0 comes to you in Source Code. This means that you have to compile
  138. parts of it before you can use it on a Unix machine. These instructions
  139. help you to do so.
  140. .SH "PREPARATION"
  141. .IX Header "PREPARATION"
  142. In order to compile and use mrtg you need a C compiler and a copy of perl
  143. installed on your machine. In most cases this will already be available.
  144. In case it is not, here are some starting points. Below I'll give you
  145. a detailed run through the whole compilation process.
  146. .IP "s-1GCCs0" 4
  147. .IX Item "GCC"
  148. The s-1GNUs0 C compiler comes preinstalled on most of the free Unicies out
  149. there.  For commercial derivatives you may have to download and compile
  150. it first. If you have no compiler at all there is a chicken and egg
  151. problem, but there are also precompiled versions of gcc available for
  152. most operating systems.
  153. .Sp
  154. .Vb 1
  155. & http://gcc.gnu.org/
  156. .Ve
  157. .IP "Perl" 4
  158. .IX Item "Perl"
  159. Large parts of the s-1MRTGs0 system are written in the Perl scripting language.
  160. Make sure there is a recent copy of perl on your machine (try perl -v).
  161. At least version 5.005 is required for mrtg to work well.
  162. You can get the latest perl from
  163. .Sp
  164. .Vb 1
  165. & http://www.perl.com/
  166. .Ve
  167. .PP
  168. &s-1MRTGs0 generates traffic graphs in the s-1PNGs0 format. To be able to do this it
  169. needs several 3rd party libraries. When compiling these libraries I urge you
  170. to make sure you compile them as fBstaticfR libraries. There is just much
  171. less trouble ahead if you are doing it like this. See the Instructions in
  172. the next section for inspiration. Note that many free unices have all
  173. the required libraries already in place so there is no need to install
  174. another copy. To check it is best to skip all the library instructions below
  175. and go straight into the mrtg compile.
  176. .PP
  177. If the first attempt fails and you do not get a working version of mrtg,
  178. try compiling new copies of all libraries as explained below. Do this
  179. &fBs-1BEFOREs0fR you send email to me about problems compiling mrtg.
  180. .IP "gd" 4
  181. .IX Item "gd"
  182. This is a basic graph drawing library created by Thomas Boutell.
  183. Note that all releases after Version 1.3 only create
  184. &s-1PNGs0 images. This is because a) Thomas got into trouble because the s-1GIFs0
  185. format which it used to produce uses a compression technology patented
  186. by Unisys. b) s-1PNGs0 is more efficient and patent free. s-1MRTGs0 can work
  187. with old and new version of the s-1GDs0 library. You can get a recent copy
  188. of s-1GDs0 from:
  189. .Sp
  190. .Vb 1
  191. & http://www.boutell.com/gd/
  192. .Ve
  193. .IP "libpng" 4
  194. .IX Item "libpng"
  195. Is required by gd in order to produce s-1PNGs0 graphics files. Get it from:
  196. .Sp
  197. .Vb 1
  198. & http://www.libpng.org/pub/png/libpng.html
  199. .Ve
  200. .IP "zlib" 4
  201. .IX Item "zlib"
  202. Is needed by libpng to compress the graphics files you create.
  203. Get a copy from
  204. .Sp
  205. .Vb 1
  206. & http://www.gzip.org/zlib
  207. .Ve
  208. .PP
  209. And last but not least you also need mrtg itself. In case you have not
  210. yet downloaded it, you can find a copy on my website:
  211. .PP
  212. .Vb 1
  213. & http://people.ee.ethz.ch/~oetiker/webtools/mrtg/pub/
  214. .Ve
  215. .SH "LIBRARY COMPILATION"
  216. .IX Header "LIBRARY COMPILATION"
  217. In this section I will give you step by step instructions on how to compile
  218. the various libraries required for the compilation of mrtg. Note that these
  219. libaries may already be installed if you have a fI*BSDfR or fILinuxfR system
  220. so you can skip recompiling them. The fBwgetfR program used below is a
  221. simple web downloader. You can also enter the address into your fBnetscapefR
  222. if you don't have fBwgetfR available.
  223. .PP
  224. First let's create a directory for the compilation. Note that this may
  225. already exist on your system. No problem, just use it.
  226. .PP
  227. .Vb 2
  228. & mkdir -p /usr/local/src
  229. & cd /usr/local/src
  230. .Ve
  231. .PP
  232. If you do not have zlib installed:
  233. .PP
  234. .Vb 8
  235. & wget http://www.gzip.org/zlib/zlib-1.1.4.tar.gz
  236. & gunzip -c zlib-*.tar.gz | tar xf -
  237. & rm zlib-*.tar.gz
  238. & mv zlib-* zlib
  239. & cd zlib
  240. & ./configure
  241. & make
  242. & cd ..
  243. .Ve
  244. .PP
  245. If you don't have libpng installed
  246. .PP
  247. .Vb 8
  248. & wget http://public.planetmirror.com/pub/sourceforge/l/li/libpng/libpng-1.0.15.tar.gz
  249. & gunzip -c libpng-*.tar.gz |tar xf -
  250. & rm libpng-*.tar.gz
  251. & mv libpng-* libpng
  252. & cd libpng
  253. & make -f scripts/makefile.std CC=gcc ZLIBLIB=../zlib ZLIBINC=../zlib
  254. & rm *.so.* *.so
  255. & cd ..
  256. .Ve
  257. .PP
  258. And now you can compile gd
  259. .PP
  260. For versions up to 1.8.4, try:
  261. .PP
  262. .Vb 5
  263. & wget http://www.boutell.com/gd/http/gd-1.8.4.tar.gz
  264. & gunzip -c gd-*.tar.gz |tar xf -
  265. & rm gd-*.tar.gz
  266. & mv gd-* gd
  267. & cd gd
  268. .Ve
  269. .PP
  270. The e characters at the end of the following lines mean that all the
  271. following material should actually be written on a single line.
  272. .PP
  273. .Vb 6
  274. & perl -i~ -p -e s/gd_jpeg.o//g Makefile            
  275. & make INCLUDEDIRS="-I. -I../zlib -I../libpng" e
  276. &      LIBDIRS="-L../zlib -L. -L../libpng" e
  277. &      LIBS="-lgd -lpng -lz -lm" e
  278. &      CFLAGS="-O -DHAVE_LIBPNG"
  279. & cd ..
  280. .Ve
  281. .PP
  282. For version starting around 2.0.11, try:
  283. .PP
  284. .Vb 8
  285. & wget http://www.boutell.com/gd/http/gd-2.0.11.tar.gz
  286. & gunzip -c gd-2.0.11.tar.gz |tar xf -
  287. & mv gd-2.0.11 gd
  288. & cd gd
  289. & env CPPFLAGS="-I../zlib -I../libpng" LDFLAGS="-L../zlib -L../libpng" ./configure --disable-shared e
  290. &     --without-freetype --without-jpeg
  291. & make
  292. & cp .libs/* .
  293. .Ve
  294. .SH "MRTG COMPILATION"
  295. .IX Header "MRTG COMPILATION"
  296. Ok, now everything is ready for the mrtg compilation.
  297. .PP
  298. .Vb 3
  299. & cd /usr/local/src
  300. & gunzip -c mrtg-2.13.2.tar.gz | tar xvf -
  301. & cd mrtg-2.13.2
  302. .Ve
  303. .PP
  304. If all the libraries have been preinstalled on your system you can
  305. configure mrtg by doing a simple:
  306. .PP
  307. .Vb 1
  308. & ./configure --prefix=/usr/local/mrtg-2
  309. .Ve
  310. .PP
  311. Otherwise you may have to give some hints on where to find the
  312. various libraries required to compile mrtg:
  313. .PP
  314. .Vb 4
  315. & ./configure --prefix=/usr/local/mrtg-2       e
  316. &             --with-gd=/usr/local/src/gd      e
  317. &             --with-z=/usr/local/src/zlib     e
  318. &             --with-png=/usr/local/src/libpng
  319. .Ve
  320. .PP
  321. If you have RRDtool available you might want to tell mrtg about it
  322. so that you can opt to use rrdtool with mrtg. Check mrtg-rrd.
  323. .PP
  324. Configure will make sure your environment is fit for building mrtg.
  325. If it finds a problem, it will tell you so and it will also tell
  326. you what to do about it. If everything is s-1OKs0, you will end up with
  327. a custom Makefile for your system. Now type:
  328. .PP
  329. .Vb 1
  330. & make
  331. .Ve
  332. .PP
  333. This builds the rateup binary and edits all the perl pathnames in
  334. the scripts. You can now install mrtg by typing
  335. .PP
  336. .Vb 1
  337. & make install   (requires gnu install)
  338. .Ve
  339. .PP
  340. All the software required by s-1MRTGs0 is now installed under
  341. the fI/usr/local/mrtg-2fR subdirectory.
  342. .PP
  343. You can now safely delete the libraries we compiled above. Then
  344. again, you might want to keep them around so that you have them
  345. available when compiling the next version of mrtg.
  346. .SH "CONFIGURATION"
  347. .IX Header "CONFIGURATION"
  348. The next step is to configure mrtg for monitoring a network
  349. device.  This is done by creating an fImrtg.cfgfR file which defines
  350. what you want to monitor. Luckily, you don't have to dive straight in
  351. and start writing your own configuration file all by
  352. yourself. Together with mrtg you also got a copy of fBcfgmakerfR. This
  353. is a script you can point at a router of your choice; it will
  354. create a mrtg configuration file for you. You can find the script in
  355. the fIbinfR subdirectory.
  356. .PP
  357. .Vb 4
  358. & cfgmaker --global 'WorkDir: /home/httpd/mrtg'  e
  359. &          --global 'Options[_]: bits,growright' e
  360. &          --output /home/mrtg/cfg/mrtg.cfg    e
  361. &           community@router.abc.xyz
  362. .Ve
  363. .PP
  364. This example above will create an mrtg config file in
  365. &fI/home/mrtg/cfgfR assuming this is a directory visible on your
  366. webserver. You can read all about cfgmaker in cfgmaker. One area you might
  367. want to look at is the possibility of using fB--ifref=ipfR to prevent
  368. interface renumbering troubles from catching you.
  369. .PP
  370. If you want to start rolling your own mrtg configuration files, make sure
  371. you read mrtg-reference to learn all about the possible configuration options.
  372. .SH "RUNNING MRTG"
  373. .IX Header "RUNNING MRTG"
  374. Once you have created a configuration file, try the following:
  375. .PP
  376. .Vb 1
  377. & /usr/local/mrtg-2/bin/mrtg /home/mrtg/cfg/mrtg.cfg
  378. .Ve
  379. .PP
  380. This will query your router and also create your first mrtg trafic
  381. graphs and webpages. When you run mrtg for the first time there will
  382. be a lot of complaints about missing log files. Don't worry, this is
  383. normal for the first 2 times you start mrtg. If it keeps complaining
  384. after this time you might want to look into the problem.
  385. .PP
  386. Starting mrtg by hand is not ideal in the long run. So when you are
  387. satisfied with the results you can automate the process of running mrtg in
  388. regular intervals (this means every 5 minutes by default).
  389. .PP
  390. You can either add mrtg to your crontab with a line like this:
  391. .PP
  392. .Vb 3
  393. & 0,5,10,15,20,25,30,35,40,45,50,55 * * * * e
  394. &       <mrtg-bin>/mrtg <path to mrtg-cfg>/mrtg.cfg e
  395. &                --logging /var/log/mrtg.log
  396. .Ve
  397. .PP
  398. or if you live in Linux Land the line may look like this if you are
  399. using f(CW*(C`crontab -e*(C'fR
  400. .PP
  401. .Vb 2
  402. & */5 * * * *  <mrtg-bin>/mrtg <path to mrtg-cfg>/mrtg.cfg e
  403. &                       --logging /var/log/mrtg.log
  404. .Ve
  405. .PP
  406. or like this if you use fI/etc/crontabfR
  407. .PP
  408. .Vb 2
  409. & */5 * * * *  mrtg-user  <mrtg-bin>/mrtg <path to mrtg-cfg>/mrtg.cfg e
  410. &                                 --logging /var/log/mrtg.log
  411. .Ve
  412. .PP
  413. You can also run mrtg as a daemon process by adding the line
  414. .PP
  415. .Vb 1
  416. & RunAsDaemon: Yes
  417. .Ve
  418. .PP
  419. to your mrtg configuration file and then creating a startup script in
  420. your system startup sequence. Unfortunately, adding startup scripts
  421. differs widely amongst different unix systems. The modern ones normally
  422. have a directory called fI/etc/init.dfR or fI/etc/rc.d/init.dfR where you
  423. put scripts which starts the process you want to run when the system
  424. boots. Further you must create a symbolic link in fI/etc/rc3.dfR or
  425. &fI/etc/rc.d/rc?.dfR called fIS65mrtgfR (this is just a sample name
  426. &... it is just important that it starts with S followed by a two digit
  427. number). If you are not sure about this, make sure you consult the
  428. documentation of your system to make sure you get this right.
  429. .PP
  430. A fBminimalfR script to put into fIinit.dfR might look like this:
  431. .PP
  432. .Vb 3
  433. & #! /bin/sh
  434. & cd /usr/local/mrtg-2.13.2/bin && ./mrtg --user=mrtg-user e
  435. &       /home/httpd/mrtg/mrtg.cfg  --logging /var/log/mrtg.log
  436. .Ve
  437. .PP
  438. Note that this will only work with fBRunAsDaemon: YesfR in your
  439. mrtg.cfg file.
  440. .SH "AUTHOR"
  441. .IX Header "AUTHOR"
  442. Tobias Oetiker <oetiker@ee.ethz.ch>