Include and exclude rules
|User Script Authoring|
The script will execute if it matches any include rule, as long as it does not match an exclude rule.
The rules are URLs, which can have a "wildcard" asterisk (*), which matches any string including the empty string. For example:
http://www.example.com/foo/* will match
http://www.example.com/foo/, but not
http://www.example.com/baz/. A rule can have several wildcards or none, in which case the rule must match the entire URL exactly. Exclude rules look the same, and prevent the script from being executed. An example:
// ==UserScript== // @include http://www.example.com/foo/* // @include http://www.example.org/*.bar // @exclude http://www.example.com/foo/baz // ==/UserScript==
If no include rule is provided,
@include * is assumed. That is, every URL will be matched.
- Only if
greasemonkey.fileIsGreaseableis set to
- Only if
greasemonkey.aboutIsGreaseableis set to
truein about:config. about:blank is always allowed.
The only special syntax besides the wildcard is .tld. An include such as
http://www.example.tld/* will match any top level domain, such as
www.example.co.uk, and so on. One must be careful with this, to not accidentally leak data to a site that they did not mean to match. This list of TLDs includes a myriad of dual-segment TLDs (such as ca.us, aeroport.fr and kyoto.jp), beside the plain country or category codes (com, jp, se). For a full list see the Magic TLD page.