PeterHero/sxbm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: some reformatting

Browse Source
This commit is contained in:
NRK
2022-11-04 04:19:23 +06:00
parent 61c7fdec63
commit 736d4e142d
1 changed files with 27 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -5,60 +5,52 @@
I needed a simple and browser-independent way of managing my bookmarks, leading to the creation of sxbm. I needed a simple and browser-independent way of managing my bookmarks, leading to the creation of sxbm.
It's written in strictly POSIX compliant shell, so it should work fine on all \*nix based operating system. It's written in strictly POSIX compliant shell, so it should work fine on all \*nix based operating system.
Sxbm stores your bookmarks in a plain text file making it easily portable. sxbm stores your bookmarks in a plain text file making it easily portable.
Bookmarks are categorized via tags as opposed to the inferior folder structure found in browsers. Bookmarks are categorized via tags as opposed to the inferior folder structure found in browsers.
## Installation ## Installation
Cone the repo. Cone the repo.
```
git clone https://codeberg.org/NRK/sxbm.git git clone https://codeberg.org/NRK/sxbm.git
```
Then just copy/move the script into your $PATH. Then just copy/move the script into your $PATH.
Instead of copying, you can also create a symlink. This way you can do a git pull to get updates. Instead of copying, you can also create a symlink. This way you can do a git pull to get updates.
## Usage ## Usage
Adding a bookmark (title and tag are optional.) * Adding a bookmark (title and tag are optional.)
```
sxbm add link.com title +tag
```
Opening a bookmark. You need to specify a title, tag or line\_number. sxbm add link.com title +tag
If there are multiple results use `sxbm open -f` to open them all.
```
sxbm open <title|+tag|line_number>
```
List all bookmarks. * Opening a bookmark. You need to specify a title, tag or line\_number.
``` If there are multiple results use `sxbm open -f` to open them all.
sxbm ls
```
Edit bookmarks. sxbm open <title|+tag|line_number>
```
sxbm edit
```
Remove a bookmark. * List all bookmarks.
```
sxbm rm <line_number> sxbm ls
```
* Edit bookmarks.
sxbm edit
* Remove a bookmark.
sxbm rm <line_number>
Run `sxbm --help` to see more detailed usage. Run `sxbm --help` to see more detailed usage.
## Searching ## Searching
Searching by tag * Searching by tag
```
sxbm ls +tag
```
Searching by title sxbm ls +tag
```
sxbm ls title * Searching by title
```
sxbm ls title
By default tag searches are non-strict while title searches are strict. By default tag searches are non-strict while title searches are strict.
@ -72,8 +64,8 @@ As for titles, `sxbm ls aplha beta` will match bookmarks that contains BOTH
`alpha` and `beta`. You can pass the `-S` option to search for entries that `alpha` and `beta`. You can pass the `-S` option to search for entries that
contain either one of the queries. contain either one of the queries.
One more thing to keep in mind is that title search also matches links. The One more thing to keep in mind is that title search also matches links.
rational is that you may want to search `sxbm ls "gentoo.org"` to find The rational is that you may want to search `sxbm ls "gentoo.org"` to find
bookmarks with the specified url. bookmarks with the specified url.
## Using it with Dmenu/Rofi ## Using it with Dmenu/Rofi