counters_params.xml 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
  4. [ <!-- Include general documentation entities -->
  5. <!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
  6. %docentities;
  7. ]
  8. >
  9. <section id="cnts.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
  10. <sectioninfo>
  11. </sectioninfo>
  12. <title>Parameters</title>
  13. <section id="scrip_counter">
  14. <title><varname>script_counter</varname></title>
  15. <para>
  16. Define a new counter that can be used from the script.
  17. The declaration might include a group in front of the counter
  18. name, separated with '.'. It might also include a counter
  19. description string (help message), separated from the name
  20. with a ' ' or ':'.
  21. If the group is missing, the group defined in the
  22. <varname>script_cnt_grp_name</varname> module parameter will
  23. be used (the default is "script").
  24. If the description is missing, the default is
  25. "custom script counter".
  26. The format of the declaration is: [group.]name[( |:)description].
  27. </para>
  28. <example>
  29. <title>
  30. Create a new <varname>script_counter</varname>
  31. </title>
  32. <programlisting>
  33. modparam("counters", "script_counter", "foo") # script.foo
  34. modparam("counters", "script_counter", "test.bar") # test.bar
  35. modparam("counters", "script_counter", "baz example counter") # script.baz
  36. modparam("counters", "script_counter", "test.x:another example") # test.x
  37. </programlisting>
  38. </example>
  39. </section>
  40. <section id="scrip_cnt_grp_name">
  41. <title><varname>script_cnt_grp_name</varname></title>
  42. <para>
  43. Group name that will be used for the counters defined
  44. via the <varname>script_counter</varname> module parameter which
  45. do not have a specified group.
  46. </para>
  47. <para>
  48. Default: "script".
  49. </para>
  50. <example>
  51. <title>
  52. Set <varname>script_cnt_grp_name</varname> in the config file
  53. </title>
  54. <programlisting>
  55. modparam("counters", "script_cnt_grp_name", "my_counters")
  56. </programlisting>
  57. </example>
  58. </section>
  59. </section>