Update manpage.

This commit is contained in:
QC 2014-10-20 20:29:26 +02:00
parent 783511a9f3
commit 6444a487b7
2 changed files with 139 additions and 105 deletions

View File

@ -86,6 +86,41 @@ The default key combinations are:
Run rofi in ssh mode once then exit. Does not bind any keys. Run rofi in ssh mode once then exit. Does not bind any keys.
`-dmenu`
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts.
Pressing `shift-enter` will open the selected entries and move to the next entry.
`-show` *mode*
Open rofi in a certain mode.
For example to show the run-dialog:
rofi -show run
This function deprecates -rnow,-snow and -now
`-switchers` *mode1,mode1*
Give a comma separated list of modes to enable, in what order.
For example to only show the run and ssh dialog (in that order):
rofi -switchers "run,ssh" -show run
Custom modes can be added using the internal 'script' mode. Each mode has two parameters:
<name>:<script>
So to have a mode 'Workspaces' using the `i3_switch_workspace.sh` script type:
rofi -switchers "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
### Theming
`-bg` `-bg`
Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222). Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222).
@ -143,6 +178,8 @@ The default key combinations are:
rofi -opacity "75" rofi -opacity "75"
### Layout
`-lines` `-lines`
Maximum number of lines the menu may show before scrolling (default: 25). Maximum number of lines the menu may show before scrolling (default: 25).
@ -163,20 +200,13 @@ The default key combinations are:
If value is larger then 100, the size is set in pixels. e.g. to span a full hd monitor: If value is larger then 100, the size is set in pixels. e.g. to span a full hd monitor:
rofi -width 1980 rofi -width 1980
If the value is negative, it tries to estimates a character width. To show 30 characters on a row: If the value is negative, it tries to estimates a character width. To show 30 characters on a row:
rofi -width -30 rofi -width -30
(Character width is a rough estimation, and might not be correct, but should work for most Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts.
monospaced fonts..)
`-terminal`
Specify what terminal to start (default x-terminal-emulator)
rofi -terminal xterm
`-location` `-location`
@ -204,16 +234,21 @@ The default key combinations are:
rofi -hmode -padding 0 rofi -hmode -padding 0
`-dmenu` ### Pattern setting
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts. `-terminal`
Pressing `shift-enter` will open the selected entries and move to the next entry. Specify what terminal to start (default x-terminal-emulator)
rofi -terminal xterm
`-ssh-client` *client*
Override the used ssh client. Default is `ssh`.
`-dump-xresources`
Dump the current active configuration in xresources format to the command-line. ### SSH settings
`-ssh-set-title` *true|false* `-ssh-set-title` *true|false*
@ -227,6 +262,8 @@ The default key combinations are:
Set the command to execute when starting a ssh session. Set the command to execute when starting a ssh session.
### Run settings
`-run-command` *cmd* `-run-command` *cmd*
Set the command to execute when running an application. Set the command to execute when running an application.
@ -237,9 +274,7 @@ The default key combinations are:
Set the command to execute when running an application in a shell. Set the command to execute when running an application in a shell.
See *PATTERN*. See *PATTERN*.
`-ssh-client` *client* ### History and Sorting
Override the used ssh client. Default is `ssh`.
`-disable-history` `-disable-history`
@ -251,32 +286,6 @@ The default key combinations are:
Note that levenshtein sort is disabled in dmenu mode. Note that levenshtein sort is disabled in dmenu mode.
`-show` *mode*
Open rofi in a certain mode.
For example to show the run-dialog:
rofi -show run
This function deprecates -rnow,-snow and -now
`-switchers` *mode1,mode1*
Give a comma separated list of modes to enable, in what order.
For example to only show the run and ssh dialog (in that order):
rofi -switchers "run,ssh" -show run
Custom modes can be added using the internal 'script' mode. Each mode has two parameters:
<name>:<script>
So to have a mode 'Workspaces' using the `i3_switch_workspace.sh` script type:
rofi -switchers "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
### Dmenu specific ### Dmenu specific
`-sep` *separator* `-sep` *separator*
@ -298,6 +307,12 @@ The default key combinations are:
Popup a message dialog (used internally for showing errors) with *message*. Popup a message dialog (used internally for showing errors) with *message*.
Message can be multi-line. Message can be multi-line.
### Dumping
`-dump-xresources`
Dump the current active configuration in xresources format to the command-line.
## Pattern ## Pattern
To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline, To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline,

View File

@ -92,6 +92,55 @@ Run rofi in run\-dialog mode once then exit. Does not bind any keys.
.IP .IP
Run rofi in ssh mode once then exit. Does not bind any keys. Run rofi in ssh mode once then exit. Does not bind any keys.
.PP .PP
\fB\fC\-dmenu\fR
.IP
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts.
.IP
Pressing \fB\fCshift\-enter\fR will open the selected entries and move to the next entry.
.PP
\fB\fC\-show\fR \fImode\fP
.IP
Open rofi in a certain mode.
.IP
For example to show the run\-dialog:
.PP
.RS
.nf
rofi \-show run
.fi
.RE
.IP
This function deprecates \-rnow,\-snow and \-now
.PP
\fB\fC\-switchers\fR \fImode1,mode1\fP
.IP
Give a comma separated list of modes to enable, in what order.
.IP
For example to only show the run and ssh dialog (in that order):
.PP
.RS
.nf
rofi \-switchers "run,ssh" \-show run
.fi
.RE
.IP
Custom modes can be added using the internal 'script' mode. Each mode has two parameters:
.PP
.RS
.nf
<name>:<script>
.fi
.RE
.IP
So to have a mode 'Workspaces' using the \fB\fCi3_switch_workspace.sh\fR script type:
.PP
.RS
.nf
rofi \-switchers "window,run,ssh,Workspaces:i3_switch_workspaces.sh" \-show Workspaces
.fi
.RE
.SS Theming
.PP
\fB\fC\-bg\fR \fB\fC\-bg\fR
.IP .IP
Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222). Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222).
@ -173,6 +222,7 @@ Set the window opacity (0\-100).
rofi \-opacity "75" rofi \-opacity "75"
.fi .fi
.RE .RE
.SS Layout
.PP .PP
\fB\fC\-lines\fR \fB\fC\-lines\fR
.IP .IP
@ -208,7 +258,7 @@ If value is larger then 100, the size is set in pixels. e.g. to span a full hd m
.PP .PP
.RS .RS
.nf .nf
rofi \-width 1980 rofi \-width 1980
.fi .fi
.RE .RE
.IP .IP
@ -216,22 +266,11 @@ If the value is negative, it tries to estimates a character width. To show 30 ch
.PP .PP
.RS .RS
.nf .nf
rofi \-width \-30 rofi \-width \-30
.fi .fi
.RE .RE
.TP
(Character width is a rough estimation, and might not be correct, but should work for most
monospaced fonts..)
.PP
\fB\fC\-terminal\fR
.IP .IP
Specify what terminal to start (default x\-terminal\-emulator) Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts.
.PP
.RS
.nf
rofi \-terminal xterm
.fi
.RE
.PP .PP
\fB\fC\-location\fR \fB\fC\-location\fR
.IP .IP
@ -266,16 +305,22 @@ To make rofi look like dmenu:
rofi \-hmode \-padding 0 rofi \-hmode \-padding 0
.fi .fi
.RE .RE
.SS Pattern setting
.PP .PP
\fB\fC\-dmenu\fR \fB\fC\-terminal\fR
.IP .IP
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts. Specify what terminal to start (default x\-terminal\-emulator)
.IP
Pressing \fB\fCshift\-enter\fR will open the selected entries and move to the next entry.
.PP .PP
\fB\fC\-dump\-xresources\fR .RS
.nf
rofi \-terminal xterm
.fi
.RE
.PP
\fB\fC\-ssh\-client\fR \fIclient\fP
.IP .IP
Dump the current active configuration in xresources format to the command\-line. Override the used ssh client. Default is \fB\fCssh\fR\&.
.SS SSH settings
.PP .PP
\fB\fC\-ssh\-set\-title\fR \fItrue|false\fP \fB\fC\-ssh\-set\-title\fR \fItrue|false\fP
.IP .IP
@ -288,6 +333,7 @@ Default value is true.
\fB\fC\-ssh\-command\fR \fIcmd\fP \fB\fC\-ssh\-command\fR \fIcmd\fP
.IP .IP
Set the command to execute when starting a ssh session. Set the command to execute when starting a ssh session.
.SS Run settings
.PP .PP
\fB\fC\-run\-command\fR \fIcmd\fP \fB\fC\-run\-command\fR \fIcmd\fP
.IP .IP
@ -298,10 +344,7 @@ See \fIPATTERN\fP\&.
.IP .IP
Set the command to execute when running an application in a shell. Set the command to execute when running an application in a shell.
See \fIPATTERN\fP\&. See \fIPATTERN\fP\&.
.PP .SS History and Sorting
\fB\fC\-ssh\-client\fR \fIclient\fP
.IP
Override the used ssh client. Default is \fB\fCssh\fR\&.
.PP .PP
\fB\fC\-disable\-history\fR \fB\fC\-disable\-history\fR
.IP .IP
@ -312,64 +355,40 @@ Disable history
When searching sort the result based on levenshtein distance. When searching sort the result based on levenshtein distance.
.IP .IP
Note that levenshtein sort is disabled in dmenu mode. Note that levenshtein sort is disabled in dmenu mode.
.SS Dmenu specific
.PP .PP
\fB\fC\-show\fR \fImode\fP \fB\fC\-sep\fR \fIseparator\fP
.IP
Open rofi in a certain mode.
.IP
For example to show the run\-dialog:
.PP .PP
.RS .RS
.nf .nf
rofi \-show run Separator for dmenu. For example to show list a to e with '|' as separator:
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu
.fi .fi
.RE .RE
.IP
This function deprecates \-rnow,\-snow and \-now
.PP .PP
\fB\fC\-switchers\fR \fImode1,mode1\fP \fB\fC\-p\fR \fIprompt\fP
.IP
Give a comma separated list of modes to enable, in what order.
.IP
For example to only show the run and ssh dialog (in that order):
.PP .PP
.RS .RS
.nf .nf
rofi \-switchers "run,ssh" \-show run Specify the prompt to show in dmenu mode. E.g. select monkey a,b,c,d or e.
.fi echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey:"
.RE
.IP
Custom modes can be added using the internal 'script' mode. Each mode has two parameters:
.PP
.RS
.nf
<name>:<script>
.fi
.RE
.IP
So to have a mode 'Workspaces' using the \fB\fCi3_switch_workspace.sh\fR script type:
.PP
.RS
.nf
rofi \-switchers "window,run,ssh,Workspaces:i3_switch_workspaces.sh" \-show Workspaces
.fi .fi
.RE .RE
.SS Message dialog
.PP .PP
\fB\fC\-e\fR \fImessage\fP \fB\fC\-e\fR \fImessage\fP
.PP .PP
.RS .RS
.nf .nf
Popup a message dialog (used internally for showing errors) with *message*. Popup a message dialog (used internally for showing errors) with *message*.
Message can be multi\-line.
.fi .fi
.RE .RE
.SS Dumping
.PP .PP
\fB\fC\-sep\fR \fIseparator\fP \fB\fC\-dump\-xresources\fR
.PP .IP
.RS Dump the current active configuration in xresources format to the command\-line.
.nf
Separator for dmenu.
.fi
.RE
.SH Pattern .SH Pattern
.PP .PP
To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline, To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline,