PolytreeDE/rofi
1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2025-07-31 21:59:25 -04:00
Code Releases Activity

Fix grammar, spelling, and formatting in readme (#888)

Browse source 
* Fix grammar and formatting mistakes in readme

* Missed a full stop
This commit is contained in:
moonrisewarrior 2019-01-02 09:51:59 +00:00 • committed by Dave Davenport
parent 238648b5b2
commit 9465d189f7
1 changed files with 43 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

88
README.md
View file

@ -9,45 +9,45 @@
# A window switcher, Application launcher and dmenu replacement # A window switcher, Application launcher and dmenu replacement
**Rofi** started as a clone of simpleswitcher, written by [Sean Pringle](http://github.com/seanpringle/simpleswitcher) a **Rofi** started as a clone of simpleswitcher, written by [Sean Pringle](http://github.com/seanpringle/simpleswitcher) - a
popup window switcher roughly based on [superswitcher](http://code.google.com/p/superswitcher/). popup window switcher roughly based on [superswitcher](http://code.google.com/p/superswitcher/).
Simpleswitcher laid the foundations, and therefor Sean Pringle deserves most of the credit for this tool. **Rofi** Simpleswitcher laid the foundations, and therefore Sean Pringle deserves most of the credit for this tool. **Rofi**
(renamed, as it lost the *simple* property) has been extended with extra features, like an application launcher, (renamed, as it lost the *simple* property) has been extended with extra features, like an application launcher and
ssh-launcher and can act as a drop-in dmenu replacement, making it a very versatile tool. ssh-launcher, and can act as a drop-in dmenu replacement, making it a very versatile tool.
**Rofi**, like dmenu, will provide the user with a textual list of options where one or more can be selected. **Rofi**, like dmenu, will provide the user with a textual list of options where one or more can be selected.
This can either be, running an application, selecting a window or options provided by an external script. This can either be running an application, selecting a window, or options provided by an external script.
Its main features are: Its main features are:
* fully configurable keyboard navigation * Fully configurable keyboard navigation
* type to filter * Type to filter
- tokenized: type any word in any order to filter - Tokenized: type any word in any order to filter
- (togglable) case insensitive - Case insensitive (togglable)
- support for fuzzy-, regex-, and glob matching - Support for fuzzy-, regex-, and glob matching
* UTF-8 enabled * UTF-8 enabled
- UTF-8-aware string collating - UTF-8-aware string collating
- international keyboard support (`e -> è) - International keyboard support (`e -> è)
* RTL language support * RTL language support
* Cairo drawing and Pango font rendering * Cairo drawing and Pango font rendering
* built-in modes: * Built-in modes:
- window switcher mode - Window switcher mode
- EWMH compatible WM - EWMH compatible WM
- application launcher - Application launcher
- desktop file application launcher - Desktop file application launcher
- SSH launcher mode - SSH launcher mode
- Combi mode, allowing several modes to be merged into one list - Combi mode, allowing several modes to be merged into one list
* history-based ordering — last 25 choices are ordered on top based on use (optional) * History-based ordering — last 25 choices are ordered on top based on use (optional)
* Levenshtein distance ordering of matches (optional) * Levenshtein distance ordering of matches (optional)
* drop-in dmenu replacement * Drop-in dmenu replacement
- many added improvements - Many added improvements
* easily extensible using scripts * Easily extensible using scripts
* theming * Theming
**Rofi** has several built-in modes implementing common use cases and can be extended by scripts (either called from **Rofi** has several built-in modes implementing common use cases and can be extended by scripts (either called from
**Rofi** or calling **Rofi**). **Rofi** or calling **Rofi**).
Below the different modes are listed: Below is a list of the different modes:
## Window Switcher ## Window Switcher
@ -61,8 +61,8 @@ The window switcher shows the following informations in columns (can be customiz
Window mode features: Window mode features:
- closing applications with `Shift-Delete` * Closing applications with `Shift-Delete`
- custom command with `Shift-Return` * Custom command with `Shift-Return`
## Application launcher ## Application launcher
@ -73,9 +73,9 @@ The run mode allows users to quickly search for and launch a program.
Run mode features: Run mode features:
- `Shift-Return` to run the selected program in a terminal * `Shift-Return` to run the selected program in a terminal
- favorites list, with frequently used programs sorted on top * Favorites list, with frequently used programs sorted on top
- custom entries, like aliases, added by executing a command * Custom entries, like aliases, added by executing a command
## Desktop File Application launcher ## Desktop File Application launcher
@ -84,16 +84,14 @@ The desktop run mode allows users to quickly search and launch an application fr
Entries. These are used by most Desktop Environments to populate launchers and menus. Entries. These are used by most Desktop Environments to populate launchers and menus.
Drun mode features: Drun mode features:
- favorites list, with frequently used programs sorted on top * Favorites list, with frequently used programs sorted on top
- auto starting terminal applications in a terminal * Auto starting terminal applications in a terminal
## SSH launcher ## SSH launcher
![SSH Launcher](https://davedavenport.github.io/rofi/images/rofi/ssh-dialog.png) ![SSH Launcher](https://davedavenport.github.io/rofi/images/rofi/ssh-dialog.png)
Quickly `ssh` into remote machines Quickly `ssh` into remote machines. Parses `~/.ssh/config` to find hosts.
- parses `~/.ssh/config` to find hosts
## Script mode ## Script mode
@ -129,7 +127,7 @@ write them to stdout.
# Usage # Usage
If used with `-show [mode]`, rofi will immediately open in the specified [mode] If used with `-show [mode]`, rofi will immediately open in the specified [mode].
If used with `-dmenu`, rofi will use data from STDIN to let the user select an option. If used with `-dmenu`, rofi will use data from STDIN to let the user select an option.
@ -211,35 +209,35 @@ A distribution can ship defaults in `/etc/rofi.conf`.
The Xresources options and the command line options are aliased. To define option X set: The Xresources options and the command line options are aliased. To define option X set:
rofi.X: value `rofi.X: value`
In the Xresources file. To set/override this from command line pass the same key In the Xresources file. To set/override this from command line pass the same key
prefixed with '-': prefixed with '-':
rofi -X value `rofi -X value`
To get a list of available options formatted as Xresources entries, run: To get a list of available options formatted as Xresources entries, run:
rofi -dump-Xresources `rofi -dump-Xresources`
or in a more readable format: or in a more readable format:
rofi -help `rofi -help`
The configuration system supports the following types: The configuration system supports the following types:
* string * String
* integer (signed and unsigned) * Integer (signed and unsigned)
* char * Char
* Boolean * Boolean
The Boolean option has a non-default command line syntax, to enable option X you do: The Boolean option has a non-default command line syntax, to enable option X you do:
rofi -X `rofi -X`
to disable it: to disable it:
rofi -no-X `rofi -no-X`
# Manpage # Manpage