about summary refs log tree commit diff stats
path: root/docs/profanity-log.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-log.1')
-rw-r--r--docs/profanity-log.151
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/profanity-log.1 b/docs/profanity-log.1
new file mode 100644
index 00000000..43a86f2f
--- /dev/null
+++ b/docs/profanity-log.1
@@ -0,0 +1,51 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/log
+
+.SH DESCRIPTION
+Manage profanity log settings.
+
+.SH SYNOPSIS
+/log where
+
+.LP
+/log rotate on|off
+
+.LP
+/log maxsize <bytes>
+
+.LP
+/log shared on|off
+
+.LP
+/log level INFO|DEBUG|WARN|ERROR
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBwhere\fR
+.RS 4
+Show the current log file location.
+.RE
+.PP
+\fBrotate on|off\fR
+.RS 4
+Rotate log, default on. Does not take effect if you specified a filename yourself when starting Profanity.
+.RE
+.PP
+\fBmaxsize <bytes>\fR
+.RS 4
+With rotate enabled, specifies the max log size, defaults to 10485760 (10MB).
+.RE
+.PP
+\fBshared on|off\fR
+.RS 4
+Share logs between all instances, default: on. When off, the process id will be included in the log filename. Does not take effect if you specified a filename yourself when starting Profanity.
+.RE
+.PP
+\fBlevel INFO|DEBUG|WARN|EFFOR\fR
+.RS 4
+Set the log level. Default is INFO. Only works with default log file, not with user provided log file during startup via -f.
+.RE