diff options
Diffstat (limited to 'Search-Syntax.md')
| -rw-r--r-- | Search-Syntax.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/Search-Syntax.md b/Search-Syntax.md new file mode 100644 index 0000000..86a8d4d --- /dev/null +++ b/Search-Syntax.md @@ -0,0 +1,22 @@ +# Search Syntax
+
+!!! notice
+
+ This only applies to built-in search, other search plugins like may override this syntax.
+
+Search query consists of several keywords. Keyword starting with "-" is considered a negative match. Several special keywords are available:
+
+* ``@{date}`` - match by date. For example, @yesterday or @2011-11-03. Please note that due to incomplete implementation, special date keywords like yesterday might not match all articles if user timezone is different from tt-rss internal timezone (UTC).
+* ``pub:{true,false}`` - match only published or unpublished articles
+* ``star:{true, false}`` - same, starred articles
+* ``unread:{true, false}`` - self explanatory (requires trunk as of 05.03.2015)
+* ``note:{true, false, sometext}`` - same, for articles having an attached note or matching the specified text
+* ``label:Somelabel`` - articles that belong to a specified label
+* ``tag:mytag`` - articles which have specified tag
+* ``title:``, ``author:`` - self explanatory
+
+When searching by keyword with spaces, use quotes like this: `"title:string with spaces"` or `tag:"multiple words"`
+
+If no special keywords are specified, search is done using PostgreSQL [Full Text Search](https://www.postgresql.org/docs/current/textsearch-intro.html) engine.
+
+Pointless as it may be, you can combine negative prefix with the special keywords: -star:true would essentially mean star:false.
|