corex: docs for shm.rprint rpc command

kamailio · Oct 9, 2023 · 6e02521 · 6e02521
1 parent 8f3d76e
commit 6e02521
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/src/modules/corex/doc/corex_admin.xml b/src/modules/corex/doc/corex_admin.xml
@@ -1105,6 +1105,26 @@ route[reply] {
         <programlisting  format="linespecific">
 		&kamcli; rpc shm.stats
 		</programlisting>
+    </section>
+	<section id="corex.rpc.shm.rprint">
+		<title>
+		<function moreinfo="none">corex.shm.rprint</function>
+		</title>
+		<para>
+			Shared memory usage status report printed to file upon filter match
+			with the file of allocation.
+		</para>
+		<para>
+			It takes two parameters: the path to file where to write the report;
+			the string to match the allocation file (the match is done as value
+			included in the path fo the allocation file).
+		</para>
+		<para>
+		Example:
+		</para>
+        <programlisting  format="linespecific">
+			&kamcli; rpc shm.rprint /tmp/kamailioshm.txt dns_cache.c
+		</programlisting>
     </section>
     </section>