about summary refs log tree commit diff stats
path: root/docs/profanity-autoping.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-autoping.1')
-rw-r--r--docs/profanity-autoping.127
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/profanity-autoping.1 b/docs/profanity-autoping.1
new file mode 100644
index 00000000..ff37175d
--- /dev/null
+++ b/docs/profanity-autoping.1
@@ -0,0 +1,27 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/autoping
+
+.SH DESCRIPTION
+Set the interval between sending ping requests to the server to ensure the connection is kept alive.
+
+.SH SYNOPSIS
+/autoping set <seconds>
+
+.LP
+/autoping timeout <seconds>
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBset <seconds>\fR
+.RS 4
+Number of seconds between sending pings, a value of 0 disables autoping.
+.RE
+.PP
+\fBtimeout <seconds>\fR
+.RS 4
+Seconds to wait for autoping responses, after which the connection is considered broken.
+.RE