Fix #2465: improve settings tutorial

This commit is contained in:
Oliver Blanthorn 2020-07-25 17:28:04 +01:00
parent acbc6938d7
commit 6247bbbc92
No known key found for this signature in database
GPG key ID: 2BB8C36BB504BFF3

View file

@ -1,8 +1,6 @@
# Settings
The Tridactyl settings are currently undergoing change; there will eventually be an `options` page where you can change and view these settings. For now, you can use `viewconfig [option]`. There's currently a small bug where we only show you your changed settings and not the rest of the defaults unless you specify the option exactly.
Currently, you can view description of settings with `help [setting]`, and find their current value with `get [setting]`. You can set a setting with `set`, and reset it to default with `unset` (the command `reset` is only for resetting keybinds because it seemed like a good idea at the time). `bind [key] [command]` is a helper command that sets settings within nmaps.
You can view description of settings with `help [setting]`, and find their current value with `get [setting]`. You can set a setting with `set`, and reset it to default with `unset` (the command `reset` is only for resetting keybinds because it seemed like a good idea at the time). `bind [key] [command]` is a helper command that sets settings within nmaps. You can also use `viewconfig` to view all settings at once (but Tridactyl cannot run on the page that it opens).
Here we will briefly summarise some of the main settings:
@ -18,4 +16,12 @@ Here we will briefly summarise some of the main settings:
- excmds
- aliases for command mode: the things on the left actually run the commands on the right. The most interesting one of these is `current_url`, which is how the binds for O, W and T (`bind T`) work.
There are many other commands related to settings:
- `:seturl [url pattern] [key] [values...]` sets a setting for URLs which match it
- `:bind [--mode=mode?] [key sequence] [ex-command...]` binds a key sequence to an ex-command in the mode specified
- `:bindurl [url pattern] [--mode=mode?] [key sequence] [ex-command...]` binds a key sequence to an ex-command in the url and mode specified
- `:unbind` unbinds a key sequence
- `:setnull` deletes a setting (overwriting the default with an "empty" setting - useful for deleting searchurls, for example)
The [next page](./6-containers.html) will talk about how to operate firefox containers with tridactyl. <a href='./4-command_mode.html' rel="prev"></a>