diff --git a/doc/rofi-manpage.markdown b/doc/rofi-manpage.markdown index ea9dc70c..5f17b6af 100644 --- a/doc/rofi-manpage.markdown +++ b/doc/rofi-manpage.markdown @@ -69,7 +69,7 @@ daemon listening to specific key-combination or emulating dmenu. ### Single-shot mode -To launch **rofi** directly in a certain mode, specifying `rofi -show `. +To launch **rofi** directly in a certain mode, specify a mode with `rofi -show `. To show the run dialog: ``` @@ -78,8 +78,8 @@ To show the run dialog: ### Daemon mode -To launch **rofi** in daemon mode don't specify a mode to show (`-show `), instead you can -bind keys to launch a certain mode. To have run mode open when pressing `F2` start **rofi** like: +To launch **rofi** in daemon mode don't specify any mode, instead keys can be bound +to launch a certain mode. To show run-mode by pressing `F2` start **rofi** like this: ``` rofi -key-run F2 @@ -102,14 +102,14 @@ There are currently three methods of setting configuration options: This is the recommended way of configuring **rofi**. * Command-line options: Arguments passed to **rofi**. -The Xresources options and the command-line options are aliased. So to set option X you would set: +The Xresources file expects options starting with `rofi.` followed by it's name. An Example to set the number of lines: - rofi.X: value + rofi.lines: 10 -In the Xresources file, and to (override) this via the command-line you would pass the same key +Command line options override settings from Xresources file. The same option set as argument: prefixed with a '-': - rofi -X value + rofi -lines 10 To get a list of available options, formatted as Xresources entries run: @@ -122,7 +122,7 @@ The configuration system supports the following types: * Char * Boolean -The boolean option has a non-default command-line syntax, to enable option X you do: +Boolean options have a non-default command-line syntax. Example to enable option X: -X @@ -138,18 +138,15 @@ Below is a list of the most important options: Set the key combination to display a {mode} in daemon mode. - rofi -key-run F12 rofi -key-ssh control+shift+s rofi -key-window mod1+Tab `-dmenu` - Run **rofi** in dmenu mode. Allowing it to be used for user interaction in scripts. - - In `dmenu` mode, **rofi** will read input from STDIN, and will output to STDOUT by default. - - Example to let the user choose between three pre-defined options: + Run **rofi** in dmenu mode. This allows for interactive scripts. + In `dmenu` mode, **rofi** reads from STDIN, and output to STDOUT. + A simple example, display 3 pre-defined options: echo -e "Option #1\nOption #2\nOption #3" | rofi -dmenu @@ -157,24 +154,21 @@ Below is a list of the most important options: ~/my_script.sh | rofi -dmenu - Pressing `shift-enter` will open the selected entries and move to the next entry. + Pressing `shift-enter` sends the selected entry to STDOUT and moves to the next entry. `-show` *mode* - Open **rofi** in a certain mode. - - For example to show the run-dialog: + Open **rofi** in a certain mode. Available modes are `window`, `run`, `ssh` + To show the run-dialog: rofi -show run - This function deprecates -rnow,-snow and -now - -`-switchers` *mode1,mode1* `-modi` *mode1,mode1* - Give a comma separated list of modes to enable, in what order. - - For example to only show the run and ssh launcher (in that order): + Specify a ordered, comma separated list of modes to enable. + Enabled modes can be changed at runtime. Default key is Ctrl+Tab. + If no modes are specified all modes will be enabled. + To only show the run and ssh launcher: rofi -modi "run,ssh" -show run @@ -182,7 +176,7 @@ Below is a list of the most important options: :