Add some usage examples to manpage.

This commit is contained in:
Dave Davenport 2016-12-21 09:42:04 +01:00
parent 74a1d0313a
commit 8099dbef4c
2 changed files with 180 additions and 1 deletions

View File

@ -839,6 +839,52 @@ The indicator shows:
`+` Case insensitive and Sorting enabled
`±` Sorting and Case sensitivity enabled"
## EXAMPLES
Some basic usage examples of **rofi**:
Show the run dialog:
rofi -modi run -show run
Show the the run dialog and allow switching to Desktop File run dialog (drun):
rofi -modi run,drun -show run
Combine the run and Desktop File run dialog (drun):
rofi -modi combi -show combi -combi-modi run,drun
Combine the run and Desktop File run dialog (drun) and allow switching to window switcher:
rofi -modi combi,window -show combi -combi-modi run,drun
Run **rofi** full monitor width at the top of the monitor like a dropdown menu:
rofi -show run -width 100 -location 1 -lines 5 -bw 2 -yoffset -2
Get a colored list of available wifi networks:
tty-pipe nmcli device wifi | out2html -p | rofi -dmenu -markup-rows
Popup a text message claiming that this is the end:
rofi -e "This is the end"
Popup a text message in red, bold font claiming that this is still the end:
rofi -e "<span color='red'><b>This is still the end</b></span>>" -markup
Show all keybindings:
rofi -show keys
Use `qalc` to get a simple calculator in **rofi**:
rofi -show calc -modi "calc:qalc +u8 -nocurrencies"
## LICENSE
MIT/X11

View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ROFI\-MANPAGE" "" "2016-12-19" "" ""
.TH "ROFI\-MANPAGE" "" "2016-12-21" "" ""
.
.SH "NAME"
\fBrofi\fR \- A window switcher, run launcher, ssh dialog and dmenu replacement
@ -1336,6 +1336,139 @@ The indicator shows:
.
.IP "" 0
.
.SH "EXAMPLES"
Some basic usage examples of \fBrofi\fR:
.
.P
Show the run dialog:
.
.IP "" 4
.
.nf
rofi \-modi run \-show run
.
.fi
.
.IP "" 0
.
.P
Show the the run dialog and allow switching to Desktop File run dialog (drun):
.
.IP "" 4
.
.nf
rofi \-modi run,drun \-show run
.
.fi
.
.IP "" 0
.
.P
Combine the run and Desktop File run dialog (drun):
.
.IP "" 4
.
.nf
rofi \-modi combi \-show combi \-combi\-modi run,drun
.
.fi
.
.IP "" 0
.
.P
Combine the run and Desktop File run dialog (drun) and allow switching to window switcher:
.
.IP "" 4
.
.nf
rofi \-modi combi,window \-show combi \-combi\-modi run,drun
.
.fi
.
.IP "" 0
.
.P
Run \fBrofi\fR full monitor width at the top of the monitor like a dropdown menu:
.
.IP "" 4
.
.nf
rofi \-show run \-width 100 \-location 1 \-lines 5 \-bw 2 \-yoffset \-2
.
.fi
.
.IP "" 0
.
.P
Get a colored list of available wifi networks:
.
.IP "" 4
.
.nf
tty\-pipe nmcli device wifi | out2html \-p | rofi \-dmenu \-markup\-rows
.
.fi
.
.IP "" 0
.
.P
Popup a text message claiming that this is the end:
.
.IP "" 4
.
.nf
rofi \-e "This is the end"
.
.fi
.
.IP "" 0
.
.P
Popup a text message in red, bold font claiming that this is still the end:
.
.IP "" 4
.
.nf
rofi \-e "<span color=\'red\'><b>This is still the end</b></span>>" \-markup
.
.fi
.
.IP "" 0
.
.P
Show all keybindings:
.
.IP "" 4
.
.nf
rofi \-show keys
.
.fi
.
.IP "" 0
.
.P
Use \fBqalc\fR to get a simple calculator in \fBrofi\fR:
.
.IP "" 4
.
.nf
rofi \-show calc \-modi "calc:qalc +u8 \-nocurrencies"
.
.fi
.
.IP "" 0
.
.SH "LICENSE"
.
.nf