From 2606907dc8137e145820968ba693ef00087aa690 Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Mon, 11 Apr 2022 11:24:36 +0200 Subject: [PATCH] [doc] Update debugging manpage. --- doc/rofi-debugging.5 | 29 ++++++++++++++++++++++++++--- doc/rofi-debugging.5.markdown | 19 +++++++++++++++++++ 2 files changed, 45 insertions(+), 3 deletions(-) diff --git a/doc/rofi-debugging.5 b/doc/rofi-debugging.5 index 6eb58331..3b9cc5bb 100644 --- a/doc/rofi-debugging.5 +++ b/doc/rofi-debugging.5 @@ -11,13 +11,36 @@ to help pin\-point the problem. First try disabling your custom configuration: \fB\fC\-no\-config\fR .PP -Disable parsing of configuration. This runs rofi in \fIstock\fP mode. +This disables the parsing of the configuration files. This runs rofi in \fIstock\fP mode. .PP -If you run custom C plugins, you can disable them using: \fB\fC\-no\-plugins\fR +If you run custom C plugins, you can disable the plugins using: \fB\fC\-no\-plugins\fR + +.SH Get the relevant information for an issue +.PP +Please pastebin the output of the following commands: .PP -Disables the loading of plugins. +.RS + +.nf +rofi \-help +rofi \-dump\-config +rofi \-dump\-theme + +.fi +.RE + +.PP +\fB\fCrofi \-help\fR provides us with the configuration files parsed, the exact version, monitor layout +and more useful information. + +.PP +The \fB\fCrofi \-dump\-config\fR and \fB\fCrofi \-dump\-theme\fR output gives us \fB\fCrofi\fR +interpretation of your configuration and theme. + +.PP +Please check the output for identifiable information and remove this. .SH Timing traces .PP diff --git a/doc/rofi-debugging.5.markdown b/doc/rofi-debugging.5.markdown index e8ac76b6..f9a1012a 100644 --- a/doc/rofi-debugging.5.markdown +++ b/doc/rofi-debugging.5.markdown @@ -14,6 +14,25 @@ This disables the parsing of the configuration files. This runs rofi in *stock* If you run custom C plugins, you can disable the plugins using: `-no-plugins` +## Get the relevant information for an issue + +Please pastebin the output of the following commands: + +```bash +rofi -help +rofi -dump-config +rofi -dump-theme +``` + +`rofi -help` provides us with the configuration files parsed, the exact version, monitor layout +and more useful information. + +The `rofi -dump-config` and `rofi -dump-theme` output gives us `rofi` +interpretation of your configuration and theme. + +Please check the output for identifiable information and remove this. + + ## Timing traces To get a timing trace, enable the **Timings** debug domain.