tridactyl/doc/amo.md

77 lines
3.6 KiB
Markdown
Raw Normal View History

2017-12-05 14:17:57 +01:00
## Control your browser with your keyboard *only*.
Replace Firefox's control mechanism with one modelled on VIM.
Most common tasks you want your browser to perform are bind to a single key
press:
You want to open a new tab? Hit `t`.
You want to follow that link? Hit `f` and type the displayed label.
You want to go to the bottom of the page? Hit `G`. Or the top? `gg`.
You want to focus the text field on Wikipedia to search for another term? `gi`.
Switch to the next tab? `gt`.
Go back in time? `H`.
Notice that this tab is rubbish and you want to close it? `d`.
Regret that decision? `u` restores it.
Temporarily disable all that magic because you can't stand it? `I`.
2017-12-05 14:17:57 +01:00
But how do you use your browser now? `Shift-Esc` and we're back on.
2017-12-05 14:17:57 +01:00
The list could go on a bit here, but I guess you'll get the point. If you feel
lost sometimes `:help` might help you a lot.
**Highlighted features:**
- follow any link on the site with just 2-3 key presses.
- switch to any open tab by searching for its URL or title or entering its ID.
- easy customizable search settings
- bind any supported command or commands to the key (sequence) of your liking
- great default bindings (if you're used to Pentadactyl or Vimperator)
This add-on is very usable, but is in an early stage of development. We intend
to implement the majority of Vimperator's features.
2018-04-11 17:55:31 +01:00
You can get beta builds from [our website][betas].
**Permissions:**
Since Tridactyl aims to provide all the features Vimperator and Pentadactyl
had, it requires quite a few permissions. Here we describe the specific
permissions and why we need them.
- Access your data for all websites:
* This is Mozilla's way of saying that Tridactyl can read the content of web
2018-04-11 17:04:08 +01:00
pages. This is necessary in order to e.g. find the links you can follow
with the `:hint` command (bound to `f` by default).
- Read and modify bookmarks:
* Tridactyl's command line has a powerful autocompletion mechanism. In
order to be able to autocomplete your bookmarks, Tridactyl needs to read
them.
- Clear recent browsing history, cookies, and related data:
* Tridactyl implements the `:sanitise` command Vimperator and Pentadactyl
had. It works a bit like the "Clear All History" dialog you can access by
pressing `Ctrl+Shift+Del` on default Firefox.
- Get data from the clipboard:
* If your clipboard contains a URL, pressing `p` will make Tridactyl follow
this URL in the current tab.
- Input data to the clipboard:
* Tridactyl lets you copy various elements to the clipboard such as a page's
URL with `yy`, a link's URL with `;y` or the content of an HTML element
with `;p`.
2018-04-11 17:04:08 +01:00
- Download files and read and modify the browser's download history:
* By pressing `;s`, `;S`, `;a` and `;A` you can save documents and pictures
from a page to your download folder.
- Access browsing history:
2018-04-11 17:04:08 +01:00
* The URLs of websites you've visited previously can be suggested as
arguments for `:tabopen` and similar commands.
- Access recently closed tabs:
2018-04-11 17:04:08 +01:00
* If you've accidentally closed a tab or window, Tridactyl will let you open
it again with the `:undo` command which is bound to `u` by default.
- Access browser tabs:
2018-04-11 17:04:08 +01:00
* Tridactyl provides a quick tab-switching menu/command with the `:buffer`
command (bound to `b`). This permission is also required to close, move,
and pin tabs, amongst other things.
- Access browser activity during navigation:
* This is needed for Tridactyl to be able to go back to normal mode every
2018-04-11 17:04:08 +01:00
time you open a new page. In the future we may use it for autocommands.
2018-04-11 17:55:31 +01:00
[betas]: https://tridactyl.cmcaine.co.uk/betas/?sort=time&order=desc