xymon

Hex Artifact Content
Login

Artifact c52057d8c0bd122971faf2c5891424d8056e29e5d06a19ed961f00039b3fb4a5:


0000: 2e 54 48 20 58 59 4d 4f 4e 43 4c 49 45 4e 54 2e  .TH XYMONCLIENT.
0010: 43 46 47 20 35 20 22 56 65 72 73 69 6f 6e 20 34  CFG 5 "Version 4
0020: 2e 33 2e 31 39 3a 20 33 30 20 4d 61 72 20 32 30  .3.19: 30 Mar 20
0030: 31 35 22 20 22 58 79 6d 6f 6e 22 0a 2e 53 48 20  15" "Xymon"..SH 
0040: 4e 41 4d 45 0a 78 79 6d 6f 6e 63 6c 69 65 6e 74  NAME.xymonclient
0050: 2e 63 66 67 20 5c 2d 20 58 79 6d 6f 6e 20 63 6c  .cfg \- Xymon cl
0060: 69 65 6e 74 20 65 6e 76 69 72 6f 6e 6d 65 6e 74  ient environment
0070: 20 76 61 72 69 61 62 6c 65 73 0a 0a 2e 53 48 20   variables...SH 
0080: 44 45 53 43 52 49 50 54 49 4f 4e 0a 58 79 6d 6f  DESCRIPTION.Xymo
0090: 6e 20 70 72 6f 67 72 61 6d 73 20 75 73 65 20 6d  n programs use m
00a0: 75 6c 74 69 70 6c 65 20 65 6e 76 69 72 6f 6e 6d  ultiple environm
00b0: 65 6e 74 20 76 61 72 69 61 62 6c 65 73 20 62 65  ent variables be
00c0: 73 69 64 65 20 74 68 65 0a 6e 6f 72 6d 61 6c 20  side the.normal 
00d0: 73 65 74 20 6f 66 20 76 61 72 69 61 62 6c 65 73  set of variables
00e0: 2e 20 20 46 6f 72 20 74 68 65 20 58 79 6d 6f 6e  .  For the Xymon
00f0: 20 63 6c 69 65 6e 74 2c 20 74 68 65 20 65 6e 76   client, the env
0100: 69 72 6f 6e 6d 65 6e 74 20 0a 64 65 66 69 6e 69  ironment .defini
0110: 74 69 6f 6e 73 20 61 72 65 20 73 74 6f 72 65 64  tions are stored
0120: 20 69 6e 20 74 68 65 20 7e 78 79 6d 6f 6e 2f 63   in the ~xymon/c
0130: 6c 69 65 6e 74 2f 65 74 63 2f 78 79 6d 6f 6e 63  lient/etc/xymonc
0140: 6c 69 65 6e 74 2e 63 66 67 20 66 69 6c 65 2e 20  lient.cfg file. 
0150: 0a 45 61 63 68 20 6c 69 6e 65 20 69 6e 20 74 68  .Each line in th
0160: 69 73 20 66 69 6c 65 20 69 73 20 6f 66 20 74 68  is file is of th
0170: 65 20 66 6f 72 6d 20 5c 66 42 4e 41 4d 45 3d 56  e form \fBNAME=V
0180: 41 4c 55 45 5c 66 52 20 61 6e 64 20 64 65 66 69  ALUE\fR and defi
0190: 6e 65 73 0a 6f 6e 65 20 65 6e 76 69 72 6f 6e 6d  nes.one environm
01a0: 65 6e 74 20 76 61 72 69 61 62 6c 65 20 4e 41 4d  ent variable NAM
01b0: 45 20 77 69 74 68 20 74 68 65 20 76 61 6c 75 65  E with the value
01c0: 20 56 41 4c 55 45 2e 0a 0a 2e 53 48 20 53 45 54   VALUE....SH SET
01d0: 54 49 4e 47 53 0a 2e 49 50 20 58 59 4d 53 52 56  TINGS..IP XYMSRV
01e0: 0a 54 68 65 20 49 50 2d 61 64 64 72 65 73 73 20  .The IP-address 
01f0: 75 73 65 64 20 74 6f 20 63 6f 6e 74 61 63 74 20  used to contact 
0200: 74 68 65 20 58 79 6d 6f 6e 20 73 65 72 76 65 72  the Xymon server
0210: 2e 20 44 65 66 61 75 6c 74 3a 0a 43 68 6f 73 65  . Default:.Chose
0220: 6e 20 77 68 65 6e 20 74 68 65 20 58 79 6d 6f 6e  n when the Xymon
0230: 20 63 6c 69 65 6e 74 20 77 61 73 20 63 6f 6d 70   client was comp
0240: 69 6c 65 64 2e 0a 0a 2e 49 50 20 58 59 4d 53 45  iled....IP XYMSE
0250: 52 56 45 52 53 0a 4c 69 73 74 20 6f 66 20 49 50  RVERS.List of IP
0260: 2d 61 64 72 65 73 73 65 73 20 6f 66 20 58 79 6d  -adresses of Xym
0270: 6f 6e 20 73 65 72 76 65 72 73 2e 20 44 61 74 61  on servers. Data
0280: 20 77 69 6c 6c 20 62 65 20 73 65 6e 74 20 74 6f   will be sent to
0290: 0a 61 6c 6c 20 6f 66 20 74 68 65 20 73 65 72 76  .all of the serv
02a0: 65 72 73 20 6c 69 73 74 65 64 20 68 65 72 65 2e  ers listed here.
02b0: 20 54 68 69 73 20 73 65 74 74 69 6e 67 20 69 73   This setting is
02c0: 20 6f 6e 6c 79 20 75 73 65 64 20 69 66 20 0a 58   only used if .X
02d0: 59 4d 53 52 56 3d 30 2e 30 2e 30 2e 30 2e 0a 0a  YMSRV=0.0.0.0...
02e0: 2e 49 50 20 58 59 4d 4f 4e 44 50 4f 52 54 0a 54  .IP XYMONDPORT.T
02f0: 68 65 20 70 6f 72 74 20 6e 75 6d 62 65 72 20 66  he port number f
0300: 6f 72 20 75 73 65 64 20 74 6f 20 63 6f 6e 74 61  or used to conta
0310: 63 74 20 74 68 65 20 58 79 6d 6f 6e 20 73 65 72  ct the Xymon ser
0320: 76 65 72 2e 0a 44 65 66 61 75 6c 74 3a 20 31 39  ver..Default: 19
0330: 38 34 2e 0a 0a 2e 49 50 20 58 59 4d 4f 4e 48 4f  84....IP XYMONHO
0340: 4d 45 0a 54 68 65 20 58 79 6d 6f 6e 20 63 6c 69  ME.The Xymon cli
0350: 65 6e 74 20 74 6f 70 2d 6c 65 76 65 6c 20 64 69  ent top-level di
0360: 72 65 63 74 6f 72 79 2e 20 44 65 66 61 75 6c 74  rectory. Default
0370: 3a 20 54 68 65 0a 24 58 59 4d 4f 4e 43 4c 49 45  : The.$XYMONCLIE
0380: 4e 54 48 4f 4d 45 20 73 65 74 74 69 6e 67 20 69  NTHOME setting i
0390: 6e 68 65 72 69 74 65 64 20 66 72 6f 6d 20 74 68  nherited from th
03a0: 65 20 22 72 75 6e 63 6c 69 65 6e 74 2e 73 68 22  e "runclient.sh"
03b0: 0a 73 63 72 69 70 74 20 77 68 69 63 68 20 73 74  .script which st
03c0: 61 72 74 73 20 74 68 65 20 58 79 6d 6f 6e 20 63  arts the Xymon c
03d0: 6c 69 65 6e 74 2e 0a 0a 2e 49 50 20 58 59 4d 4f  lient....IP XYMO
03e0: 4e 43 4c 49 45 4e 54 4c 4f 47 53 0a 54 68 65 20  NCLIENTLOGS.The 
03f0: 64 69 72 65 63 74 6f 72 79 20 66 6f 72 20 74 68  directory for th
0400: 65 20 58 79 6d 6f 6e 20 63 6c 69 65 6e 74 73 27  e Xymon clients'
0410: 20 6f 77 6e 20 6c 6f 67 20 66 69 6c 65 73 2e 20   own log files. 
0420: 44 65 66 61 75 6c 74 3a 0a 24 58 59 4d 4f 4e 48  Default:.$XYMONH
0430: 4f 4d 45 2f 6c 6f 67 73 0a 0a 2e 49 50 20 58 59  OME/logs...IP XY
0440: 4d 4f 4e 54 4d 50 0a 44 69 72 65 63 74 6f 72 79  MONTMP.Directory
0450: 20 75 73 65 64 20 66 6f 72 20 74 65 6d 70 6f 72   used for tempor
0460: 61 72 79 20 66 69 6c 65 73 2e 20 44 65 66 61 75  ary files. Defau
0470: 6c 74 3a 20 24 58 59 4d 4f 4e 48 4f 4d 45 2f 74  lt: $XYMONHOME/t
0480: 6d 70 2f 0a 0a 2e 49 50 20 58 59 4d 4f 4e 0a 46  mp/...IP XYMON.F
0490: 75 6c 6c 20 70 61 74 68 20 74 6f 20 74 68 65 20  ull path to the 
04a0: 0a 2e 49 20 78 79 6d 6f 6e 28 31 29 0a 63 6c 69  ..I xymon(1).cli
04b0: 65 6e 74 20 70 72 6f 67 72 61 6d 2e 20 44 65 66  ent program. Def
04c0: 61 75 6c 74 3a 20 24 58 59 4d 4f 4e 48 4f 4d 45  ault: $XYMONHOME
04d0: 2f 62 69 6e 2f 78 79 6d 6f 6e 2e 0a 0a 2e 49 50  /bin/xymon....IP
04e0: 20 43 6f 6d 6d 61 6e 64 73 0a 4d 61 6e 79 20 65   Commands.Many e
04f0: 78 74 65 6e 73 69 6f 6e 20 73 63 72 69 70 74 73  xtension scripts
0500: 20 65 78 70 65 63 74 20 61 20 73 65 72 69 65 73   expect a series
0510: 20 6f 66 20 65 6e 76 69 72 6f 6e 6d 65 6e 74 20   of environment 
0520: 76 61 72 69 61 62 6c 65 73 20 74 6f 0a 70 6f 69  variables to.poi
0530: 6e 74 20 61 74 20 76 61 72 69 6f 75 73 20 73 79  nt at various sy
0540: 73 74 65 6d 20 75 74 69 6c 69 74 69 65 73 2e 20  stem utilities. 
0550: 54 68 65 73 65 20 61 72 65 20 69 6e 63 6c 75 64  These are includ
0560: 65 64 20 69 6e 20 74 68 65 20 66 69 6c 65 0a 77  ed in the file.w
0570: 68 65 6e 20 74 68 65 20 63 6c 69 65 6e 74 20 69  hen the client i
0580: 73 20 62 75 69 6c 74 2e 0a 0a 2e 53 48 20 49 4e  s built....SH IN
0590: 48 45 52 49 54 45 44 20 53 45 54 54 49 4e 47 53  HERITED SETTINGS
05a0: 0a 53 6f 6d 65 20 65 6e 76 69 72 6f 6e 6d 65 6e  .Some environmen
05b0: 74 20 76 61 72 69 61 62 6c 65 73 20 61 72 65 20  t variables are 
05c0: 69 6e 68 65 72 69 74 65 64 20 66 72 6f 6d 20 74  inherited from t
05d0: 68 65 20 22 72 75 6e 63 6c 69 65 6e 74 2e 73 68  he "runclient.sh
05e0: 22 0a 73 63 72 69 70 74 20 77 68 69 63 68 20 6c  ".script which l
05f0: 61 75 6e 63 68 65 73 20 74 68 65 20 58 79 6d 6f  aunches the Xymo
0600: 6e 20 63 6c 69 65 6e 74 3a 0a 0a 2e 49 50 20 4d  n client:...IP M
0610: 41 43 48 49 4e 45 44 4f 54 53 0a 54 68 65 20 68  ACHINEDOTS.The h
0620: 6f 73 74 6e 61 6d 65 20 6f 66 20 74 68 65 20 6c  ostname of the l
0630: 6f 63 61 6c 20 73 79 73 74 65 6d 2e 20 44 65 66  ocal system. Def
0640: 61 75 6c 74 3a 20 54 61 6b 65 6e 20 66 72 6f 6d  ault: Taken from
0650: 20 22 75 6e 61 6d 65 20 2d 6e 22 2e 0a 0a 2e 49   "uname -n"....I
0660: 50 20 4d 41 43 48 49 4e 45 0a 54 68 65 20 68 6f  P MACHINE.The ho
0670: 73 74 6e 61 6d 65 20 6f 66 20 74 68 65 20 6c 6f  stname of the lo
0680: 63 61 6c 20 73 79 73 74 65 6d 2c 20 77 69 74 68  cal system, with
0690: 20 64 6f 74 73 20 72 65 70 6c 61 63 65 64 20 62   dots replaced b
06a0: 79 20 63 6f 6d 6d 61 73 2e 0a 46 6f 72 20 63 6f  y commas..For co
06b0: 6d 70 61 74 69 62 69 6c 69 74 79 20 77 69 74 68  mpatibility with
06c0: 20 42 69 67 20 42 72 6f 74 68 65 72 20 65 78 74   Big Brother ext
06d0: 65 6e 73 69 6f 6e 20 73 63 72 69 70 74 73 2e 0a  ension scripts..
06e0: 0a 2e 49 50 20 53 45 52 56 45 52 4f 53 54 59 50  ..IP SERVEROSTYP
06f0: 45 0a 54 68 65 20 6f 70 65 72 61 74 69 6e 67 20  E.The operating 
0700: 73 79 73 74 65 6d 20 6f 66 20 74 68 65 20 6c 6f  system of the lo
0710: 63 61 6c 20 73 79 73 74 65 6d 2c 20 69 6e 20 6c  cal system, in l
0720: 6f 77 65 72 63 61 73 65 2e 20 44 65 66 61 75 6c  owercase. Defaul
0730: 74 3a 0a 74 61 6b 65 6e 20 66 72 6f 6d 20 22 75  t:.taken from "u
0740: 6e 61 6d 65 20 2d 73 22 2e 0a 0a 2e 49 50 20 58  name -s"....IP X
0750: 59 4d 4f 4e 43 4c 49 45 4e 54 48 4f 4d 45 0a 54  YMONCLIENTHOME.T
0760: 68 65 20 74 6f 70 2d 6c 65 76 65 6c 20 64 69 72  he top-level dir
0770: 65 63 74 6f 72 79 20 66 6f 72 20 74 68 65 20 58  ectory for the X
0780: 79 6d 6f 6e 20 63 6c 69 65 6e 74 2e 20 44 65 66  ymon client. Def
0790: 61 75 6c 74 3a 20 54 68 65 20 6c 6f 63 61 74 69  ault: The locati
07a0: 6f 6e 0a 6f 66 20 74 68 65 20 22 72 75 6e 63 6c  on.of the "runcl
07b0: 69 65 6e 74 2e 73 68 22 20 73 63 72 69 70 74 2e  ient.sh" script.
07c0: 0a 0a 2e 53 48 20 22 53 45 45 20 41 4c 53 4f 22  ...SH "SEE ALSO"
07d0: 0a 78 79 6d 6f 6e 28 37 29 0a 0a                 .xymon(7)..