summaryrefslogtreecommitdiffstats
path: root/doc/rofi.1
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2021-12-14 20:42:21 +0100
committerDave Davenport <qball@blame.services>2021-12-14 20:42:21 +0100
commit555f9be1f7e52cf736455d06cdc1f475c889c709 (patch)
tree36a6272d662db98825951687b6f2abd6102ed527 /doc/rofi.1
parentf0500a5a0eeee9aad6ead78714ccfa4121578853 (diff)
[Doc] Update manpage with clarification.
Diffstat (limited to 'doc/rofi.1')
-rw-r--r--doc/rofi.151
1 files changed, 33 insertions, 18 deletions
diff --git a/doc/rofi.1 b/doc/rofi.1
index 05d6a2ba..d33123b6 100644
--- a/doc/rofi.1
+++ b/doc/rofi.1
@@ -1,4 +1,3 @@
-.nh
.TH ROFI 1 rofi
.SH NAME
.PP
@@ -19,9 +18,9 @@ filter, tokenized search and more.
\fBrofi\fP\&'s main functionality is to assist in your workflow, allowing you to quickly switch
between windows, start applications or log into a remote machine via \fB\fCssh\fR\&.
There are different \fImodi\fP for different types of actions.
-
-.PP
-\fBrofi\fP can also function as (drop\-in) replacement for \fBdmenu(1)\fP\&.
+\fBrofi\fP is a standalone application and should not be integrated into scripts.
+For integration into scripts it has a special mode that functions as a
+(drop\-in) replacement for \fBdmenu(1)\fP\&. See emulating dmenu below.
.SS Running rofi
.PP
@@ -47,7 +46,7 @@ The website for \fB\fCdmenu\fR can be found here
.PP
\fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many flavors of \fB\fCdmenu\fR\&.
-The idea is that the basic usage command\-\&line flags are obeyed, theme\-\&related flags are not.
+The idea is that the basic usage command\-line flags are obeyed, theme\-related flags are not.
Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings).
.SS Display Error message
@@ -181,7 +180,11 @@ Specify the number of threads \fBrofi\fP should use:
.IP \(bu 2
1: Disable threading
.IP \(bu 2
-2..n: Specify the maximum number of threads to use in the thread pool.Default: Autodetect
+
+.PP
+2..n: Specify the maximum number of threads to use in the thread pool.
+.PP
+Default: Autodetect
.RE
@@ -461,7 +464,11 @@ The different fields are:
.IP \(bu 2
\fBcomment\fP: the application comment
.IP \(bu 2
-\fBall\fP: all the aboveDefault: \fIname,generic,exec,categories,keywords\fP
+
+.PP
+\fBall\fP: all the above
+.PP
+Default: \fIname,generic,exec,categories,keywords\fP
.RE
@@ -534,7 +541,11 @@ The different fields are:
.IP \(bu 2
\fBdesktop\fP: window's current desktop
.IP \(bu 2
-\fBall\fP: all the aboveDefault: \fIall\fP
+
+.PP
+\fBall\fP: all the above
+.PP
+Default: \fIall\fP
.RE
@@ -667,7 +678,11 @@ behavior.)
.IP \(bu 2
\fB\-4\fP: the monitor with the focused window.
.IP \(bu 2
-\fB\-5\fP: the monitor that shows the mouse pointer.Default: \fI\-5\fP
+
+.PP
+\fB\-5\fP: the monitor that shows the mouse pointer.
+.PP
+Default: \fI\-5\fP
.RE
@@ -1165,7 +1180,7 @@ Set ellipsize mode to start. So, the end of the string is visible.
.PP
Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&.
-Message can be multi\-\&line.
+Message can be multi\-line.
.SS File browser settings
.PP
@@ -1784,21 +1799,21 @@ first.
.SH AUTHOR
.RS
.IP \(bu 2
-Qball Cow qball@blame.services
-\[la]mailto:qball@blame.services\[ra]
+Qball Cow
+\[la]qball@blame.services\[ra]
.IP \(bu 2
-Rasmus Steinke rasi@xssn.at
-\[la]mailto:rasi@xssn.at\[ra]
+Rasmus Steinke
+\[la]rasi@xssn.at\[ra]
.IP \(bu 2
-Quentin Glidic sardemff7+rofi@sardemff7.net
-\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
+Quentin Glidic
+\[la]sardemff7+rofi@sardemff7.net\[ra]
.RE
.PP
Original code based on work by: Sean Pringle
-\[la]https://github.com/seanpringle/simpleswitcher\[ra] sean.pringle@gmail.com
-\[la]mailto:sean.pringle@gmail.com\[ra]
+\[la]https://github.com/seanpringle/simpleswitcher\[ra]
+\[la]sean.pringle@gmail.com\[ra]
.PP
For a full list of authors, check the \fB\fCAUTHORS\fR file.