doc/manpage.template

   1 title: Dummy check man page - used as template for new check manuals
   2 agents: linux, windows, aix, solaris, hpux, vms, freebsd, snmp
   3 catalog: see modules/catalog.py for possible values
   4 license: GPL
   5 distribution: check_mk
   6 description:
   7  Describe here: (1) what the check actually does, (2) under which
   8  circumstances it goes warning/critical, (3) which devices are supported
   9  by the check, (4) if the check requires a separated plugin or
  10  tool or separate configuration on the target host.
  11
  12 item:
  13  Describe the syntax and meaning of the check's item here. Provide all
  14  information one needs if coding a manual check with {checks +=} in {main.mk}.
  15  Give an example.  If the check uses {None} as sole item,
  16  then leave out this section.
  17
  18 examples:
  19  # Give examples for configuration in {main.mk} here. If the check has
  20  # configuration variable, then give example for them here.
  21
  22  # set default levels to 40 and 60 percent:
  23  foo_default_values = (40, 60)
  24
  25  # another configuration variable here:
  26  inventory_foo_filter = [ "superfoo", "superfoo2" ]
  27
  28 perfdata:
  29  Describe precisely the number and meaning of performance variables
  30  the check sends. If it outputs no performance data, then leave out this
  31  section.
  32
  33 inventory:
  34  Describe how the inventory for the check works. Which items
  35  will it find? Describe the influence of check specific
  36  configuration parameters to the inventory.
  37
  38 [parameters]
  39 foofirst(int): describe the first parameter here (if parameters are grouped
  40         as tuple)
  41 fooother(string): describe another parameter here.
  42
  43 [configuration]
  44 foo_default_levels(int, int): Describe global configuration variable of
  45     foo here. Important: also tell the user how they are preset.