Clean up rofi config
This commit is contained in:
107
general/configs/rofi/spotlight/README.md
Normal file
107
general/configs/rofi/spotlight/README.md
Normal file
@@ -0,0 +1,107 @@
|
||||
## rofi: *spotlight*
|
||||
|
||||
A spotlight-like rofi. Supports file and web search.
|
||||
|
||||
<p align='center'>
|
||||
<img alt='rofi: spotlight' src='scrot.webp'/>
|
||||
<br/>
|
||||
<i>
|
||||
rofi: spotlight
|
||||
</i>
|
||||
</p>
|
||||
|
||||
#### Dependencies
|
||||
|
||||
+ `rofi-git master branch`
|
||||
+ `python3`
|
||||
+ `bash`
|
||||
+ `fd (optional)`
|
||||
+ `an icon theme (optional)`
|
||||
|
||||
#### Icon themes used:
|
||||
|
||||
+ Papirus
|
||||
+ Tela Blue
|
||||
|
||||
#### Run it by:
|
||||
|
||||
```bash
|
||||
$ rofi -modi "Global Search":"rofi-spotlight/rofi-spotlight.sh" -show "Global Search" \
|
||||
-config rofi-spotlight/rofi.rasi
|
||||
```
|
||||
|
||||
#### Recommendation
|
||||
|
||||
+ Install `fd` for faster file searching. Defaults to `find` if not installed.
|
||||
|
||||
#### Configuration:
|
||||
|
||||
You can change the following variables in the `rofi-spotlight.sh`
|
||||
+ Terminal Emulator
|
||||
+ File Manager
|
||||
+ Bluetooth sender
|
||||
|
||||
You can change the following variables in the `web-search.py`
|
||||
+ Search engine
|
||||
+ Web browser
|
||||
+ Terminal Emulator
|
||||
|
||||
#### Available commands:
|
||||
|
||||
Just type them on rofi search bar:
|
||||
|
||||
+ **`:help`** to print the help message
|
||||
+ **`:h`** or **`:hidden`** to show hidden files/directories
|
||||
+ **`:xdg XDGDIR`** to jump to an xdg directory
|
||||
|
||||
Examples:
|
||||
|
||||
```
|
||||
:xdg DOCUMENTS
|
||||
:xdg DOWNLOADS
|
||||
|
||||
# Also supports incomplete path. Examples:
|
||||
|
||||
:xdg doc # Same as :xdg DOCUMENTS
|
||||
:xdg down # Same as :xdg DOWNLOADS
|
||||
|
||||
# For more info about XDG dirs, see:
|
||||
# man xdg-user-dir
|
||||
```
|
||||
|
||||
**File search syntaxes:**
|
||||
+ **`!<search_query>`** to search for a file and web suggestions
|
||||
+ **`?<search_query>`** to search parent directories
|
||||
|
||||
Examples:
|
||||
|
||||
```
|
||||
!half-life 3
|
||||
?portal 3
|
||||
```
|
||||
|
||||
**Web search syntaxes:**
|
||||
|
||||
+ **`!<search_query>`** to get a search suggestions
|
||||
+ **`:web <search_query>`** to also to gets search suggestions
|
||||
+ **`:webbro <search_query>`** to search directly from your browser
|
||||
|
||||
Examples:
|
||||
|
||||
```
|
||||
!how to install archlinux
|
||||
:web how to install gentoo
|
||||
:webbro how to install wine in windowsxp
|
||||
```
|
||||
|
||||
#### TODOs:
|
||||
|
||||
- [x] Web search support
|
||||
- [x] Cleaner bash script
|
||||
|
||||
#### Notes:
|
||||
|
||||
+ This is not a file manager nor a web browser. This is a file/web-searching rofi. Nothing else.
|
||||
+ Default rofi design is better with blur. Rofi's appearance can be change in `rofi.rasi`. It uses CSS syntax. More info by executing `man rofi-theme` in your terminal emulator.
|
||||
|
||||
#### Credits to [these people](https://github.com/manilarome/rofi-spotlight/graphs/contributors)
|
Reference in New Issue
Block a user