summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2022-04-14 20:45:37 +0200
committerDave Davenport <qball@blame.services>2022-04-14 20:45:37 +0200
commit54e272df295cca15b457aa79f327609128aa76c5 (patch)
treebbc57dad50366769cf2b78e94965f80a12d80f37
parentd57d6de2ce8efcc051355c77c04793abac7210df (diff)
[Doc] Update rofi.1 with an extra example.
-rw-r--r--config/config.c4
-rw-r--r--doc/rofi-debugging.5135
-rw-r--r--doc/rofi-dmenu.5119
-rw-r--r--doc/rofi-keys.5339
-rw-r--r--doc/rofi-script.551
-rw-r--r--doc/rofi-sensible-terminal.121
-rw-r--r--doc/rofi-theme-selector.125
-rw-r--r--doc/rofi-theme.5328
-rw-r--r--doc/rofi.1467
-rw-r--r--doc/rofi.1.markdown30
-rw-r--r--meson.build2
11 files changed, 763 insertions, 758 deletions
diff --git a/config/config.c b/config/config.c
index 4d6b09bd..c0e6e008 100644
--- a/config/config.c
+++ b/config/config.c
@@ -36,9 +36,9 @@ Settings config = {
/** List of enabled modes. */
/** -modes */
#ifdef WINDOW_MODE
- .modes = "window,run,ssh",
+ .modes = "window,drun,run,ssh",
#else
- .modes = "run,ssh",
+ .modes = "drun,run,ssh",
#endif
/** Font */
.menu_font = "mono 12",
diff --git a/doc/rofi-debugging.5 b/doc/rofi-debugging.5
index 3b9cc5bb..747d1fd0 100644
--- a/doc/rofi-debugging.5
+++ b/doc/rofi-debugging.5
@@ -1,3 +1,4 @@
+.nh
.TH ROFI DEBUGGING 5 rofi debugging
.SH NAME
.PP
@@ -5,16 +6,16 @@ Debugging rofi.
.PP
When reporting an issue with rofi crashing, or misbehaving. It helps to do some small test
-to help pin\-point the problem.
+to help pin-point the problem.
.PP
-First try disabling your custom configuration: \fB\fC\-no\-config\fR
+First try disabling your custom configuration: \fB\fC-no-config\fR
.PP
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 the plugins 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
@@ -24,19 +25,19 @@ Please pastebin the output of the following commands:
.RS
.nf
-rofi \-help
-rofi \-dump\-config
-rofi \-dump\-theme
+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
+\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
+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
@@ -50,7 +51,7 @@ To get a timing trace, enable the \fBTimings\fP debug domain.
.RS
.nf
-G\_MESSAGES\_DEBUG=Timings rofi \-show drun
+G_MESSAGES_DEBUG=Timings rofi -show drun
.fi
.RE
@@ -66,56 +67,56 @@ Example trace:
.RS
.nf
-(process:14942): Timings\-DEBUG: 13:47:39.335: 0.000000 (0.000000): Started
-(process:14942): Timings\-DEBUG: 13:47:39.335: 0.000126 (0.000126): ../source/rofi.c:main:786
-(process:14942): Timings\-DEBUG: 13:47:39.335: 0.000163 (0.000037): ../source/rofi.c:main:819
-(process:14942): Timings\-DEBUG: 13:47:39.336: 0.000219 (0.000056): ../source/rofi.c:main:826 Setup Locale
-(process:14942): Timings\-DEBUG: 13:47:39.337: 0.001235 (0.001016): ../source/rofi.c:main:828 Collect MODI
-(process:14942): Timings\-DEBUG: 13:47:39.337: 0.001264 (0.000029): ../source/rofi.c:main:830 Setup MODI
-(process:14942): Timings\-DEBUG: 13:47:39.337: 0.001283 (0.000019): ../source/rofi.c:main:834 Setup mainloop
-(process:14942): Timings\-DEBUG: 13:47:39.337: 0.001369 (0.000086): ../source/rofi.c:main:837 NK Bindings
-(process:14942): Timings\-DEBUG: 13:47:39.337: 0.001512 (0.000143): ../source/xcb.c:display\_setup:1177 Open Display
-(process:14942): Timings\-DEBUG: 13:47:39.337: 0.001829 (0.000317): ../source/xcb.c:display\_setup:1192 Setup XCB
-(process:14942): Timings\-DEBUG: 13:47:39.346: 0.010650 (0.008821): ../source/rofi.c:main:844 Setup Display
-(process:14942): Timings\-DEBUG: 13:47:39.346: 0.010715 (0.000065): ../source/rofi.c:main:848 Setup abe
-(process:14942): Timings\-DEBUG: 13:47:39.350: 0.015101 (0.004386): ../source/rofi.c:main:883 Load cmd config
-(process:14942): Timings\-DEBUG: 13:47:39.351: 0.015275 (0.000174): ../source/rofi.c:main:907 Setup Modi
-(process:14942): Timings\-DEBUG: 13:47:39.351: 0.015291 (0.000016): ../source/view.c:rofi\_view\_workers\_initialize:1922 Setup Threadpool, start
-(process:14942): Timings\-DEBUG: 13:47:39.351: 0.015349 (0.000058): ../source/view.c:rofi\_view\_workers\_initialize:1945 Setup Threadpool, done
-(process:14942): Timings\-DEBUG: 13:47:39.367: 0.032018 (0.016669): ../source/rofi.c:main:1000 Setup late Display
-(process:14942): Timings\-DEBUG: 13:47:39.367: 0.032080 (0.000062): ../source/rofi.c:main:1003 Theme setup
-(process:14942): Timings\-DEBUG: 13:47:39.367: 0.032109 (0.000029): ../source/rofi.c:startup:668 Startup
-(process:14942): Timings\-DEBUG: 13:47:39.367: 0.032121 (0.000012): ../source/rofi.c:startup:677 Grab keyboard
-(process:14942): Timings\-DEBUG: 13:47:39.368: 0.032214 (0.000093): ../source/view.c:\_\_create\_window:701 xcb create window
-(process:14942): Timings\-DEBUG: 13:47:39.368: 0.032235 (0.000021): ../source/view.c:\_\_create\_window:705 xcb create gc
-(process:14942): Timings\-DEBUG: 13:47:39.368: 0.033136 (0.000901): ../source/view.c:\_\_create\_window:714 create cairo surface
-(process:14942): Timings\-DEBUG: 13:47:39.369: 0.033286 (0.000150): ../source/view.c:\_\_create\_window:723 pango cairo font setup
-(process:14942): Timings\-DEBUG: 13:47:39.369: 0.033351 (0.000065): ../source/view.c:\_\_create\_window:761 configure font
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045896 (0.012545): ../source/view.c:\_\_create\_window:769 textbox setup
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045944 (0.000048): ../source/view.c:\_\_create\_window:781 setup window attributes
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045955 (0.000011): ../source/view.c:\_\_create\_window:791 setup window fullscreen
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045966 (0.000011): ../source/view.c:\_\_create\_window:797 setup window name and class
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045974 (0.000008): ../source/view.c:\_\_create\_window:808 setup startup notification
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045981 (0.000007): ../source/view.c:\_\_create\_window:810 done
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045992 (0.000011): ../source/rofi.c:startup:679 Create Window
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.045999 (0.000007): ../source/rofi.c:startup:681 Parse ABE
-(process:14942): Timings\-DEBUG: 13:47:39.381: 0.046113 (0.000114): ../source/rofi.c:startup:684 Config sanity check
-(process:14942): Timings\-DEBUG: 13:47:39.384: 0.048229 (0.002116): ../source/dialogs/run.c:get\_apps:216 start
-(process:14942): Timings\-DEBUG: 13:47:39.390: 0.054626 (0.006397): ../source/dialogs/run.c:get\_apps:336 stop
-(process:14942): Timings\-DEBUG: 13:47:39.390: 0.054781 (0.000155): ../source/dialogs/drun.c:get\_apps:634 Get Desktop apps (start)
-(process:14942): Timings\-DEBUG: 13:47:39.391: 0.055264 (0.000483): ../source/dialogs/drun.c:get\_apps:641 Get Desktop apps (user dir)
-(process:14942): Timings\-DEBUG: 13:47:39.418: 0.082884 (0.027620): ../source/dialogs/drun.c:get\_apps:659 Get Desktop apps (system dirs)
-(process:14942): Timings\-DEBUG: 13:47:39.418: 0.082944 (0.000060): ../source/dialogs/drun.c:get\_apps\_history:597 Start drun history
-(process:14942): Timings\-DEBUG: 13:47:39.418: 0.082977 (0.000033): ../source/dialogs/drun.c:get\_apps\_history:617 Stop drun history
-(process:14942): Timings\-DEBUG: 13:47:39.419: 0.083638 (0.000661): ../source/dialogs/drun.c:get\_apps:664 Sorting done.
-(process:14942): Timings\-DEBUG: 13:47:39.419: 0.083685 (0.000047): ../source/view.c:rofi\_view\_create:1759
-(process:14942): Timings\-DEBUG: 13:47:39.419: 0.083700 (0.000015): ../source/view.c:rofi\_view\_create:1783 Startup notification
-(process:14942): Timings\-DEBUG: 13:47:39.419: 0.083711 (0.000011): ../source/view.c:rofi\_view\_create:1786 Get active monitor
-(process:14942): Timings\-DEBUG: 13:47:39.420: 0.084693 (0.000982): ../source/view.c:rofi\_view\_refilter:1028 Filter start
-(process:14942): Timings\-DEBUG: 13:47:39.421: 0.085992 (0.001299): ../source/view.c:rofi\_view\_refilter:1132 Filter done
-(process:14942): Timings\-DEBUG: 13:47:39.421: 0.086090 (0.000098): ../source/view.c:rofi\_view\_update:982
-(process:14942): Timings\-DEBUG: 13:47:39.421: 0.086123 (0.000033): ../source/view.c:rofi\_view\_update:1002 Background
-(process:14942): Timings\-DEBUG: 13:47:39.428: 0.092864 (0.006741): ../source/view.c:rofi\_view\_update:1008 widgets
+(process:14942): Timings-DEBUG: 13:47:39.335: 0.000000 (0.000000): Started
+(process:14942): Timings-DEBUG: 13:47:39.335: 0.000126 (0.000126): ../source/rofi.c:main:786
+(process:14942): Timings-DEBUG: 13:47:39.335: 0.000163 (0.000037): ../source/rofi.c:main:819
+(process:14942): Timings-DEBUG: 13:47:39.336: 0.000219 (0.000056): ../source/rofi.c:main:826 Setup Locale
+(process:14942): Timings-DEBUG: 13:47:39.337: 0.001235 (0.001016): ../source/rofi.c:main:828 Collect MODI
+(process:14942): Timings-DEBUG: 13:47:39.337: 0.001264 (0.000029): ../source/rofi.c:main:830 Setup MODI
+(process:14942): Timings-DEBUG: 13:47:39.337: 0.001283 (0.000019): ../source/rofi.c:main:834 Setup mainloop
+(process:14942): Timings-DEBUG: 13:47:39.337: 0.001369 (0.000086): ../source/rofi.c:main:837 NK Bindings
+(process:14942): Timings-DEBUG: 13:47:39.337: 0.001512 (0.000143): ../source/xcb.c:display_setup:1177 Open Display
+(process:14942): Timings-DEBUG: 13:47:39.337: 0.001829 (0.000317): ../source/xcb.c:display_setup:1192 Setup XCB
+(process:14942): Timings-DEBUG: 13:47:39.346: 0.010650 (0.008821): ../source/rofi.c:main:844 Setup Display
+(process:14942): Timings-DEBUG: 13:47:39.346: 0.010715 (0.000065): ../source/rofi.c:main:848 Setup abe
+(process:14942): Timings-DEBUG: 13:47:39.350: 0.015101 (0.004386): ../source/rofi.c:main:883 Load cmd config
+(process:14942): Timings-DEBUG: 13:47:39.351: 0.015275 (0.000174): ../source/rofi.c:main:907 Setup Modi
+(process:14942): Timings-DEBUG: 13:47:39.351: 0.015291 (0.000016): ../source/view.c:rofi_view_workers_initialize:1922 Setup Threadpool, start
+(process:14942): Timings-DEBUG: 13:47:39.351: 0.015349 (0.000058): ../source/view.c:rofi_view_workers_initialize:1945 Setup Threadpool, done
+(process:14942): Timings-DEBUG: 13:47:39.367: 0.032018 (0.016669): ../source/rofi.c:main:1000 Setup late Display
+(process:14942): Timings-DEBUG: 13:47:39.367: 0.032080 (0.000062): ../source/rofi.c:main:1003 Theme setup
+(process:14942): Timings-DEBUG: 13:47:39.367: 0.032109 (0.000029): ../source/rofi.c:startup:668 Startup
+(process:14942): Timings-DEBUG: 13:47:39.367: 0.032121 (0.000012): ../source/rofi.c:startup:677 Grab keyboard
+(process:14942): Timings-DEBUG: 13:47:39.368: 0.032214 (0.000093): ../source/view.c:__create_window:701 xcb create window
+(process:14942): Timings-DEBUG: 13:47:39.368: 0.032235 (0.000021): ../source/view.c:__create_window:705 xcb create gc
+(process:14942): Timings-DEBUG: 13:47:39.368: 0.033136 (0.000901): ../source/view.c:__create_window:714 create cairo surface
+(process:14942): Timings-DEBUG: 13:47:39.369: 0.033286 (0.000150): ../source/view.c:__create_window:723 pango cairo font setup
+(process:14942): Timings-DEBUG: 13:47:39.369: 0.033351 (0.000065): ../source/view.c:__create_window:761 configure font
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045896 (0.012545): ../source/view.c:__create_window:769 textbox setup
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045944 (0.000048): ../source/view.c:__create_window:781 setup window attributes
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045955 (0.000011): ../source/view.c:__create_window:791 setup window fullscreen
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045966 (0.000011): ../source/view.c:__create_window:797 setup window name and class
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045974 (0.000008): ../source/view.c:__create_window:808 setup startup notification
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045981 (0.000007): ../source/view.c:__create_window:810 done
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045992 (0.000011): ../source/rofi.c:startup:679 Create Window
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.045999 (0.000007): ../source/rofi.c:startup:681 Parse ABE
+(process:14942): Timings-DEBUG: 13:47:39.381: 0.046113 (0.000114): ../source/rofi.c:startup:684 Config sanity check
+(process:14942): Timings-DEBUG: 13:47:39.384: 0.048229 (0.002116): ../source/dialogs/run.c:get_apps:216 start
+(process:14942): Timings-DEBUG: 13:47:39.390: 0.054626 (0.006397): ../source/dialogs/run.c:get_apps:336 stop
+(process:14942): Timings-DEBUG: 13:47:39.390: 0.054781 (0.000155): ../source/dialogs/drun.c:get_apps:634 Get Desktop apps (start)
+(process:14942): Timings-DEBUG: 13:47:39.391: 0.055264 (0.000483): ../source/dialogs/drun.c:get_apps:641 Get Desktop apps (user dir)
+(process:14942): Timings-DEBUG: 13:47:39.418: 0.082884 (0.027620): ../source/dialogs/drun.c:get_apps:659 Get Desktop apps (system dirs)
+(process:14942): Timings-DEBUG: 13:47:39.418: 0.082944 (0.000060): ../source/dialogs/drun.c:get_apps_history:597 Start drun history
+(process:14942): Timings-DEBUG: 13:47:39.418: 0.082977 (0.000033): ../source/dialogs/drun.c:get_apps_history:617 Stop drun history
+(process:14942): Timings-DEBUG: 13:47:39.419: 0.083638 (0.000661): ../source/dialogs/drun.c:get_apps:664 Sorting done.
+(process:14942): Timings-DEBUG: 13:47:39.419: 0.083685 (0.000047): ../source/view.c:rofi_view_create:1759
+(process:14942): Timings-DEBUG: 13:47:39.419: 0.083700 (0.000015): ../source/view.c:rofi_view_create:1783 Startup notification
+(process:14942): Timings-DEBUG: 13:47:39.419: 0.083711 (0.000011): ../source/view.c:rofi_view_create:1786 Get active monitor
+(process:14942): Timings-DEBUG: 13:47:39.420: 0.084693 (0.000982): ../source/view.c:rofi_view_refilter:1028 Filter start
+(process:14942): Timings-DEBUG: 13:47:39.421: 0.085992 (0.001299): ../source/view.c:rofi_view_refilter:1132 Filter done
+(process:14942): Timings-DEBUG: 13:47:39.421: 0.086090 (0.000098): ../source/view.c:rofi_view_update:982
+(process:14942): Timings-DEBUG: 13:47:39.421: 0.086123 (0.000033): ../source/view.c:rofi_view_update:1002 Background
+(process:14942): Timings-DEBUG: 13:47:39.428: 0.092864 (0.006741): ../source/view.c:rofi_view_update:1008 widgets
.fi
.RE
@@ -123,7 +124,7 @@ Example trace:
.SH Debug domains
.PP
To further debug the plugin, you can get a trace with (lots of) debug information. This debug output can be enabled for
-multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G\_MESSAGES\_DEBUG
+multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G_MESSAGES_DEBUG
environment variable. At the time of creation of this page, the following debug domains exist:
.RS
@@ -172,7 +173,7 @@ Helpers.IconFetcher: Information about icon lookup.
For full list see \fB\fCman rofi\fR\&.
.PP
-Example: \fB\fCG\_MESSAGES\_DEBUG=Dialogs.DRun rofi \-show drun\fR To get specific output from the Desktop file run dialog.
+Example: \fB\fCG_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun\fR To get specific output from the Desktop file run dialog.
.SH Creating a backtrace.
.PP
@@ -182,7 +183,7 @@ First make sure you compile \fBrofi\fP with debug symbols:
.RS
.nf
-make CFLAGS="\-O0 \-g3" clean rofi
+make CFLAGS="-O0 -g3" clean rofi
.fi
.RE
@@ -190,7 +191,7 @@ make CFLAGS="\-O0 \-g3" clean rofi
.PP
Getting a backtrace using GDB is not very handy. Because if rofi get stuck, it grabs keyboard and
mouse. So if it crashes in GDB you are stuck.
-The best way to go is to enable core file. (ulimit \-c unlimited in bash) then make rofi crash. You
+The best way to go is to enable core file. (ulimit -c unlimited in bash) then make rofi crash. You
can then load the core in GDB.
.PP
@@ -218,16 +219,16 @@ thread apply all bt
The output trace is useful when reporting crashes.
.PP
-Some distribution have \fB\fCsystemd\-coredump\fR, this way you can easily get a backtrace via \fB\fCcoredumpctl\fR\&.
+Some distribution have \fB\fCsystemd-coredump\fR, this way you can easily get a backtrace via \fB\fCcoredumpctl\fR\&.
.SH SEE ALSO
.PP
-\fBrofi\-sensible\-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi\-debugging(5)\fP, \fBrofi\-theme(5)\fP, \fBrofi\-script(5)\fP, \fBrofi\-keys(5)\fP,\fBrofi\-theme\-selector(1)\fP
+\fBrofi-sensible-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi-debugging(5)\fP, \fBrofi-theme(5)\fP, \fBrofi-script(5)\fP, \fBrofi-keys(5)\fP,\fBrofi-theme-selector(1)\fP
.SH AUTHOR
.RS
.IP \(bu 2
-Qball Cow
-\[la]qball@blame.services\[ra]
+Qball Cow qball@blame.services
+\[la]mailto:qball@blame.services\[ra]
.RE
diff --git a/doc/rofi-dmenu.5 b/doc/rofi-dmenu.5
index 9a2123aa..f361af08 100644
--- a/doc/rofi-dmenu.5
+++ b/doc/rofi-dmenu.5
@@ -1,7 +1,8 @@
-.TH ROFI\-DMENU 5 rofi\-dmenu
+.nh
+.TH ROFI-DMENU 5 rofi-dmenu
.SH NAME
.PP
-\fBrofi dmenu mode\fP \- Rofi dmenu emulation
+\fBrofi dmenu mode\fP - Rofi dmenu emulation
.SH DESCRIPTION
.PP
@@ -14,8 +15,8 @@ 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.
-Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings).
+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).
.SH BASIC CONCEPT
.PP
@@ -28,27 +29,27 @@ By default separation of rows is done on new lines, making it easy to pipe the o
.SH USAGE
.PP
-By launching \fBrofi\fP with the \fB\fC\-dmenu\fR flag it will go into dmenu emulation mode.
+By launching \fBrofi\fP with the \fB\fC-dmenu\fR flag it will go into dmenu emulation mode.
.PP
.RS
.nf
-ls | rofi \-dmenu
+ls | rofi -dmenu
.fi
.RE
-.SS DMENU DROP\-IN REPLACEMENT
+.SS DMENU DROP-IN REPLACEMENT
.PP
If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode.
-This way, it can be used as a drop\-in replacement for dmenu. Just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&.
+This way, it can be used as a drop-in replacement for dmenu. Just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&.
.PP
.RS
.nf
-ln \-s /usr/bin/rofi /usr/bin/dmenu
+ln -s /usr/bin/rofi /usr/bin/dmenu
.fi
.RE
@@ -56,15 +57,15 @@ ln \-s /usr/bin/rofi /usr/bin/dmenu
.SS DMENU VS SCRIPT MODE
.PP
Script mode is used to extend \fBrofi\fP, dmenu mode is used to extend a script.
-The two do share much of the same input format. Please see the \fBrofi\-script(5)\fP manpage for more information.
+The two do share much of the same input format. Please see the \fBrofi-script(5)\fP manpage for more information.
.SS DMENU SPECIFIC COMMANDLINE FLAGS
.PP
-A lot of these options can also be modified by the script using special input. See the \fBrofi\-script(5)\fP manpage
+A lot of these options can also be modified by the script using special input. See the \fBrofi-script(5)\fP manpage
for more information about this syntax.
.PP
-\fB\fC\-sep\fR \fIseparator\fP
+\fB\fC-sep\fR \fIseparator\fP
.PP
Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' as a separator:
@@ -73,13 +74,13 @@ Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' a
.RS
.nf
-echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu
+echo "a|b|c|d|e" | rofi -sep '|' -dmenu
.fi
.RE
.PP
-\fB\fC\-p\fR \fIprompt\fP
+\fB\fC-p\fR \fIprompt\fP
.PP
Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey', a,b,c,d, or e.
@@ -88,7 +89,7 @@ Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey',
.RS
.nf
-echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey"
+echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
.fi
.RE
@@ -97,7 +98,7 @@ echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey"
Default: \fIdmenu\fP
.PP
-\fB\fC\-l\fR \fInumber of lines to show\fP
+\fB\fC-l\fR \fInumber of lines to show\fP
.PP
Maximum number of lines the menu may show before scrolling.
@@ -106,7 +107,7 @@ Maximum number of lines the menu may show before scrolling.
.RS
.nf
-rofi \-dmenu \-l 25
+rofi -dmenu -l 25
.fi
.RE
@@ -115,39 +116,39 @@ rofi \-dmenu \-l 25
Default: \fI15\fP
.PP
-\fB\fC\-i\fR
+\fB\fC-i\fR
.PP
-Makes \fB\fCdmenu\fR searches case\-insensitive
+Makes \fB\fCdmenu\fR searches case-insensitive
.PP
-\fB\fC\-a\fR \fIX\fP
+\fB\fC-a\fR \fIX\fP
.PP
-Active row, mark \fIX\fP as active. Where \fIX\fP is a comma\-separated list of python(1)\-style indices and ranges, e.g. indices start at 0, \-1 refers to the last row with \-2 preceding it, ranges are left\-open and right\-close, and so on. You can specify:
+Active row, mark \fIX\fP as active. Where \fIX\fP is a comma-separated list of python(1)-style indices and ranges, e.g. indices start at 0, -1 refers to the last row with -2 preceding it, ranges are left-open and right-close, and so on. You can specify:
.RS
.IP \(bu 2
A single row: '5'
.IP \(bu 2
-A range of (last 3) rows: '\-3:'
+A range of (last 3) rows: '-3:'
.IP \(bu 2
-4 rows starting from row 7: '7:11' (or in legacy notation: '7\-10')
+4 rows starting from row 7: '7:11' (or in legacy notation: '7-10')
.IP \(bu 2
-A set of rows: '2,0,\-9'
+A set of rows: '2,0,-9'
.IP \(bu 2
-Or any combination: '5,\-3:,7:11,2,0,\-9'
+Or any combination: '5,-3:,7:11,2,0,-9'
.RE
.PP
-\fB\fC\-u\fR \fIX\fP
+\fB\fC-u\fR \fIX\fP
.PP
-Urgent row, mark \fIX\fP as urgent. See \fB\fC\-a\fR option for details.
+Urgent row, mark \fIX\fP as urgent. See \fB\fC-a\fR option for details.
.PP
-\fB\fC\-only\-match\fR
+\fB\fC-only-match\fR
.PP
Only return a selected item, do not allow custom entry.
@@ -155,14 +156,14 @@ This mode always returns an entry. It will not return if no matching entry is
selected.
.PP
-\fB\fC\-no\-custom\fR
+\fB\fC-no-custom\fR
.PP
Only return a selected item, do not allow custom entry.
This mode returns directly when no entries given.
.PP
-\fB\fC\-format\fR \fIformat\fP
+\fB\fC-format\fR \fIformat\fP
.PP
Allows the output of dmenu to be customized (N is the total number of input entries):
@@ -171,9 +172,9 @@ Allows the output of dmenu to be customized (N is the total number of input entr
.IP \(bu 2
\&'s' selected string
.IP \(bu 2
-\&'i' index (0 \-\& (N\-\&1))
+\&'i' index (0 - (N-1))
.IP \(bu 2
-\&'d' index (1 \-\& N)
+\&'d' index (1 - N)
.IP \(bu 2
\&'q' quote string
.IP \(bu 2
@@ -189,13 +190,13 @@ Allows the output of dmenu to be customized (N is the total number of input entr
Default: 's'
.PP
-\fB\fC\-select\fR \fIstring\fP
+\fB\fC-select\fR \fIstring\fP
.PP
Select first line that matches the given string
.PP
-\fB\fC\-mesg\fR \fIstring\fP
+\fB\fC-mesg\fR \fIstring\fP
.PP
Add a message line below the filter entry box. Supports Pango markup.
@@ -203,27 +204,27 @@ For more information on supported markup, see here
\[la]https://docs.gtk.org/Pango/pango_markup.html\[ra]
.PP
-\fB\fC\-dump\fR
+\fB\fC-dump\fR
.PP
Dump the filtered list to stdout and quit.
This can be used to get the list as \fBrofi\fP would filter it.
-Use together with \fB\fC\-filter\fR command.
+Use together with \fB\fC-filter\fR command.
.PP
-\fB\fC\-input\fR \fIfile\fP
+\fB\fC-input\fR \fIfile\fP
.PP
Reads from \fIfile\fP instead of stdin.
.PP
-\fB\fC\-password\fR
+\fB\fC-password\fR
.PP
Hide the input text. This should not be considered secure!
.PP
-\fB\fC\-markup\-rows\fR
+\fB\fC-markup-rows\fR
.PP
Tell \fBrofi\fP that DMenu input is Pango markup encoded, and should be rendered.
@@ -231,23 +232,23 @@ See here
\[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra] for details about Pango markup.
.PP
-\fB\fC\-multi\-select\fR
+\fB\fC-multi-select\fR
.PP
Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry.
.PP
-\fB\fC\-sync\fR
+\fB\fC-sync\fR
.PP
Force \fBrofi\fP mode to first read all data from stdin before showing the selection window. This is original dmenu behavior.
.PP
Note: the default asynchronous mode will also be automatically disabled if used with conflicting options,
-such as \fB\fC\-dump\fR, \fB\fC\-only\-match\fR or \fB\fC\-auto\-select\fR\&.
+such as \fB\fC-dump\fR, \fB\fC-only-match\fR or \fB\fC-auto-select\fR\&.
.PP
-\fB\fC\-async\-pre\-read\fR \fInumber\fP
+\fB\fC-async-pre-read\fR \fInumber\fP
.PP
Reads the first \fInumber\fP entries blocking, then switches to async mode.
@@ -257,31 +258,31 @@ This makes it feel more 'snappy'.
\fIdefault\fP: 25
.PP
-\fB\fC\-window\-title\fR \fItitle\fP
+\fB\fC-window-title\fR \fItitle\fP
.PP
-Set name used for the window title. Will be shown as Rofi \- \fItitle\fP
+Set name used for the window title. Will be shown as Rofi - \fItitle\fP
.PP
-\fB\fC\-w\fR \fIwindowid\fP
+\fB\fC-w\fR \fIwindowid\fP
.PP
Position \fBrofi\fP over the window with the given X11 window ID.
.PP
-\fB\fC\-keep\-right\fR
+\fB\fC-keep-right\fR
.PP
Set ellipsize mode to start. So, the end of the string is visible.
.PP
-\fB\fC\-display\-columns\fR
+\fB\fC-display-columns\fR
.PP
A comma seperated list of columns to show.
.PP
-\fB\fC\-display\-column\-separator\fR
+\fB\fC-display-column-separator\fR
.PP
The column separator. This is a regex.
@@ -296,30 +297,30 @@ The column separator. This is a regex.
.IP \(bu 2
\fB1\fP: User cancelled the selection.
.IP \(bu 2
-\fB10\-28\fP: Row accepted by custom keybinding.
+\fB10-28\fP: Row accepted by custom keybinding.
.RE
.SH SEE ALSO
.PP
-rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-script(5), rofi\-theme\-selector(1)
+rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1)
.SH AUTHOR
.PP
-Qball Cow
-\[la]qball@gmpclient.org\[ra]
+Qball Cow qball@gmpclient.org
+\[la]mailto:qball@gmpclient.org\[ra]
.PP
-Rasmus Steinke
-\[la]rasi@xssn.at\[ra]
+Rasmus Steinke rasi@xssn.at
+\[la]mailto:rasi@xssn.at\[ra]
.PP
-Morgane Glidic
-\[la]sardemff7+rofi@sardemff7.net\[ra]
+Morgane Glidic sardemff7+rofi@sardemff7.net
+\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.PP
-Original code based on work by: Sean Pringle
-\[la]sean.pringle@gmail.com\[ra]
+Original code based on work by: Sean Pringle sean.pringle@gmail.com
+\[la]mailto:sean.pringle@gmail.com\[ra]
.PP
For a full list of authors, check the AUTHORS file.
diff --git a/doc/rofi-keys.5 b/doc/rofi-keys.5
index ee0cb1df..8a20e17c 100644
--- a/doc/rofi-keys.5
+++ b/doc/rofi-keys.5
@@ -1,7 +1,8 @@
-.TH ROFI\-KEYS 5 rofi\-keys
+.nh
+.TH ROFI-KEYS 5 rofi-keys
.SH NAME
.PP
-\fBrofi keys\fP \- Rofi Key and Mouse bindings
+\fBrofi keys\fP - Rofi Key and Mouse bindings
.SH DESCRIPTION
.PP
@@ -9,13 +10,13 @@
.SH Setting binding
.PP
-Bindings can be done on the commandline (\-{bindingname}):
+Bindings can be done on the commandline (-{bindingname}):
.PP
.RS
.nf
-rofi \-show run \-kb\-accept\-entry 'Control+Shift+space'
+rofi -show run -kb-accept-entry 'Control+Shift+space'
.fi
.RE
@@ -28,7 +29,7 @@ or via the configuration file:
.nf
configuration {
- kb\-accept\-entry: "Control+Shift+space";
+ kb-accept-entry: "Control+Shift+space";
}
.fi
@@ -42,7 +43,7 @@ The key can be set by its name (see above) or its keycode:
.nf
configuration {
- kb\-accept\-entry: "Control+Shift+[65]";
+ kb-accept-entry: "Control+Shift+[65]";
}
.fi
@@ -59,7 +60,7 @@ Multiple keys can be specified for an action as a comma separated list:
.nf
configuration {
- kb\-accept\-entry: "Control+Shift+space,Return";
+ kb-accept-entry: "Control+Shift+space,Return";
}
.fi
@@ -74,566 +75,566 @@ prepend the binding with \fB\fC!\fR:
.nf
configuration {
- kb\-accept\-entry: "!Control+Shift+space,Return";
+ kb-accept-entry: "!Control+Shift+space,Return";
}
.fi
.RE
.SH Keyboard Bindings
-.SS \fBkb\-primary\-paste\fP:
+.SS \fBkb-primary-paste\fP:
.PP
Paste primary selection
.PP
-\fBDefault\fP: Control+V,Shift+Insert
+\fBDefault\fP: Control+V,Shift+Insert
-.SS \fBkb\-secondary\-paste\fP
+.SS \fBkb-secondary-paste\fP
.PP
Paste clipboard
.PP
-\fBDefault\fP: Control+v,Insert
+\fBDefault\fP: Control+v,Insert
-.SS \fBkb\-clear\-line\fP
+.SS \fBkb-clear-line\fP
.PP
Clear input line
.PP
-\fBDefault\fP: Control+w
+\fBDefault\fP: Control+w
-.SS \fBkb\-move\-front\fP
+.SS \fBkb-move-front\fP
.PP
Beginning of line
.PP
-\fBDefault\fP: Control+a
+\fBDefault\fP: Control+a
-.SS \fBkb\-move\-end\fP
+.SS \fBkb-move-end\fP
.PP
End of line
.PP
-\fBDefault\fP: Control+e
+\fBDefault\fP: Control+e
-.SS \fBkb\-move\-word\-back\fP
+.SS \fBkb-move-word-back\fP
.PP
Move back one word
.PP
-\fBDefault\fP: Alt+b,Control+Left
+\fBDefault\fP: Alt+b,Control+Left
-.SS \fBkb\-move\-word\-forward\fP
+.SS \fBkb-move-word-forward\fP
.PP
Move forward one word
.PP
-\fBDefault\fP: Alt+f,Control+Right
+\fBDefault\fP: Alt+f,Control+Right
-.SS \fBkb\-move\-char\-back\fP
+.SS \fBkb-move-char-back\fP
.PP
Move back one char
.PP
-\fBDefault\fP: Left,Control+b
+\fBDefault\fP: Left,Control+b
-.SS \fBkb\-move\-char\-forward\fP
+.SS \fBkb-move-char-forward\fP
.PP
Move forward one char
.PP
-\fBDefault\fP: Right,Control+f
+\fBDefault\fP: Right,Control+f
-.SS \fBkb\-remove\-word\-back\fP
+.SS \fBkb-remove-word-back\fP
.PP
Delete previous word
.PP
-\fBDefault\fP: Control+Alt+h,Control+BackSpace
+\fBDefault\fP: Control+Alt+h,Control+BackSpace
-.SS \fBkb\-remove\-word\-forward\fP
+.SS \fBkb-remove-word-forward\fP
.PP
Delete next word
.PP
-\fBDefault\fP: Control+Alt+d
+\fBDefault\fP: Control+Alt+d
-.SS \fBkb\-remove\-char\-forward\fP
+.SS \fBkb-remove-char-forward\fP
.PP
Delete next char
.PP
-\fBDefault\fP: Delete,Control+d
+\fBDefault\fP: Delete,Control+d
-.SS \fBkb\-remove\-char\-back\fP
+.SS \fBkb-remove-char-back\fP
.PP
Delete previous char
.PP
-\fBDefault\fP: BackSpace,Shift+BackSpace,Control+h
+\fBDefault\fP: BackSpace,Shift+BackSpace,Control+h
-.SS \fBkb\-remove\-to\-eol\fP
+.SS \fBkb-remove-to-eol\fP
.PP
Delete till the end of line
.PP
-\fBDefault\fP: Control+k
+\fBDefault\fP: Control+k
-.SS \fBkb\-remove\-to\-sol\fP
+.SS \fBkb-remove-to-sol\fP
.PP
Delete till the start of line
.PP
-\fBDefault\fP: Control+u
+\fBDefault\fP: Control+u
-.SS \fBkb\-accept\-entry\fP
+.SS \fBkb-accept-entry\fP
.PP
Accept entry
.PP
-\fBDefault\fP: Control+j,Control+m,Return,KP\_Enter
+\fBDefault\fP: Control+j,Control+m,Return,KP_Enter
-.SS \fBkb\-accept\-custom\fP
+.SS \fBkb-accept-custom\fP
.PP
Use entered text as command (in ssh/run modes)
.PP
-\fBDefault\fP: Control+Return
+\fBDefault\fP: Control+Return
-.SS \fBkb\-accept\-custom\-alt\fP
+.SS \fBkb-accept-custom-alt\fP
.PP
Use entered text as command (in ssh/run modes)
.PP
-\fBDefault\fP: Control+Shift+Return
+\fBDefault\fP: Control+Shift+Return
-.SS \fBkb\-accept\-alt\fP
+.SS \fBkb-accept-alt\fP
.PP
Use alternate accept command.
.PP
-\fBDefault\fP: Shift+Return
+\fBDefault\fP: Shift+Return
-.SS \fBkb\-delete\-entry\fP
+.SS \fBkb-delete-entry\fP
.PP
Delete entry from history
.PP
-\fBDefault\fP: Shift+Delete
+\fBDefault\fP: Shift+Delete
-.SS \fBkb\-mode\-next\fP
+.SS \fBkb-mode-next\fP
.PP
Switch to the next mode.
.PP
-\fBDefault\fP: Shift+Right,Control+Tab
+\fBDefault\fP: Shift+Right,Control+Tab
-.SS \fBkb\-mode\-previous\fP
+.SS \fBkb-mode-previous\fP
.PP
Switch to the previous mode.
.PP
-\fBDefault\fP: Shift+Left,Control+ISO\_Left\_Tab
+\fBDefault\fP: Shift+Left,Control+ISO_Left_Tab
-.SS \fBkb\-mode\-complete\fP
+.SS \fBkb-mode-complete\fP
.PP
Start completion for mode.
.PP
-\fBDefault\fP: Control+l
+\fBDefault\fP: Control+l
-.SS \fBkb\-row\-left\fP
+.SS \fBkb-row-left\fP
.PP
Go to the previous column
.PP
-\fBDefault\fP: Control+Page\_Up
+\fBDefault\fP: Control+Page_Up
-.SS \fBkb\-row\-right\fP
+.SS \fBkb-row-right\fP
.PP
Go to the next column
.PP
-\fBDefault\fP: Control+Page\_Down
+\fBDefault\fP: Control+Page_Down
-.SS \fBkb\-row\-up\fP
+.SS \fBkb-row-up\fP
.PP
Select previous entry
.PP
-\fBDefault\fP: Up,Control+p
+\fBDefault\fP: Up,Control+p
-.SS \fBkb\-row\-down\fP
+.SS \fBkb-row-down\fP
.PP