PolytreeDE/rofi
1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-25 13:55:34 -05:00
Code Releases Activity

[Doc] Tweak rofi-theme manpage.

Browse source
This commit is contained in:
Dave Davenport 2022-04-05 22:21:13 +02:00
parent 0f3a88fc2c
commit 88a1d1cbf7
8 changed files with 755 additions and 758 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

119
doc/rofi-dmenu.5
View file

@ -1,7 +1,8 @@
.TH ROFI\-DMENU 5 rofi\-dmenu .nh
.TH ROFI-DMENU 5 rofi-dmenu
.SH NAME .SH NAME
.PP .PP
\fBrofi dmenu mode\fP \- Rofi dmenu emulation \fBrofi dmenu mode\fP - Rofi dmenu emulation
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
@ -14,8 +15,8 @@ The website for \fB\fCdmenu\fR can be found here
.PP .PP
\fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many flavors of \fB\fCdmenu\fR\&. \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). Besides, \fBrofi\fP offers some extended features (like multi-select, highlighting, message bar, extra key bindings).
.SH BASIC CONCEPT .SH BASIC CONCEPT
.PP .PP
@ -28,27 +29,27 @@ By default separation of rows is done on new lines, making it easy to pipe the o
.SH USAGE .SH USAGE
.PP .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 .PP
.RS .RS
.nf .nf
ls | rofi \-dmenu ls | rofi -dmenu
.fi .fi
.RE .RE
.SS DMENU DROP\-IN REPLACEMENT .SS DMENU DROP-IN REPLACEMENT
.PP .PP
If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode. 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 .PP
.RS .RS
.nf .nf
ln \-s /usr/bin/rofi /usr/bin/dmenu ln -s /usr/bin/rofi /usr/bin/dmenu
.fi .fi
.RE .RE
@ -56,15 +57,15 @@ ln \-s /usr/bin/rofi /usr/bin/dmenu
.SS DMENU VS SCRIPT MODE .SS DMENU VS SCRIPT MODE
.PP .PP
Script mode is used to extend \fBrofi\fP, dmenu mode is used to extend a script. 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 .SS DMENU SPECIFIC COMMANDLINE FLAGS
.PP .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. for more information about this syntax.
.PP .PP
\fB\fC\-sep\fR \fIseparator\fP \fB\fC-sep\fR \fIseparator\fP
.PP .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:
@ -73,13 +74,13 @@ Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' a
.RS .RS
.nf .nf
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu echo "a|b|c|d|e" | rofi -sep '|' -dmenu
.fi .fi
.RE .RE
.PP .PP
\fB\fC\-p\fR \fIprompt\fP \fB\fC-p\fR \fIprompt\fP
.PP .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.
@ -88,7 +89,7 @@ Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey',
.RS .RS
.nf .nf
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey" echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
.fi .fi
.RE .RE
@ -97,7 +98,7 @@ echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey"
Default: \fIdmenu\fP Default: \fIdmenu\fP
.PP .PP
\fB\fC\-l\fR \fInumber of lines to show\fP \fB\fC-l\fR \fInumber of lines to show\fP
.PP .PP
Maximum number of lines the menu may show before scrolling. 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 .RS
.nf .nf
rofi \-dmenu \-l 25 rofi -dmenu -l 25
.fi .fi
.RE .RE
@ -115,39 +116,39 @@ rofi \-dmenu \-l 25
Default: \fI15\fP Default: \fI15\fP
.PP .PP
\fB\fC\-i\fR \fB\fC-i\fR
.PP .PP
Makes \fB\fCdmenu\fR searches case\-insensitive Makes \fB\fCdmenu\fR searches case-insensitive
.PP .PP
\fB\fC\-a\fR \fIX\fP \fB\fC-a\fR \fIX\fP
.PP .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 .RS
.IP \(bu 2 .IP \(bu 2
A single row: '5' A single row: '5'
.IP \(bu 2 .IP \(bu 2
A range of (last 3) rows: '\-3:' A range of (last 3) rows: '-3:'
.IP \(bu 2 .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 .IP \(bu 2
A set of rows: '2,0,\-9' A set of rows: '2,0,-9'
.IP \(bu 2 .IP \(bu 2
Or any combination: '5,\-3:,7:11,2,0,\-9' Or any combination: '5,-3:,7:11,2,0,-9'
.RE .RE
.PP .PP
\fB\fC\-u\fR \fIX\fP \fB\fC-u\fR \fIX\fP
.PP .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 .PP
\fB\fC\-only\-match\fR \fB\fC-only-match\fR
.PP .PP
Only return a selected item, do not allow custom entry. 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. selected.
.PP .PP
\fB\fC\-no\-custom\fR \fB\fC-no-custom\fR
.PP .PP
Only return a selected item, do not allow custom entry. Only return a selected item, do not allow custom entry.
This mode returns directly when no entries given. This mode returns directly when no entries given.
.PP .PP
\fB\fC\-format\fR \fIformat\fP \fB\fC-format\fR \fIformat\fP
.PP .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):
@ -171,9 +172,9 @@ Allows the output of dmenu to be customized (N is the total number of input entr
.IP \(bu 2 .IP \(bu 2
\&'s' selected string \&'s' selected string
.IP \(bu 2 .IP \(bu 2
\&'i' index (0 \-\& (N\-\&1)) \&'i' index (0 - (N-1))
.IP \(bu 2 .IP \(bu 2
\&'d' index (1 \-\& N) \&'d' index (1 - N)
.IP \(bu 2 .IP \(bu 2
\&'q' quote string \&'q' quote string
.IP \(bu 2 .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' Default: 's'
.PP .PP
\fB\fC\-select\fR \fIstring\fP \fB\fC-select\fR \fIstring\fP
.PP .PP
Select first line that matches the given string Select first line that matches the given string
.PP .PP
\fB\fC\-mesg\fR \fIstring\fP \fB\fC-mesg\fR \fIstring\fP
.PP .PP
Add a message line below the filter entry box. Supports Pango markup. 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] \[la]https://docs.gtk.org/Pango/pango_markup.html\[ra]
.PP .PP
\fB\fC\-dump\fR \fB\fC-dump\fR
.PP .PP
Dump the filtered list to stdout and quit. Dump the filtered list to stdout and quit.
This can be used to get the list as \fBrofi\fP would filter it. 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 .PP
\fB\fC\-input\fR \fIfile\fP \fB\fC-input\fR \fIfile\fP
.PP .PP
Reads from \fIfile\fP instead of stdin. Reads from \fIfile\fP instead of stdin.
.PP .PP
\fB\fC\-password\fR \fB\fC-password\fR
.PP .PP
Hide the input text. This should not be considered secure! Hide the input text. This should not be considered secure!
.PP .PP
\fB\fC\-markup\-rows\fR \fB\fC-markup-rows\fR
.PP .PP
Tell \fBrofi\fP that DMenu input is Pango markup encoded, and should be rendered. 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. \[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra] for details about Pango markup.
.PP .PP
\fB\fC\-multi\-select\fR \fB\fC-multi-select\fR
.PP .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 .PP
\fB\fC\-sync\fR \fB\fC-sync\fR
.PP .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 .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\&. such as \fB\fC-dump\fR, \fB\fC-only-match\fR or \fB\fC-auto-select\fR\&.
.PP .PP
\fB\fC\-async\-pre\-read\fR \fInumber\fP \fB\fC-async-pre-read\fR \fInumber\fP
.PP .PP
Reads the first \fInumber\fP entries blocking, then switches to async mode. 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 \fIdefault\fP: 25
.PP .PP
\fB\fC\-window\-title\fR \fItitle\fP \fB\fC-window-title\fR \fItitle\fP
.PP .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 .PP
\fB\fC\-w\fR \fIwindowid\fP \fB\fC-w\fR \fIwindowid\fP
.PP .PP
Position \fBrofi\fP over the window with the given X11 window ID. Position \fBrofi\fP over the window with the given X11 window ID.
.PP .PP
\fB\fC\-keep\-right\fR \fB\fC-keep-right\fR
.PP .PP
Set ellipsize mode to start. So, the end of the string is visible. Set ellipsize mode to start. So, the end of the string is visible.
.PP .PP
\fB\fC\-display\-columns\fR \fB\fC-display-columns\fR
.PP .PP
A comma seperated list of columns to show. A comma seperated list of columns to show.
.PP .PP
\fB\fC\-display\-column\-separator\fR \fB\fC-display-column-separator\fR
.PP .PP
The column separator. This is a regex. The column separator. This is a regex.
@ -296,30 +297,30 @@ The column separator. This is a regex.
.IP \(bu 2 .IP \(bu 2
\fB1\fP: User cancelled the selection. \fB1\fP: User cancelled the selection.
.IP \(bu 2 .IP \(bu 2
\fB10\-28\fP: Row accepted by custom keybinding. \fB10-28\fP: Row accepted by custom keybinding.
.RE .RE
.SH SEE ALSO .SH SEE ALSO
.PP .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 .SH AUTHOR
.PP .PP
Qball Cow Qball Cow qball@gmpclient.org
\[la]qball@gmpclient.org\[ra] \[la]mailto:qball@gmpclient.org\[ra]
.PP .PP
Rasmus Steinke Rasmus Steinke rasi@xssn.at
\[la]rasi@xssn.at\[ra] \[la]mailto:rasi@xssn.at\[ra]
.PP .PP
Morgane Glidic Morgane Glidic sardemff7+rofi@sardemff7.net
\[la]sardemff7+rofi@sardemff7.net\[ra] \[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.PP .PP
Original code based on work by: Sean Pringle Original code based on work by: Sean Pringle sean.pringle@gmail.com
\[la]sean.pringle@gmail.com\[ra] \[la]mailto:sean.pringle@gmail.com\[ra]
.PP .PP
For a full list of authors, check the AUTHORS file. For a full list of authors, check the AUTHORS file.

209
doc/rofi-keys.5
View file

@ -1,7 +1,8 @@
.TH ROFI\-KEYS 5 rofi\-keys .nh
.TH ROFI-KEYS 5 rofi-keys
.SH NAME .SH NAME
.PP .PP
\fBrofi keys\fP \- Rofi Key and Mouse bindings \fBrofi keys\fP - Rofi Key and Mouse bindings
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
@ -9,13 +10,13 @@
.SH Setting binding .SH Setting binding
.PP .PP
Bindings can be done on the commandline (\-{bindingname}): Bindings can be done on the commandline (-{bindingname}):
.PP .PP
.RS .RS
.nf .nf
rofi \-show run \-kb\-accept\-entry 'Control+Shift+space' rofi -show run -kb-accept-entry 'Control+Shift+space'
.fi .fi
.RE .RE
@ -28,7 +29,7 @@ or via the configuration file:
.nf .nf
configuration { configuration {
kb\-accept\-entry: "Control+Shift+space"; kb-accept-entry: "Control+Shift+space";
} }
.fi .fi
@ -42,7 +43,7 @@ The key can be set by its name (see above) or its keycode:
.nf .nf
configuration { configuration {
kb\-accept\-entry: "Control+Shift+[65]"; kb-accept-entry: "Control+Shift+[65]";
} }
.fi .fi
@ -59,7 +60,7 @@ Multiple keys can be specified for an action as a comma separated list:
.nf .nf
configuration { configuration {
kb\-accept\-entry: "Control+Shift+space,Return"; kb-accept-entry: "Control+Shift+space,Return";
} }
.fi .fi
@ -74,490 +75,490 @@ prepend the binding with \fB\fC!\fR:
.nf .nf
configuration { configuration {
kb\-accept\-entry: "!Control+Shift+space,Return"; kb-accept-entry: "!Control+Shift+space,Return";
} }
.fi .fi
.RE .RE
.SH Keyboard Bindings .SH Keyboard Bindings
.SS \fBkb\-primary\-paste\fP: .SS \fBkb-primary-paste\fP:
.PP .PP
Paste primary selection Paste primary selection
.PP .PP
\fBDefault\fP: Control+V,Shift+Insert \fBDefault\fP: Control+V,Shift+Insert
.SS \fBkb\-secondary\-paste\fP .SS \fBkb-secondary-paste\fP
.PP .PP
Paste clipboard Paste clipboard
.PP .PP
\fBDefault\fP: Control+v,Insert \fBDefault\fP: Control+v,Insert
.SS \fBkb\-clear\-line\fP .SS \fBkb-clear-line\fP
.PP .PP
Clear input line Clear input line
.PP .PP
\fBDefault\fP: Control+w \fBDefault\fP: Control+w
.SS \fBkb\-move\-front\fP .SS \fBkb-move-front\fP
.PP .PP
Beginning of line Beginning of line
.PP .PP
\fBDefault\fP: Control+a \fBDefault\fP: Control+a
.SS \fBkb\-move\-end\fP .SS \fBkb-move-end\fP
.PP .PP
End of line End of line
.PP .PP
\fBDefault\fP: Control+e \fBDefault\fP: Control+e
.SS \fBkb\-move\-word\-back\fP .SS \fBkb-move-word-back\fP
.PP .PP
Move back one word Move back one word
.PP .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 .PP
Move forward one word Move forward one word
.PP .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 .PP
Move back one char Move back one char
.PP .PP
\fBDefault\fP: Left,Control+b \fBDefault\fP: Left,Control+b
.SS \fBkb\-move\-char\-forward\fP .SS \fBkb-move-char-forward\fP
.PP .PP
Move forward one char Move forward one char
.PP .PP
\fBDefault\fP: Right,Control+f \fBDefault\fP: Right,Control+f
.SS \fBkb\-remove\-word\-back\fP .SS \fBkb-remove-word-back\fP
.PP .PP
Delete previous word Delete previous word
.PP .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 .PP
Delete next word Delete next word
.PP .PP
\fBDefault\fP: Control+Alt+d \fBDefault\fP: Control+Alt+d
.SS \fBkb\-remove\-char\-forward\fP .SS \fBkb-remove-char-forward\fP
.PP .PP
Delete next char Delete next char
.PP .PP
\fBDefault\fP: Delete,Control+d \fBDefault\fP: Delete,Control+d
.SS \fBkb\-remove\-char\-back\fP .SS \fBkb-remove-char-back\fP
.PP .PP
Delete previous char Delete previous char
.PP .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 .PP
Delete till the end of line Delete till the end of line
.PP .PP
\fBDefault\fP: Control+k \fBDefault\fP: Control+k
.SS \fBkb\-remove\-to\-sol\fP .SS \fBkb-remove-to-sol\fP
.PP .PP
Delete till the start of line Delete till the start of line
.PP .PP
\fBDefault\fP: Control+u \fBDefault\fP: Control+u
.SS \fBkb\-accept\-entry\fP .SS \fBkb-accept-entry\fP
.PP .PP
Accept entry Accept entry
.PP .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 .PP
Use entered text as command (in ssh/run modes) Use entered text as command (in ssh/run modes)
.PP .PP
\fBDefault\fP: Control+Return \fBDefault\fP: Control+Return
.SS \fBkb\-accept\-custom\-alt\fP .SS \fBkb-accept-custom-alt\fP
.PP .PP
Use entered text as command (in ssh/run modes) Use entered text as command (in ssh/run modes)
.PP .PP
\fBDefault\fP: Control+Shift+Return \fBDefault\fP: Control+Shift+Return
.SS \fBkb\-accept\-alt\fP .SS \fBkb-accept-alt\fP
.PP .PP
Use alternate accept command. Use alternate accept command.
.PP .PP
\fBDefault\fP: Shift+Return \fBDefault\fP: Shift+Return
.SS \fBkb\-delete\-entry\fP .SS \fBkb-delete-entry\fP
.PP .PP
Delete entry from history Delete entry from history
.PP .PP
\fBDefault\fP: Shift+Delete \fBDefault\fP: Shift+Delete
.SS \fBkb\-mode\-next\fP .SS \fBkb-mode-next\fP
.PP .PP
Switch to the next mode. Switch to the next mode.
.PP .PP
\fBDefault\fP: Shift+Right,Control+Tab \fBDefault\fP: Shift+Right,Control+Tab
.SS \fBkb\-mode\-previous\fP .SS \fBkb-mode-previous\fP
.PP .PP
Switch to the previous mode. Switch to the previous mode.
.PP .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 .PP
Start completion for mode. Start completion for mode.
.PP .PP
\fBDefault\fP: Control+l \fBDefault\fP: Control+l
.SS \fBkb\-row\-left\fP .SS \fBkb-row-left\fP
.PP .PP
Go to the previous column Go to the previous column
.PP .PP
\fBDefault\fP: Control+Page\_Up \fBDefault\fP: Control+Page_Up
.SS \fBkb\-row\-right\fP .SS \fBkb-row-right\fP
.PP .PP
Go to the next column Go to the next column
.PP .PP
\fBDefault\fP: Control+Page\_Down \fBDefault\fP: Control+Page_Down
.SS \fBkb\-row\-up\fP .SS \fBkb-row-up\fP
.PP .PP
Select previous entry Select previous entry
.PP .PP
\fBDefault\fP: Up,Control+p \fBDefault\fP: Up,Control+p
.SS \fBkb\-row\-down\fP .SS \fBkb-row-down\fP
.PP .PP
Select next entry Select next entry
.PP .PP
\fBDefault\fP: Down,Control+n \fBDefault\fP: Down,Control+n
.SS \fBkb\-row\-tab\fP .SS \fBkb-row-tab\fP
.PP .PP
Go to next row, if one left, accept it, if no left next mode. Go to next row, if one left, accept it, if no left next mode.
.PP .PP
\fBDefault\fP: \fBDefault\fP:
.SS \fBkb\-element\-next\fP .SS \fBkb-element-next\fP
.PP .PP
Go to next row. Go to next row.
.PP .PP
\fBDefault\fP: Tab \fBDefault\fP: Tab
.SS \fBkb\-element\-prev\fP .SS \fBkb-element-prev\fP
.PP .PP
Go to previous row. Go to previous row.
.PP .PP
\fBDefault\fP: ISO\_Left\_Tab \fBDefault\fP: ISO_Left_Tab
.SS \fBkb\-page\-prev\fP .SS \fBkb-page-prev\fP
.PP .PP
Go to the previous page Go to the previous page
.PP .PP
\fBDefault\fP: Page\_Up \fBDefault\fP: Page_Up
.SS \fBkb\-page\-next\fP .SS \fBkb-page-next\fP
.PP .PP
Go to the next page Go to the next page
.PP .PP
\fBDefault\fP: Page\_Down \fBDefault\fP: Page_Down
.SS \fBkb\-row\-first\fP .SS \fBkb-row-first\fP
.PP .PP
Go to the first entry Go to the first entry
.PP .PP
\fBDefault\fP: Home,KP\_Home \fBDefault\fP: Home,KP_Home
.SS \fBkb\-row\-last\fP .SS \fBkb-row-last\fP
.PP .PP
Go to the last entry Go to the last entry
.PP .PP
\fBDefault\fP: End,KP\_End \fBDefault\fP: End,KP_End
.SS \fBkb\-row\-select\fP .SS \fBkb-row-select\fP
.PP .PP
Set selected item as input text Set selected item as input text
.PP .PP
\fBDefault\fP: Control+space \fBDefault\fP: Control+space
.SS \fBkb\-screenshot\fP .SS \fBkb-screenshot\fP
.PP .PP
Take a screenshot of the rofi window Take a screenshot of the rofi window
.PP .PP
\fBDefault\fP: Alt+S \fBDefault\fP: Alt+S
.SS \fBkb\-ellipsize\fP .SS \fBkb-ellipsize\fP
.PP .PP
Toggle between ellipsize modes for displayed data Toggle between ellipsize modes for displayed data
.PP .PP
\fBDefault\fP: Alt+period \fBDefault\fP: Alt+period
.SS \fBkb\-toggle\-case\-sensitivity\fP .SS \fBkb-toggle-case-sensitivity\fP
.PP .PP
Toggle case sensitivity Toggle case sensitivity
.PP .PP
\fBDefault\fP: grave,dead\_grave \fBDefault\fP: grave,dead_grave
.SS \fBkb\-toggle\-sort\fP .SS \fBkb-toggle-sort\fP
.PP .PP
Toggle sort Toggle sort
.PP .PP
\fBDefault\fP: Alt+grave \fBDefault\fP: Alt+grave
.SS \fBkb\-cancel\fP .SS \fBkb-cancel\fP
.PP .PP
Quit rofi Quit rofi
.PP .PP
\fBDefault\fP: Escape,Control+g,Control+bracketleft \fBDefault\fP: Escape,Control+g,Control+bracketleft
.SS \fBkb\-custom\-1\fP .SS \fBkb-custom-1\fP
.PP .PP
Custom keybinding 1 Custom keybinding 1
.PP .PP
\fBDefault\fP: Alt+1 \fBDefault\fP: Alt+1
.SS \fBkb\-custom\-2\fP .SS \fBkb-custom-2\fP
.PP .PP
Custom keybinding 2 Custom keybinding 2
.PP .PP
\fBDefault\fP: Alt+2 \fBDefault\fP: Alt+2
.SS \fBkb\-custom\-3\fP .SS \fBkb-custom-3\fP
.PP .PP
Custom keybinding 3 Custom keybinding 3
.PP .PP
\fBDefault\fP: Alt+3 \fBDefault\fP: Alt+3
.SS \fBkb\-custom\-4\fP .SS \fBkb-custom-4\fP
.PP .PP
Custom keybinding 4 Custom keybinding 4
.PP .PP
\fBDefault\fP: Alt+4 \fBDefault\fP: Alt+4
.SS \fBkb\-custom\-5\fP .SS \fBkb-custom-5\fP
.PP .PP
Custom Keybinding 5 Custom Keybinding 5
.PP .PP
\fBDefault\fP: Alt+5 \fBDefault\fP: Alt+5
.SS \fBkb\-custom\-6\fP .SS \fBkb-custom-6\fP
.PP .PP
Custom keybinding 6 Custom keybinding 6
.PP .PP
\fBDefault\fP: Alt+6 \fBDefault\fP: Alt+6
.SS \fBkb\-custom\-7\fP .SS \fBkb-custom-7\fP
.PP .PP
Custom Keybinding 7 Custom Keybinding 7
.PP .PP
\fBDefault\fP: Alt+7 \fBDefault\fP: Alt+7
.SS \fBkb\-custom\-8\fP .SS \fBkb-custom-8\fP
.PP .PP
Custom keybinding 8 Custom keybinding 8
.PP .PP
\fBDefault\fP: Alt+8 \fBDefault\fP: Alt+8
.SS \fBkb\-custom\-9\fP .SS \fBkb-custom-9\fP
.PP .PP
Custom keybinding 9 Custom keybinding 9
.PP .PP
\fBDefault\fP: Alt+9 \fBDefault\fP: Alt+9
.SS \fBkb\-custom\-10\fP .SS \fBkb-custom-10\fP
.PP .PP
Custom keybinding 10 Custom keybinding 10
.PP .PP
\fBDefault\fP: Alt+0 \fBDefault\fP: Alt+0
.SS \fBkb\-custom\-11\fP .SS \fBkb-custom-11\fP
.PP .PP
Custom keybinding 11 Custom keybinding 11
.PP .PP
\fBDefault\fP: Alt+exclam \fBDefault\fP: Alt+exclam
.SS \fBkb\-custom\-12\fP .SS \fBkb-custom-12\fP
.PP .PP
Custom keybinding 12 Custom keybinding 12
.PP .PP
\fBDefault\fP: Alt+at \fBDefault\fP: Alt+at
.SS \fBkb\-custom\-13\fP .SS \fBkb-custom-13\fP
.PP .PP
Custom keybinding 13 Custom keybinding 13
.PP .PP
\fBDefault\fP: Alt+numbersign \fBDefault\fP: Alt+numbersign
.SS \fBkb\-custom\-14\fP .SS \fBkb-custom-14\fP
.PP .PP
Custom keybinding 14 Custom keybinding 14
.PP .PP
\fBDefault\fP: Alt+dollar \fBDefault\fP: Alt+dollar
.SS \fBkb\-custom\-15\fP .SS \fBkb-custom-15\fP
.PP .PP
Custom keybinding 15 Custom keybinding 15
.PP .PP
\fBDefault\fP: Alt+percent \fBDefault\fP: Alt+percent
.SS \fBkb\-custom\-16\fP .SS \fBkb-custom-16\fP
.PP .PP
Custom keybinding 16 Custom keybinding 16
.PP .PP
\fBDefault\fP: Alt+dead\_circumflex \fBDefault\fP: Alt+dead_circumflex
.SS \fBkb\-custom\-17\fP .SS \fBkb-custom-17\fP
.PP .PP
Custom keybinding 17 Custom keybinding 17
.PP .PP
\fBDefault\fP: Alt+ampersand \fBDefault\fP: Alt+ampersand
.SS \fBkb\-custom\-18\fP .SS \fBkb-custom-18\fP
.PP .PP
Custom keybinding 18 Custom keybinding 18
.PP .PP
\fBDefault\fP: Alt+asterisk \fBDefault\fP: Alt+asterisk
.SS \fBkb\-custom\-19\fP .SS \fBkb-custom-19\fP
.PP .PP
Custom Keybinding 19 Custom Keybinding 19
.PP .PP
\fBDefault\fP: Alt+parenleft \fBDefault\fP: Alt+parenleft
.SS \fBkb\-select\-1\fP .SS \fBkb-select-1\fP
.PP .PP
Select row 1 Select row 1
.PP .PP
\fBDefault\fP: Super+1 \fBDefault\fP: Super+1
.SS \fBkb\-select\-2\fP .SS \fBkb-select-2\fP
.PP .PP
Select row 2 Select row 2
.PP .PP
\fBDefault\fP: Super+2 \fBDefault\fP: Super+2
.SS \fBkb\-select\-3\fP .SS \fBkb-select-3\fP
.PP .PP
Select row 3 Select row 3
.PP .PP
\fBDefault\fP: Super+3 \fBDefault\fP: Super+3
.SS \fBkb\-select\-4\fP .SS \fBkb-select-4\fP
.PP .PP
Select row 4 Select row 4
.PP .PP
\fBDefault\fP: Super+4 \fBDefault\fP: Super+4
.SS \fBkb\-select\-5\fP .SS \fBkb-select-5\fP
.PP .PP
Select row 5 Select row 5
.PP .PP
\fBDefault\fP: Super+5 \fBDefault\fP: Super+5
.SS \fBkb\-select\-6\fP .SS \fBkb-select-6\fP
.PP .PP
Select row 6 Select row 6
.PP .PP
\fBDefault\fP: Super+6 \fBDefault\fP: Super+6
.SS \fBkb\-select\-7\fP .SS \fBkb-select-7\fP
.PP .PP
Select row 7 Select row 7
.PP .PP
\fBDefault\fP: Super+7 \fBDefault\fP: Super+7
.SS \fBkb\-select\-8\fP .SS \fBkb-select-8\fP
.PP .PP
Select row 8 Select row 8
.PP .PP
\fBDefault\fP: Super+8 \fBDefault\fP: Super+8
.SS \fBkb\-select\-9\fP .SS \fBkb-select-9\fP
.PP .PP
Select row 9 Select row 9
.PP .PP
\fBDefault\fP: Super+9 \fBDefault\fP: Super+9
.SS \fBkb\-select\-10\fP .SS \fBkb-select-10\fP
.PP .PP
Select row 10 Select row 10
@ -565,49 +566,49 @@ Select row 10
\fBDefault\fP: Super+0 \fBDefault\fP: Super+0
.SH Mouse Bindings .SH Mouse Bindings
.SS \fBml\-row\-left\fP .SS \fBml-row-left\fP
.PP .PP
Go to the previous column Go to the previous column
.PP .PP
\fBDefault\fP: ScrollLeft \fBDefault\fP: ScrollLeft
.SS \fBml\-row\-right\fP .SS \fBml-row-right\fP
.PP .PP
Go to the next column Go to the next column
.PP .PP
\fBDefault\fP: ScrollRight \fBDefault\fP: ScrollRight
.SS \fBml\-row\-up\fP .SS \fBml-row-up\fP
.PP .PP
Select previous entry Select previous entry
.PP .PP
\fBDefault\fP: ScrollUp \fBDefault\fP: ScrollUp
.SS \fBml\-row\-down\fP .SS \fBml-row-down\fP
.PP .PP
Select next entry Select next entry
.PP .PP
\fBDefault\fP: ScrollDown \fBDefault\fP: ScrollDown
.SS \fBme\-select\-entry\fP .SS \fBme-select-entry\fP
.PP .PP
Select hovered row Select hovered row
.PP .PP
\fBDefault\fP: MousePrimary \fBDefault\fP: MousePrimary
.SS \fBme\-accept\-entry\fP .SS \fBme-accept-entry\fP
.PP .PP
Accept hovered row Accept hovered row
.PP .PP
\fBDefault\fP: MouseDPrimary \fBDefault\fP: MouseDPrimary
.SS \fBme\-accept\-custom\fP .SS \fBme-accept-custom\fP
.PP .PP
Accept hovered row with custom action Accept hovered row with custom action
@ -616,24 +617,24 @@ Accept hovered row with custom action
.SH SEE ALSO .SH SEE ALSO
.PP .PP
rofi(1), rofi\-sensible\-terminal(1), rofi\-theme(5), rofi\-script(5) rofi(1), rofi-sensible-terminal(1), rofi-theme(5), rofi-script(5)
.SH AUTHOR .SH AUTHOR
.PP .PP
Qball Cow Qball Cow qball@gmpclient.org
\[la]qball@gmpclient.org\[ra] \[la]mailto:qball@gmpclient.org\[ra]
.PP .PP
Rasmus Steinke Rasmus Steinke rasi@xssn.at
\[la]rasi@xssn.at\[ra] \[la]mailto:rasi@xssn.at\[ra]
.PP .PP
Morgane Glidic Morgane Glidic sardemff7+rofi@sardemff7.net
\[la]sardemff7+rofi@sardemff7.net\[ra] \[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.PP .PP
Original code based on work by: Sean Pringle Original code based on work by: Sean Pringle sean.pringle@gmail.com
\[la]sean.pringle@gmail.com\[ra] \[la]mailto:sean.pringle@gmail.com\[ra]
.PP .PP
For a full list of authors, check the AUTHORS file. For a full list of authors, check the AUTHORS file.

51
doc/rofi-script.5
View file

@ -1,7 +1,8 @@
.TH ROFI\-SCRIPT 5 rofi\-script .nh
.TH ROFI-SCRIPT 5 rofi-script
.SH NAME .SH NAME
.PP .PP
\fBrofi script mode\fP \- Rofi format for scriptable mode. \fBrofi script mode\fP - Rofi format for scriptable mode.
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
@ -19,7 +20,7 @@ For example:
.RS .RS
.nf .nf
rofi \-show fb \-modes "fb:file\_browser.sh" rofi -show fb -modes "fb:file_browser.sh"
.fi .fi
.RE .RE
@ -61,7 +62,7 @@ This shows two entries, reload and quit. When the quit entry is selected, rofi c
.PP .PP
Rofi sets the following environment variable when executing the script: Rofi sets the following environment variable when executing the script:
.SS \fB\fCROFI\_RETV\fR .SS \fB\fCROFI_RETV\fR
.PP .PP
An integer number with the current state: An integer number with the current state:
@ -73,15 +74,15 @@ An integer number with the current state:
.IP \(bu 2 .IP \(bu 2
\fB2\fP: Selected a custom entry. \fB2\fP: Selected a custom entry.
.IP \(bu 2 .IP \(bu 2
\fB10\-28\fP: Custom keybinding 1\-19 ( need to be explicitly enabled by script ). \fB10-28\fP: Custom keybinding 1-19 ( need to be explicitly enabled by script ).
.RE .RE
.SS \fB\fCROFI\_INFO\fR .SS \fB\fCROFI_INFO\fR
.PP .PP
Environment get set when selected entry get set with the property value of the 'info' row option, if set. Environment get set when selected entry get set with the property value of the 'info' row option, if set.
.SS \fB\fCROFI\_DATA\fR .SS \fB\fCROFI_DATA\fR
.PP .PP
Environment get set when script sets \fB\fCdata\fR option in header. Environment get set when script sets \fB\fCdata\fR option in header.
@ -97,7 +98,7 @@ For example to set the prompt:
.RS .RS
.nf .nf
echo \-en "\\0prompt\\x1fChange prompt\\n" echo -en "\\0prompt\\x1fChange prompt\\n"
.fi .fi
.RE .RE
@ -111,7 +112,7 @@ The following extra options exists:
.IP \(bu 2 .IP \(bu 2
\fBmessage\fP: Update the message text. \fBmessage\fP: Update the message text.
.IP \(bu 2 .IP \(bu 2
\fBmarkup\-rows\fP: If 'true' renders markup in the row. \fBmarkup-rows\fP: If 'true' renders markup in the row.
.IP \(bu 2 .IP \(bu 2
\fBurgent\fP: Mark rows as urgent. (for syntax see the urgent option in dmenu mode) \fBurgent\fP: Mark rows as urgent. (for syntax see the urgent option in dmenu mode)
.IP \(bu 2 .IP \(bu 2
@ -119,11 +120,11 @@ The following extra options exists:
.IP \(bu 2 .IP \(bu 2
\fBdelim\fP: Set the delimiter for for next rows. Default is '\\n' and this option should finish with this. Only call this on first call of script, it is remembered for consecutive calls. \fBdelim\fP: Set the delimiter for for next rows. Default is '\\n' and this option should finish with this. Only call this on first call of script, it is remembered for consecutive calls.
.IP \(bu 2 .IP \(bu 2
\fBno\-custom\fP: If set to 'true'; only accept listed entries, ignore custom input. \fBno-custom\fP: If set to 'true'; only accept listed entries, ignore custom input.
.IP \(bu 2 .IP \(bu 2
\fBuse\-hot\-keys\fP: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow. \fBuse-hot-keys\fP: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow.
.IP \(bu 2 .IP \(bu 2
\fBdata\fP: Passed data to the next execution of the script via \fBROFI\_DATA\fP\&. \fBdata\fP: Passed data to the next execution of the script via \fBROFI_DATA\fP\&.
.RE .RE
@ -139,7 +140,7 @@ For example:
.RS .RS
.nf .nf
echo \-en "aap\\0icon\\x1ffolder\\n" echo -en "aap\\0icon\\x1ffolder\\n"
.fi .fi
.RE .RE
@ -155,7 +156,7 @@ The following options are supported:
.IP \(bu 2 .IP \(bu 2
\fBnonselectable\fP: If true the row cannot activated. \fBnonselectable\fP: If true the row cannot activated.
.IP \(bu 2 .IP \(bu 2
\fBinfo\fP: Info that, on selection, gets placed in the \fB\fCROFI\_INFO\fR environment variable. This entry does not get searched. \fBinfo\fP: Info that, on selection, gets placed in the \fB\fCROFI_INFO\fR environment variable. This entry does not get searched.
.RE .RE
@ -166,7 +167,7 @@ multiple entries can be passed using the \fB\fC\\x1f\fR separator.
.RS .RS
.nf .nf
echo \-en "aap\\0icon\\x1ffolder\\x1finfo\\x1ftest\\n" echo -en "aap\\0icon\\x1ffolder\\x1finfo\\x1ftest\\n"
.fi .fi
.RE .RE
@ -183,7 +184,7 @@ In bash the best way to do this is using \fB\fCcoproc\fR\&.
.RS .RS
.nf .nf
coproc ( myApp > /dev/null 2>\&1 ) coproc ( myApp > /dev/null 2>&1 )
.fi .fi
.RE .RE
@ -195,24 +196,24 @@ See issue #1201 on github.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-selector(1) rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-theme-selector(1)
.SH AUTHOR .SH AUTHOR
.PP .PP
Qball Cow Qball Cow qball@gmpclient.org
\[la]qball@gmpclient.org\[ra] \[la]mailto:qball@gmpclient.org\[ra]
.PP .PP
Rasmus Steinke Rasmus Steinke rasi@xssn.at
\[la]rasi@xssn.at\[ra] \[la]mailto:rasi@xssn.at\[ra]
.PP .PP
Morgane Glidic Morgane Glidic sardemff7+rofi@sardemff7.net
\[la]sardemff7+rofi@sardemff7.net\[ra] \[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.PP .PP
Original code based on work by: Sean Pringle Original code based on work by: Sean Pringle sean.pringle@gmail.com
\[la]sean.pringle@gmail.com\[ra] \[la]mailto:sean.pringle@gmail.com\[ra]
.PP .PP
For a full list of authors, check the AUTHORS file. For a full list of authors, check the AUTHORS file.

21
doc/rofi-sensible-terminal.1
View file

@ -1,17 +1,18 @@
.TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal .nh
.TH rofi-sensible-terminal 1 rofi-sensible-terminal
.SH NAME .SH NAME
.PP .PP
\fBrofi\-sensible\-terminal\fP \- launches $TERMINAL with fallbacks \fBrofi-sensible-terminal\fP - launches $TERMINAL with fallbacks
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
rofi\-sensible\-terminal [arguments] rofi-sensible-terminal [arguments]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
rofi\-sensible\-terminal is invoked in the rofi default config to start a terminal. This rofi-sensible-terminal is invoked in the rofi default config to start a terminal. This
wrapper script is necessary since there is no distribution\-independent terminal launcher wrapper script is necessary since there is no distribution-independent terminal launcher
(but for example Debian has x\-terminal\-emulator). Distribution packagers are responsible for (but for example Debian has x-terminal-emulator). Distribution packagers are responsible for
shipping this script in a way which is appropriate for the distribution. shipping this script in a way which is appropriate for the distribution.
.PP .PP
@ -19,9 +20,9 @@ It tries to start one of the following (in that order):
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fC$TERMINAL\fR (this is a non\-standard variable) \fB\fC$TERMINAL\fR (this is a non-standard variable)
.IP \(bu 2 .IP \(bu 2
x\-terminal\-emulator x-terminal-emulator
.IP \(bu 2 .IP \(bu 2
urxvt urxvt
.IP \(bu 2 .IP \(bu 2
@ -43,9 +44,9 @@ xterm
.IP \(bu 2 .IP \(bu 2
roxterm roxterm
.IP \(bu 2 .IP \(bu 2
xfce4\-terminal.wrapper xfce4-terminal.wrapper
.IP \(bu 2 .IP \(bu 2
mate\-terminal mate-terminal
.IP \(bu 2 .IP \(bu 2
lxterminal lxterminal
.IP \(bu 2 .IP \(bu 2

25
doc/rofi-theme-selector.1
View file

@ -1,38 +1,39 @@
.TH rofi\-theme\-selector 1 rofi\-theme\-selector .nh
.TH rofi-theme-selector 1 rofi-theme-selector
.SH NAME .SH NAME
.PP .PP
\fBrofi\-theme\-selector\fP \- Preview and apply themes for \fBrofi\fP \fBrofi-theme-selector\fP - Preview and apply themes for \fBrofi\fP
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\fBrofi\-theme\-selector\fP is a bash/rofi script to preview and apply themes for \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\&. It's part of any installation of \fBrofi\fP\&.
.SH USAGE .SH USAGE
.SS Running rofi\-theme\-selector .SS Running rofi-theme-selector
.PP .PP
\fBrofi\-theme\-selector\fP shows a list of all available themes in a \fBrofi\fP window. \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 It lets you preview each theme with the Enter key and apply the theme to your
\fBrofi\fP configuration file with Alt+a. \fBrofi\fP configuration file with Alt+a.
.SH Theme directories .SH Theme directories
.PP .PP
\fBrofi\-theme\-selector\fP searches the following directories for themes: \fBrofi-theme-selector\fP searches the following directories for themes:
.RS .RS
.IP \(bu 2 .IP \(bu 2
${PREFIX}/share/rofi/themes ${PREFIX}/share/rofi/themes
.IP \(bu 2 .IP \(bu 2
$XDG\_CONFIG\_HOME/rofi/themes $XDG_CONFIG_HOME/rofi/themes
.IP \(bu 2 .IP \(bu 2
$XDG\_DATA\_HOME/share/rofi/themes $XDG_DATA_HOME/share/rofi/themes
.RE .RE
.PP .PP
${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".
$XDG\_CONFIG\_HOME is normally unset. Default path is "$HOME/.config".<br> $XDG_CONFIG_HOME is normally unset. Default path is "$HOME/.config".
$XDG\_DATA\_HOME is normally unset. Default path is "$HOME/.local/share". $XDG_DATA_HOME is normally unset. Default path is "$HOME/.local/share".
.SH SEE ALSO .SH SEE ALSO
.PP .PP
@ -40,5 +41,5 @@ rofi(1)
.SH AUTHORS .SH AUTHORS
.PP .PP
Qball Cow qball@gmpclient.org<br> Qball Cow qball@gmpclient.org
Rasmus Steinke rasi@xssn.at Rasmus Steinke rasi@xssn.at

447
doc/rofi-theme.5
View file

File diff suppressed because it is too large Load diff

36
doc/rofi-theme.5.markdown
View file

@ -47,7 +47,7 @@ preferred.
C and C++ file comments are supported. C and C++ file comments are supported.
* Anything after `// ` and before a newline is considered a comment. * Anything after `// ` and before a newline is considered a comment.
* Everything between `/*` and `*/` is a comment. * Everything between `/*` and `*/` is a comment, this comment can span multiple lines.
Comments can be nested and the C comments can be inline. Comments can be nested and the C comments can be inline.
@ -91,7 +91,7 @@ abbreviation for **r**ofi **a**dvanced **s**tyle **i**nformation.
## Basic Structure ## Basic Structure
Each element has a section with defined properties. Global properties can be defined in section `* { }`. Each element has a section with defined properties. Global properties can be defined in section `* { }`.
Sub-section names begin with a hash symbol `#`. Sub-section names begin with an optional hash symbol `#`.
It is advised to define the *global properties section* on top of the file to It is advised to define the *global properties section* on top of the file to
make inheritance of properties clearer. make inheritance of properties clearer.
@ -131,8 +131,8 @@ A theme can have multiple element theme sections.
The element path can consist of multiple names separated by whitespace or dots. The element path can consist of multiple names separated by whitespace or dots.
Each element may contain any number of letters, numbers and `-`'s. Each element may contain any number of letters, numbers and `-`'s.
The first element in the element path should always start with a `#`. The first element in the element path can optionally start with a `#` (for
Multiple elements can be specified by a `,`. historic reasons). Multiple elements can be specified by a `,`.
This is a valid element name: This is a valid element name:
@ -153,8 +153,8 @@ element normal normal, button {
} }
``` ```
Each section inherits the global properties. Properties can be explicitly inherited from their parent with the Each section inherits the global properties. Properties can be explicitly
`inherit` keyword. inherited from their parent with the `inherit` keyword.
In the following example: In the following example:
```css ```css
@ -170,7 +170,8 @@ mainbox {
} }
``` ```
The element `mainbox` will have the following set of properties (if `mainbox` is a child of `window`): The element `mainbox` will have the following set of properties (if `mainbox`
is a child of `window`):
```css ```css
a: 1; a: 1;
@ -234,7 +235,15 @@ For example:
font: "Awasome 12"; font: "Awasome 12";
``` ```
The string must be valid UTF-8. The string must be valid UTF-8, special characters can be escaped:
```css
text {
content: "Line one\n\tIndented line two";
}
```
The following special characters can be escaped: `\b`, `\f`, `\n`, `\r`, `\t`, `\v`, `\` and `"`.
## Integer ## Integer
@ -407,9 +416,9 @@ It supports the following operations:
* `-` : Subtract * `-` : Subtract
* `/` : Divide * `/` : Divide
* `*` : Multiply * `*` : Multiply
* `%` : Multiply * `%` : Modulo
* `min` : Minimum of l or rvalue; * `min` : Minimum of lvalue or rvalue;
* `max` : Maximum of l or rvalue; * `max` : Maximum of lvalue or rvalue;
* `floor` : Round down lvalue to the next multiple of rvalue * `floor` : Round down lvalue to the next multiple of rvalue
* `ceil` : Round up lvalue to the next multiple of rvalue * `ceil` : Round up lvalue to the next multiple of rvalue
* `round` : Round lvalue to the next multiple of rvalue * `round` : Round lvalue to the next multiple of rvalue
@ -471,9 +480,12 @@ south west | south | south east
It is possible to hide widgets: It is possible to hide widgets:
```css
inputbar { inputbar {
enabled: false; enabled: false;
} }
```
## Reference ## Reference
@ -755,7 +767,7 @@ The following properties are currently supported:
* **background-color**: color * **background-color**: color
* **border-color**: the color used for the border around the widget. * **border-color**: the color used for the border around the widget.
* **font**: the font used by this textbox (string). * **font**: the font used by this textbox (string).
* **str**: the string to display by this textbox (string). * **str**/**content**: the string to display by this textbox (string).
* **vertical-align**: Vertical alignment of the text. A number between 0 (top) and 1 (bottom). * **vertical-align**: Vertical alignment of the text. A number between 0 (top) and 1 (bottom).
* **horizontal-align**: Horizontal alignment of the text. A number between 0 (left) and 1 (right). * **horizontal-align**: Horizontal alignment of the text. A number between 0 (left) and 1 (right).
* **text-color**: the text color to use. * **text-color**: the text color to use.

441
doc/rofi.1
View file

File diff suppressed because it is too large Load diff