Improve source URL help

This commit is contained in:
Oliver Blanthorn 2019-09-20 19:10:45 +01:00
parent 7670cc7784
commit 7d05f76b40
No known key found for this signature in database
GPG key ID: 2BB8C36BB504BFF3

View file

@ -726,7 +726,9 @@ export async function mktridactylrc(...args: string[]) {
*
* If no argument given, it will try to open ~/.tridactylrc, ~/.config/tridactyl/tridactylrc or $XDG_CONFIG_HOME/tridactyl/tridactylrc in reverse order. You may use a `_` in place of a leading `.` if you wish, e.g, if you use Windows.
*
* If no url is specified with the `--url` flag, the current page's URL is used to locate the RC file.
* If no url is specified with the `--url` flag, the current page's URL is used to locate the RC file. Ensure the URL you pass (or page you are on) is a "raw" RC file, e.g. https://raw.githubusercontent.com/tridactyl/tridactyl/master/.tridactylrc and not https://github.com/tridactyl/tridactyl/blob/master/.tridactylrc.
*
* Tridactyl won't run on many raw pages due to a Firefox bug with Content Security Policy, so you may need to use the `source --url [URL]` form.
*
* On Windows, the `~` expands to `%USERPROFILE%`.
*