瀏覽代碼

presence: update documentation for new parameter, `force_delete`

Emmanuel Schmidbauer 9 年之前
父節點
當前提交
18029a11e8
共有 1 個文件被更改,包括 22 次插入0 次删除
  1. 22 0
      modules/presence/doc/presence_admin.xml

+ 22 - 0
modules/presence/doc/presence_admin.xml

@@ -278,6 +278,28 @@ modparam("presence", "notifier_processes", 2)
 		</example>
 	</section>
 
+	<section id="presence.p.force_delete">
+		<title><varname>force_delete</varname> (int)</title>
+		<para>
+		Enabling this parameter will delete expired presentity records without updating watchers.
+		</para>
+		<para>
+		Set this parameter to <quote>1<quote> to enable.
+		</para>
+		<para>
+		<emphasis>Default value is <quote>0</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>force_delete</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("presence", "force_delete", 1)
+...
+</programlisting>
+		</example>
+	</section>
+
 	<section id="presence.p.to_tag_pref">
 		<title><varname>to_tag_pref</varname> (str)</title>
 		<para>