|
@@ -1,5 +1,5 @@
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
|
|
|
|
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
[ <!-- Include general documentation entities -->
|
|
[ <!-- Include general documentation entities -->
|
|
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
|
|
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
|
|
@@ -10,13 +10,16 @@
|
|
<section id="cnts.rpcs" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<section id="cnts.rpcs" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<sectioninfo>
|
|
<sectioninfo>
|
|
</sectioninfo>
|
|
</sectioninfo>
|
|
- <title>counters RPC Functions</title>
|
|
|
|
|
|
+ <title>RPC Commands</title>
|
|
|
|
|
|
- <section id="cnt.get">
|
|
|
|
- <title> <function>cnt.get group counter_name</function></title>
|
|
|
|
|
|
+ <section id="cnt.r.get">
|
|
|
|
+ <title> <function>cnt.get</function></title>
|
|
<para>
|
|
<para>
|
|
Get the value of the counter identified by group.counter_name.
|
|
Get the value of the counter identified by group.counter_name.
|
|
</para>
|
|
</para>
|
|
|
|
+ <para>
|
|
|
|
+ Prototype: cnt.get group counter_name
|
|
|
|
+ </para>
|
|
<example>
|
|
<example>
|
|
<title><function>cnt.get grp counter_name</function> usage</title>
|
|
<title><function>cnt.get grp counter_name</function> usage</title>
|
|
<programlisting>
|
|
<programlisting>
|
|
@@ -25,11 +28,14 @@
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
- <section id="cnt.reset">
|
|
|
|
- <title> <function>cnt.reset group counter_name</function></title>
|
|
|
|
|
|
+ <section id="cnt.r.reset">
|
|
|
|
+ <title> <function>cnt.reset</function></title>
|
|
<para>
|
|
<para>
|
|
Resets the counter identified by group.counter_name.
|
|
Resets the counter identified by group.counter_name.
|
|
</para>
|
|
</para>
|
|
|
|
+ <para>
|
|
|
|
+ Prototype: cnt.reset group counter_name
|
|
|
|
+ </para>
|
|
<example>
|
|
<example>
|
|
<title><function>cnt.reset grp name</function> usage</title>
|
|
<title><function>cnt.reset grp name</function> usage</title>
|
|
<programlisting>
|
|
<programlisting>
|
|
@@ -38,52 +44,85 @@
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
- <section id="cnt.grps_list">
|
|
|
|
- <title> <function>cnt.grps_list</function></title>
|
|
|
|
|
|
+ <section id="cnt.r.list_groups">
|
|
|
|
+ <title> <function>cnt.list_groups</function></title>
|
|
<para>
|
|
<para>
|
|
Lists all the declared counter groups.
|
|
Lists all the declared counter groups.
|
|
</para>
|
|
</para>
|
|
|
|
+ <para>
|
|
|
|
+ Prototype: cnt.list_groups
|
|
|
|
+ </para>
|
|
<example>
|
|
<example>
|
|
- <title><function>cnt.grps_list</function> usage</title>
|
|
|
|
|
|
+ <title><function>cnt.list_groups</function> usage</title>
|
|
<programlisting>
|
|
<programlisting>
|
|
- $ &sercmd; cnt.grps_list
|
|
|
|
|
|
+ $ &sercmd; cnt.list_groups
|
|
</programlisting>
|
|
</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
- <section id="cnt.var_list">
|
|
|
|
- <title> <function>cnt.var_list group</function></title>
|
|
|
|
|
|
+ <section id="cnt.r.grps_list">
|
|
|
|
+ <title> <function>cnt.grps_list</function></title>
|
|
|
|
+ <para>
|
|
|
|
+ Alias to cnt.list_groups.
|
|
|
|
+ </para>
|
|
|
|
+ </section>
|
|
|
|
+
|
|
|
|
+ <section id="cnt.r.list_vars">
|
|
|
|
+ <title> <function>cnt.list_vars</function></title>
|
|
<para>
|
|
<para>
|
|
Lists all the names of all the counters belonging to the
|
|
Lists all the names of all the counters belonging to the
|
|
specified group.
|
|
specified group.
|
|
</para>
|
|
</para>
|
|
|
|
+ <para>
|
|
|
|
+ Prototype: cnt.list_vars group
|
|
|
|
+ </para>
|
|
<example>
|
|
<example>
|
|
- <title><function>cnt.var_list group</function> usage</title>
|
|
|
|
|
|
+ <title><function>cnt.list_vars group</function> usage</title>
|
|
<programlisting>
|
|
<programlisting>
|
|
- $ &sercmd; cnt.var_list script
|
|
|
|
|
|
+ $ &sercmd; cnt.list_vars tmx
|
|
</programlisting>
|
|
</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
- <section id="cnt.grp_get_all">
|
|
|
|
- <title> <function>cnt.grp_get_all</function></title>
|
|
|
|
|
|
+ <section id="cnt.r.var_list">
|
|
|
|
+ <title> <function>cnt.var_list</function></title>
|
|
|
|
+ <para>
|
|
|
|
+ Alias to cnt.list_vars.
|
|
|
|
+ </para>
|
|
|
|
+ </section>
|
|
|
|
+
|
|
|
|
+ <section id="cnt.r.get_vars">
|
|
|
|
+ <title> <function>cnt.get_vars</function></title>
|
|
<para>
|
|
<para>
|
|
Lists all the counter names and their values in the
|
|
Lists all the counter names and their values in the
|
|
specified group.
|
|
specified group.
|
|
</para>
|
|
</para>
|
|
|
|
+ <para>
|
|
|
|
+ Prototype: cnt.get_vars group
|
|
|
|
+ </para>
|
|
<example>
|
|
<example>
|
|
- <title><function>cnt.var_list group</function> usage</title>
|
|
|
|
|
|
+ <title><function>cnt.get_vars group</function> usage</title>
|
|
<programlisting>
|
|
<programlisting>
|
|
- $ &sercmd; cnt.grp_get_all script
|
|
|
|
|
|
+ $ &sercmd; cnt.get_vars script
|
|
</programlisting>
|
|
</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
- <section id="cnt.help">
|
|
|
|
- <title> <function>cnt.help group counter_name</function></title>
|
|
|
|
|
|
+ <section id="cnt.r.grp_get_all">
|
|
|
|
+ <title> <function>cnt.grp_get_all</function></title>
|
|
|
|
+ <para>
|
|
|
|
+ Alias to cnt.get_vars.
|
|
|
|
+ </para>
|
|
|
|
+ </section>
|
|
|
|
+
|
|
|
|
+ <section id="cnt.r.help">
|
|
|
|
+ <title> <function>cnt.help</function></title>
|
|
<para>
|
|
<para>
|
|
Displays the counter description.
|
|
Displays the counter description.
|
|
</para>
|
|
</para>
|
|
|
|
+ <para>
|
|
|
|
+ Prototype: cnt.help group counter_name
|
|
|
|
+ </para>
|
|
<example>
|
|
<example>
|
|
<title><function>cnt.help grp name</function> usage</title>
|
|
<title><function>cnt.help grp name</function> usage</title>
|
|
<programlisting>
|
|
<programlisting>
|