summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2017-07-22 21:11:46 +0200
committerDave Davenport <qball@gmpclient.org>2017-07-22 21:11:46 +0200
commit2e0b973bcf84824e027c6b9e58cb159a00e000cb (patch)
tree2c42c1d89b4d9043f8ba333c914e39b9d61673db /doc
parent138ffc168d68f43c74db0e658cb30261a07d9a8b (diff)
Small updates to manpage
Diffstat (limited to 'doc')
-rw-r--r--doc/rofi.118
-rw-r--r--doc/rofi.1.markdown56
2 files changed, 28 insertions, 46 deletions
diff --git a/doc/rofi.1 b/doc/rofi.1
index 0bfe3c2c..774e8027 100644
--- a/doc/rofi.1
+++ b/doc/rofi.1
@@ -7,7 +7,7 @@
\fBrofi\fR \- A window switcher, application launcher, ssh dialog and dmenu replacement
.
.SH "SYNOPSIS"
-\fBrofi\fR [ \-width \fIpct_scr\fR ] [ \-lines \fIlines\fR ] [ \-columns \fIcolumns\fR ] [ \-font \fIpangofont\fR ] [ \-terminal \fIterminal\fR ] [ \-location \fIposition\fR ] [ \-fixed\-num\-lines ] [ \-padding \fIpadding\fR ] [ \-display \fIdisplay\fR ] [ \-bw \fIwidth\fR ] [ \-dmenu [ \-p \fIprompt\fR ] [ \-sep \fIseparator\fR ] [ \-l \fIselected line\fR ] [ \-mesg ] [ \-select ] [ \-input \fIinput\fR ] ] [ \-filter \fIfilter\fR ] [ \-ssh\-client \fIclient\fR ] [ \-ssh\-command \fIcommand\fR ] [ \-window\-command \fIcommand\fR ] [ \-disable\-history ] [ \-levenshtein\-sort ] [ \-case\-sensitive ] [ \-cycle ] [ \-show \fImode\fR ] [ \-modi \fImode1,mode2\fR ] [ \-eh \fIelement height\fR ] [ \-e \fImessage\fR] [ \-a \fIrow\fR ] [ \-u \fIrow\fR ] [ \-pid \fIpath\fR ] [ \-version ] [ \-help ] [ \-dump\-xresources ] [ \-auto\-select ] [ \-parse\-hosts ] [ \-no\-parse\-known\-hosts ] [ \-combi\-modi \fImode1,mode2\fR ] [ \-normal\-window ] [ \-fake\-transparency ] [ \-matching \fImethod\fR ] [ \-tokenize ] [ \-no\-click\-to\-exit ] [ \-threads \fInum\fR ] [ \-config \fIfilename\fR ] [ \-no\-show\-match ] [ \-theme \fIfilename\fR ] [ \-theme\-str \fIstring\fR ] [ \-dpi \fIdpi\fR ]
+\fBrofi\fR [ \-show \fImode\fR ]|[ \-dmenu ]|[ \-e \fImsg\fR ] [ CONFIGURATION ]
.
.SH "DESCRIPTION"
\fBrofi\fR is an X11 popup window switcher, run dialog, dmenu replacement and more\. It focuses on being fast to use and have minimal distraction\. It supports keyboard and mouse navigation, type to filter, tokenized search and more\.
@@ -40,6 +40,22 @@ The "official" website for \fBdmenu\fR can be found here \fIhttp://tools\.suckle
.P
\fBrofi\fR does not aim to be 100% compatible with dmenu\. There are simply to many different flavours of dmenu\. The idea is the basic usage commandline flags are obeyed, theme related flags are not\. Besides this, \fBrofi\fR offers some extended features (like multi\-select, highlighting, message bar, extra key\-bindings)\.
.
+.SS "Display Error message"
+\fBrofi\fR error dialog can also be called from the commandline\.
+.
+.IP "" 4
+.
+.nf
+
+rofi \-e "my message"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Markup support can be enabled, see CONFIGURATION options\.
+.
.SH "CONFIGURATION"
There are currently three methods of setting configuration options (evaluated in order below):
.
diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown
index 5194cab4..d6f04641 100644
--- a/doc/rofi.1.markdown
+++ b/doc/rofi.1.markdown
@@ -6,51 +6,8 @@
## SYNOPSIS
-**rofi**
-[ -width *pct_scr* ]
-[ -lines *lines* ]
-[ -columns *columns* ]
-[ -font *pangofont* ]
-[ -terminal *terminal* ]
-[ -location *position* ]
-[ -fixed-num-lines ]
-[ -padding *padding* ]
-[ -display *display* ]
-[ -bw *width* ]
-[ -dmenu [ -p *prompt* ] [ -sep *separator* ] [ -l *selected line* ] [ -mesg ] [ -select ] [ -input *input* ] ]
-[ -filter *filter* ]
-[ -ssh-client *client* ]
-[ -ssh-command *command* ]
-[ -window-command *command* ]
-[ -disable-history ]
-[ -levenshtein-sort ]
-[ -case-sensitive ]
-[ -cycle ]
-[ -show *mode* ]
-[ -modi *mode1,mode2* ]
-[ -eh *element height* ]
-[ -e *message*]
-[ -a *row* ]
-[ -u *row* ]
-[ -pid *path* ]
-[ -version ]
-[ -help ]
-[ -dump-xresources ]
-[ -auto-select ]
-[ -parse-hosts ]
-[ -no-parse-known-hosts ]
-[ -combi-modi *mode1,mode2* ]
-[ -normal-window ]
-[ -fake-transparency ]
-[ -matching *method* ]
-[ -tokenize ]
-[ -no-click-to-exit ]
-[ -threads *num* ]
-[ -config *filename* ]
-[ -no-show-match ]
-[ -theme *filename* ]
-[ -theme-str *string* ]
-[ -dpi *dpi* ]
+**rofi** [ -show *mode* ]|[ -dmenu ]|[ -e *msg* ] [ CONFIGURATION ]
+
## DESCRIPTION
@@ -85,6 +42,15 @@ The "official" website for `dmenu` can be found [here](http://tools.suckless.org
The idea is the basic usage commandline flags are obeyed, theme related flags are not.
Besides this, **rofi** offers some extended features (like multi-select, highlighting, message bar, extra key-bindings).
+
+### Display Error message
+
+**rofi** error dialog can also be called from the commandline.
+
+ rofi -e "my message"
+
+Markup support can be enabled, see CONFIGURATION options.
+
## CONFIGURATION
There are currently three methods of setting configuration options (evaluated in order below):