Commit 7e1b1aaf authored by adam j hartz's avatar adam j hartz

bookmark: move docs

parent d8d8ac7a
......@@ -11,27 +11,6 @@ To install any of them, place the appropriate `.tako` file in your `~/.config/ta
* [Van](#van) (virtual environment management)
### Bookmark
Adds the `bmark` and `bgo` aliases. `bmark` can be used to quickly mark a
location, and `bgo` can be used to return to that location:
```
~ $ cd some/very/deeply/nested/structure
~/s/v/d/n/structure $ # oh shoot i forgot i wanted to go someplace else
~/s/v/d/n/structure $ bmark # remember this location
~/s/v/d/n/structure $ cd ~/someplace/else/entirely
~/s/e/entirely $ touch foo # do some work
~/s/e/entirely $ bgo # quickly jump back to the marked location
~/s/v/d/n/structure $ # i didn't have to navigate here by hand! hooray!
```
`bmark NAME` associates the current directory with a name, and then `bgo NAME`
can be used to jump back to it.
Currently, bookmarks do not persist across sessions.
### Frecency
Overrides the built-in suggestions for misspelled commands with new ones based
......
# Tako PLugin: Bookmark
This plugin adds several aliases to make moving between known/frequent
locations easier. For example:
```
~ $ cd some/very/deeply/nested/structure
~/s/v/d/n/structure $ # oh shoot i forgot i wanted to go someplace else
~/s/v/d/n/structure $ bmark # remember this location
~/s/v/d/n/structure $ cd ~/someplace
~/someplace $ cd else/entirely
~/s/e/entirely $ touch foo # do some work
~/s/e/entirely $ bgo # quickly jump back to the marked location
~/s/v/d/n/structure $ # i didn't have to navigate here by hand! hooray!
```
This plugin adds the following commands to `tako`:
```
bmark: Add a bookmark to the in-memory store
Usage:
bmark [NAME] [DIR]
If no name is specified, store the directory in an anonymous bookmark.
If no directory is specified, use the current working directory.
```
```
bgo: Follow a bookmark
Usage:
bgo [NAME]
If no name is specified, try to move to the anonymous bookmark.
```
```
brop: Delete a bookmark
Usage:
bdrop [NAME]
If no name is specified, try to remove the anonymous bookmark.
```
```
blist: List current in-memory bookmarks
Usage:
blist
```
By default, bookmarks do not persist across sessions. However, they can be
serialized to disk using the following commands:
```
bwrite: Serialize current bookmarks to disk
Usage:
bwrite [FILE]
If no file is specified, a default location in ~/.local/share/tako/plugins/bookmark is used.
```
```
bload: Load bookmarks from disk
Usage:
bload [FILE]
If no file is specified, a default location in ~/.local/share/tako/plugins/bookmark is used.
```
If you are using persistent bookmarks, you probably want to add `bload` to the
bottom of your `config.tako` file so that these bookmarks are automatically
loaded for each new session.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment