From 555f9be1f7e52cf736455d06cdc1f475c889c709 Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Tue, 14 Dec 2021 20:42:21 +0100 Subject: [PATCH] [Doc] Update manpage with clarification. --- doc/rofi-script.5 | 17 +++++---- doc/rofi-sensible-terminal.1 | 1 - doc/rofi-theme-selector.1 | 7 ++-- doc/rofi-theme.5 | 68 +++++++++++++++++++++++++----------- doc/rofi.1 | 51 +++++++++++++++++---------- doc/rofi.1.markdown | 5 +-- 6 files changed, 94 insertions(+), 55 deletions(-) diff --git a/doc/rofi-script.5 b/doc/rofi-script.5 index f414c1a2..cc409edd 100644 --- a/doc/rofi-script.5 +++ b/doc/rofi-script.5 @@ -1,4 +1,3 @@ -.nh .TH ROFI\-SCRIPT 5 rofi\-script .SH NAME .PP @@ -194,20 +193,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-sel .SH AUTHOR .PP -Qball Cow qball@gmpclient.org -\[la]mailto:qball@gmpclient.org\[ra] +Qball Cow +\[la]qball@gmpclient.org\[ra] .PP -Rasmus Steinke rasi@xssn.at -\[la]mailto:rasi@xssn.at\[ra] +Rasmus Steinke +\[la]rasi@xssn.at\[ra] .PP -Quentin Glidic sardemff7+rofi@sardemff7.net -\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic +\[la]sardemff7+rofi@sardemff7.net\[ra] .PP -Original code based on work by: Sean Pringle sean.pringle@gmail.com -\[la]mailto:sean.pringle@gmail.com\[ra] +Original code based on work by: Sean Pringle +\[la]sean.pringle@gmail.com\[ra] .PP For a full list of authors, check the AUTHORS file. diff --git a/doc/rofi-sensible-terminal.1 b/doc/rofi-sensible-terminal.1 index 653dee3f..30d4a15d 100644 --- a/doc/rofi-sensible-terminal.1 +++ b/doc/rofi-sensible-terminal.1 @@ -1,4 +1,3 @@ -.nh .TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal .SH NAME .PP diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1 index e0f09c31..de076ff4 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -1,4 +1,3 @@ -.nh .TH rofi\-theme\-selector 1 rofi\-theme\-selector .SH NAME .PP @@ -31,8 +30,8 @@ $XDG\_DATA\_HOME/share/rofi/themes .RE .PP -${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". +${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". .SH SEE ALSO @@ -41,5 +40,5 @@ rofi(1) .SH AUTHORS .PP -Qball Cow qball@gmpclient.org +Qball Cow qball@gmpclient.org
Rasmus Steinke rasi@xssn.at diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index d08d55db..47564b18 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1,4 +1,3 @@ -.nh .TH ROFI\-THEME 5 rofi\-theme .SH NAME .PP @@ -134,7 +133,7 @@ abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation. .SH Basic Structure .PP Each element has a section with defined properties. Global properties can be defined in section \fB\fC* { }\fR\&. -Sub\-\§ion names begin with a hash symbol \fB\fC#\fR\&. +Sub\-section names begin with a hash symbol \fB\fC#\fR\&. .PP It is advised to define the \fIglobal properties section\fP on top of the file to @@ -491,7 +490,11 @@ The different values are: .IP \(bu 2 \fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100% .IP \(bu 2 -\fB\fC{named\-color}\fR is one of the following colors:AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, + +.PP +\fB\fC{named\-color}\fR is one of the following colors: +.PP +AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan, DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed, DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue, @@ -723,7 +726,6 @@ style property. .PP When no unit is specified, pixels are assumed. - .RE .SH Position @@ -732,14 +734,22 @@ Indicate a place on the window/monitor. .RS .IP \(bu 2 + +.PP Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR -\fB\fC +.PP +.RS + +.nf + north west | north | north east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- west | center | east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- south west | south | south east -\fR + +.fi +.RE .RE @@ -964,6 +974,7 @@ The current widgets available in \fBrofi\fP: .RS .IP \(bu 2 \fB\fCwindow\fR + .RS .IP \(bu 2 \fB\fCoverlay\fR: the overlay widget. @@ -971,6 +982,7 @@ The current widgets available in \fBrofi\fP: \fB\fCmainbox\fR: The mainbox box. .IP \(bu 2 \fB\fCinputbar\fR: The input bar box. + .RS .IP \(bu 2 \fB\fCbox\fR: the horizontal @box packing the widgets @@ -986,14 +998,15 @@ The current widgets available in \fBrofi\fP: \fB\fCnum\-filtered\-rows\fR: Shows the total number of rows after filtering. .RE - .IP \(bu 2 \fB\fClistview\fR: The listview. + .RS .IP \(bu 2 \fB\fCscrollbar\fR: the listview scrollbar .IP \(bu 2 \fB\fCelement\fR: a box in the listview holding the entries + .RS .IP \(bu 2 \fB\fCelement\-icon\fR: the widget in the listview's entry showing the (optional) icon @@ -1004,29 +1017,26 @@ The current widgets available in \fBrofi\fP: .RE - .RE - .IP \(bu 2 \fB\fCmode\-switcher\fR: the main horizontal @box packing the buttons. + .RS .IP \(bu 2 \fB\fCbutton\fR: the buttons @textbox for each mode .RE - .IP \(bu 2 \fB\fCmessage\fR: The container holding the textbox. + .RS .IP \(bu 2 \fB\fCtextbox\fR: the message textbox .RE - .RE - .RE .PP @@ -1134,9 +1144,13 @@ Type of mouse cursor that is set when the mouse pointer is hovered over the widg .SS window: .RS .IP \(bu 2 + +.PP \fBfont\fP: string The font used in the window .IP \(bu 2 + +.PP \fBtransparency\fP: string Indicating if transparency should be used and what type: \fBreal\fP \- True transparency. Only works with a compositor. @@ -1144,20 +1158,32 @@ Indicating if transparency should be used and what type: \fBscreenshot\fP \- Take a screenshot of the screen and use that. \fBPath\fP to png file \- Use an image. .IP \(bu 2 + +.PP \fBlocation\fP: position The place of the anchor on the monitor .IP \(bu 2 + +.PP \fBanchor\fP: anchor The anchor position on the window .IP \(bu 2 + +.PP \fBfullscreen\fP: boolean Window is fullscreen. .IP \(bu 2 + +.PP \fBwidth\fP: distance The width of the window .IP \(bu 2 + +.PP \fBx\-offset\fP: distance .IP \(bu 2 + +.PP \fBy\-offset\fP: distance The offset of the window to the anchor point, allowing you to push the window left/right/up/down @@ -1655,15 +1681,15 @@ More dynamic spacing can be achieved by adding dummy widgets, for example to mak .RS .nf -|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| -| |\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-| | -| | dummy | | child | | dummy | | -| | expand: y | | | | expand: y | | -| | | | | | | | -| | | | | | | | -| | | | | | | | -| |\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-| | -|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| +|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| +| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | +| | dummy | | child | | dummy | | +| | expand: true; | | | | expand: true; | | +| | | | | | | | +| | | | | | | | +| | | | | | | | +| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | +|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| .fi .RE diff --git a/doc/rofi.1 b/doc/rofi.1 index 05d6a2ba..d33123b6 100644 --- a/doc/rofi.1 +++ b/doc/rofi.1 @@ -1,4 +1,3 @@ -.nh .TH ROFI 1 rofi .SH NAME .PP @@ -19,9 +18,9 @@ filter, tokenized search and more. \fBrofi\fP\&'s main functionality is to assist in your workflow, allowing you to quickly switch between windows, start applications or log into a remote machine via \fB\fCssh\fR\&. There are different \fImodi\fP for different types of actions. - -.PP -\fBrofi\fP can also function as (drop\-in) replacement for \fBdmenu(1)\fP\&. +\fBrofi\fP is a standalone application and should not be integrated into scripts. +For integration into scripts it has a special mode that functions as a +(drop\-in) replacement for \fBdmenu(1)\fP\&. See emulating dmenu below. .SS Running rofi .PP @@ -47,7 +46,7 @@ The website for \fB\fCdmenu\fR can be found here .PP \fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many flavors of \fB\fCdmenu\fR\&. -The idea is that the basic usage command\-\&line flags are obeyed, theme\-\&related flags are not. +The idea is that the basic usage command\-line flags are obeyed, theme\-related flags are not. Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings). .SS Display Error message @@ -181,7 +180,11 @@ Specify the number of threads \fBrofi\fP should use: .IP \(bu 2 1: Disable threading .IP \(bu 2 -2..n: Specify the maximum number of threads to use in the thread pool.Default: Autodetect + +.PP +2..n: Specify the maximum number of threads to use in the thread pool. +.PP +Default: Autodetect .RE @@ -461,7 +464,11 @@ The different fields are: .IP \(bu 2 \fBcomment\fP: the application comment .IP \(bu 2 -\fBall\fP: all the aboveDefault: \fIname,generic,exec,categories,keywords\fP + +.PP +\fBall\fP: all the above +.PP +Default: \fIname,generic,exec,categories,keywords\fP .RE @@ -534,7 +541,11 @@ The different fields are: .IP \(bu 2 \fBdesktop\fP: window's current desktop .IP \(bu 2 -\fBall\fP: all the aboveDefault: \fIall\fP + +.PP +\fBall\fP: all the above +.PP +Default: \fIall\fP .RE @@ -667,7 +678,11 @@ behavior.) .IP \(bu 2 \fB\-4\fP: the monitor with the focused window. .IP \(bu 2 -\fB\-5\fP: the monitor that shows the mouse pointer.Default: \fI\-5\fP + +.PP +\fB\-5\fP: the monitor that shows the mouse pointer. +.PP +Default: \fI\-5\fP .RE @@ -1165,7 +1180,7 @@ Set ellipsize mode to start. So, the end of the string is visible. .PP Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&. -Message can be multi\-\&line. +Message can be multi\-line. .SS File browser settings .PP @@ -1784,21 +1799,21 @@ first. .SH AUTHOR .RS .IP \(bu 2 -Qball Cow qball@blame.services -\[la]mailto:qball@blame.services\[ra] +Qball Cow +\[la]qball@blame.services\[ra] .IP \(bu 2 -Rasmus Steinke rasi@xssn.at -\[la]mailto:rasi@xssn.at\[ra] +Rasmus Steinke +\[la]rasi@xssn.at\[ra] .IP \(bu 2 -Quentin Glidic sardemff7+rofi@sardemff7.net -\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic +\[la]sardemff7+rofi@sardemff7.net\[ra] .RE .PP Original code based on work by: Sean Pringle -\[la]https://github.com/seanpringle/simpleswitcher\[ra] sean.pringle@gmail.com -\[la]mailto:sean.pringle@gmail.com\[ra] +\[la]https://github.com/seanpringle/simpleswitcher\[ra] +\[la]sean.pringle@gmail.com\[ra] .PP For a full list of authors, check the \fB\fCAUTHORS\fR file. diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index 48e5ff5f..8addda06 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -21,8 +21,9 @@ filter, tokenized search and more. **rofi**'s main functionality is to assist in your workflow, allowing you to quickly switch between windows, start applications or log into a remote machine via `ssh`. There are different *modi* for different types of actions. - -**rofi** can also function as (drop-in) replacement for **dmenu(1)**. +**rofi** is a standalone application and should not be integrated into scripts. +For integration into scripts it has a special mode that functions as a +(drop-in) replacement for **dmenu(1)**. See emulating dmenu below. ### Running rofi