diff options
author | Dave Davenport <qball@gmpclient.org> | 2023-03-27 18:45:44 +0200 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2023-03-27 18:45:44 +0200 |
commit | 0133697fd2c3c5ca77c7a32f0b30ae750949a027 (patch) | |
tree | c1c9e3ac72ad56485d7fad4048c8105d549b2ff5 | |
parent | 586980aeaf16869e6ec618a11e8d149306e58c4b (diff) |
[Doc] Update theme manpage with remark-lint hints.
-rw-r--r-- | doc/rofi-debugging.5 | 42 | ||||
-rw-r--r-- | doc/rofi-debugging.5.markdown | 93 | ||||
-rw-r--r-- | doc/rofi-dmenu.5 | 66 | ||||
-rw-r--r-- | doc/rofi-dmenu.5.markdown | 120 | ||||
-rw-r--r-- | doc/rofi-theme-selector.1 | 13 | ||||
-rw-r--r-- | doc/rofi-theme-selector.1.markdown | 20 | ||||
-rw-r--r-- | doc/rofi-theme.5 | 450 | ||||
-rw-r--r-- | doc/rofi-theme.5.markdown | 984 |
8 files changed, 1010 insertions, 778 deletions
diff --git a/doc/rofi-debugging.5 b/doc/rofi-debugging.5 index dc0eb01b..73a934b9 100644 --- a/doc/rofi-debugging.5 +++ b/doc/rofi-debugging.5 @@ -5,14 +5,15 @@ 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. +When reporting an issue with rofi crashing, or misbehaving. It helps to do some +small test to help pin-point the problem. .PP 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. +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 @@ -33,8 +34,8 @@ rofi -dump-theme .RE .PP -\fB\fCrofi -help\fR provides us with the configuration files parsed, the exact version, monitor layout -and more useful information. +\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 @@ -57,8 +58,8 @@ G_MESSAGES_DEBUG=Timings rofi -show drun .RE .PP -It will show a trace with (useful) timing information at relevant points during the execution. -This will help debugging when rofi is slow to start. +It will show a trace with (useful) timing information at relevant points during +the execution. This will help debugging when rofi is slow to start. .PP Example trace: @@ -123,9 +124,11 @@ 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 -environment variable. At the time of creation of this page, the following debug domains exist: +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 environment variable. At the time of creation of this page, +the following debug domains exist: .RS .IP \(bu 2 @@ -173,7 +176,8 @@ 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. .PP To redirect the debug output to a file (\fB\fC~/rofi.log\fR) add: @@ -191,7 +195,7 @@ rofi -show drun -log ~/rofi.log Specifying the logfile automatically enabled all log domains. This can be useful when rofi is launched from a window manager. -.SH Creating a backtrace. +.SH Creating a backtrace .PP First make sure you compile \fBrofi\fP with debug symbols: @@ -205,10 +209,10 @@ make CFLAGS="-O0 -g3" clean rofi .RE .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 -can then load the core in GDB. +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 can then load the core in GDB. .PP .RS @@ -235,11 +239,13 @@ 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 +rofi-sensible-terminal(1), dmenu(1), rofi-debugging(5), rofi-theme(5), +rofi-script(5), rofi-keys(5),rofi-theme-selector(1) .SH AUTHOR .RS diff --git a/doc/rofi-debugging.5.markdown b/doc/rofi-debugging.5.markdown index 643c68b1..229fe773 100644 --- a/doc/rofi-debugging.5.markdown +++ b/doc/rofi-debugging.5.markdown @@ -4,16 +4,16 @@ Debugging rofi. -When reporting an issue with rofi crashing, or misbehaving. It helps to do some small test -to help pin-point the problem. +When reporting an issue with rofi crashing, or misbehaving. It helps to do some +small test to help pin-point the problem. First try disabling your custom configuration: `-no-config` -This disables the parsing of the configuration files. This runs rofi in *stock* mode. +This disables the parsing of the configuration files. This runs rofi in *stock* +mode. 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: @@ -24,15 +24,14 @@ rofi -dump-config rofi -dump-theme ``` -`rofi -help` provides us with the configuration files parsed, the exact version, monitor layout -and more useful information. +`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. @@ -40,13 +39,12 @@ To get a timing trace, enable the **Timings** debug domain. ```bash G_MESSAGES_DEBUG=Timings rofi -show drun ``` - -It will show a trace with (useful) timing information at relevant points during the execution. -This will help debugging when rofi is slow to start. +It will show a trace with (useful) timing information at relevant points during +the execution. This will help debugging when rofi is slow to start. Example trace: -``` +```text (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 @@ -99,48 +97,49 @@ Example trace: (process:14942): Timings-DEBUG: 13:47:39.428: 0.092864 (0.006741): ../source/view.c:rofi_view_update:1008 widgets ``` - ## Debug domains -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 -environment variable. At the time of creation of this page, the following debug domains exist: - - * all: Show debug information from all domains. - * X11Helper: The X11 Helper functions. - * View: The main window view functions. - * Widgets.Box: The Box widget. - * Modes.DMenu: The dmenu mode. - * Modes.Run: The run mode. - * Modes.DRun: The desktop file run mode. - * Modes.Window: The window mode. - * Modes.Script: The script mode. - * Modes.Combi: The script mode. - * Modes.Ssh: The ssh mode. - * Rofi: The main application. - * Timings: Get timing output. - * Theme: Theme engine debug output. (warning lots of output). - * Widgets.Icon: The Icon widget. - * Widgets.Box: The box widget. - * Widgets.Container: The container widget. - * Widgets.Window: The window widget. - * Helpers.IconFetcher: Information about icon lookup. +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 environment variable. At the time of creation of this page, +the following debug domains exist: + +- all: Show debug information from all domains. +- X11Helper: The X11 Helper functions. +- View: The main window view functions. +- Widgets.Box: The Box widget. +- Modes.DMenu: The dmenu mode. +- Modes.Run: The run mode. +- Modes.DRun: The desktop file run mode. +- Modes.Window: The window mode. +- Modes.Script: The script mode. +- Modes.Combi: The script mode. +- Modes.Ssh: The ssh mode. +- Rofi: The main application. +- Timings: Get timing output. +- Theme: Theme engine debug output. (warning lots of output). +- Widgets.Icon: The Icon widget. +- Widgets.Box: The box widget. +- Widgets.Container: The container widget. +- Widgets.Window: The window widget. +- Helpers.IconFetcher: Information about icon lookup. For full list see `man rofi`. -Example: `G_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun` To get specific output from the Desktop file run dialog. +Example: `G_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun` To get specific output +from the Desktop file run dialog. To redirect the debug output to a file (`~/rofi.log`) add: -``` +```bash rofi -show drun -log ~/rofi.log ``` Specifying the logfile automatically enabled all log domains. This can be useful when rofi is launched from a window manager. - -## Creating a backtrace. +## Creating a backtrace First make sure you compile **rofi** with debug symbols: @@ -148,10 +147,10 @@ First make sure you compile **rofi** with debug symbols: make CFLAGS="-O0 -g3" clean rofi ``` -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 -can then load the core in GDB. +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 can then load the core in GDB. ```bash gdb rofi core @@ -159,17 +158,19 @@ gdb rofi core Then type inside gdb: -``` +```bash thread apply all bt ``` The output trace is useful when reporting crashes. -Some distribution have `systemd-coredump`, this way you can easily get a backtrace via `coredumpctl`. +Some distribution have `systemd-coredump`, this way you can easily get a +backtrace via `coredumpctl`. ## SEE ALSO -**rofi-sensible-terminal(1)**, **dmenu(1)**, **rofi-debugging(5)**, **rofi-theme(5)**, **rofi-script(5)**, **rofi-keys(5)**,**rofi-theme-selector(1)** +rofi-sensible-terminal(1), dmenu(1), rofi-debugging(5), rofi-theme(5), +rofi-script(5), rofi-keys(5),rofi-theme-selector(1) ## AUTHOR diff --git a/doc/rofi-dmenu.5 b/doc/rofi-dmenu.5 index c11dc96c..21482ab7 100644 --- a/doc/rofi-dmenu.5 +++ b/doc/rofi-dmenu.5 @@ -14,22 +14,25 @@ The website for \fB\fCdmenu\fR can be found here \[la]http://tools.suckless.org/dmenu/\[ra]\&. .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). +\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). .SH BASIC CONCEPT .PP -In \fB\fCdmenu\fR mode, \fBrofi\fP reads data from standard in, splits them into separate entries and displays them. -If the user selects an row, this is printed out to standard out, allow the script to process it further. +In \fB\fCdmenu\fR mode, \fBrofi\fP reads data from standard in, splits them into +separate entries and displays them. If the user selects an row, this is printed +out to standard out, allow the script to process it further. .PP -By default separation of rows is done on new lines, making it easy to pipe the output a one application into -\fBrofi\fP and the output of rofi into the next. +By default separation of rows is done on new lines, making it easy to pipe the +output a one application into \fBrofi\fP and the output of rofi into the next. .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 @@ -43,7 +46,8 @@ ls | rofi -dmenu .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 @@ -57,18 +61,20 @@ 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 -for more information about this syntax. +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 .PP -Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' as a separator: +Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' as a +separator: .PP .RS @@ -83,7 +89,8 @@ echo "a|b|c|d|e" | rofi -sep '|' -dmenu \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. +Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey', +a,b,c,d, or e. .PP .RS @@ -125,7 +132,10 @@ Makes \fB\fCdmenu\fR searches case-insensitive \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 @@ -166,7 +176,8 @@ This mode returns directly when no entries given. \fB\fC-format\fR \fIformat\fP .PP -Allows the output of dmenu to be customized (N is the total number of input entries): +Allows the output of dmenu to be customized (N is the total number of input +entries): .RS .IP \(bu 2 @@ -199,8 +210,9 @@ Select first line that matches the given string \fB\fC-mesg\fR \fIstring\fP .PP -Add a message line below the filter entry box. Supports Pango markup. -For more information on supported markup, see here +Add a message line below the filter entry box. Supports Pango markup. For more +information on supported markup, see +here \[la]https://docs.gtk.org/Pango/pango_markup.html\[ra] .PP @@ -229,22 +241,26 @@ Hide the input text. This should not be considered secure! .PP Tell \fBrofi\fP that DMenu input is Pango markup encoded, and should be rendered. See here -\[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra] for details about Pango markup. +\[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra] +for details about Pango markup. .PP \fB\fC-multi-select\fR .PP -Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry. +Allow multiple lines to be selected. Adds a small selection indicator to the +left of each entry. .PP \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. +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, +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\&. .PP @@ -309,7 +325,8 @@ Set ellipsize mode on the listview. .SH PARSING ROW OPTIONS .PP -Extra options for individual rows can be also set. See the \fBrofi-script(5)\fP manpage for details; the syntax and supported features are identical. +Extra options for individual rows can be also set. See the \fBrofi-script(5)\fP +manpage for details; the syntax and supported features are identical. .SH RETURN VALUE .RS @@ -324,7 +341,8 @@ Extra options for individual rows can be also set. See the \fBrofi-script(5)\fP .SH SEE ALSO .PP -rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1), ascii(7) +rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), +rofi-theme-selector(1), ascii(7) .SH AUTHOR .PP diff --git a/doc/rofi-dmenu.5.markdown b/doc/rofi-dmenu.5.markdown index ff2f0203..b1dd8ab3 100644 --- a/doc/rofi-dmenu.5.markdown +++ b/doc/rofi-dmenu.5.markdown @@ -4,7 +4,6 @@ **rofi dmenu mode** - Rofi dmenu emulation - ## DESCRIPTION To integrate **rofi** into scripts as simple selection dialogs, @@ -12,58 +11,67 @@ To integrate **rofi** into scripts as simple selection dialogs, The website for `dmenu` can be found [here](http://tools.suckless.org/dmenu/). -**rofi** does not aim to be 100% compatible with `dmenu`. There are simply too many flavors of `dmenu`. -The idea is that the basic usage command-line flags are obeyed, theme-related flags are not. -Besides, **rofi** offers some extended features (like multi-select, highlighting, message bar, extra key bindings). - +**rofi** does not aim to be 100% compatible with `dmenu`. There are simply too +many flavors of `dmenu`. The idea is that the basic usage command-line flags +are obeyed, theme-related flags are not. Besides, **rofi** offers some extended +features (like multi-select, highlighting, message bar, extra key bindings). ## BASIC CONCEPT -In `dmenu` mode, **rofi** reads data from standard in, splits them into separate entries and displays them. -If the user selects an row, this is printed out to standard out, allow the script to process it further. +In `dmenu` mode, **rofi** reads data from standard in, splits them into +separate entries and displays them. If the user selects an row, this is printed +out to standard out, allow the script to process it further. -By default separation of rows is done on new lines, making it easy to pipe the output a one application into -**rofi** and the output of rofi into the next. +By default separation of rows is done on new lines, making it easy to pipe the +output a one application into **rofi** and the output of rofi into the next. ## USAGE -By launching **rofi** with the `-dmenu` flag it will go into dmenu emulation mode. +By launching **rofi** with the `-dmenu` flag it will go into dmenu emulation +mode. ```bash ls | rofi -dmenu ``` - ### DMENU DROP-IN REPLACEMENT If `argv[0]` (calling command) is dmenu, **rofi** will start in dmenu mode. -This way, it can be used as a drop-in replacement for dmenu. Just copy or symlink **rofi** to dmenu in `$PATH`. - - ln -s /usr/bin/rofi /usr/bin/dmenu +This way, it can be used as a drop-in replacement for dmenu. Just copy or +symlink **rofi** to dmenu in `$PATH`. +```bash +ln -s /usr/bin/rofi /usr/bin/dmenu +``` ### DMENU VS SCRIPT MODE Script mode is used to extend **rofi**, dmenu mode is used to extend a script. -The two do share much of the same input format. Please see the **rofi-script(5)** manpage for more information. - +The two do share much of the same input format. Please see the +**rofi-script(5)** manpage for more information. ### DMENU SPECIFIC COMMANDLINE FLAGS -A lot of these options can also be modified by the script using special input. See the **rofi-script(5)** manpage -for more information about this syntax. +A lot of these options can also be modified by the script using special input. +See the **rofi-script(5)** manpage for more information about this syntax. `-sep` *separator* -Separator for `dmenu`. Example: To show a list of 'a' to 'e' with '|' as a separator: +Separator for `dmenu`. Example: To show a list of 'a' to 'e' with '|' as a +separator: - echo "a|b|c|d|e" | rofi -sep '|' -dmenu +```bash +echo "a|b|c|d|e" | rofi -sep '|' -dmenu +``` `-p` *prompt* -Specify the prompt to show in `dmenu` mode. For example, select 'monkey', a,b,c,d, or e. +Specify the prompt to show in `dmenu` mode. For example, select 'monkey', +a,b,c,d, or e. - echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey" +```bash +echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey" +``` Default: *dmenu* @@ -71,7 +79,9 @@ Default: *dmenu* Maximum number of lines the menu may show before scrolling. - rofi -dmenu -l 25 +```bash +rofi -dmenu -l 25 +``` Default: *15* @@ -81,13 +91,16 @@ Makes `dmenu` searches case-insensitive `-a` *X* -Active row, mark *X* as active. Where *X* 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 *X* as active. Where *X* 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: - * A single row: '5' - * A range of (last 3) rows: '-3:' - * 4 rows starting from row 7: '7:11' (or in legacy notation: '7-10') - * A set of rows: '2,0,-9' - * Or any combination: '5,-3:,7:11,2,0,-9' +- A single row: '5' +- A range of (last 3) rows: '-3:' +- 4 rows starting from row 7: '7:11' (or in legacy notation: '7-10') +- A set of rows: '2,0,-9' +- Or any combination: '5,-3:,7:11,2,0,-9' `-u` *X* @@ -106,15 +119,16 @@ This mode returns directly when no entries given. `-format` *format* -Allows the output of dmenu to be customized (N is the total number of input entries): +Allows the output of dmenu to be customized (N is the total number of input +entries): - * 's' selected string - * 'i' index (0 - (N-1)) - * 'd' index (1 - N) - * 'q' quote string - * 'p' Selected string stripped from Pango markup (Needs to be a valid string) - * 'f' filter string (user input) - * 'F' quoted filter string (user input) +- 's' selected string +- 'i' index (0 - (N-1)) +- 'd' index (1 - N) +- 'q' quote string +- 'p' Selected string stripped from Pango markup (Needs to be a valid string) +- 'f' filter string (user input) +- 'F' quoted filter string (user input) Default: 's' @@ -124,8 +138,9 @@ Select first line that matches the given string `-mesg` *string* -Add a message line below the filter entry box. Supports Pango markup. -For more information on supported markup, see [here](https://docs.gtk.org/Pango/pango_markup.html) +Add a message line below the filter entry box. Supports Pango markup. For more +information on supported markup, see +[here](https://docs.gtk.org/Pango/pango_markup.html) `-dump` @@ -144,18 +159,21 @@ Hide the input text. This should not be considered secure! `-markup-rows` Tell **rofi** that DMenu input is Pango markup encoded, and should be rendered. -See [here](https://developer.gnome.org/pygtk/stable/pango-markup-language.html) for details about Pango markup. - +See [here](https://developer.gnome.org/pygtk/stable/pango-markup-language.html) +for details about Pango markup. `-multi-select` -Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry. +Allow multiple lines to be selected. Adds a small selection indicator to the +left of each entry. `-sync` -Force **rofi** mode to first read all data from stdin before showing the selection window. This is original dmenu behavior. +Force **rofi** mode to first read all data from stdin before showing the +selection window. This is original dmenu behavior. -Note: the default asynchronous mode will also be automatically disabled if used with conflicting options, +Note: the default asynchronous mode will also be automatically disabled if used +with conflicting options, such as `-dump`, `-only-match` or `-auto-select`. `-window-title` *title* @@ -200,18 +218,19 @@ Set ellipsize mode on the listview. ## PARSING ROW OPTIONS -Extra options for individual rows can be also set. See the **rofi-script(5)** manpage for details; the syntax and supported features are identical. +Extra options for individual rows can be also set. See the **rofi-script(5)** +manpage for details; the syntax and supported features are identical. ## RETURN VALUE - * **0**: Row has been selected accepted by user. - * **1**: User cancelled the selection. - * **10-28**: Row accepted by custom keybinding. - +- **0**: Row has been selected accepted by user. +- **1**: User cancelled the selection. +- **10-28**: Row accepted by custom keybinding. ## SEE ALSO -rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1), ascii(7) +rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), +rofi-theme-selector(1), ascii(7) ## AUTHOR @@ -221,7 +240,6 @@ Rasmus Steinke <rasi@xssn.at> Morgane Glidic <sardemff7+rofi@sardemff7.net> - Original code based on work by: Sean Pringle <sean.pringle@gmail.com> For a full list of authors, check the AUTHORS file. diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1 index 96df43df..f0d31d6e 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -6,15 +6,15 @@ .SH DESCRIPTION .PP -\fBrofi-theme-selector\fP is a bash/rofi script to preview and apply themes for \fBrofi\fP\&. -It's part of any installation of \fBrofi\fP\&. +\fBrofi-theme-selector\fP is a bash/rofi script to preview and apply themes for +\fBrofi\fP\&. It's part of any installation of \fBrofi\fP\&. .SH USAGE .SS Running rofi-theme-selector .PP -\fBrofi-theme-selector\fP shows a list of all available themes in a \fBrofi\fP window. -It lets you preview each theme with the Enter key and apply the theme to your -\fBrofi\fP configuration file with Alt+a. +\fBrofi-theme-selector\fP shows a list of all available themes in a \fBrofi\fP +window. It lets you preview each theme with the Enter key and apply the theme +to your \fBrofi\fP configuration file with Alt+a. .SH Theme directories .PP @@ -31,7 +31,8 @@ $XDG_DATA_HOME/share/rofi/themes .RE .PP -${PREFIX} reflects the install location of rofi. In most cases this will be "/usr". +${PREFIX} reflects the install location of rofi. In most cases this will be +"/usr". $XDG_CONFIG_HOME is normally unset. Default path is "$HOME/.config". $XDG_DATA_HOME is normally unset. Default path is "$HOME/.local/share". diff --git a/doc/rofi-theme-selector.1.markdown b/doc/rofi-theme-selector.1.markdown index e5c401ce..f52f31c7 100644 --- a/doc/rofi-theme-selector.1.markdown +++ b/doc/rofi-theme-selector.1.markdown @@ -6,27 +6,27 @@ ## DESCRIPTION -**rofi-theme-selector** is a bash/rofi script to preview and apply themes for **rofi**. -It's part of any installation of **rofi**. +**rofi-theme-selector** is a bash/rofi script to preview and apply themes for +**rofi**. It's part of any installation of **rofi**. ## USAGE ### Running rofi-theme-selector -**rofi-theme-selector** shows a list of all available themes in a **rofi** window. -It lets you preview each theme with the Enter key and apply the theme to your -**rofi** configuration file with Alt+a. - +**rofi-theme-selector** shows a list of all available themes in a **rofi** +window. It lets you preview each theme with the Enter key and apply the theme +to your **rofi** configuration file with Alt+a. ## Theme directories **rofi-theme-selector** searches the following directories for themes: -* ${PREFIX}/share/rofi/themes -* $XDG_CONFIG_HOME/rofi/themes -* $XDG_DATA_HOME/share/rofi/themes +- ${PREFIX}/share/rofi/themes +- $XDG_CONFIG_HOME/rofi/themes +- $XDG_DATA_HOME/share/rofi/themes -${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".<br> +${PREFIX} reflects the install location of rofi. In most cases this will be +"/usr".<br> $XDG_CONFIG_HOME is normally unset. Default path is "$HOME/.config".<br> $XDG_DATA_HOME is normally unset. Default path is "$HOME/.local/share". diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index 306687bc..45fec34e 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -9,8 +9,7 @@ The easiest way to get started theming rofi is by modifying your existing theme. .PP -Themes can be modified/tweaked by adding theming elements to the end of the -.br +Themes can be modified/tweaked by adding theming elements to the end of the\\ config file. The default location of this file is \fB\fC~/.config/rofi/config.rasi\fR, if the file does not exists, you can create it. @@ -50,8 +49,8 @@ entry { .PP In the above section, \fB\fCentry\fR indicates the widget, \fB\fCplaceholder\fR is the -property we want to modify and we set it to the string \fB\fC"Type here"\fR\&. -To find the commonly available widgets in rofi, see the 'Basic structure' section. +property we want to modify and we set it to the string \fB\fC"Type here"\fR\&. To find +the commonly available widgets in rofi, see the 'Basic structure' section. .PP To change the mouse over cursor to a pointer, add: @@ -146,7 +145,8 @@ In this example we specify the size in the em \[la]https://www.w3.org/Style/LieBos3e/em\[ra] unit. .PP -Now lets change the text color of both the \fB\fCentry\fR and the \fB\fCelement-text\fR widget to red and background to blue. +Now lets change the text color of both the \fB\fCentry\fR and the \fB\fCelement-text\fR +widget to red and background to blue. .PP .RS @@ -213,7 +213,8 @@ entry { .RE .PP -By default, the \fB\fCcursor-color\fR will be the same as the \fB\fCtext-color\fR\&. The \fB\fCcursor-width\fR will always default to 2 pixels. +By default, the \fB\fCcursor-color\fR will be the same as the \fB\fCtext-color\fR\&. The +\fB\fCcursor-width\fR will always default to 2 pixels. .PP If you want to see the complete theme, including the modification you can run: @@ -267,16 +268,18 @@ rofi -no-config -dump-theme .SH Description .PP -The need for a new theme format was motivated by the fact that the way rofi handled widgets has changed. From a very -static drawing of lines and text to a nice structured form of packing widgets. This change made it possible to provide a -more flexible theme framework. The old theme format and config file are not flexible enough to expose these options in a -user-friendly way. Therefore, a new file format has been created, replacing the old one. +The need for a new theme format was motivated by the fact that the way rofi +handled widgets has changed. From a very static drawing of lines and text to a +nice structured form of packing widgets. This change made it possible to +provide a more flexible theme framework. The old theme format and config file +are not flexible enough to expose these options in a user-friendly way. +Therefore, a new file format has been created, replacing the old one. .SH Format specification .SH Encoding .PP -The encoding of the file is UTF-8. Both unix (\fB\fC\\n\fR) and windows (\fB\fC\\r\\n\fR) newlines format are supported. But unix is -preferred. +The encoding of the file is UTF-8. Both unix (\fB\fC\\n\fR) and windows (\fB\fC\\r\\n\fR) +newlines format are supported. But unix is preferred. .SH Comments .PP @@ -286,7 +289,8 @@ C and C++ file comments are supported. .IP \(bu 2 Anything after \fB\fC//\fR and before a newline is considered a comment. .IP \(bu 2 -Everything between \fB\fC/*\fR and \fB\fC*/\fR is a comment, this comment can span multiple lines. +Everything between \fB\fC/*\fR and \fB\fC*/\fR is a comment, this comment can span +multiple lines. .RE @@ -352,13 +356,15 @@ name .SH File extension .PP The preferred file extension for the new theme format is \fBrasi\fP\&. This is an -abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation. -If a theme file is split over multiple files, include files can have the: \fBrasinc\fP extension. +abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation. If a theme +file is split over multiple files, include files can have the: \fBras |